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 6.77 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 43 44 45 46 47
    /** 
     * Before creating a playlist directly, please see 
     * PlaylistSplitter::createPlaylist().
     */
    Playlist(PlaylistSplitter *s, QWidget *parent, const QString &name = QString::null);
    /** 
     * Before creating a playlist directly, please see 
     * PlaylistSplitter::openPlaylist().
     */
    Playlist(PlaylistSplitter *s, const QFileInfo &playlistFile, QWidget *parent, const char *name = 0);
48 49
    virtual ~Playlist();

50 51 52 53 54 55 56
    /**
     * 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);
57 58 59
    virtual void saveAs();
    virtual void refresh();
    virtual void clearItems(const PlaylistItemList &items);
60

61 62 63
    /** 
     * All of the (media) files in the list. 
     */
64
    QStringList files() const;
65
    /** 
66
     * Returns a list of all of the items in the playlist.
67
     */
68
    PlaylistItemList items() const;
69 70 71 72
    
    /**
     * Returns a list of the currently selected items.
     */
73
    PlaylistItemList selectedItems() const;
74 75
    
    /**
76 77
     * Remove \a items from the playlist and disk.  This will ignore items that
     * are not actually in the list.
78
     */
79
    void remove(const PlaylistItemList &items);
80

81 82 83
    /** 
     * Allow duplicate files in the playlist. 
     */
84 85
    void setAllowDuplicates(bool allow);

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

93 94 95 96
    /**
     * 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.
     */
97 98 99 100
    bool isInternalFile() const { return(internalFile); }
    void setInternal(bool internal) { internalFile = internal; }
    QString fileName() const { return(playlistFileName); }
    void setFileName(const QString &n) { playlistFileName = n; }
101 102 103 104 105 106

    /**
     * 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.
     */
107
    QString name() const;
108

109 110 111
    /**
     * This sets a name for the playlist that is \e different from the file name.
     */ 
112
    void setName(const QString &n);
113

114 115
    PlaylistBoxItem *playlistBoxItem() const { return(boxItem); }
    void setPlaylistBoxItem(PlaylistBoxItem *item) { boxItem = item; }
116

117
    int count() const { return(childCount()); }
118 119

    /** 
120 121
     * 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.
122
     */
123 124
    PlaylistItem *nextItem(PlaylistItem *current, bool random = false);
    PlaylistItem *previousItem(PlaylistItem *current, bool random = false);
125

126 127 128 129 130 131
public slots:
    /**
     * Remove the currently selected items from the playlist and disk.
     */ 
    void removeSelectedItems() { remove(selectedItems()); };

132
protected:
133 134 135
    virtual QDragObject *dragObject();
    virtual void contentsDropEvent(QDropEvent *e);
    virtual void contentsDragMoveEvent(QDragMoveEvent *e);
136
    PlaylistSplitter *playlistSplitter() const { return(splitter); }
137

138
signals:
139 140 141 142
    /** 
     * This signal is connected to PlaylistItem::refreshed() in the 
     * PlaylistItem class. 
     */
143
    void dataChanged();
144 145 146 147 148
    /** 
     * 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. 
     */
149
    void collectionChanged();
150

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

167 168 169 170 171 172
    /**
     * This signal is emitted just before a playlist item is removed from the 
     * list.
     */
    void aboutToRemove(PlaylistItem *item);

173 174 175 176 177
private:
    void setup();
    QPtrStack<PlaylistItem> history;

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

private:
185 186 187
    QPopupMenu *rmbMenu;
    int currentColumn;

188
    SortedStringList members;
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
    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;
208 209

    int rmbEditID;
210 211 212
};

#endif