modules/gui/qt4/components/playlist/playlist_model.hpp

   1 /*****************************************************************************
   2  * playlist_model.hpp : Model for a playlist tree
   3  ****************************************************************************
   4  * Copyright (C) 2006-2011 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 <vlc_input.h>
  33 #include <vlc_playlist.h>
  34 #include "vlc_model.hpp"
  35 #include "playlist_item.hpp"
  36
  37 #include <QObject>
  38 #include <QEvent>
  39 #include <QSignalMapper>
  40 #include <QMimeData>
  41 #include <QAbstractItemModel>
  42 #include <QVariant>
  43 #include <QModelIndex>
  44
  45 class PLItem;
  46 class PLSelector;
  47 class PlMimeData;
  48 class QSignalMapper;
  49
  50 class PLModel : public VLCModel
  51 {
  52     Q_OBJECT
  53
  54 public:
  55     PLModel( playlist_t *, intf_thread_t *,
  56              playlist_item_t *, QObject *parent = 0 );
  57     virtual ~PLModel();
  58
  59     /* Qt4 main PLModel */
  60     static PLModel* getPLModel( intf_thread_t *p_intf )
  61     {
  62         if(!p_intf->p_sys->pl_model )
  63         {
  64             playlist_Lock( THEPL );
  65             playlist_item_t *p_root = THEPL->p_playing;
  66             playlist_Unlock( THEPL );
  67             p_intf->p_sys->pl_model = new PLModel( THEPL, p_intf, p_root, NULL );
  68         }
  69
  70         return p_intf->p_sys->pl_model;
  71     }
  72
  73     /*** QAbstractItemModel subclassing ***/
  74
  75     /* Data structure */
  76     virtual QVariant data( const QModelIndex &index, const int role ) const;
  77     virtual QVariant headerData( int section, Qt::Orientation orientation,
  78                          int role = Qt::DisplayRole ) const;
  79     virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const;
  80     virtual int columnCount( const QModelIndex &parent = QModelIndex() ) const;
  81     virtual Qt::ItemFlags flags( const QModelIndex &index ) const;
  82     virtual QModelIndex index( const int r, const int c, const QModelIndex &parent ) const;
  83     virtual QModelIndex parent( const QModelIndex &index ) const;
  84
  85     /* Drag and Drop */
  86     virtual Qt::DropActions supportedDropActions() const;
  87     virtual QMimeData* mimeData( const QModelIndexList &indexes ) const;
  88     virtual bool dropMimeData( const QMimeData *data, Qt::DropAction action,
  89                       int row, int column, const QModelIndex &target );
  90     virtual QStringList mimeTypes() const;
  91
  92     /* Sort */
  93     virtual void sort( const int column, Qt::SortOrder order = Qt::AscendingOrder );
  94
  95     /**** Custom ****/
  96
  97     /* Lookups */
  98     QModelIndex index( const int i_id, const int c );
  99     virtual QModelIndex currentIndex() const;
 100     int itemId( const QModelIndex &index ) const;
 101
 102     /* */
 103     void search( const QString& search_text, const QModelIndex & root, bool b_recursive );
 104     void rebuild( playlist_item_t * p = NULL );
 105
 106     /* Popup Actions */
 107     virtual bool popup( const QModelIndex & index, const QPoint &point, const QModelIndexList &list );
 108     virtual void doDelete( QModelIndexList selected );
 109
 110     PLItem *getItem( const QModelIndex & index ) const
 111     {
 112         if( index.isValid() )
 113             return static_cast<PLItem*>( index.internalPointer() );
 114         else return rootItem;
 115     }
 116
 117 signals:
 118     void currentIndexChanged( const QModelIndex& );
 119     void rootIndexChanged();
 120
 121 public slots:
 122     virtual void activateItem( const QModelIndex &index );
 123
 124 private:
 125     /* General */
 126     PLItem *rootItem;
 127
 128     playlist_t *p_playlist;
 129
 130     static QIcon icons[ITEM_TYPE_NUMBER];
 131
 132     /* Custom model private methods */
 133     /* Lookups */
 134     QStringList selectedURIs();
 135     QModelIndex index( PLItem *, const int c ) const;
 136     bool isCurrent( const QModelIndex &index ) const;
 137     bool isParent( const QModelIndex &index, const QModelIndex &current) const;
 138
 139     /* Shallow actions (do not affect core playlist) */
 140     void updateTreeItem( PLItem * );
 141     void removeItem ( PLItem * );
 142     void removeItem( int );
 143     void recurseDelete( QList<PLItem*> children, QModelIndexList *fullList );
 144     void takeItem( PLItem * ); //will not delete item
 145     void insertChildren( PLItem *node, QList<PLItem*>& items, int i_pos );
 146     /* ...of which  the following will not update the views */
 147     void updateChildren( PLItem * );
 148     void updateChildren( playlist_item_t *, PLItem * );
 149
 150     /* Deep actions (affect core playlist) */
 151     void dropAppendCopy( const PlMimeData * data, PLItem *target, int pos );
 152     void dropMove( const PlMimeData * data, PLItem *target, int new_pos );
 153
 154     /* */
 155     void sort( const int i_root_id, const int column, Qt::SortOrder order );
 156
 157     /* Popup */
 158     int i_popup_item, i_popup_parent;
 159     QModelIndexList current_selection;
 160     QMenu *sortingMenu;
 161     QSignalMapper *sortingMapper;
 162
 163     /* Lookups */
 164     PLItem *findById( PLItem *, int ) const;
 165     PLItem *findByInput( PLItem *, int ) const;
 166     PLItem *findInner(PLItem *, int , bool ) const;
 167     bool canEdit() const;
 168
 169     PLItem *p_cached_item;
 170     PLItem *p_cached_item_bi;
 171     int i_cached_id;
 172     int i_cached_input_id;
 173
 174     /* Zoom factor for font-size */
 175     int i_zoom;
 176
 177     /* */
 178     QString latestSearch;
 179
 180 private slots:
 181     void popupPlay();
 182     void popupDel();
 183     void popupInfo();
 184     void popupStream();
 185     void popupSave();
 186     void popupExplore();
 187     void popupAddNode();
 188     void popupAddToPlaylist();
 189     void popupSort( int column );
 190     void processInputItemUpdate( input_item_t *);
 191     void processInputItemUpdate( input_thread_t* p_input );
 192     void processItemRemoval( int i_id );
 193     void processItemAppend( int item, int parent );
 194     void activateItem( playlist_item_t *p_item );
 195     void increaseZoom();
 196     void decreaseZoom();
 197 };
 198
 199 class PlMimeData : public QMimeData
 200 {
 201     Q_OBJECT
 202
 203 public:
 204     PlMimeData() {}
 205     ~PlMimeData();
 206     void appendItem( input_item_t *p_item );
 207     QList<input_item_t*> inputItems() const;
 208     QStringList formats () const;
 209
 210 private:
 211     QList<input_item_t*> _inputItems;
 212     QMimeData *_mimeData;
 213 };
 214
 215 #endif