playlist.h 23.6 KB
Newer Older
1 2
/***************************************************************************
    begin                : Sat Feb 16 2002
3
    copyright            : (C) 2002 - 2004 by Scott Wheeler
4
    email                : wheeler@kde.org
5 6
    copyright            : (c) 2007 Michael Pyne
    email                : michael.pyne@kdemail.net
7 8 9 10 11 12 13 14 15 16 17 18 19 20
***************************************************************************/

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

Laurent Montel's avatar
Laurent Montel committed
21
#include <k3listview.h>
22
#include <kglobalsettings.h>
23
#include <kdebug.h>
24

25
#include <QVector>
26
#include <QEvent>
27
#include <QList>
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

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

38 39 40
class QFileInfo;
class QMimeData;
class QDrag;
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

48
typedef QList<PlaylistItem *> PlaylistItemList;
49

Laurent Montel's avatar
Laurent Montel committed
50
class Playlist : public K3ListView, public PlaylistInterface
51 52
{
    Q_OBJECT
53

54
public:
55

56
    explicit Playlist(PlaylistCollection *collection, const QString &name = QString(),
57
             const QString &iconName = "midi");
58
    Playlist(PlaylistCollection *collection, const PlaylistItemList &items,
59
             const QString &name = QString(), const QString &iconName = "midi");
60
    Playlist(PlaylistCollection *collection, const QFileInfo &playlistFile,
61
             const QString &iconName = "midi");
62

63
    /**
64 65 66
     * 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.
67
     */
68
    Playlist(PlaylistCollection *collection, bool delaySetup);
69

70 71
    virtual ~Playlist();

72 73 74 75 76 77 78 79 80 81 82

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

    virtual QString name() const;
    virtual FileHandle currentFile() const;
    virtual int count() const { return childCount(); }
    virtual int time() const;
    virtual void playNext();
    virtual void playPrevious();
    virtual void stop();

83 84 85
    /**
     * Plays the top item of the playlist.
     */
86 87
    void playFirst();

88 89 90 91 92 93
    /**
     * Plays the next album in the playlist.  Only useful when in album random
     * play mode.
     */
    void playNextAlbum();

94 95 96
    /**
     * 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
97
     * name.
98
     */
99
    virtual void save();
Scott Wheeler's avatar
Scott Wheeler committed
100 101 102 103 104

    /**
     * Standard "save as".  Prompts the user for a location where to save the
     * playlist to.
     */
105
    virtual void saveAs();
Scott Wheeler's avatar
Scott Wheeler committed
106 107 108 109 110 111 112 113 114 115 116

    /**
     * Removes \a item from the Playlist, but not from the disk.  If
     * \a emitChanged is true this will also notify relevant classes
     * that the content of the list has changed.
     *
     * In some situations, for instance when removing items in a loop, it is
     * preferable to delay this notification until after other operations have
     * completed.  In those cases set \a emitChanged to false and call the
     * signal directly.
     */
117
    virtual void clearItem(PlaylistItem *item, bool emitChanged = true);
Scott Wheeler's avatar
Scott Wheeler committed
118 119 120 121 122

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

125 126 127 128 129 130
    /**
     * 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.
     */
131
    static PlaylistItem *playingItem();
132

133 134
    /**
     * All of the (media) files in the list.
135
     */
136
    QStringList files() const;
137

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

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

148 149 150
    /**
     * Returns a list of the currently selected items.
     */
151
    PlaylistItemList selectedItems();
152

153 154 155 156 157
    /**
     * Returns properly casted first child item in list.
     */
    PlaylistItem *firstChild() const;

158 159
    /**
     * Allow duplicate files in the playlist.
160
     */
161
    void setAllowDuplicates(bool allow) { m_allowDuplicates = allow; }
162

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

Scott Wheeler's avatar
Scott Wheeler committed
172 173 174 175 176
    /**
     * This is implemented as a template method to allow subclasses to
     * instantiate their PlaylistItem subclasses using the same method.  Some
     * of the types here are artificially templatized (i.e. CollectionListType and
     * CollectionItemType) to avoid recursive includes, but in fact will always
177
     * be the same.
Scott Wheeler's avatar
Scott Wheeler committed
178
     */
179
    template <class ItemType, class CollectionItemType, class CollectionListType>
180
    ItemType *createItem(const FileHandle &file,
181 182
                         Q3ListViewItem *after = 0,
                         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);
222 223
    bool isColumnVisible(int c) const;

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

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

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

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

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

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

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

263 264 265 266
    /**
     * 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
267
    PlaylistSearch search() const { return m_search; }
268 269 270 271

    /**
     * Set the search associtated with this playlist.
     */
272 273 274 275 276 277 278
    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
279

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

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

    /**
     * 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.
     */
298
    virtual bool readOnly() const { return false; }
299

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

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

311 312 313 314 315 316 317
    /**
     * Synchronizes the the playing item in this playlist with the playing item
     * 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);

318 319 320 321 322 323 324
    /**
     * 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();

325 326
    void read(QDataStream &s);

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

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

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

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

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

    /**
     * Removes the selected items from the list, but not the disk.
     *
     * @see clearItem()
     * @see clearItems()
     */
358
    virtual void clear();
Laurent Montel's avatar
Laurent Montel committed
359
    virtual void selectAll() { K3ListView::selectAll(true); }
360

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

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

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

376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
    /**
     * 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();

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

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

402 403 404 405 406
    /**
     * 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.
     */
407
    void slotWeightDirty(int column = -1);
408

409 410
    void slotShowPlaying();

411 412
    void slotColumnResizeModeChanged();

413 414
    virtual void dataChanged();

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

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

    virtual bool eventFilter(QObject *watched, QEvent *e);
425
    virtual void keyPressEvent(QKeyEvent *e);
Tim Beaulen's avatar
Tim Beaulen committed
426 427
    virtual QDrag *drag(QWidget *parent);
    virtual QDrag *drag() { return drag(this); }
428
    virtual bool canDecode(QMimeSource *s);
Tim Beaulen's avatar
Tim Beaulen committed
429
    virtual void decode(const QMimeData *s, PlaylistItem *item = 0);
430
    virtual void contentsDropEvent(QDropEvent *e);
431
    virtual void contentsMouseDoubleClickEvent(QMouseEvent *e);
Michael Pyne's avatar
Michael Pyne committed
432
    virtual void contentsDragEnterEvent(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 437
    virtual void viewportPaintEvent(QPaintEvent *pe);
    virtual void viewportResizeEvent(QResizeEvent *re);

Laurent Montel's avatar
Laurent Montel committed
438 439
    virtual void insertItem(Q3ListViewItem *item);
    virtual void takeItem(Q3ListViewItem *item);
440

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

443
    void addColumn(const QString &label);
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 464 465 466 467
    /**
     * As a template this allows us to use the same code to initialize the items
     * in subclasses.  CollectionItemType should always be CollectionListItem and
     * ItemType should be a PlaylistItem subclass.
     */
    template <class CollectionItemType, class ItemType, class SiblingType>
468
    void createItems(const QList<SiblingType *> &siblings, ItemType *after = 0);
469

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

474
signals:
475

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

482
    /**
483
     * This signal is emitted just before a playlist item is removed from the
484 485 486
     * 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.
487
     */
488
    void signalAboutToRemove(PlaylistItem *item);
489

490 491
    void signalEnableDirWatch(bool enable);

492 493
    void coverChanged();

494 495
    void signalPlaylistItemsDropped(Playlist *p);

496 497
private:
    void setup();
498

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

505 506 507 508 509 510
    /**
     * 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.
     */
511
    void loadFile(const QString &fileName, const QFileInfo &fileInfo);
512

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

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

526 527 528 529 530 531 532 533
    /**
     * This method is used internally to provide the backend to the other item
     * lists.
     *
     * \see items()
     * \see visibleItems()
     * \see selectedItems()
     */
Laurent Montel's avatar
Laurent Montel committed
534
    PlaylistItemList items(Q3ListViewItemIterator::IteratorFlag flags);
535

536 537 538 539 540
    /**
     * Build the column "weights" for the weighted width mode.
     */
    void calculateColumnWeights();

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

    void redisplaySearch() { setSearch(m_search); }

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

553 554
    void refreshAlbum(const QString &artist, const QString &album);

555 556
    void updatePlaying() const;

557 558 559 560 561 562
    /**
     * 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;

563
private slots:
564

565 566 567 568 569 570 571 572 573 574
    /**
     * 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();

575 576
    void slotUpdateColumnWidths();

577 578
    void slotAddToUpcoming();

579
    /**
580
     * Show the RMB menu.  Matches the signature for the signal
581 582
     * QListView::contextMenuRequested().
     */
Laurent Montel's avatar
Laurent Montel committed
583
    void slotShowRMBMenu(Q3ListViewItem *item, const QPoint &point, int column);
584 585

    /**
Scott Wheeler's avatar
Scott Wheeler committed
586 587
     * This slot is called when the inline tag editor has completed its editing
     * and starts the process of renaming the values.
588
     *
Scott Wheeler's avatar
Scott Wheeler committed
589
     * \see editTag()
590
     */
Laurent Montel's avatar
Laurent Montel committed
591
    void slotInlineEditDone(Q3ListViewItem *, const QString &, int column);
592 593

    /**
594
     * This starts the renaming process by displaying a line edit if the mouse is in
595 596
     * an appropriate position.
     */
597
    void slotRenameTag();
598

599 600 601 602 603 604
    /**
     * The image fetcher will update the cover asynchronously, this internal
     * slot is called when it happens.
     */
    void slotCoverChanged(int coverId);

605 606 607 608
    /**
     * Moves the column \a from to the position \a to.  This matches the signature
     * for the signal QHeader::indexChange().
     */
609
    void slotColumnOrderChanged(int, int from, int to);
610 611 612 613 614 615 616

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

619 620 621
    /**
     * Prompts the user to create a new playlist with from the selected items.
     */
622
    void slotCreateGroup();
623

624 625 626 627 628 629
    /**
     * This slot is called when the user drags the slider in the listview header
     * to manually set the size of the column.
     */
    void slotColumnSizeChanged(int column, int oldSize, int newSize);

630 631 632 633 634 635 636 637
    /**
     * 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);

638 639
    void slotPlayCurrent();

640
private:
641 642
    PlaylistCollection *m_collection;

643
    StringHash m_members;
644

645
    WebImageFetcher *m_fetcher;
646

647
    int m_currentColumn;
648
    int m_processed;
Matthias Kretz's avatar
Matthias Kretz committed
649
    QAction *m_rmbEdit;
650 651
    int m_selectedCount;

652
    bool m_allowDuplicates;
653
    bool m_applySharedSettings;
654
    bool m_columnWidthModeChanged;
655

656
    QList<int> m_weightDirty;
657
    bool m_disableColumnWidthUpdates;
658

659
    mutable int m_time;
660 661
    mutable PlaylistItemList m_addTime;
    mutable PlaylistItemList m_subtractTime;
662

663
    /**
664
     * The average minimum widths of columns to be used in balancing calculations.
665
     */
666 667
    QVector<int> m_columnWeights;
    QVector<int> m_columnFixedWidths;
668
    bool m_widthsDirty;
669

670
    static PlaylistItemList m_history;
671
    PlaylistSearch m_search;
672

673 674
    bool m_searchEnabled;

675
    PlaylistItem *m_lastSelected;
676

677
    /**
678
     * Used to store the text for inline editing before it is changed so that
679 680 681 682
     * we can know if something actually changed and as such if we need to save
     * the tag.
     */
    QString m_editText;
683 684 685 686 687

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
688
    QString m_playlistName;
689
    QString m_fileName;
690

Laurent Montel's avatar
Laurent Montel committed
691 692
    KMenu *m_rmbMenu;
    KMenu *m_headerMenu;
693
    KActionMenu *m_columnVisibleAction;
694
    PlaylistToolTip *m_toolTip;
695

696
    /**
697
     * This is used to indicate if the list of visible items has changed (via a
698 699 700
     * call to setVisibleItems()) while random play is playing.
     */
    static bool m_visibleChanged;
701
    static bool m_shuttingDown;
702
    static int m_leftColumn;
703
    static QMap<int, PlaylistItem *> m_backMenuItems;
704 705

    bool m_blockDataChanged;
706 707
};

708 709
typedef QList<Playlist *> PlaylistList;

710
bool processEvents();
711

712
class FocusUpEvent : public QEvent
713 714
{
public:
715 716 717 718
    FocusUpEvent() : QEvent(id) {}
    Type type() const { return id; }

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

721
QDataStream &operator<<(QDataStream &s, const Playlist &p);
722 723
QDataStream &operator>>(QDataStream &s, Playlist &p);

724 725
// template method implementations

726
template <class ItemType, class CollectionItemType, class CollectionListType>
Laurent Montel's avatar
Laurent Montel committed
727
ItemType *Playlist::createItem(const FileHandle &file, Q3ListViewItem *after,
728
                               bool emitChanged)
729
{
730
    CollectionItemType *item = CollectionListType::instance()->lookup(file.absFilePath());
731 732

    if(!item) {
733 734
        item = new CollectionItemType(file);
        setupItem(item);
735

736
        // If a valid tag was not created, destroy the CollectionListItem.
737

738 739 740 741 742 743
        if(!item->isValid()) {
            kError(65432) << "Playlist::createItem() -- A valid tag was not created for \""
                           << file.absFilePath() << "\"" << endl;
            delete item;
            return 0;
        }
744 745
    }

746
    if(item && !m_members.insert(file.absFilePath()) || m_allowDuplicates) {
747

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

751 752
        if(emitChanged)
            dataChanged();
753

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

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

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

    m_disableColumnWidthUpdates = false;

    return after;
}

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

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

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

788
#endif
789 790

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