playlist.h 23.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/**
 * Copyright (C) 2002-2004 Scott Wheeler <wheeler@kde.org>
 * Copyright (C) 2007 Michael Pyne <mpyne@kde.org>
 *
 * 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/>.
 */
17 18 19 20

#ifndef PLAYLIST_H
#define PLAYLIST_H

21
#include <kglobalsettings.h>
22
#include <kdebug.h>
23

24
#include <QVector>
25
#include <QEvent>
26
#include <QList>
27
#include <QTreeWidget>
28

29
#include "covermanager.h"
30
#include "stringhash.h"
Scott Wheeler's avatar
Scott Wheeler committed
31
#include "playlistsearch.h"
32
#include "tagguesser.h"
33
#include "playlistinterface.h"
34
#include "filehandle.h"
35

Laurent Montel's avatar
Laurent Montel committed
36
class KMenu;
37
class KActionMenu;
38

39 40
class QFileInfo;
class QMimeData;
Matthias Kretz's avatar
Matthias Kretz committed
41
class QAction;
Scott Wheeler's avatar
Scott Wheeler committed
42

43
class WebImageFetcher;
44
class PlaylistItem;
45
class PlaylistCollection;
46
class PlaylistToolTip;
47
class CollectionListItem;
48

49
typedef QList<PlaylistItem *> PlaylistItemList;
50

51
class Playlist : public QTreeWidget, public PlaylistInterface
52 53
{
    Q_OBJECT
54

55
public:
56

57
    explicit Playlist(PlaylistCollection *collection, const QString &name = QString(),
Michael Pyne's avatar
Michael Pyne committed
58
             const QString &iconName = "audio-midi");
59
    Playlist(PlaylistCollection *collection, const PlaylistItemList &items,
Michael Pyne's avatar
Michael Pyne committed
60
             const QString &name = QString(), const QString &iconName = "audio-midi");
61
    Playlist(PlaylistCollection *collection, const QFileInfo &playlistFile,
Michael Pyne's avatar
Michael Pyne committed
62
             const QString &iconName = "audio-midi");
63

64
    /**
65 66 67
     * This constructor should generally only be used either by the cache
     * restoration methods or by subclasses that want to handle calls to
     * PlaylistCollection::setupPlaylist() differently.
68 69 70 71 72
     *
     * @param extraColumns is used to preallocate columns for subclasses that
     * need them (since extra columns are assumed to start from 0). extraColumns
     * should be equal to columnOffset() (we can't use columnOffset until the
     * ctor has run).
73
     */
74
    Playlist(PlaylistCollection *collection, bool delaySetup, int extraColumns = 0);
75

76 77
    virtual ~Playlist();

78 79 80 81 82

    // The following group of functions implement the PlaylistInterface API.

    virtual QString name() const;
    virtual FileHandle currentFile() const;
83
    virtual int count() const { return model()->rowCount(); }
84 85 86 87 88
    virtual int time() const;
    virtual void playNext();
    virtual void playPrevious();
    virtual void stop();

89 90 91
    /**
     * Plays the top item of the playlist.
     */
92 93
    void playFirst();

94 95 96 97 98 99
    /**
     * Plays the next album in the playlist.  Only useful when in album random
     * play mode.
     */
    void playNextAlbum();

100 101 102
    /**
     * 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
103
     * name.
104
     */
105
    virtual void save();
Scott Wheeler's avatar
Scott Wheeler committed
106 107 108 109 110

    /**
     * Standard "save as".  Prompts the user for a location where to save the
     * playlist to.
     */
111
    virtual void saveAs();
Scott Wheeler's avatar
Scott Wheeler committed
112 113

    /**
114
     * Removes \a item from the Playlist, but not from the disk.
Scott Wheeler's avatar
Scott Wheeler committed
115
     *
116 117 118
     * Since the GUI updates after an item is cleared, you should use clearItems() if you have
     * a list of items to remove, as that will remove the whole batch before updating
     * other components/GUI to the change.
Scott Wheeler's avatar
Scott Wheeler committed
119
     */
120
    virtual void clearItem(PlaylistItem *item);
Scott Wheeler's avatar
Scott Wheeler committed
121 122 123 124 125

    /**
     * Remove \a items from the playlist and emit a signal indicating
     * that the number of items in the list has changed.
     */
126
    virtual void clearItems(const PlaylistItemList &items);
127

128 129 130 131 132 133
    /**
     * Accessor function to return a pointer to the currently playing file.
     *
     * @return 0 if no file is playing, otherwise a pointer to the PlaylistItem
     *     of the track that is currently playing.
     */
134
    static PlaylistItem *playingItem();
135

136 137
    /**
     * All of the (media) files in the list.
138
     */
139
    QStringList files() const;
140

141
    /**
Scott Wheeler's avatar
Scott Wheeler committed
142
     * Returns a list of all of the items in the playlist.
143
     */
144
    virtual PlaylistItemList items();
145

146
    /**
Scott Wheeler's avatar
Scott Wheeler committed
147
     * Returns a list of all of the \e visible items in the playlist.
148
     */
149
    PlaylistItemList visibleItems();
150

151 152 153
    /**
     * Returns a list of the currently selected items.
     */
154
    PlaylistItemList selectedItems();
155

156 157 158 159 160
    /**
     * Returns properly casted first child item in list.
     */
    PlaylistItem *firstChild() const;

161 162
    /**
     * Allow duplicate files in the playlist.
163
     */
164
    void setAllowDuplicates(bool allow) { m_allowDuplicates = allow; }
165

166
    /**
167
     * This is being used as a mini-factory of sorts to make the construction
168 169
     * of PlaylistItems virtual.  In this case it allows for the creation of
     * both PlaylistItems and CollectionListItems.
170
     */
171
    virtual PlaylistItem *createItem(const FileHandle &file,
172
                                     QTreeWidgetItem *after = 0,
173
                                     bool emitChanged = true);
174

Scott Wheeler's avatar
Scott Wheeler committed
175 176
    /**
     * This is implemented as a template method to allow subclasses to
177
     * instantiate their PlaylistItem subclasses using the same method.
Scott Wheeler's avatar
Scott Wheeler committed
178
     */
179
    template <class ItemType>
180
    ItemType *createItem(const FileHandle &file,
181
                         QTreeWidgetItem *after = 0,
182
                         bool emitChanged = true);
183

184
    virtual void createItems(const PlaylistItemList &siblings, PlaylistItem *after = 0);
185

186 187 188 189
    /**
     * This handles adding files of various types -- music, playlist or directory
     * files.  Music files that are found will be added to this playlist.  New
     * playlist files that are found will result in new playlists being created.
190 191 192 193
     *
     * Note that this should not be used in the case of adding *only* playlist
     * items since it has the overhead of checking to see if the file is a playlist
     * or directory first.
194
     */
195
    virtual void addFiles(const QStringList &files, PlaylistItem *after = 0);
196

197 198
    /**
     * Returns the file name associated with this playlist (an m3u file) or
199
     * an empty QString if no such file exists.
200
     */
201
    QString fileName() const { return m_fileName; }
202 203 204 205 206

    /**
     * Sets the file name to be associated with this playlist; this file should
     * have the "m3u" extension.
     */
207
    void setFileName(const QString &n) { m_fileName = n; }
208

209
    /**
210
     * Hides column \a c.  If \a updateSearch is true then a signal that the
211 212 213
     * visible columns have changed will be emitted and things like the search
     * will be udated.
     */
214
    void hideColumn(int c, bool updateSearch = true);
215 216

    /**
217
     * Shows column \a c.  If \a updateSearch is true then a signal that the
218 219 220
     * visible columns have changed will be emitted and things like the search
     * will be udated.
     */
221
    void showColumn(int c, bool updateSearch = true);
Kacper Kasper's avatar
Kacper Kasper committed
222 223
    
    void sortByColumn(int column, Qt::SortOrder order = Qt::AscendingOrder);
224

225 226 227 228
    /**
     * This sets a name for the playlist that is \e different from the file name.
     */
    void setName(const QString &n);
229

230 231 232 233
    /**
     * Returns the KActionMenu that allows this to be embedded in menus outside
     * of the playlist.
     */
234
    KActionMenu *columnVisibleAction() const { return m_columnVisibleAction; }
235

236
    /**
237 238
     * Set item to be the playing item.  If \a item is null then this will clear
     * the playing indicator.
239
     */
240
    static void setPlaying(PlaylistItem *item, bool addToHistory = true);
241 242 243 244

    /**
     * Returns true if this playlist is currently playing.
     */
Scott Wheeler's avatar
Scott Wheeler committed
245
    bool playing() const;
246

Scott Wheeler's avatar
Scott Wheeler committed
247 248 249
    /**
     * This forces an update of the left most visible column, but does not save
     * the settings for this.
250
     */
Scott Wheeler's avatar
Scott Wheeler committed
251
    void updateLeftColumn();
252

253 254 255 256 257
    /**
     * Returns the leftmost visible column of the listview.
     */
    int leftColumn() const { return m_leftColumn; }

258 259 260 261
    /**
     * Sets the items in the list to be either visible based on the value of
     * visible.  This is useful for search operations and such.
     */
262 263
    static void setItemsVisible(const PlaylistItemList &items, bool visible = true);

264 265 266 267
    /**
     * Returns the search associated with this list, or an empty search if one
     * has not yet been set.
     */
Scott Wheeler's avatar
Scott Wheeler committed
268
    PlaylistSearch search() const { return m_search; }
269 270 271 272

    /**
     * Set the search associtated with this playlist.
     */
273 274 275 276 277 278 279
    void setSearch(const PlaylistSearch &s);

    /**
     * If the search is disabled then all items will be shown, not just those that
     * match the current search.
     */
    void setSearchEnabled(bool searchEnabled);
Scott Wheeler's avatar
Scott Wheeler committed
280

Scott Wheeler's avatar
Scott Wheeler committed
281 282 283
    /**
     * Marks \a item as either selected or deselected based.
     */
284 285
    void markItemSelected(PlaylistItem *item, bool selected);

Scott Wheeler's avatar
Scott Wheeler committed
286 287
    /**
     * Subclasses of Playlist which add new columns will set this value to
Jan Gerrit Marker's avatar
Jan Gerrit Marker committed
288
     * specify how many of those columns exist.  This allows the Playlist
Scott Wheeler's avatar
Scott Wheeler committed
289 290 291
     * class to do some internal calculations on the number and positions
     * of columns.
     */
292
    virtual int columnOffset() const { return 0; }
Scott Wheeler's avatar
Scott Wheeler committed
293 294 295 296 297 298

    /**
     * Some subclasses of Playlist will be "read only" lists (i.e. the history
     * playlist).  This is a way for those subclasses to indicate that to the
     * Playlist internals.
     */
299
    virtual bool readOnly() const { return false; }
300

301 302 303
    /**
     * Returns true if it's possible to reload this playlist.
     */
304
    virtual bool canReload() const { return !m_fileName.isEmpty(); }
305

306 307 308 309 310 311
    /**
     * Returns true if the playlist is a search playlist and the search should be
     * editable.
     */
    virtual bool searchIsEditable() const { return false; }

312
    /**
313
     * Synchronizes the playing item in this playlist with the playing item
314 315 316 317 318
     * in \a sources.  If \a setMaster is true, this list will become the source
     * for determining the next item.
     */
    void synchronizePlayingItems(const PlaylistList &sources, bool setMaster);

319 320 321 322 323 324 325
    /**
     * Playlists have a common set of shared settings such as visible columns
     * that should be applied just before the playlist is shown.  Calling this
     * method applies those.
     */
    void applySharedSettings();

326 327
    void read(QDataStream &s);

328 329
    static void setShuttingDown() { m_shuttingDown = true; }

330
public slots:
331
    /**
332
     * Remove the currently selected items from the playlist and disk.
333
     */
334
    void slotRemoveSelectedItems() { removeFromDisk(selectedItems()); }
Scott Wheeler's avatar
Scott Wheeler committed
335

336 337 338 339
    /*
     * The edit slots are required to use the canonical names so that they are
     * detected by the application wide framework.
     */
340
    virtual void cut() { copy(); clear(); }
Scott Wheeler's avatar
Scott Wheeler committed
341 342 343 344 345

    /**
     * Puts a list of URLs pointing to the files in the current selection on the
     * clipboard.
     */
346
    virtual void copy();
Scott Wheeler's avatar
Scott Wheeler committed
347 348 349 350

    /**
     * Checks the clipboard for local URLs to be inserted into this playlist.
     */
351
    virtual void paste();
Scott Wheeler's avatar
Scott Wheeler committed
352 353 354 355 356 357 358

    /**
     * Removes the selected items from the list, but not the disk.
     *
     * @see clearItem()
     * @see clearItems()
     */
359
    virtual void clear();
360
    virtual void selectAll() { QTreeView::selectAll(); }
361

362 363 364 365 366 367
    /**
     * Refreshes the tags of the selection from disk, or all of the files in the
     * list if there is no selection.
     */
    virtual void slotRefresh();

368
    void slotGuessTagInfo(TagGuesser::Type type);
Scott Wheeler's avatar
Scott Wheeler committed
369 370 371 372 373 374

    /**
     * Renames the selected items' files based on their tags contents.
     *
     * @see PlaylistItem::renameFile()
     */
375 376
    void slotRenameFile();

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
    /**
     * Sets the cover of the selected items, pass in true if you want to load from the local system,
     * false if you want to load from the internet.
     */
    void slotAddCover(bool fromLocal);

    /**
     * Shows a large image of the cover
     */
    void slotViewCover();

    /**
     * Removes covers from the selected items
     */
    void slotRemoveCover();

393 394 395 396 397
    /**
     * Shows the cover manager GUI dialog
     */
    void slotShowCoverManager();

398 399 400
    /**
     * Reload the playlist contents from the m3u file.
     */
401
    virtual void slotReload();
402

403 404 405 406 407
    /**
     * Tells the listview that the next time that it paints that the weighted
     * column widths must be recalculated.  If this is called without a column
     * all visible columns are marked as dirty.
     */
408
    void slotWeightDirty(int column = -1);
409

410 411
    void slotShowPlaying();

412 413
    void slotColumnResizeModeChanged();

414 415
    virtual void dataChanged();

416
protected:
417 418 419 420
    /**
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
     */
421
    void removeFromDisk(const PlaylistItemList &items);
422

423 424 425
    // the following are all reimplemented from base classes

    virtual bool eventFilter(QObject *watched, QEvent *e);
426
    virtual void keyPressEvent(QKeyEvent *e);
Tim Beaulen's avatar
Tim Beaulen committed
427
    virtual void decode(const QMimeData *s, PlaylistItem *item = 0);
Kacper Kasper's avatar
Kacper Kasper committed
428 429 430 431 432
    QStringList mimeTypes() const;
    QMimeData* mimeData(const QList<QTreeWidgetItem *> items) const;
    virtual bool dropMimeData(QTreeWidgetItem *parent, int index, const QMimeData *data, Qt::DropAction action);
    virtual void dropEvent(QDropEvent *e);
    virtual void dragEnterEvent(QDragEnterEvent *e);
Scott Wheeler's avatar
Scott Wheeler committed
433
    virtual void showEvent(QShowEvent *e);
Michael Pyne's avatar
Michael Pyne committed
434
    virtual bool acceptDrag(QDropEvent *e) const;
435 436
    virtual void paintEvent(QPaintEvent *pe);
    virtual void resizeEvent(QResizeEvent *re);
437

438 439
    virtual void insertItem(QTreeWidgetItem *item);
    virtual void takeItem(QTreeWidgetItem *item);
440

441 442
    virtual bool hasItem(const QString &file) const { return m_members.contains(file); }

443
    virtual void addColumn(const QString &label, int width = -1);
Scott Wheeler's avatar
Scott Wheeler committed
444

445 446 447 448 449 450 451 452
    /**
     * Do some finial initialization of created items.  Notably ensure that they
     * are shown or hidden based on the contents of the current PlaylistSearch.
     *
     * This is called by the PlaylistItem constructor.
     */
    void setupItem(PlaylistItem *item);

453 454 455 456
    /**
     * Forwards the call to the parent to enable or disable automatic deletion
     * of tree view playlists.  Used by CollectionListItem.
     */
457
    void setDynamicListsFrozen(bool frozen);
458

459 460 461
    template <class ItemType, class SiblingType>
    ItemType *createItem(SiblingType *sibling, ItemType *after = 0);

462 463
    /**
     * As a template this allows us to use the same code to initialize the items
464
     * in subclasses. ItemType should be a PlaylistItem subclass.
465
     */
466
    template <class ItemType, class SiblingType>
467
    void createItems(const QList<SiblingType *> &siblings, ItemType *after = 0);
468

469 470
protected slots:
    void slotPopulateBackMenu() const;
Tim Beaulen's avatar
Tim Beaulen committed
471
    void slotPlayFromBackMenu(QAction *) const;
472

473
signals:
474

475
    /**
476
     * This is connected to the PlaylistBox::Item to let it know when the
477 478
     * playlist's name has changed.
     */
479
    void signalNameChanged(const QString &name);
480

481
    /**
482
     * This signal is emitted just before a playlist item is removed from the
483 484 485
     * list allowing for any cleanup that needs to happen.  Typically this
     * is used to remove the item from the history and safeguard against
     * dangling pointers.
486
     */
487
    void signalAboutToRemove(PlaylistItem *item);
488

489 490
    void signalEnableDirWatch(bool enable);

491 492
    void signalPlaylistItemsDropped(Playlist *p);

493 494
private:
    void setup();
495

496 497 498 499 500 501
    /**
     * This function is called to let the user know that JuK has automatically enabled
     * manual column width adjust mode.
     */
    void notifyUserColumnWidthModeChanged();

502 503 504 505 506 507
    /**
     * Load the playlist from a file.  \a fileName should be the absolute path.
     * \a fileInfo should point to the same file as \a fileName.  This is a
     * little awkward API-wise, but keeps us from throwing away useful
     * information.
     */
508
    void loadFile(const QString &fileName, const QFileInfo &fileInfo);
509

510
    /**
Scott Wheeler's avatar
Scott Wheeler committed
511
     * Writes \a text to \a item in \a column.  This is used by the inline tag
512
     * editor.  Returns false if the tag update failed.
513
     */
514
    bool editTag(PlaylistItem *item, const QString &text, int column);
515 516 517 518 519 520

    /**
     * Returns the index of the left most visible column in the playlist.
     *
     * \see isColumnVisible()
     */
521
    int leftMostVisibleColumn() const;
522

523 524 525 526 527 528 529 530
    /**
     * This method is used internally to provide the backend to the other item
     * lists.
     *
     * \see items()
     * \see visibleItems()
     * \see selectedItems()
     */
531
    PlaylistItemList items(QTreeWidgetItemIterator::IteratorFlags flags);
532

533 534 535 536 537
    /**
     * Build the column "weights" for the weighted width mode.
     */
    void calculateColumnWeights();

538
    void addFile(const QString &file, FileHandleList &files, bool importPlaylists,
539
                 PlaylistItem **after);
540
    void addFileHelper(FileHandleList &files, PlaylistItem **after,
541
                       bool ignoreTimer = false);
542 543 544

    void redisplaySearch() { setSearch(m_search); }

545 546 547 548 549
    /**
     * Sets the cover for items to the cover identified by id.
     */
    void refreshAlbums(const PlaylistItemList &items, coverKey id = CoverManager::NoMatch);

550 551
    void refreshAlbum(const QString &artist, const QString &album);

552 553
    void updatePlaying() const;

554 555 556 557 558 559 560
    /**
     * This function should be called when item is deleted to ensure that any
     * internal bookkeeping is performed.  It is automatically called by
     * PlaylistItem::~PlaylistItem and by clearItem() and clearItems().
     */
    void updateDeletedItem(PlaylistItem *item);

561 562 563 564 565 566 567 568
    /**
     * Used as a helper to implement template<> createItem().  This grabs the
     * CollectionListItem for file if it exists, otherwise it creates a new one and
     * returns that.  If 0 is returned then some kind of error occurred, such as file not
     * found and probably nothing should be done with the FileHandle you have.
     */
    CollectionListItem *collectionListItem(const FileHandle &file);

569 570 571 572 573 574
    /**
     * 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;

575
private slots:
576

577 578 579 580 581 582 583 584 585 586
    /**
     * Handle the necessary tasks needed to create and setup the playlist that
     * don't need to happen in the ctor, such as setting up the columns,
     * initializing the RMB menu, and setting up signal/slot connections.
     *
     * Used to be a subclass of K3ListView::polish() but the timing of the
     * call is not consistent and therefore lead to crashes.
     */
    void slotInitialize();

587 588
    void slotUpdateColumnWidths();

589 590
    void slotAddToUpcoming();

591
    /**
592
     * Show the RMB menu.  Matches the signature for the signal
593 594
     * QListView::contextMenuRequested().
     */
Kacper Kasper's avatar
Kacper Kasper committed
595
    void slotShowRMBMenu(const QPoint &point);
596 597

    /**
Scott Wheeler's avatar
Scott Wheeler committed
598 599
     * This slot is called when the inline tag editor has completed its editing
     * and starts the process of renaming the values.
600
     *
Scott Wheeler's avatar
Scott Wheeler committed
601
     * \see editTag()
602
     */
603
    void slotInlineEditDone(QTreeWidgetItem *, const QString &, int column);
604 605

    /**
606
     * This starts the renaming process by displaying a line edit if the mouse is in
607 608
     * an appropriate position.
     */
609
    void slotRenameTag();
610

611 612 613 614 615 616
    /**
     * The image fetcher will update the cover asynchronously, this internal
     * slot is called when it happens.
     */
    void slotCoverChanged(int coverId);

617 618 619 620
    /**
     * Moves the column \a from to the position \a to.  This matches the signature
     * for the signal QHeader::indexChange().
     */
621
    void slotColumnOrderChanged(int, int from, int to);
622 623 624 625 626 627 628

    /**
     * Toggles a columns visible status.  Useful for KActions.
     *
     * \see hideColumn()
     * \see showColumn()
     */
629
    void slotToggleColumnVisible(QAction *action);
630

631 632 633
    /**
     * Prompts the user to create a new playlist with from the selected items.
     */
634
    void slotCreateGroup();
635

636 637 638 639
    /**
     * This slot is called when the user drags the slider in the listview header
     * to manually set the size of the column.
     */
Kacper Kasper's avatar
Kacper Kasper committed
640
    void columnResized(int column, int oldSize, int newSize);
641

642 643 644 645 646 647 648 649
    /**
     * The slot is called when the completion mode for the line edit in the
     * inline tag editor is changed.  It saves the settings and through the
     * magic of the SharedSettings class will apply it to the other playlists as
     * well.
     */
    void slotInlineCompletionModeChanged(KGlobalSettings::Completion mode);

650 651
    void slotPlayCurrent();

652
private:
653 654
    friend class PlaylistItem;

655 656
    PlaylistCollection *m_collection;

657
    StringHash m_members;
658

659
    WebImageFetcher *m_fetcher;
660

661
    int m_currentColumn;
Matthias Kretz's avatar
Matthias Kretz committed
662
    QAction *m_rmbEdit;
663 664
    int m_selectedCount;

665
    bool m_allowDuplicates;
666
    bool m_applySharedSettings;
667
    bool m_columnWidthModeChanged;
668

669
    QList<int> m_weightDirty;
670
    bool m_disableColumnWidthUpdates;
671

672
    mutable int m_time;
673 674
    mutable PlaylistItemList m_addTime;
    mutable PlaylistItemList m_subtractTime;
675

676
    /**
677
     * The average minimum widths of columns to be used in balancing calculations.
678
     */
679 680
    QVector<int> m_columnWeights;
    QVector<int> m_columnFixedWidths;
681
    bool m_widthsDirty;
682

683
    static PlaylistItemList m_history;
684
    PlaylistSearch m_search;
685

686 687
    bool m_searchEnabled;

688
    PlaylistItem *m_lastSelected;
689

690
    /**
691
     * Used to store the text for inline editing before it is changed so that
692 693 694 695
     * we can know if something actually changed and as such if we need to save
     * the tag.
     */
    QString m_editText;
696 697 698 699 700

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
701
    QString m_playlistName;
702
    QString m_fileName;
703

704
    QStringList m_columns;
Kacper Kasper's avatar
Kacper Kasper committed
705
    QMenu *m_rmbMenu;
706
    QMenu *m_headerMenu;
707
    KActionMenu *m_columnVisibleAction;
708
    PlaylistToolTip *m_toolTip;
709

710
    /**
711
     * This is used to indicate if the list of visible items has changed (via a
712 713 714
     * call to setVisibleItems()) while random play is playing.
     */
    static bool m_visibleChanged;
715
    static bool m_shuttingDown;
716
    static int m_leftColumn;
717
    static QVector<PlaylistItem *> m_backMenuItems;
718 719

    bool m_blockDataChanged;
720 721
};

722 723
typedef QList<Playlist *> PlaylistList;

724
bool processEvents();
725

726
class FocusUpEvent : public QEvent
727 728
{
public:
729 730 731 732
    FocusUpEvent() : QEvent(id) {}
    Type type() const { return id; }

    static const Type id = static_cast<Type>(QEvent::User + 1);
733 734
};

735
QDataStream &operator<<(QDataStream &s, const Playlist &p);
736 737
QDataStream &operator>>(QDataStream &s, Playlist &p);

738 739
// template method implementations

740
template <class ItemType>
741
ItemType *Playlist::createItem(const FileHandle &file, QTreeWidgetItem *after,
742
                               bool emitChanged)
743
{
744
    CollectionListItem *item = collectionListItem(file);
André Wöbbeking's avatar
André Wöbbeking committed
745
    if(item && (!m_members.insert(file.absFilePath()) || m_allowDuplicates)) {
746

747 748
        ItemType *i = after ? new ItemType(item, this, after) : new ItemType(item, this);
        setupItem(i);
749

750 751
        if(emitChanged)
            dataChanged();
752

753
        return i;
754 755
    }
    else
756
        return 0;
757 758
}

759 760 761 762
template <class ItemType, class SiblingType>
ItemType *Playlist::createItem(SiblingType *sibling, ItemType *after)
{
    m_disableColumnWidthUpdates = true;
763

764
    if(!m_members.insert(sibling->file().absFilePath()) || m_allowDuplicates) {
765 766
        after = new ItemType(sibling->collectionItem(), this, after);
        setupItem(after);
767 768 769 770 771 772 773
    }

    m_disableColumnWidthUpdates = false;

    return after;
}

774
template <class ItemType, class SiblingType>
775
void Playlist::createItems(const QList<SiblingType *> &siblings, ItemType *after)
776
{
777
    if(siblings.isEmpty())
778
        return;
779

780 781
    foreach(SiblingType *sibling, siblings)
        after = createItem(sibling, after);
782

783
    dataChanged();
784
    slotWeightDirty();
785 786
}

787
#endif
788 789

// vim: set et sw=4 tw=0 sta: