]> git.sesse.net Git - vlc/blob - modules/gui/qt4/components/playlist/playlist_model.hpp
Qt: make PLModel::getItem return rootItem as well, add id getter to PLItem
[vlc] / 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  *          Jakob Leben <jleben@videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #ifndef _PLAYLIST_MODEL_H_
26 #define _PLAYLIST_MODEL_H_
27
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include "qt4.hpp"
33
34 #include <vlc_input.h>
35 #include <vlc_playlist.h>
36
37 #include "playlist_item.hpp"
38
39 #include <QModelIndex>
40 #include <QObject>
41 #include <QEvent>
42 #include <QMimeData>
43 #include <QSignalMapper>
44 #include <QAbstractItemModel>
45 #include <QVariant>
46
47 class QSignalMapper;
48 class PLItem;
49
50 class PLModel : public QAbstractItemModel
51 {
52     Q_OBJECT
53
54 friend class PLItem;
55
56 public:
57     PLModel( playlist_t *, intf_thread_t *,
58              playlist_item_t *, QObject *parent = 0 );
59     ~PLModel();
60
61     /*** QModel subclassing ***/
62
63     /* Data structure */
64     QVariant data( const QModelIndex &index, int role ) const;
65     QVariant headerData( int section, Qt::Orientation orientation,
66                          int role = Qt::DisplayRole ) const;
67     int rowCount( const QModelIndex &parent = QModelIndex() ) const;
68     int columnCount( const QModelIndex &parent = QModelIndex() ) const;
69     Qt::ItemFlags flags( const QModelIndex &index ) const;
70     QModelIndex index( int r, int c, const QModelIndex &parent ) const;
71     QModelIndex parent( const QModelIndex &index ) const;
72
73     /* Drag and Drop */
74     Qt::DropActions supportedDropActions() const;
75     QMimeData* mimeData( const QModelIndexList &indexes ) const;
76     bool dropMimeData( const QMimeData *data, Qt::DropAction action,
77                       int row, int column, const QModelIndex &target );
78     QStringList mimeTypes() const;
79
80     /**** Custom ****/
81
82     /* Lookups */
83     QStringList selectedURIs();
84     QModelIndex index( PLItem *, int c ) const;
85     QModelIndex index( int i_id, int c );
86     QModelIndex currentIndex( ) { return index( currentItem, 0 ); };
87     bool isCurrent( const QModelIndex &index ) const;
88     int itemId( const QModelIndex &index ) const;
89
90     /* Actions */
91     void popup( const QModelIndex & index, const QPoint &point, const QModelIndexList &list );
92     void doDelete( QModelIndexList selected );
93     void search( const QString& search_text );
94     void sort( int column, Qt::SortOrder order );
95     void sort( int i_root_id, int column, Qt::SortOrder order );
96     void removeItem( int );
97     void rebuild(); void rebuild( playlist_item_t *, bool b_first = false );
98
99     inline PLItem *getItem( QModelIndex index ) const
100     {
101         if( index.isValid() )
102             return static_cast<PLItem*>( index.internalPointer() );
103         else return rootItem;
104     }
105
106 private:
107
108     /* General */
109     PLItem *rootItem;
110     PLItem *currentItem;
111
112     playlist_t *p_playlist;
113     intf_thread_t *p_intf;
114     int i_depth;
115
116     static QIcon icons[ITEM_TYPE_NUMBER];
117
118     /* Actions */
119     void recurseDelete( QList<PLItem*> children, QModelIndexList *fullList );
120     void doDeleteItem( PLItem *item, QModelIndexList *fullList );
121     void updateTreeItem( PLItem * );
122     void removeItem ( PLItem * );
123     void takeItem( PLItem * ); //will not delete item
124     void insertChildren( PLItem *node, QList<PLItem*>& items, int i_pos );
125     void dropAppendCopy( QByteArray& data, PLItem *target );
126     void dropMove( QByteArray& data, PLItem *target, int new_pos );
127     /* The following actions will not signal the view! */
128     void updateChildren( PLItem * );
129     void updateChildren( playlist_item_t *, PLItem * );
130
131     /* Popup */
132     int i_popup_item, i_popup_parent, i_popup_column;
133     QModelIndexList current_selection;
134
135     /* Lookups */
136     PLItem *findById( PLItem *, int );
137     PLItem *findByInput( PLItem *, int );
138     PLItem *findInner( PLItem *, int , bool );
139
140     int columnFromMeta( int meta_column ) const;
141     int columnToMeta( int column ) const;
142     bool canEdit() const;
143     PLItem *p_cached_item;
144     PLItem *p_cached_item_bi;
145     int i_cached_id;
146     int i_cached_input_id;
147
148 signals:
149     void currentChanged( const QModelIndex& );
150
151 public slots:
152     void activateItem( const QModelIndex &index );
153     void activateItem( playlist_item_t *p_item );
154
155 private slots:
156     void popupPlay();
157     void popupDel();
158     void popupInfo();
159     void popupStream();
160     void popupSave();
161     void popupExplore();
162     void popupAddNode();
163     void popupSortAsc();
164     void popupSortDesc();
165     void processInputItemUpdate( input_item_t *);
166     void processInputItemUpdate( input_thread_t* p_input );
167     void processItemRemoval( int i_id );
168     void processItemAppend( int item, int parent );
169 };
170
171 #endif