playlist.h 8.21 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 76 77 78
    /** 
     * Returns a list of all of the \e visible items in the playlist.
     */
    PlaylistItemList items();

79
    /** 
80
     * Returns a list of all of the items in the playlist.
81
     */
82
    PlaylistItemList visibleItems() const;
83 84 85 86
    
    /**
     * Returns a list of the currently selected items.
     */
87
    PlaylistItemList selectedItems() const;
88
    
89 90 91
    /** 
     * Allow duplicate files in the playlist. 
     */
92 93
    void setAllowDuplicates(bool allow);

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

101 102
    QString fileName() const { return m_fileName; }
    void setFileName(const QString &n) { m_fileName = n; }
103

104 105 106 107
    void hideColumn(int c);
    void showColumn(int c);
    bool isColumnVisible(int c) const;

108
    /**
109
     * If m_playlistName has no value -- i.e. the name has not been set to 
110
     * something other than the filename, this returns the filename less the
111
     * extension.  If m_playlistName does have a value, this returns that.
112
     */
113
    QString name() const;
114

115 116 117
    /**
     * This sets a name for the playlist that is \e different from the file name.
     */ 
118
    void setName(const QString &n);
119

120
    int count() const { return childCount(); }
121 122

    /** 
123 124
     * 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.
125
     */
126 127
    PlaylistItem *nextItem(PlaylistItem *current, bool random = false);
    PlaylistItem *previousItem(PlaylistItem *current, bool random = false);
128

129
    KActionMenu *columnVisibleAction() const { return m_columnVisibleAction; }
130

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

139 140
    static void setItemsVisible(const PlaylistItemList &items, bool visible = true);

141
public slots:
142
    /**
143 144
     * Remove the currently selected items from the playlist and disk.
     */ 
145
    void slotDeleteSelectedItems() { deleteFromDisk(selectedItems()); };
146 147
    void slotSetNext();

148 149 150 151
    /*
     * The edit slots are required to use the canonical names so that they are
     * detected by the application wide framework.
     */
152
    virtual void cut() { copy(); clear(); }
153
    virtual void copy();
154
    virtual void paste();
155
    virtual void clear();
156
    virtual void selectAll() { KListView::selectAll(true); }
157

158
    void slotGuessTagInfo();
159 160
    void slotRenameFile();

161 162 163 164
    /**
     * Reload the playlist contents from the m3u file.
     */
    void slotReload();
165

166
protected:
167 168 169 170 171 172
    /**
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
     */
    void deleteFromDisk(const PlaylistItemList &items);

173
    virtual bool eventFilter(QObject* watched, QEvent* e);
174
    virtual QDragObject *dragObject(QWidget *parent);
175
    virtual QDragObject *dragObject() { return dragObject(this); }
176
    virtual bool canDecode(QMimeSource *s);
177
    virtual void decode(QMimeSource *s);
178 179
    virtual void contentsDropEvent(QDropEvent *e);
    virtual void contentsDragMoveEvent(QDragMoveEvent *e);
Scott Wheeler's avatar
Scott Wheeler committed
180
    virtual void showEvent(QShowEvent *e);
181 182
    
    static QString resolveSymLinks(const QFileInfo &file);
Scott Wheeler's avatar
Scott Wheeler committed
183

184 185 186
    KPopupMenu *rmbMenu() { return m_rmbMenu; }
    const KPopupMenu *rmbMenu() const { return m_rmbMenu; }

187
signals:
188 189 190 191
    /** 
     * This signal is connected to PlaylistItem::refreshed() in the 
     * PlaylistItem class. 
     */
192
    void signalDataChanged();
193

194 195 196 197
    /** 
     * This is emitted when the playlist selection is changed.  This is used
     * primarily to notify the TagEditor of the new data. 
     */
198
    void signalSelectionChanged(const PlaylistItemList &selection);
199 200
    
    /**
201
     * This is connected to the PlaylistBox::Item to let it know when the 
202 203
     * playlist's name has changed.
     */
204
    void signalNameChanged(const QString &fileName);
205
    
206
    void signalNumberOfItemsChanged(Playlist *);
207
    
208
    void signalDoubleClicked();
209

210 211 212 213
    /**
     * This signal is emitted just before a playlist item is removed from the 
     * list.
     */
214
    void signalAboutToRemove(PlaylistItem *item);
215 216
    void signalFilesDropped(const QStringList &files, Playlist *);
    void signalSetNext(PlaylistItem *item);    
217
    void signalVisibleColumnsChanged();
218

219 220
private:
    void setup();
221
    void loadFile(const QString &fileName, const QFileInfo &fileInfo);
222
    void applyTag(QListViewItem *item, const QString &text, int column);
223
    int leftMostVisibleColumn() const;
224

225 226 227 228 229 230
    /**
     * 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;

231
private slots:
232 233 234
    void slotEmitSelected() { emit signalSelectionChanged(selectedItems()); }
    void slotEmitDoubleClicked(QListViewItem *) { emit signalDoubleClicked(); }
    void slotShowRMBMenu(QListViewItem *item, const QPoint &point, int column);
235
    void slotApplyModification(QListViewItem *item, const QString &text, int column);
236
    void slotRenameTag();
237
    void slotColumnOrderChanged(int, int from, int to);
238
    void slotToggleColumnVisible(int column);
239 240

private:
241 242 243 244
    int m_currentColumn;
    SortedStringList m_members;
    int m_processed;
    bool m_allowDuplicates;
245
    QPtrStack<PlaylistItem> m_history;
246

247
    QString m_fileName;
248 249 250 251 252

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
253
    QString m_playlistName;
254
   
255 256 257
    KPopupMenu *m_rmbMenu;
    KPopupMenu *m_headerMenu;
    KActionMenu *m_columnVisibleAction;
258

259 260
    int m_rmbPasteID;
    int m_rmbEditID;
261 262 263

    PlaylistItem *m_playingItem;
    int m_leftColumn;
264 265
};

266 267 268
QDataStream &operator<<(QDataStream &s, const Playlist &p);
QDataStream &operator>>(QDataStream &s, Playlist &p);

269
#endif