missing from [24525]
[vlc.git] / modules / gui / qt4 / components / playlist / 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 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc/vlc.h>
32 #include <vlc_input.h>
33 #include <vlc_playlist.h>
34
35 #include <QModelIndex>
36 #include <QObject>
37 #include <QEvent>
38 #include <QMimeData>
39 #include <QSignalMapper>
40
41 class PLModel;
42 class QSignalMapper;
43
44 class PLItem
45 {
46     friend class PLModel;
47 public:
48     PLItem( int, int, PLItem *parent , PLModel * );
49     PLItem( playlist_item_t *, PLItem *parent, PLModel * );
50     ~PLItem();
51
52     int row() const;
53     void insertChild( PLItem *, int p, bool signal = true );
54
55     void appendChild( PLItem *item, bool signal = true )
56     {
57         insertChild( item, children.count(), signal );
58     };
59     void remove( PLItem *removed );
60
61     PLItem *child( int row ) { return children.value( row ); };
62     int childCount() const { return children.count(); };
63     QString columnString( int col ) { return item_col_strings.value( col ); };
64     PLItem *parent() { return parentItem; };
65
66     void update( playlist_item_t *, bool );
67 protected:
68     QList<PLItem*> children;
69     QList<QString> item_col_strings;
70     bool b_current;
71     int i_type;
72     int i_id;
73     int i_input_id;
74     int i_showflags;
75
76     void updateview();
77 private:
78     void init( int, int, PLItem *, PLModel * );
79     PLItem *parentItem;
80     PLModel *model;
81 };
82
83 static int ItemUpdate_Type = QEvent::User + 2;
84 static int ItemDelete_Type = QEvent::User + 3;
85 static int ItemAppend_Type = QEvent::User + 4;
86 static int PLUpdate_Type = QEvent::User + 5;
87
88 class PLEvent : public QEvent
89 {
90 public:
91     PLEvent( int type, int id ) : QEvent( (QEvent::Type)(type) )
92     { i_id = id; p_add = NULL; };
93     PLEvent(  playlist_add_t  *a ) : QEvent( (QEvent::Type)(ItemAppend_Type) )
94     { p_add = a; };
95     virtual ~PLEvent() {};
96
97     int i_id;
98     playlist_add_t *p_add;
99 };
100
101 #include <QAbstractItemModel>
102 #include <QVariant>
103
104 class PLModel : public QAbstractItemModel
105 {
106     Q_OBJECT
107
108 friend class PLItem;
109
110 public:
111     PLModel( playlist_t *, intf_thread_t *,
112              playlist_item_t *, int, QObject *parent = 0 );
113     ~PLModel();
114
115     /* All types of lookups / QModel stuff */
116     QVariant data( const QModelIndex &index, int role ) const;
117     Qt::ItemFlags flags( const QModelIndex &index ) const;
118     QVariant headerData( int section, Qt::Orientation orientation,
119                          int role = Qt::DisplayRole ) const;
120     QModelIndex index( int r, int c, const QModelIndex &parent ) const;
121     QModelIndex index( PLItem *, int c ) const;
122     int itemId( const QModelIndex &index ) const;
123     bool isCurrent( const QModelIndex &index );
124     QModelIndex parent( const QModelIndex &index ) const;
125     int childrenCount( const QModelIndex &parent = QModelIndex() ) const;
126     int rowCount( const QModelIndex &parent = QModelIndex() ) const;
127     int columnCount( const QModelIndex &parent = QModelIndex() ) const;
128
129     bool b_need_update;
130     int i_items_to_append;
131
132     void rebuild(); void rebuild( playlist_item_t * );
133     bool hasRandom(); bool hasLoop(); bool hasRepeat();
134
135     /* Actions made by the views */
136     void popup( QModelIndex & index, QPoint &point, QModelIndexList list );
137     void doDelete( QModelIndexList selected );
138     void search( QString search );
139     void sort( int column, Qt::SortOrder order );
140     void removeItem( int );
141
142     /* DnD handling */
143     Qt::DropActions supportedDropActions() const;
144     QMimeData* mimeData( const QModelIndexList &indexes ) const;
145     bool dropMimeData( const QMimeData *data, Qt::DropAction action,
146                       int row, int column, const QModelIndex &target );
147     QStringList mimeTypes() const;
148
149     int shownFlags() {  return rootItem->i_showflags;  }
150 private:
151     void addCallbacks();
152     void delCallbacks();
153     void customEvent( QEvent * );
154
155     PLItem *rootItem;
156
157     playlist_t *p_playlist;
158     intf_thread_t *p_intf;
159     int i_depth;
160
161     static QIcon icons[ITEM_TYPE_NUMBER];
162
163     /* Update processing */
164     void ProcessInputItemUpdate( int i_input_id );
165     void ProcessItemRemoval( int i_id );
166     void ProcessItemAppend( playlist_add_t *p_add );
167
168     void UpdateTreeItem( PLItem *, bool, bool force = false );
169     void UpdateTreeItem( playlist_item_t *, PLItem *, bool, bool forc = false );
170     void UpdateNodeChildren( PLItem * );
171     void UpdateNodeChildren( playlist_item_t *, PLItem * );
172
173     /* Actions */
174     void recurseDelete( QList<PLItem*> children, QModelIndexList *fullList );
175     void doDeleteItem( PLItem *item, QModelIndexList *fullList );
176
177     /* Popup */
178     int i_popup_item, i_popup_parent;
179     QModelIndexList current_selection;
180     QSignalMapper *ContextUpdateMapper;
181
182     /* Lookups */
183     PLItem *FindById( PLItem *, int );
184     PLItem *FindByInput( PLItem *, int );
185     PLItem *FindInner( PLItem *, int , bool );
186     PLItem *p_cached_item;
187     PLItem *p_cached_item_bi;
188     int i_cached_id;
189     int i_cached_input_id;
190 signals:
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 #ifdef WIN32
205     void popupExplore();
206 #endif
207     void viewchanged( int );
208 };
209
210 #endif