dynamicplaylist.h 3.46 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
    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"
20

21
#include <QList>
22 23 24 25 26 27 28 29 30 31 32 33

/**
 * 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.
     */
34 35
    DynamicPlaylist(const PlaylistList &lists,
                    PlaylistCollection *collection,
36
                    const QString &name = QString(),
Michael Pyne's avatar
Michael Pyne committed
37
                    const QString &iconName = "audio-midi",
38
                    bool setupPlaylist = true,
39
                    bool synchronizePlaying = false);
40

41 42
    virtual ~DynamicPlaylist();

43 44
    virtual bool canReload() const { return false; }

45 46
    void setPlaylists(const PlaylistList &playlists);

47 48 49 50 51 52
public slots:
    /**
     * Reimplemented so that it will reload all of the playlists that are
     * associated with the dynamic list.
     */
    virtual void slotReload();
53
    void slotSetDirty() { m_dirty = true; }
54

55 56 57 58 59 60 61
    /**
     * This is called when lowering the widget from the widget stack so that
     * it can synchronize the playing item with the one that playlist it was
     * create from.
     */
    void lower(QWidget *top = 0);

62 63 64 65 66
protected:
    /**
     * Returns true if this list's items need to be updated the next time it's
     * shown.
     */
67
    bool dirty() const { return m_dirty; }
68 69

    /**
70
     * Return a list of the items in this playlist.  For example in a search
71 72 73
     * list this should return only the matched items.  By default it returns
     * all of the items in the playlists associated with this dynamic list.
     */
74
    virtual PlaylistItemList items();
75 76 77 78 79 80 81

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

82 83
    virtual void paintEvent(QPaintEvent *e);

84 85 86 87 88 89 90
    /**
     * 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();

91 92
    bool synchronizePlaying() const;

93 94 95 96 97 98 99 100
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();

101 102 103
private slots:
    void slotUpdateItems();

104
private:
105
    QList<PlaylistObserver *> m_observers;
106
    PlaylistItemList m_siblings;
107 108
    PlaylistList m_playlists;
    bool m_dirty;
109
    bool m_synchronizePlaying;
110 111 112
};

#endif
113 114

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