playlist.h 6.78 KB
Newer Older
1 2 3 4 5
/***************************************************************************
                          playlist.h  -  description
                             -------------------
    begin                : Sat Feb 16 2002
    copyright            : (C) 2002 by Scott Wheeler
6
    email                : wheeler@kde.org
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
***************************************************************************/

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

#include <klistview.h>

#include <qstringlist.h>
24
#include <qptrstack.h>
25 26

#include "playlistitem.h"
27
#include "sortedstringlist.h"
28

29
class PlaylistSplitter;
30
class PlaylistBoxItem;
31
class QPopupMenu;
32

33 34 35
class Playlist : public KListView
{
    Q_OBJECT
36

37
public:
38 39 40 41 42
    /** 
     * Before creating a playlist directly, please see 
     * PlaylistSplitter::createPlaylist().
     */
    Playlist(PlaylistSplitter *s, QWidget *parent, const QString &name = QString::null);
43

44 45 46 47 48
    /** 
     * Before creating a playlist directly, please see 
     * PlaylistSplitter::openPlaylist().
     */
    Playlist(PlaylistSplitter *s, const QFileInfo &playlistFile, QWidget *parent, const char *name = 0);
49

50 51
    virtual ~Playlist();

52 53 54 55 56 57 58
    /**
     * 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
     * name.  However, by setting autoGenerateFileName, you can tell save to 
     * pick a file name.
     */
    virtual void save(bool autoGenerateFileName = false);
59 60 61
    virtual void saveAs();
    virtual void refresh();
    virtual void clearItems(const PlaylistItemList &items);
62

63 64 65
    /** 
     * All of the (media) files in the list. 
     */
66

67
    QStringList files() const;
68
    /** 
69
     * Returns a list of all of the items in the playlist.
70
     */
71

72
    PlaylistItemList items() const;
73 74 75 76
    
    /**
     * Returns a list of the currently selected items.
     */
77
    PlaylistItemList selectedItems() const;
78 79
    
    /**
80 81
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
82
     */
83
    void remove(const PlaylistItemList &items);
84

85 86 87
    /** 
     * Allow duplicate files in the playlist. 
     */
88 89
    void setAllowDuplicates(bool allow);

90 91
    /** 
     * This is being used as a mini-factory of sorts to make the construction
92 93
     * of PlaylistItems virtual.  In this case it allows for the creation of
     * both PlaylistItems and CollectionListItems.
94 95
     */
    virtual PlaylistItem *createItem(const QFileInfo &file, QListViewItem *after = 0);
96

97 98 99 100
    /**
     * Internal files are files which have not been saved by the user, but rather
     * are stored in JuK's data directory and are restored by session management.
     */
101 102 103 104
    bool isInternalFile() const { return(internalFile); }
    void setInternal(bool internal) { internalFile = internal; }
    QString fileName() const { return(playlistFileName); }
    void setFileName(const QString &n) { playlistFileName = n; }
105 106 107 108 109 110

    /**
     * If playlistName has no value -- i.e. the name has not been set to 
     * something other than the filename, this returns the filename less the
     * extension.  If playlistName does have a value, this returns that.
     */
111
    QString name() const;
112

113 114 115
    /**
     * This sets a name for the playlist that is \e different from the file name.
     */ 
116
    void setName(const QString &n);
117

118 119
    PlaylistBoxItem *playlistBoxItem() const { return(boxItem); }
    void setPlaylistBoxItem(PlaylistBoxItem *item) { boxItem = item; }
120

121
    int count() const { return(childCount()); }
122 123

    /** 
124 125
     * This gets the next item to be played.  This is static because often we 
     * know about the playing item, but not to which list it belongs.
126
     */
127 128
    PlaylistItem *nextItem(PlaylistItem *current, bool random = false);
    PlaylistItem *previousItem(PlaylistItem *current, bool random = false);
129

130 131 132 133 134 135
public slots:
    /**
     * Remove the currently selected items from the playlist and disk.
     */ 
    void removeSelectedItems() { remove(selectedItems()); };

136
protected:
137 138 139
    virtual QDragObject *dragObject();
    virtual void contentsDropEvent(QDropEvent *e);
    virtual void contentsDragMoveEvent(QDragMoveEvent *e);
140
    PlaylistSplitter *playlistSplitter() const { return(splitter); }
141

142
signals:
143 144 145 146
    /** 
     * This signal is connected to PlaylistItem::refreshed() in the 
     * PlaylistItem class. 
     */
147
    void dataChanged();
148 149 150 151 152
    /** 
     * This signal is emitted when items are added to the collection list.  
     * This happens in the createItem() method when items are added to the 
     * collection. 
     */
153
    void collectionChanged();
154

155 156 157 158
    /** 
     * This is emitted when the playlist selection is changed.  This is used
     * primarily to notify the TagEditor of the new data. 
     */
159
    void selectionChanged(const PlaylistItemList &selection);
160 161 162 163 164
    
    /**
     * This is connected to the PlaylistBoxItem to let it know when the 
     * playlist's name has changed.
     */
165
    void nameChanged(const QString &fileName);
166 167
    
    void numberOfItemsChanged(Playlist *);
168 169 170
    
    void doubleClicked();

171 172 173 174 175 176
    /**
     * This signal is emitted just before a playlist item is removed from the 
     * list.
     */
    void aboutToRemove(PlaylistItem *item);

177 178 179 180 181
private:
    void setup();
    QPtrStack<PlaylistItem> history;

private slots:
182 183
    void emitSelected() {  emit(selectionChanged(selectedItems())); }
    void emitDoubleClicked(QListViewItem *) { emit(doubleClicked()); }
184 185 186
    void showRMBMenu(QListViewItem *item, const QPoint &point, int column);
    void applyTags(QListViewItem *item, const QString &text, int column);
    void renameTag();
187 188

private:
189 190 191
    QPopupMenu *rmbMenu;
    int currentColumn;

192
    SortedStringList members;
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
    int processed;
    bool allowDuplicates;

    /**
     * If a file is "internal" it is not one that the user has yet chosen to 
     * save.  However for the purposes of being able to restore a user's 
     * loaded playlists it will be saved "internally" in:
     * $KDEHOME/share/apps/juk/playlists.
     */
    bool internalFile;
    QString playlistFileName;

    /**
     * This is only defined if the playlist name is something other than the
     * file name.
     */
    QString playlistName;
    PlaylistSplitter *splitter;
    PlaylistBoxItem *boxItem;
212 213

    int rmbEditID;
214 215 216
};

#endif