dynamicplaylist.h 2.93 KB
Newer Older
1 2
/***************************************************************************
    begin                : Mon May 5 2003
3
    copyright            : (C) 2003 - 2004 by Scott Wheeler
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
    email                : wheeler@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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef DYNAMICPLAYLIST_H
#define DYNAMICPLAYLIST_H

#include "playlist.h"

/**
 * A Playlist that is a union of other playlists that is created dynamically.
 */

class DynamicPlaylist : public Playlist
{
    Q_OBJECT
public:
    /**
     * Creates a dynamic playlist based on lists.
     */
32 33 34
    DynamicPlaylist(const PlaylistList &lists,
                    PlaylistCollection *collection,
                    const QString &name = QString::null,
35 36
                    const QString &iconName = "midi",
                    bool setupPlaylist = true);
37

38 39
    virtual ~DynamicPlaylist();

40 41 42 43 44 45
public slots:
    /**
     * Reimplemented so that it will reload all of the playlists that are
     * associated with the dynamic list.
     */
    virtual void slotReload();
46
    void slotSetDirty() { m_dirty = true; }
47

48 49 50 51 52
protected:
    /**
     * Returns true if this list's items need to be updated the next time it's
     * shown.
     */
53
    bool dirty() const { return m_dirty; }
54 55

    /**
56
     * Return a list of the items in this playlist.  For example in a search
57 58 59
     * list this should return only the matched items.  By default it returns
     * all of the items in the playlists associated with this dynamic list.
     */
60
    virtual PlaylistItemList items();
61 62 63 64 65 66 67

    /**
     * Reimplemented from QWidget.  Here it updates the list of items (when
     * appropriate) as the widget is shown.
     */
    virtual void showEvent(QShowEvent *e);

68 69 70 71 72 73 74
    /**
     * Updates the items (unconditionally).  This should be reimplemented in
     * subclasses to refresh the items in the dynamic list (i.e. running a
     * search).
     */
    virtual void updateItems();

75 76 77 78 79 80 81 82
private:
    /**
     * Checks to see if the current list of items is "dirty" and if so updates
     * this dynamic playlist's items to be in sync with the lists that it is a
     * wrapper around.
     */
    void checkUpdateItems();

83 84 85
private slots:
    void slotUpdateItems();

86
private:
87
    QValueList<PlaylistObserver *> m_observers;
88
    PlaylistItemList m_siblings;
89 90 91 92 93
    PlaylistList m_playlists;
    bool m_dirty;
};

#endif