File indexing completed on 2025-01-05 04:26:51

 /****************************************************************************************
  * Copyright (c) 2013 Anmol Ahuja <darthcodus@gmail.com>                                *
  *                                                                                      *
  * This program is free software; you can redistribute it and/or modify it under        *
  * the terms of the GNU General Public License as published by the Free Software        *
  * Foundation; either version 2 of the License, or (at your option) any later           *
  * version.                                                                             *
  *                                                                                      *
  * This program is distributed in the hope that it will be useful, but WITHOUT ANY      *
  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A      *
  * PARTICULAR PURPOSE. See the GNU General Public License for more details.             *
  *                                                                                      *
  * You should have received a copy of the GNU General Public License along with         *
  * this program.  If not, see <http://www.gnu.org/licenses/>.                           *
  ****************************************************************************************/
 
 #ifndef AMAROK_PLAYLISTMANAGER_SCRIPT_H
 #define AMAROK_PLAYLISTMANAGER_SCRIPT_H
 
 #include "core/meta/forward_declarations.h"
 
 #include <QObject>
 
 namespace Playlists
 {
     class Playlist;
     class PlaylistProvider;
 
     typedef AmarokSharedPointer<Playlist> PlaylistPtr;
     typedef QList<PlaylistPtr> PlaylistList;
     typedef QList<Playlists::PlaylistProvider *> PlaylistProviderList;
 }
 
 namespace AmarokScript
 {
     class AmarokScriptEngine;
 
     //ANM-TODO podcasts!
     // SCRIPTDOX Amarok.PlaylistManager
     class AmarokPlaylistManagerScript : public QObject
     {
         Q_OBJECT
 
         // SCRIPTDOX ENUM Amarok.PlaylistManager.PlaylistCategory
         // enum PlaylistCategory { UserPlaylist, PodcastChannel };
 
         /**
          * @returns all available categories registered at that moment
          */
         Q_PROPERTY( QList<int> availableCategories READ availableCategories )
 
         public:
             explicit AmarokPlaylistManagerScript( AmarokScriptEngine* engine );
 
             /**
              * @returns playlists of a certain category from all registered PlaylistProviders
              */
             Q_INVOKABLE Playlists::PlaylistList playlistsOfCategory( int playlistCategory );
 
             /**
              * @returns all PlaylistProviders that provide a certain playlist category.
              **/
             Q_INVOKABLE Playlists::PlaylistProviderList providersForCategory( int playlistCategory );
 
             // ANM-TODO synced playlists
             /**
              * Do all the work necessary to sync playlists, including the
              * SyncedPlaylist creation and more. This sync is persistent.
              * @arg playlist of the master playlist
              * @arg playlist of the slave playlist
              */
             //void setupSync( const Playlists::PlaylistPtr master, const Playlists::PlaylistPtr slave );
 
             /**
              * Return provider with @p name and @p category.
              *
              * @param category the category.
              * @param name the name.
              */
             Q_INVOKABLE Playlists::PlaylistProvider *playlistProvider( int category, QString name );
 
             /**
              *   Saves a list of tracks to a new playlist. Used in the Playlist save button.
              *   @arg tracks list of tracks to save
              *   @arg name of playlist to save
              *   @arg toProvider If 0 (default) will save to the default UserPlaylistProvider ( SQLPlaylistProvider )
              */
             Q_INVOKABLE bool save( Meta::TrackList tracks, const QString &name = QString(),
                        Playlists::PlaylistProvider *toProvider = nullptr );
 
             /**
              *  Saves a playlist from a file to the database.
              *  @param fromLocation Saved playlist file to load
              */
             Q_INVOKABLE bool import( const QUrl &fromLocation );
 
             /**
              * Rename @p playlist to @p newName, return true if renaming was successful,
              * false otherwise.
              *
              * @param playlist the playlist.
              * @param newName the new name.
              */
             Q_INVOKABLE bool rename( Playlists::PlaylistPtr playlist, const QString &newName );
 
             Q_INVOKABLE bool deletePlaylists( Playlists::PlaylistList playlistList );
 
             /**
              *  Retrieves the provider owning the given playlist.
              *  Will only return multiple providers if this is a synced playlist
              *  @arg playlist the playlist whose provider we want
              */
             Q_INVOKABLE QList<Playlists::PlaylistProvider*>
             getProvidersForPlaylist( const Playlists::PlaylistPtr playlist );
 
             /**
              *  Checks if the provider to whom this playlist belongs supports writing
              *  @arg playlist the playlist we are testing for writability
              *  @return whether or not the playlist is writable
              */
             Q_INVOKABLE bool isWritable( const Playlists::PlaylistPtr &playlist );
 
         private:
             QList<int> availableCategories();
 
         Q_SIGNALS:
             void updated( int category );
             void categoryAdded( int category );
             void providerAdded( Playlists::PlaylistProvider *provider, int category );
             void providerRemoved( Playlists::PlaylistProvider *provider, int category );
             void playlistAdded( Playlists::PlaylistPtr playlist, int category );
             void playlistRemoved( Playlists::PlaylistPtr playlist, int category );
             void playlistUpdated( Playlists::PlaylistPtr playlist, int category );
             void renamePlaylist( Playlists::PlaylistPtr playlist );
     };
 }
 
 #endif