File indexing completed on 2024-05-05 04:47:22

0001 /****************************************************************************************
0002  * Copyright (c) 2009 Casey Link <unnamedrambler@gmail.com>                             *
0003  *                                                                                      *
0004  * This program is free software; you can redistribute it and/or modify it under        *
0005  * the terms of the GNU General Public License as published by the Free Software        *
0006  * Foundation; either version 2 of the License, or (at your option) any later           *
0007  * version.                                                                             *
0008  *                                                                                      *
0009  * This program is distributed in the hope that it will be useful, but WITHOUT ANY      *
0010  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A      *
0011  * PARTICULAR PURPOSE. See the GNU General Public License for more details.             *
0012  *                                                                                      *
0013  * You should have received a copy of the GNU General Public License along with         *
0014  * this program.  If not, see <http://www.gnu.org/licenses/>.                           *
0015  ****************************************************************************************/
0016 
0017 #ifndef PLAYURLRUNNER_H
0018 #define PLAYURLRUNNER_H
0019 
0020 #include "amarok_export.h"
0021 #include "AmarokUrlRunnerBase.h"
0022 
0023 #include <QList>
0024 /**
0025  * The Runner that handles urls that plays tracks.
0026  * @author Casey Link <unnamedrambler@gmail.com>
0027  */
0028 class AMAROK_EXPORT PlayUrlRunner : public AmarokUrlRunnerBase
0029 {
0030 public:
0031     PlayUrlRunner ();
0032 
0033     ~PlayUrlRunner () override;
0034 
0035     QString command () const override;
0036     QString prettyCommand() const override;
0037     bool run ( const AmarokUrl &url ) override;
0038     QIcon icon () const override;
0039 
0040     /**
0041      * This function takes a url for a track, and returns a list
0042      * of bookmarks (represented by play amarokurls) for the track.
0043      * The definition of a play amarokurl is in PlayUrlGenerator
0044      *
0045      * @param url the playableUrl() of a Meta::Track
0046      * @return a list of bookmarks. the list is empty if no bookmarks exist.
0047      * @see PlayUrlGenerator
0048      */
0049     static BookmarkList bookmarksFromUrl( const QUrl &url );
0050 
0051 };
0052 
0053 #endif // PLAYURLRUNNER_H