playlist.h 23.9 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 7 8 9 10 11 12 13 14 15 16 17 18
***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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
19
#include <k3listview.h>
Laurent Montel's avatar
Laurent Montel committed
20
#include <k3urldrag.h>
Dirk Mueller's avatar
compile  
Dirk Mueller committed
21
#include <kdebug.h>
22
#include <kglobalsettings.h>
23

Laurent Montel's avatar
Laurent Montel committed
24
#include <q3valuevector.h>
Dirk Mueller's avatar
compile  
Dirk Mueller committed
25
#include <qfileinfo.h>
26

Laurent Montel's avatar
Laurent Montel committed
27 28 29 30 31 32 33 34 35 36
#include <QPaintEvent>
#include <QKeyEvent>
#include <QEvent>
#include <QDropEvent>
#include <Q3ValueList>
#include <QShowEvent>
#include <QResizeEvent>
#include <QDragEnterEvent>
#include <QMouseEvent>
#include <QCustomEvent>
37

38
#include "covermanager.h"
39
#include "stringhash.h"
Scott Wheeler's avatar
Scott Wheeler committed
40
#include "playlistsearch.h"
41
#include "tagguesser.h"
42
#include "playlistinterface.h"
43
#include "playlistitem.h"
44

Laurent Montel's avatar
Laurent Montel committed
45
class KMenu;
46
class KActionMenu;
47 48

class QEvent;
Scott Wheeler's avatar
Scott Wheeler committed
49

50
class PlaylistCollection;
Scott Wheeler's avatar
Scott Wheeler committed
51

52
class PlaylistToolTip;
53 54
class UpcomingPlaylist;

Laurent Montel's avatar
Laurent Montel committed
55
typedef Q3ValueList<PlaylistItem *> PlaylistItemList;
56

Laurent Montel's avatar
Laurent Montel committed
57
class Playlist : public K3ListView, public PlaylistInterface
58 59
{
    Q_OBJECT
60

61
public:
62

63
    Playlist(PlaylistCollection *collection, const QString &name = QString::null,
64
             const QString &iconName = "midi");
65
    Playlist(PlaylistCollection *collection, const PlaylistItemList &items,
66
             const QString &name = QString::null, const QString &iconName = "midi");
67
    Playlist(PlaylistCollection *collection, const QFileInfo &playlistFile,
68
             const QString &iconName = "midi");
69

70
    /**
71 72 73
     * 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.
74
     */
75
    Playlist(PlaylistCollection *collection, bool delaySetup);
76

77 78
    virtual ~Playlist();

79 80 81 82 83 84 85 86 87 88 89

    // 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();

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

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

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

    /**
     * Standard "save as".  Prompts the user for a location where to save the
     * playlist to.
     */
112
    virtual void saveAs();
Scott Wheeler's avatar
Scott Wheeler committed
113 114 115 116 117 118 119 120 121 122 123

    /**
     * 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.
     */
124
    virtual void clearItem(PlaylistItem *item, bool emitChanged = true);
Scott Wheeler's avatar
Scott Wheeler committed
125 126 127 128 129

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

132 133 134 135 136 137
    /**
     * 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.
     */
138
    static PlaylistItem *playingItem();
139

140 141
    /**
     * All of the (media) files in the list.
142
     */
143
    QStringList files() const;
144

145
    /**
Scott Wheeler's avatar
Scott Wheeler committed
146
     * Returns a list of all of the items in the playlist.
147
     */
148
    virtual PlaylistItemList items();
149

150
    /**
Scott Wheeler's avatar
Scott Wheeler committed
151
     * Returns a list of all of the \e visible items in the playlist.
152
     */
153
    PlaylistItemList visibleItems();
154

155 156 157
    /**
     * Returns a list of the currently selected items.
     */
158
    PlaylistItemList selectedItems();
159

160 161 162 163 164
    /**
     * Returns properly casted first child item in list.
     */
    PlaylistItem *firstChild() const;

165 166
    /**
     * Allow duplicate files in the playlist.
167
     */
168
    void setAllowDuplicates(bool allow) { m_allowDuplicates = allow; }
169

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

Scott Wheeler's avatar
Scott Wheeler committed
179 180 181 182 183
    /**
     * 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
184
     * be the same.
Scott Wheeler's avatar
Scott Wheeler committed
185
     */
186
    template <class ItemType, class CollectionItemType, class CollectionListType>
187
    ItemType *createItem(const FileHandle &file,
188 189
                         Q3ListViewItem *after = 0,
                         bool emitChanged = true);
190

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

193 194 195 196
    /**
     * 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.
197 198 199 200
     *
     * 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.
201
     */
202
    virtual void addFiles(const QStringList &files, PlaylistItem *after = 0);
203

204 205 206 207
    /**
     * Returns the file name associated with this playlist (an m3u file) or
     * QString::null if no such file exists.
     */
208
    QString fileName() const { return m_fileName; }
209 210 211 212 213

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

216
    /**
217
     * Hides 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 hideColumn(int c, bool updateSearch = true);
222 223

    /**
224
     * Shows column \a c.  If \a updateSearch is true then a signal that the
225 226 227
     * visible columns have changed will be emitted and things like the search
     * will be udated.
     */
228
    void showColumn(int c, bool updateSearch = true);
229 230
    bool isColumnVisible(int c) const;

231 232 233 234
    /**
     * This sets a name for the playlist that is \e different from the file name.
     */
    void setName(const QString &n);
235

236 237 238 239
    /**
     * Returns the KActionMenu that allows this to be embedded in menus outside
     * of the playlist.
     */
240
    KActionMenu *columnVisibleAction() const { return m_columnVisibleAction; }
241

242
    /**
243 244
     * Set item to be the playing item.  If \a item is null then this will clear
     * the playing indicator.
245
     */
246
    static void setPlaying(PlaylistItem *item, bool addToHistory = true);
247 248 249 250

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

Scott Wheeler's avatar
Scott Wheeler committed
253 254 255
    /**
     * This forces an update of the left most visible column, but does not save
     * the settings for this.
256
     */
Scott Wheeler's avatar
Scott Wheeler committed
257
    void updateLeftColumn();
258

259 260 261 262 263
    /**
     * Returns the leftmost visible column of the listview.
     */
    int leftColumn() const { return m_leftColumn; }

264 265 266 267
    /**
     * Sets the items in the list to be either visible based on the value of
     * visible.  This is useful for search operations and such.
     */
268 269
    static void setItemsVisible(const PlaylistItemList &items, bool visible = true);

270 271 272 273
    /**
     * 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
274
    PlaylistSearch search() const { return m_search; }
275 276 277 278

    /**
     * Set the search associtated with this playlist.
     */
279 280 281 282 283 284 285
    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
286

Scott Wheeler's avatar
Scott Wheeler committed
287 288 289
    /**
     * Marks \a item as either selected or deselected based.
     */
290 291
    void markItemSelected(PlaylistItem *item, bool selected);

Scott Wheeler's avatar
Scott Wheeler committed
292 293 294 295 296 297
    /**
     * 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.
     */
298
    virtual int columnOffset() const { return 0; }
Scott Wheeler's avatar
Scott Wheeler committed
299 300 301 302 303 304

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

307 308 309 310 311
    /**
     * Returns true if it's possible to reload this playlist.
     */
    virtual bool canReload() const { return !m_fileName.isNull(); }

312 313 314 315 316 317
    /**
     * Returns true if the playlist is a search playlist and the search should be
     * editable.
     */
    virtual bool searchIsEditable() const { return false; }

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

325 326 327 328 329 330 331
    /**
     * 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();

332 333
    void read(QDataStream &s);

334 335
    static void setShuttingDown() { m_shuttingDown = true; }

336
public slots:
337
    /**
338
     * Remove the currently selected items from the playlist and disk.
339
     */
340
    void slotRemoveSelectedItems() { removeFromDisk(selectedItems()); };
Scott Wheeler's avatar
Scott Wheeler committed
341

342 343 344 345
    /*
     * The edit slots are required to use the canonical names so that they are
     * detected by the application wide framework.
     */
346
    virtual void cut() { copy(); clear(); }
Scott Wheeler's avatar
Scott Wheeler committed
347 348 349 350 351

    /**
     * Puts a list of URLs pointing to the files in the current selection on the
     * clipboard.
     */
352
    virtual void copy();
Scott Wheeler's avatar
Scott Wheeler committed
353 354 355 356

    /**
     * Checks the clipboard for local URLs to be inserted into this playlist.
     */
357
    virtual void paste();
Scott Wheeler's avatar
Scott Wheeler committed
358 359 360 361 362 363 364

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

368 369 370 371 372 373
    /**
     * Refreshes the tags of the selection from disk, or all of the files in the
     * list if there is no selection.
     */
    virtual void slotRefresh();

374
    void slotGuessTagInfo(TagGuesser::Type type);
Scott Wheeler's avatar
Scott Wheeler committed
375 376 377 378 379 380

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

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
    /**
     * 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();

399 400 401 402 403
    /**
     * Shows the cover manager GUI dialog
     */
    void slotShowCoverManager();

404 405 406
    /**
     * Reload the playlist contents from the m3u file.
     */
407
    virtual void slotReload();
408

409 410 411 412 413
    /**
     * 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.
     */
414
    void slotWeightDirty(int column = -1);
415

416 417
    void slotShowPlaying();

418 419
    void slotColumnResizeModeChanged();

420 421
    virtual void dataChanged();

422
protected:
423 424 425 426
    /**
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
     */
427
    void removeFromDisk(const PlaylistItemList &items);
428

429 430 431
    // the following are all reimplemented from base classes

    virtual bool eventFilter(QObject *watched, QEvent *e);
432
    virtual void keyPressEvent(QKeyEvent *e);
Laurent Montel's avatar
Laurent Montel committed
433 434
    virtual Q3DragObject *dragObject(QWidget *parent);
    virtual Q3DragObject *dragObject() { return dragObject(this); }
435
    virtual bool canDecode(QMimeSource *s);
436
    virtual void decode(QMimeSource *s, PlaylistItem *item = 0);
437
    virtual void contentsDropEvent(QDropEvent *e);
438
    virtual void contentsMouseDoubleClickEvent(QMouseEvent *e);
Michael Pyne's avatar
Michael Pyne committed
439
    virtual void contentsDragEnterEvent(QDragEnterEvent *e);
Scott Wheeler's avatar
Scott Wheeler committed
440
    virtual void showEvent(QShowEvent *e);
Michael Pyne's avatar
Michael Pyne committed
441
    virtual bool acceptDrag(QDropEvent *e) const;
442 443 444
    virtual void viewportPaintEvent(QPaintEvent *pe);
    virtual void viewportResizeEvent(QResizeEvent *re);

Laurent Montel's avatar
Laurent Montel committed
445 446
    virtual void insertItem(Q3ListViewItem *item);
    virtual void takeItem(Q3ListViewItem *item);
447

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

450
    void addColumn(const QString &label);
Scott Wheeler's avatar
Scott Wheeler committed
451 452 453 454 455 456 457 458

    /**
     * Here I'm using delayed setup of some things that aren't quite intuitive.
     * Creating columns and setting up connections are both time consuming if
     * there are a lot of playlists to initialize.  This moves that cost from the
     * startup time to the time when the widget is "polished" -- i.e. just before
     * it's painted the first time.
     */
459
    virtual void polish();
460

461 462 463 464 465 466 467 468
    /**
     * 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);

469 470 471 472
    /**
     * Forwards the call to the parent to enable or disable automatic deletion
     * of tree view playlists.  Used by CollectionListItem.
     */
473
    void setDynamicListsFrozen(bool frozen);
474

475 476 477
    template <class ItemType, class SiblingType>
    ItemType *createItem(SiblingType *sibling, ItemType *after = 0);

478 479 480 481 482 483
    /**
     * 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>
Laurent Montel's avatar
Laurent Montel committed
484
    void createItems(const Q3ValueList<SiblingType *> &siblings, ItemType *after = 0);
485

486 487 488 489
protected slots:
    void slotPopulateBackMenu() const;
    void slotPlayFromBackMenu(int number) const;

490
signals:
491

492
    /**
493
     * This is connected to the PlaylistBox::Item to let it know when the
494 495
     * playlist's name has changed.
     */
496
    void signalNameChanged(const QString &name);
497

498
    /**
499
     * This signal is emitted just before a playlist item is removed from the
500 501 502
     * 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.
503
     */
504
    void signalAboutToRemove(PlaylistItem *item);
505

506 507
    void signalEnableDirWatch(bool enable);

508 509
    void coverChanged();

510 511
    void signalPlaylistItemsDropped(Playlist *p);

512 513
private:
    void setup();
514

515 516 517 518 519 520
    /**
     * This function is called to let the user know that JuK has automatically enabled
     * manual column width adjust mode.
     */
    void notifyUserColumnWidthModeChanged();

521 522 523 524 525 526
    /**
     * 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.
     */
527
    void loadFile(const QString &fileName, const QFileInfo &fileInfo);
528

529
    /**
Scott Wheeler's avatar
Scott Wheeler committed
530
     * Writes \a text to \a item in \a column.  This is used by the inline tag
531
     * editor.  Returns false if the tag update failed.
532
     */
533
    bool editTag(PlaylistItem *item, const QString &text, int column);
534 535 536 537 538 539

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

542 543 544 545 546 547 548 549
    /**
     * 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
550
    PlaylistItemList items(Q3ListViewItemIterator::IteratorFlag flags);
551

552 553 554 555 556
    /**
     * Build the column "weights" for the weighted width mode.
     */
    void calculateColumnWeights();

557
    void addFile(const QString &file, FileHandleList &files, bool importPlaylists,
558
                 PlaylistItem **after);
559
    void addFileHelper(FileHandleList &files, PlaylistItem **after,
560
                       bool ignoreTimer = false);
561 562 563

    void redisplaySearch() { setSearch(m_search); }

564 565 566 567 568
    /**
     * Sets the cover for items to the cover identified by id.
     */
    void refreshAlbums(const PlaylistItemList &items, coverKey id = CoverManager::NoMatch);

569 570
    void refreshAlbum(const QString &artist, const QString &album);

571 572 573 574 575
    /**
     * Returns the number of PlaylistItems in @p items that can be assigned a
     * cover.  Used to avoid wasting the users' time setting the cover for 20
     * items when none are eligible.
     */
576
    unsigned int eligibleCoverItems(const PlaylistItemList &items);
577

578 579
    void updatePlaying() const;

580 581 582 583 584 585
    /**
     * 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;

586
private slots:
587

588 589
    void slotUpdateColumnWidths();

590 591
    void slotAddToUpcoming();

592
    /**
593
     * Show the RMB menu.  Matches the signature for the signal
594 595
     * QListView::contextMenuRequested().
     */
Laurent Montel's avatar
Laurent Montel committed
596
    void slotShowRMBMenu(Q3ListViewItem *item, const QPoint &point, int column);
597 598

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

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

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

    /**
     * Toggles a columns visible status.  Useful for KActions.
     *
     * \see hideColumn()
     * \see showColumn()
     */
624
    void slotToggleColumnVisible(int column);
625

626 627 628
    /**
     * Prompts the user to create a new playlist with from the selected items.
     */
629
    void slotCreateGroup();
630

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

637 638 639 640 641 642 643 644
    /**
     * 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);

645 646
    void slotPlayCurrent();

647
private:
648 649
    PlaylistCollection *m_collection;

650
    StringHash m_members;
651

652
    int m_currentColumn;
653
    int m_processed;
654
    int m_rmbEditID;
655
    int m_rmbUpcomingID;
656 657
    int m_selectedCount;

658
    bool m_allowDuplicates;
659
    bool m_polished;
660
    bool m_applySharedSettings;
661
    bool m_columnWidthModeChanged;
662

Laurent Montel's avatar
Laurent Montel committed
663
    Q3ValueList<int> m_weightDirty;
664
    bool m_disableColumnWidthUpdates;
665

666
    mutable int m_time;
667 668
    mutable PlaylistItemList m_addTime;
    mutable PlaylistItemList m_subtractTime;
669

670
    /**
671
     * The average minimum widths of columns to be used in balancing calculations.
672
     */
Laurent Montel's avatar
Laurent Montel committed
673 674
    Q3ValueVector<int> m_columnWeights;
    Q3ValueVector<int> m_columnFixedWidths;
675
    bool m_widthsDirty;
676

677
    static PlaylistItemList m_history;
678
    PlaylistSearch m_search;
679

680 681
    bool m_searchEnabled;

682
    PlaylistItem *m_lastSelected;
683

684
    /**
685
     * Used to store the text for inline editing before it is changed so that
686 687 688 689
     * we can know if something actually changed and as such if we need to save
     * the tag.
     */
    QString m_editText;
690 691 692 693 694

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
695
    QString m_playlistName;
696
    QString m_fileName;
697

Laurent Montel's avatar
Laurent Montel committed
698 699
    KMenu *m_rmbMenu;
    KMenu *m_headerMenu;
700
    KActionMenu *m_columnVisibleAction;
701
    PlaylistToolTip *m_toolTip;
702

703
    /**
704
     * This is used to indicate if the list of visible items has changed (via a
705 706 707
     * call to setVisibleItems()) while random play is playing.
     */
    static bool m_visibleChanged;
708
    static bool m_shuttingDown;
709
    static int m_leftColumn;
710
    static QMap<int, PlaylistItem *> m_backMenuItems;
711 712

    bool m_blockDataChanged;
713 714
};

715
bool processEvents();
716

717
class FocusUpEvent : public QEvent
718 719
{
public:
720 721 722 723
    FocusUpEvent() : QEvent(id) {}
    Type type() const { return id; }

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

726
QDataStream &operator<<(QDataStream &s, const Playlist &p);
727 728
QDataStream &operator>>(QDataStream &s, Playlist &p);

729 730
// template method implementations

731
template <class ItemType, class CollectionItemType, class CollectionListType>
Laurent Montel's avatar
Laurent Montel committed
732
ItemType *Playlist::createItem(const FileHandle &file, Q3ListViewItem *after,
733
                               bool emitChanged)
734
{
735
    CollectionItemType *item = CollectionListType::instance()->lookup(file.absFilePath());
736 737

    if(!item) {
738 739
        item = new CollectionItemType(file);
        setupItem(item);
740

741
        // If a valid tag was not created, destroy the CollectionListItem.
742

743 744 745 746 747 748
        if(!item->isValid()) {
            kError(65432) << "Playlist::createItem() -- A valid tag was not created for \""
                           << file.absFilePath() << "\"" << endl;
            delete item;
            return 0;
        }
749 750
    }

751
    if(item && !m_members.insert(file.absFilePath()) || m_allowDuplicates) {
752

753 754
        ItemType *i = after ? new ItemType(item, this, after) : new ItemType(item, this);
        setupItem(i);
755

756 757
        if(emitChanged)
            dataChanged();
758

759
        return i;
760 761
    }
    else
762
        return 0;
763 764
}

765 766 767 768
template <class ItemType, class SiblingType>
ItemType *Playlist::createItem(SiblingType *sibling, ItemType *after)
{
    m_disableColumnWidthUpdates = true;
769

770
    if(!m_members.insert(sibling->file().absFilePath()) || m_allowDuplicates) {
771 772
        after = new ItemType(sibling->collectionItem(), this, after);
        setupItem(after);
773 774 775 776 777 778 779
    }

    m_disableColumnWidthUpdates = false;

    return after;
}

780
template <class CollectionItemType, class ItemType, class SiblingType>
Laurent Montel's avatar
Laurent Montel committed
781
void Playlist::createItems(const Q3ValueList<SiblingType *> &siblings, ItemType *after)
782
{
783
    if(siblings.isEmpty())
784
        return;
785

Laurent Montel's avatar
Laurent Montel committed
786
    Q3ValueListConstIterator<SiblingType *> it = siblings.begin();
787
    for(; it != siblings.end(); ++it)
788
        after = createItem(*it, after);
789

790
    dataChanged();
791
    slotWeightDirty();
792 793
}

794
#endif
795 796

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