Members of the KDE Community are recommended to subscribe to the kde-community mailing list at https://mail.kde.org/mailman/listinfo/kde-community to allow them to participate in important discussions and receive other important announcements

playlist.h 7.93 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 <qvaluevector.h>
25
#include <qptrstack.h>
26 27

#include "playlistitem.h"
28
#include "sortedstringlist.h"
29

30 31 32
class KPopupMenu;

class KPopupMenu;
33
class KActionMenu;
34 35

class QEvent;
36

37 38
typedef QValueList<Playlist *> PlaylistList;

39 40 41
class Playlist : public KListView
{
    Q_OBJECT
42

43
public:
44 45 46 47
    /** 
     * Before creating a playlist directly, please see 
     * PlaylistSplitter::createPlaylist().
     */
48
    Playlist(QWidget *parent, const QString &name = QString::null);
49

50 51 52 53
    /** 
     * Before creating a playlist directly, please see 
     * PlaylistSplitter::openPlaylist().
     */
54
    Playlist(const QFileInfo &playlistFile, QWidget *parent, const char *name = 0);
55

56 57
    virtual ~Playlist();

58 59 60
    /**
     * 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
61
     * name.  
62
     */
63
    virtual void save();
64 65
    virtual void saveAs();
    virtual void refresh();
66
    virtual void clearItem(PlaylistItem *item, bool emitChanged = true);
67
    virtual void clearItems(const PlaylistItemList &items);
68

69 70 71
    /** 
     * All of the (media) files in the list. 
     */
72
    QStringList files() const;
73

74
    /** 
75
     * Returns a list of all of the items in the playlist.
76
     */
77
    PlaylistItemList items() const;
78 79 80 81
    
    /**
     * Returns a list of the currently selected items.
     */
82
    PlaylistItemList selectedItems() const;
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
    QString fileName() const { return m_fileName; }
    void setFileName(const QString &n) { m_fileName = n; }
98

99 100 101 102
    void hideColumn(int c);
    void showColumn(int c);
    bool isColumnVisible(int c) const;

103
    /**
104
     * If m_playlistName has no value -- i.e. the name has not been set to 
105
     * something other than the filename, this returns the filename less the
106
     * extension.  If m_playlistName does have a value, this returns that.
107
     */
108
    QString name() const;
109

110 111 112
    /**
     * This sets a name for the playlist that is \e different from the file name.
     */ 
113
    void setName(const QString &n);
114

115
    int count() const { return childCount(); }
116 117

    /** 
118 119
     * 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.
120
     */
121 122
    PlaylistItem *nextItem(PlaylistItem *current, bool random = false);
    PlaylistItem *previousItem(PlaylistItem *current, bool random = false);
123

124
    KActionMenu *columnVisibleAction() const { return m_columnVisibleAction; }
125

126
    void setPlaying(PlaylistItem *item, bool playing = true);
Scott Wheeler's avatar
Scott Wheeler committed
127 128 129 130 131 132
    
    /**
     * This forces an update of the left most visible column, but does not save
     * the settings for this.
     */ 
    void updateLeftColumn();
133

134
public slots:
135
    /**
136 137
     * Remove the currently selected items from the playlist and disk.
     */ 
138
    void slotDeleteSelectedItems() { deleteFromDisk(selectedItems()); };
139 140
    void slotSetNext();

141 142 143 144
    /*
     * The edit slots are required to use the canonical names so that they are
     * detected by the application wide framework.
     */
145
    virtual void cut() { copy(); clear(); }
146
    virtual void copy();
147
    virtual void paste();
148
    virtual void clear();
149
    virtual void selectAll() { KListView::selectAll(true); }
150

151
    void slotGuessTagInfo();
152 153 154 155
    /**
     * Reload the playlist contents from the m3u file.
     */
    void slotReload();
156

157
protected:
158 159 160 161 162 163
    /**
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
     */
    void deleteFromDisk(const PlaylistItemList &items);

164
    virtual bool eventFilter(QObject* watched, QEvent* e);
165
    virtual QDragObject *dragObject(QWidget *parent);
166
    virtual QDragObject *dragObject() { return dragObject(this); }
167
    virtual bool canDecode(QMimeSource *s);
168
    virtual void decode(QMimeSource *s);
169 170
    virtual void contentsDropEvent(QDropEvent *e);
    virtual void contentsDragMoveEvent(QDragMoveEvent *e);
Scott Wheeler's avatar
Scott Wheeler committed
171
    virtual void showEvent(QShowEvent *e);
172 173
    
    static QString resolveSymLinks(const QFileInfo &file);
Scott Wheeler's avatar
Scott Wheeler committed
174

175 176 177
    KPopupMenu *rmbMenu() { return m_rmbMenu; }
    const KPopupMenu *rmbMenu() const { return m_rmbMenu; }

178
signals:
179 180 181 182
    /** 
     * This signal is connected to PlaylistItem::refreshed() in the 
     * PlaylistItem class. 
     */
183
    void signalDataChanged();
184

185 186 187 188
    /** 
     * This is emitted when the playlist selection is changed.  This is used
     * primarily to notify the TagEditor of the new data. 
     */
189
    void signalSelectionChanged(const PlaylistItemList &selection);
190 191
    
    /**
192
     * This is connected to the PlaylistBox::Item to let it know when the 
193 194
     * playlist's name has changed.
     */
195
    void signalNameChanged(const QString &fileName);
196
    
197
    void signalNumberOfItemsChanged(Playlist *);
198
    
199
    void signalDoubleClicked();
200

201 202 203 204
    /**
     * This signal is emitted just before a playlist item is removed from the 
     * list.
     */
205
    void signalAboutToRemove(PlaylistItem *item);
206 207
    void signalFilesDropped(const QStringList &files, Playlist *);
    void signalSetNext(PlaylistItem *item);    
208

209 210
private:
    void setup();
211
    void loadFile(const QString &fileName, const QFileInfo &fileInfo);
212
    void applyTag(QListViewItem *item, const QString &text, int column);
213
    int leftMostVisibleColumn() const;
214

215 216 217 218 219 220
    /**
     * This class is used internally to store settings that are shared by all
     * of the playlists, such as column order.  It is implemented as a singleton.
     */
    class SharedSettings;

221
private slots:
222 223 224
    void slotEmitSelected() { emit signalSelectionChanged(selectedItems()); }
    void slotEmitDoubleClicked(QListViewItem *) { emit signalDoubleClicked(); }
    void slotShowRMBMenu(QListViewItem *item, const QPoint &point, int column);
225
    void slotApplyModification(QListViewItem *item, const QString &text, int column);
226
    void slotRenameTag();
227
    void slotColumnOrderChanged(int, int from, int to);
228
    void slotToggleColumnVisible(int column);
229 230

private:
231 232 233 234
    int m_currentColumn;
    SortedStringList m_members;
    int m_processed;
    bool m_allowDuplicates;
235
    QPtrStack<PlaylistItem> m_history;
236

237
    QString m_fileName;
238 239 240 241 242

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
243
    QString m_playlistName;
244
   
245 246 247
    KPopupMenu *m_rmbMenu;
    KPopupMenu *m_headerMenu;
    KActionMenu *m_columnVisibleAction;
248

249 250
    int m_rmbPasteID;
    int m_rmbEditID;
251 252 253

    PlaylistItem *m_playingItem;
    int m_leftColumn;
254 255
};

256 257 258
QDataStream &operator<<(QDataStream &s, const Playlist &p);
QDataStream &operator>>(QDataStream &s, Playlist &p);

259
#endif