Members of the KDE Community are recommended to subscribe to the kde-community mailing list at https://mail.kde.org/mailman/listinfo/kde-community to allow them to participate in important discussions and receive other important announcements

playlist.h 23.6 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

Michael Pyne's avatar
Michael Pyne committed
18 19
#ifndef JUK_PLAYLIST_H
#define JUK_PLAYLIST_H
20

Michael Pyne's avatar
Michael Pyne committed
21
#include <KCompletion>
22

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

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

36
class KActionMenu;
37

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

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

48
typedef QList<PlaylistItem *> PlaylistItemList;
49

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

54
public:
55

56
    explicit Playlist(PlaylistCollection *collection, const QString &name = QString(),
Michael Pyne's avatar
Michael Pyne committed
57
             const QString &iconName = "audio-midi");
58
    Playlist(PlaylistCollection *collection, const PlaylistItemList &items,
Michael Pyne's avatar
Michael Pyne committed
59
             const QString &name = QString(), const QString &iconName = "audio-midi");
60
    Playlist(PlaylistCollection *collection, const QFileInfo &playlistFile,
Michael Pyne's avatar
Michael Pyne committed
61
             const QString &iconName = "audio-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 69 70 71
     *
     * @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).
72
     */
73
    Playlist(PlaylistCollection *collection, bool delaySetup, int extraColumns = 0);
74

75 76
    virtual ~Playlist();

77 78 79 80 81

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

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

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

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

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

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

    /**
113
     * Removes \a item from the Playlist, but not from the disk.
Scott Wheeler's avatar
Scott Wheeler committed
114
     *
115 116 117
     * 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
118
     */
119
    virtual void clearItem(PlaylistItem *item);
Scott Wheeler's avatar
Scott Wheeler committed
120 121 122 123 124

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

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

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

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

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

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

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

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

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

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

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

185 186 187 188
    /**
     * 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.
189 190 191 192
     *
     * 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.
193
     */
194
    virtual void addFiles(const QStringList &files, PlaylistItem *after = 0);
195

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

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

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

    /**
216
     * Shows column \a c.  If \a updateSearch is true then a signal that the
217 218 219
     * visible columns have changed will be emitted and things like the search
     * will be udated.
     */
220
    void showColumn(int c, bool updateSearch = true);
221

Kacper Kasper's avatar
Kacper Kasper committed
222
    void sortByColumn(int column, Qt::SortOrder order = Qt::AscendingOrder);
223

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
    /**
     * Subclasses of Playlist which add new columns will set this value to
Jan Gerrit Marker's avatar
Jan Gerrit Marker committed
282
     * specify how many of those columns exist.  This allows the Playlist
Scott Wheeler's avatar
Scott Wheeler committed
283 284 285
     * class to do some internal calculations on the number and positions
     * of columns.
     */
286
    virtual int columnOffset() const { return 0; }
Scott Wheeler's avatar
Scott Wheeler committed
287 288 289 290 291 292

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

295 296 297
    /**
     * Returns true if it's possible to reload this playlist.
     */
298
    virtual bool canReload() const { return !m_fileName.isEmpty(); }
299

300 301 302 303 304 305
    /**
     * Returns true if the playlist is a search playlist and the search should be
     * editable.
     */
    virtual bool searchIsEditable() const { return false; }

306
    /**
307
     * Synchronizes the playing item in this playlist with the playing item
308 309 310 311 312
     * 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);

313 314 315 316 317 318 319
    /**
     * 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();

320 321
    void read(QDataStream &s);

322 323
    static void setShuttingDown() { m_shuttingDown = true; }

324
public slots:
325
    /**
326
     * Remove the currently selected items from the playlist and disk.
327
     */
328
    void slotRemoveSelectedItems() { removeFromDisk(selectedItems()); }
Scott Wheeler's avatar
Scott Wheeler committed
329

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

    /**
     * Puts a list of URLs pointing to the files in the current selection on the
     * clipboard.
     */
340
    virtual void copy();
Scott Wheeler's avatar
Scott Wheeler committed
341 342 343 344

    /**
     * Checks the clipboard for local URLs to be inserted into this playlist.
     */
345
    virtual void paste();
Scott Wheeler's avatar
Scott Wheeler committed
346 347 348 349 350 351 352

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

356 357 358 359 360 361
    /**
     * Refreshes the tags of the selection from disk, or all of the files in the
     * list if there is no selection.
     */
    virtual void slotRefresh();

362
    void slotGuessTagInfo(TagGuesser::Type type);
Scott Wheeler's avatar
Scott Wheeler committed
363 364 365 366 367 368

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

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
    /**
     * 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();

387 388 389 390 391
    /**
     * Shows the cover manager GUI dialog
     */
    void slotShowCoverManager();

392 393 394
    /**
     * Reload the playlist contents from the m3u file.
     */
395
    virtual void slotReload();
396

397 398 399 400 401
    /**
     * 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.
     */
402
    void slotWeightDirty(int column = -1);
403

404 405
    void slotShowPlaying();

406 407
    void slotColumnResizeModeChanged();

408
    virtual void playlistItemsChanged();
409

410
protected:
411 412 413 414
    /**
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
     */
415
    void removeFromDisk(const PlaylistItemList &items);
416

417 418 419 420 421 422 423 424 425
    /**
     * Adds and removes items from this Playlist as necessary to ensure that
     * the same items are present in this Playlist as in @p itemList.
     *
     * No ordering guarantees are imposed, just that the playlist will have the
     * same items as in the given list afterwards.
     */
    void synchronizeItemsTo(const PlaylistItemList &itemList);

426 427 428
    // the following are all reimplemented from base classes

    virtual bool eventFilter(QObject *watched, QEvent *e);
429
    virtual void keyPressEvent(QKeyEvent *e);
Tim Beaulen's avatar
Tim Beaulen committed
430
    virtual void decode(const QMimeData *s, PlaylistItem *item = 0);
Kacper Kasper's avatar
Kacper Kasper committed
431 432 433 434 435
    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
436
    virtual void showEvent(QShowEvent *e);
Michael Pyne's avatar
Michael Pyne committed
437
    virtual bool acceptDrag(QDropEvent *e) const;
438 439
    virtual void paintEvent(QPaintEvent *pe);
    virtual void resizeEvent(QResizeEvent *re);
440

441 442
    virtual void insertItem(QTreeWidgetItem *item);
    virtual void takeItem(QTreeWidgetItem *item);
443

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

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

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

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

462 463 464
    template <class ItemType, class SiblingType>
    ItemType *createItem(SiblingType *sibling, ItemType *after = 0);

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

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

476
signals:
477

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

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

492 493
    void signalEnableDirWatch(bool enable);

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()
     */
534
    PlaylistItemList items(QTreeWidgetItemIterator::IteratorFlags 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 563
    /**
     * 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);

564 565 566 567 568 569 570 571
    /**
     * 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);

572 573 574 575 576 577
    /**
     * 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;

578
private slots:
579

580 581 582 583 584 585 586 587 588 589
    /**
     * 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();

590 591
    void slotUpdateColumnWidths();

592 593
    void slotAddToUpcoming();

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

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

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

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

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

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

634 635 636
    /**
     * Prompts the user to create a new playlist with from the selected items.
     */
637
    void slotCreateGroup();
638

639 640 641 642
    /**
     * 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
643
    void columnResized(int column, int oldSize, int newSize);
644

645 646 647 648 649 650
    /**
     * 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.
     */
Michael Pyne's avatar
Michael Pyne committed
651
    void slotInlineCompletionModeChanged(KCompletion::CompletionMode mode);
652

653 654
    void slotPlayCurrent();

655
private:
656 657
    friend class PlaylistItem;

658 659
    PlaylistCollection *m_collection;

660
    StringHash m_members;
661

662
    WebImageFetcher *m_fetcher;
663

664
    int m_currentColumn;
Matthias Kretz's avatar
Matthias Kretz committed
665
    QAction *m_rmbEdit;
666

667
    bool m_allowDuplicates;
668
    bool m_applySharedSettings;
669
    bool m_columnWidthModeChanged;
670

671
    QList<int> m_weightDirty;
672
    bool m_disableColumnWidthUpdates;
673

674
    mutable int m_time;
675 676
    mutable PlaylistItemList m_addTime;
    mutable PlaylistItemList m_subtractTime;
677

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

685
    static PlaylistItemList m_history;
686
    PlaylistSearch m_search;
687

688 689
    bool m_searchEnabled;

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
        if(emitChanged)
751
            playlistItemsChanged();
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
    playlistItemsChanged();
784
    slotWeightDirty();
785 786
}

787
#endif
788 789

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