Qt4 - Right click on the header on the QTreeView for the playlist enables you to...
[vlc.git] / modules / gui / qt4 / playlist_model.hpp
1 /*****************************************************************************
2  * playlist_model.hpp : Model for a playlist tree
3  ****************************************************************************
4  * Copyright (C) 2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifndef _PLAYLIST_MODEL_H_
25 #define _PLAYLIST_MODEL_H_
26
27 #include <vlc/vlc.h>
28 #include <vlc_input.h>
29 #include <vlc_playlist.h>
30
31 #include <QModelIndex>
32 #include <QObject>
33 #include <QEvent>
34 #include <QMimeData>
35 #include <QSignalMapper>
36
37 class PLModel;
38 class QSignalMapper;
39
40 class PLItem
41 {
42 public:
43     PLItem( int, int, PLItem *parent , PLModel *);
44     PLItem( playlist_item_t *, PLItem *parent, PLModel *);
45     ~PLItem();
46
47     int row() const;
48     void insertChild( PLItem *, int p, bool signal = true );
49
50     void appendChild( PLItem *item, bool signal = true )
51     {
52         insertChild( item, children.count(), signal );
53     };
54     void remove( PLItem *removed );
55     PLItem *child( int row ) { return children.value( row ); };
56     int childCount() const { return children.count(); };
57     QString columnString( int col ) { return strings.value( col ); };
58     PLItem *parent() { return parentItem; };
59
60     void update( playlist_item_t *, bool);
61 protected:
62     QList<PLItem*> children;
63     QList<QString> strings;
64     bool current;
65     int type;
66     int i_id;
67     int i_input_id;
68     int i_showflags;
69     
70     void updateview( void );
71     friend class PLModel;
72 private:
73     void init( int, int, PLItem *, PLModel * );
74     PLItem *parentItem;
75     PLModel *model;
76 };
77
78 static int ItemUpdate_Type = QEvent::User + 2;
79 static int ItemDelete_Type = QEvent::User + 3;
80 static int ItemAppend_Type = QEvent::User + 4;
81 static int PLUpdate_Type = QEvent::User + 5;
82
83 class PLEvent : public QEvent
84 {
85 public:
86     PLEvent( int type, int id ) : QEvent( (QEvent::Type)(type) )
87     { i_id = id; p_add = NULL; };
88     PLEvent(  playlist_add_t  *a ) : QEvent( (QEvent::Type)(ItemAppend_Type) )
89     { p_add = a; };
90     virtual ~PLEvent() {};
91
92     int i_id;
93     playlist_add_t *p_add;
94 };
95
96 #include <QAbstractItemModel>
97 #include <QVariant>
98
99 class PLModel : public QAbstractItemModel
100 {
101     Q_OBJECT
102
103 public:
104     PLModel( playlist_t *, intf_thread_t *,
105              playlist_item_t *, int, QObject *parent = 0);
106     ~PLModel();
107
108     /* All types of lookups / QModel stuff */
109     QVariant data( const QModelIndex &index, int role) const;
110     Qt::ItemFlags flags( const QModelIndex &index) const;
111     QVariant headerData( int section, Qt::Orientation orientation,
112                          int role = Qt::DisplayRole) const;
113     QModelIndex index( int r, int c, const QModelIndex &parent ) const;
114     QModelIndex index( PLItem *, int c ) const;
115     int itemId( const QModelIndex &index ) const;
116     bool isCurrent( const QModelIndex &index );
117     QModelIndex parent( const QModelIndex &index) const;
118     int childrenCount( const QModelIndex &parent = QModelIndex() ) const;
119     int rowCount( const QModelIndex &parent = QModelIndex() ) const;
120     int columnCount( const QModelIndex &parent = QModelIndex() ) const;
121
122     bool b_need_update;
123     int i_items_to_append;
124    
125     void rebuild(); void rebuild( playlist_item_t *);
126     bool hasRandom(); bool hasLoop(); bool hasRepeat();
127
128     /* Actions made by the views */
129     void popup( QModelIndex & index, QPoint &point, QModelIndexList list );
130     void doDelete( QModelIndexList selected );
131     void search( QString search );
132     void sort( int column, Qt::SortOrder order );
133     void removeItem( int );
134
135     /* DnD handling */
136     Qt::DropActions supportedDropActions() const;
137     QMimeData* mimeData(const QModelIndexList &indexes) const;
138     bool dropMimeData(const QMimeData *data, Qt::DropAction action,
139                       int row, int column, const QModelIndex &target);
140     QStringList mimeTypes() const;
141
142     void sendArt( QString url );
143     void removeArt( );
144     
145     int shownFlags()
146     {
147         return rootItem->i_showflags;
148     }
149 private:
150     void addCallbacks();
151     void delCallbacks();
152     void customEvent( QEvent * );
153
154     PLItem *rootItem;
155
156     playlist_t *p_playlist;
157     intf_thread_t *p_intf;
158     int i_depth;
159
160     static QIcon icons[ITEM_TYPE_NUMBER];
161
162     /* Update processing */
163     void ProcessInputItemUpdate( int i_input_id );
164     void ProcessItemRemoval( int i_id );
165     void ProcessItemAppend( playlist_add_t *p_add );
166
167     void UpdateTreeItem( PLItem *, bool, bool force = false );
168     void UpdateTreeItem( playlist_item_t *, PLItem *, bool, bool forc = false );
169     void UpdateNodeChildren( PLItem * );
170     void UpdateNodeChildren( playlist_item_t *, PLItem * );
171
172     /* Actions */
173     void recurseDelete( QList<PLItem*> children, QModelIndexList *fullList);
174     void doDeleteItem( PLItem *item, QModelIndexList *fullList );
175
176     /* Popup */
177     int i_popup_item, i_popup_parent;
178     QModelIndexList current_selection;
179     QSignalMapper *ContextUpdateMapper;
180
181     /* Lookups */
182     PLItem *FindById( PLItem *, int );
183     PLItem *FindByInput( PLItem *, int );
184     PLItem *FindInner( PLItem *, int , bool );
185     PLItem *p_cached_item;
186     PLItem *p_cached_item_bi;
187     int i_cached_id;
188     int i_cached_input_id;
189 signals:
190     void artSet( QString );
191     void shouldRemove( int );
192 public slots:
193     void activateItem( const QModelIndex &index );
194     void activateItem( playlist_item_t *p_item );
195     void setRandom( bool );
196     void setLoop( bool );
197     void setRepeat( bool );
198 private slots:
199     void popupPlay();
200     void popupDel();
201     void popupInfo();
202     void popupStream();
203     void popupSave();
204     void viewchanged( int );
205 friend class PLItem;
206 };
207
208 #endif