playlist.h 8.71 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
    /**
     * Before creating a playlist directly, please see
46 47
     * PlaylistSplitter::createPlaylist().
     */
48
    Playlist(QWidget *parent, const QString &name = QString::null);
49

50 51
    /**
     * Before creating a playlist directly, please see
52 53
     * 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
    /**
     * All of the (media) files in the list.
71
     */
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 92 93
    /**
     * Returns a list of the last 10 played items.
     */
    PlaylistItemList historyItems(PlaylistItem *current, bool random) const;

94 95
    /**
     * Allow duplicate files in the playlist.
96
     */
97 98
    void setAllowDuplicates(bool allow);

99
    /**
100
     * This is being used as a mini-factory of sorts to make the construction
101 102
     * of PlaylistItems virtual.  In this case it allows for the creation of
     * both PlaylistItems and CollectionListItems.
103
     */
104 105
    virtual PlaylistItem *createItem(const QFileInfo &file,
				     const QString &absFilePath = QString::null,
106 107
				     QListViewItem *after = 0);

108 109
    void createItems(const PlaylistItemList &siblings);

110 111
    QString fileName() const { return m_fileName; }
    void setFileName(const QString &n) { m_fileName = n; }
112

113 114 115 116
    void hideColumn(int c);
    void showColumn(int c);
    bool isColumnVisible(int c) const;

117
    /**
118
     * If m_playlistName has no value -- i.e. the name has not been set to
119
     * something other than the filename, this returns the filename less the
120
     * extension.  If m_playlistName does have a value, this returns that.
121
     */
122
    QString name() const;
123

124 125
    /**
     * This sets a name for the playlist that is \e different from the file name.
126
     */
127
    void setName(const QString &n);
128

129
    int count() const { return childCount(); }
130

131 132
    /** 
     * This gets the next item to be played.
133
     */
134 135
    PlaylistItem *nextItem(PlaylistItem *current, bool random = false);
    PlaylistItem *previousItem(PlaylistItem *current, bool random = false);
136

137
    KActionMenu *columnVisibleAction() const { return m_columnVisibleAction; }
138

139
    void setPlaying(PlaylistItem *item, bool playing = true);
140

Scott Wheeler's avatar
Scott Wheeler committed
141 142 143
    /**
     * This forces an update of the left most visible column, but does not save
     * the settings for this.
144
     */
Scott Wheeler's avatar
Scott Wheeler committed
145
    void updateLeftColumn();
146

147 148
    static void setItemsVisible(const PlaylistItemList &items, bool visible = true);

149
public slots:
150
    /**
151
     * Remove the currently selected items from the playlist and disk.
152
     */
153
    void slotDeleteSelectedItems() { deleteFromDisk(selectedItems()); };
154 155
    void slotSetNext();

156 157 158 159
    /*
     * The edit slots are required to use the canonical names so that they are
     * detected by the application wide framework.
     */
160
    virtual void cut() { copy(); clear(); }
161
    virtual void copy();
162
    virtual void paste();
163
    virtual void clear();
164
    virtual void selectAll() { KListView::selectAll(true); }
165

166
    void slotGuessTagInfo();
167 168
    void slotRenameFile();

169 170 171 172
    /**
     * Reload the playlist contents from the m3u file.
     */
    void slotReload();
173

174
protected:
175 176 177 178 179 180
    /**
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
     */
    void deleteFromDisk(const PlaylistItemList &items);

181
    virtual bool eventFilter(QObject* watched, QEvent* e);
182
    virtual QDragObject *dragObject(QWidget *parent);
183
    virtual QDragObject *dragObject() { return dragObject(this); }
184
    virtual bool canDecode(QMimeSource *s);
185
    virtual void decode(QMimeSource *s);
186 187
    virtual void contentsDropEvent(QDropEvent *e);
    virtual void contentsDragMoveEvent(QDragMoveEvent *e);
Scott Wheeler's avatar
Scott Wheeler committed
188
    virtual void showEvent(QShowEvent *e);
189

190 191 192 193
    /**
     * Though it's somewhat obvious, this function will stat the file, so only use it when
     * you're out of a performance critical loop.
     */
194
    static QString resolveSymLinks(const QFileInfo &file);
Scott Wheeler's avatar
Scott Wheeler committed
195

196 197 198
    KPopupMenu *rmbMenu() { return m_rmbMenu; }
    const KPopupMenu *rmbMenu() const { return m_rmbMenu; }

199
signals:
200 201 202
    /**
     * This signal is connected to PlaylistItem::refreshed() in the
     * PlaylistItem class.
203
     */
204
    void signalDataChanged();
205

206
    /**
207
     * This is emitted when the playlist selection is changed.  This is used
208
     * primarily to notify the TagEditor of the new data.
209
     */
210
    void signalSelectionChanged(const PlaylistItemList &selection);
211

212
    /**
213
     * This is connected to the PlaylistBox::Item to let it know when the
214 215
     * playlist's name has changed.
     */
216
    void signalNameChanged(const QString &fileName);
217

218
    void signalNumberOfItemsChanged(Playlist *);
219

220
    void signalDoubleClicked();
221

222
    /**
223
     * This signal is emitted just before a playlist item is removed from the
224 225
     * list.
     */
226
    void signalAboutToRemove(PlaylistItem *item);
227
    void signalFilesDropped(const QStringList &files, Playlist *);
228
    void signalSetNext(PlaylistItem *item);
229
    void signalVisibleColumnsChanged();
230

231 232
private:
    void setup();
233
    void loadFile(const QString &fileName, const QFileInfo &fileInfo);
234
    void applyTag(QListViewItem *item, const QString &text, int column);
235
    int leftMostVisibleColumn() const;
236

237 238 239 240 241 242
    /**
     * 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;

243
private slots:
244 245 246
    void slotEmitSelected() { emit signalSelectionChanged(selectedItems()); }
    void slotEmitDoubleClicked(QListViewItem *) { emit signalDoubleClicked(); }
    void slotShowRMBMenu(QListViewItem *item, const QPoint &point, int column);
247
    void slotApplyModification(QListViewItem *item, const QString &text, int column);
248
    void slotRenameTag();
249
    void slotColumnOrderChanged(int, int from, int to);
250
    void slotToggleColumnVisible(int column);
251 252

private:
253 254 255 256
    int m_currentColumn;
    SortedStringList m_members;
    int m_processed;
    bool m_allowDuplicates;
257
    QPtrList<PlaylistItem> m_history;
258

259
    QString m_fileName;
260 261 262 263 264 265 266
    
    /**
     * Used to store the text for inline editing before it is changed so that 
     * we can know if something actually changed and as such if we need to save
     * the tag.
     */
    QString m_editText;
267 268 269 270 271

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
272
    QString m_playlistName;
273

274 275 276
    KPopupMenu *m_rmbMenu;
    KPopupMenu *m_headerMenu;
    KActionMenu *m_columnVisibleAction;
277

278 279
    int m_rmbPasteID;
    int m_rmbEditID;
280 281 282

    PlaylistItem *m_playingItem;
    int m_leftColumn;
283 284

    PlaylistItemList m_randomList;
285 286
};

287 288 289
QDataStream &operator<<(QDataStream &s, const Playlist &p);
QDataStream &operator>>(QDataStream &s, Playlist &p);

290
#endif