playlist.h 5.89 KB
Newer Older
1 2 3 4 5
/***************************************************************************
                          playlist.h  -  description
                             -------------------
    begin                : Sat Feb 16 2002
    copyright            : (C) 2002 by Scott Wheeler
6
    email                : wheeler@kde.org
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef PLAYLIST_H
#define PLAYLIST_H

#include <klistview.h>

#include <qstringlist.h>
24
#include <qptrstack.h>
25 26 27

#include "playlistitem.h"

28
class PlaylistSplitter;
29
class PlaylistBoxItem;
30

31 32 33
class Playlist : public KListView
{
    Q_OBJECT
34

35
public:
36 37 38 39 40 41 42 43 44 45
    /** 
     * Before creating a playlist directly, please see 
     * PlaylistSplitter::createPlaylist().
     */
    Playlist(PlaylistSplitter *s, QWidget *parent, const QString &name = QString::null);
    /** 
     * Before creating a playlist directly, please see 
     * PlaylistSplitter::openPlaylist().
     */
    Playlist(PlaylistSplitter *s, const QFileInfo &playlistFile, QWidget *parent, const char *name = 0);
46 47
    virtual ~Playlist();

48 49 50 51 52 53 54
    /**
     * Saves the file to the currently set file name.  If there is no filename
     * currently set, the default behavior is to prompt the user for a file
     * name.  However, by setting autoGenerateFileName, you can tell save to 
     * pick a file name.
     */
    virtual void save(bool autoGenerateFileName = false);
55 56 57
    virtual void saveAs();
    virtual void refresh();
    virtual void clearItems(const PlaylistItemList &items);
58

59 60 61
    /** 
     * All of the (media) files in the list. 
     */
62
    QStringList files() const;
63
    /** 
64
     * Returns a list of all of the items in the playlist.
65
     */
66
    PlaylistItemList items() const;
67 68 69 70
    
    /**
     * Returns a list of the currently selected items.
     */
71
    PlaylistItemList selectedItems() const;
72

73 74 75
    /**
     * Remove the currently selected items from the playlist.
     */ 
76
    void remove();
77 78 79 80 81
    
    /**
     * Remove \a items from the playlist.  This will ignore items that are not
     * actually in the list.
     */
82
    void remove(const PlaylistItemList &items);
83

84 85 86
    /** 
     * Allow duplicate files in the playlist. 
     */
87 88
    void setAllowDuplicates(bool allow);

89 90
    /** 
     * This is being used as a mini-factory of sorts to make the construction
91 92
     * of PlaylistItems virtual.  In this case it allows for the creation of
     * both PlaylistItems and CollectionListItems.
93 94
     */
    virtual PlaylistItem *createItem(const QFileInfo &file, QListViewItem *after = 0);
95

96 97 98 99
    /**
     * Internal files are files which have not been saved by the user, but rather
     * are stored in JuK's data directory and are restored by session management.
     */
100
    bool isInternalFile() const;
101
    void setInternal(bool internal);
102
    QString fileName() const;
103
    void setFileName(const QString &n);
104 105 106 107 108 109

    /**
     * If playlistName has no value -- i.e. the name has not been set to 
     * something other than the filename, this returns the filename less the
     * extension.  If playlistName does have a value, this returns that.
     */
110
    QString name() const;
111 112 113
    /**
     * This sets a name for the playlist that is \e different from the file name.
     */ 
114
    void setName(const QString &n);
115

116 117 118
    PlaylistBoxItem *playlistBoxItem() const;
    void setPlaylistBoxItem(PlaylistBoxItem *item);

119 120 121
    // static methods

    /** 
122 123
     * This gets the next item to be played.  This is static because often we 
     * know about the playing item, but not to which list it belongs.
124 125
     */
    static PlaylistItem *nextItem(PlaylistItem *current, bool random = false);
126
    static PlaylistItem *previousItem(PlaylistItem *current, bool random = false);
127

128
protected:
129 130 131
    virtual QDragObject *dragObject();
    virtual void contentsDropEvent(QDropEvent *e);
    virtual void contentsDragMoveEvent(QDragMoveEvent *e);
132
    PlaylistSplitter *playlistSplitter() const;
133

134 135 136 137 138
private:
    void setup();

    QStringList members;
    int processed;
139
    bool allowDuplicates;
140

141 142 143 144 145 146
    /**
     * If a file is "internal" it is not one that the user has yet chosen to 
     * save.  However for the purposes of being able to restore a user's 
     * loaded playlists it will be saved "internally" in:
     * $KDEHOME/share/apps/juk/playlists.
     */
147
    bool internalFile;
148
    QString playlistFileName;
149 150 151 152 153

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
154 155
    QString playlistName;
    PlaylistSplitter *splitter;
156
    PlaylistBoxItem *boxItem;
157 158
    
    QPtrStack<PlaylistItem> history;
159

160 161 162 163
private slots:
    void emitSelected();

signals:
164 165 166 167
    /** 
     * This signal is connected to PlaylistItem::refreshed() in the 
     * PlaylistItem class. 
     */
168
    void dataChanged();
169 170 171 172 173
    /** 
     * This signal is emitted when items are added to the collection list.  
     * This happens in the createItem() method when items are added to the 
     * collection. 
     */
174
    void collectionChanged();
175

176 177 178 179
    /** 
     * This is emitted when the playlist selection is changed.  This is used
     * primarily to notify the TagEditor of the new data. 
     */
180
    void selectionChanged(const PlaylistItemList &selection);
181 182 183 184 185
    
    /**
     * This is connected to the PlaylistBoxItem to let it know when the 
     * playlist's name has changed.
     */
186
    void nameChanged(const QString &fileName);
187 188 189
};

#endif