Playlist model
[vlc.git] / modules / gui / qt4 / playlist_model.hpp
1 /*****************************************************************************
2  * playlist_model.hpp : Model for a playlist tree
3  ****************************************************************************
4  * Copyright (C) 2000-2005 the VideoLAN team
5  * $Id: wxwidgets.cpp 15731 2006-05-25 14:43:53Z zorglub $
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 <QObject>
28 #include <QEvent>
29 #include <vlc/vlc.h>
30 #include <vlc/input.h>
31 #include <vlc_playlist.h>
32
33 class PLModel;
34
35 class PLItem
36 {
37 public:
38     PLItem( int, int, PLItem *parent , PLModel *);
39     PLItem( playlist_item_t *, PLItem *parent, PLModel *);
40     ~PLItem();
41
42     int row() const;
43     void insertChild( PLItem *, int );
44
45     void appendChild( PLItem *item ) { insertChild( item, children.count() ); };
46     PLItem *child( int row ) { return children.value( row ); };
47     int childCount() const { return children.count(); };
48     QString columnString( int col ) { return strings.value( col ); };
49     PLItem *parent() { return parentItem; };
50 protected:
51     QList<PLItem*> children;
52     int i_id;
53     int i_input_id;
54     friend class PLModel;
55 private:
56     QList<QString> strings;
57     PLItem *parentItem;
58
59     PLModel *model;
60 };
61
62 static int ItemUpdate_Type = QEvent::User + 2;
63 static int ItemDelete_Type = QEvent::User + 3;
64 static int ItemAppend_Type = QEvent::User + 4;
65
66 class PLEvent : public QEvent
67 {
68 public:
69     PLEvent( int type, int id ) : QEvent( (QEvent::Type)(type) )
70     { i_id = id; p_add = NULL; };
71     PLEvent(  playlist_add_t  *a ) : QEvent( (QEvent::Type)(ItemAppend_Type) )
72     { p_add = a; };
73     virtual ~PLEvent() {};
74                           
75     int i_id;
76     playlist_add_t *p_add;
77 };   
78                     
79
80 #include <QAbstractItemModel>
81 #include <QModelIndex>
82 #include <QVariant>
83
84 class PLModel : public QAbstractItemModel
85 {
86     Q_OBJECT
87
88 public:
89     PLModel( playlist_item_t *, int, QObject *parent = 0);
90     ~PLModel();
91
92     void customEvent( QEvent * );
93
94     /* QModel stuff */
95     QVariant data( const QModelIndex &index, int role) const;
96     Qt::ItemFlags flags( const QModelIndex &index) const;
97     QVariant headerData( int section, Qt::Orientation orientation,
98                          int role = Qt::DisplayRole) const;
99     
100     QModelIndex index( int r, int c, const QModelIndex &parent ) const;
101     QModelIndex index( PLItem *, int c ) const;
102                     
103     QModelIndex parent( const QModelIndex &index) const;
104     int childrenCount( const QModelIndex &parent = QModelIndex() ) const;
105
106     bool b_need_update;
107     int i_items_to_append;
108 private:
109     PLItem *rootItem;
110
111     playlist_t *p_playlist;
112
113     /* Update processing */
114     void ProcessInputItemUpdate( int i_input_id );
115     void ProcessItemRemoval( int i_id );
116     void ProcessItemAppend( playlist_add_t *p_add );
117             
118     /* Lookups */
119     PLItem *FindById( PLItem *, int );
120     PLItem *FindByInput( PLItem *, int );
121     PLItem *FindInner( PLItem *, int , bool );
122     PLItem *p_cached_item;
123     PLItem *p_cached_item_bi;
124     int i_cached_id;
125     int i_cached_input_id;
126
127 friend class PLItem;
128 };
129
130 #endif