git.sesse.net Git - vlc/blob - 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     /*** QModel subclassing ***/
  60
  61     /* Data structure */
  62     virtual QVariant data( const QModelIndex &index, const int role ) const;
  63     virtual QVariant headerData( int section, Qt::Orientation orientation,
  64                          int role = Qt::DisplayRole ) const;
  65     virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const;
  66     virtual int columnCount( const QModelIndex &parent = QModelIndex() ) const;
  67     virtual Qt::ItemFlags flags( const QModelIndex &index ) const;
  68     virtual QModelIndex index( const int r, const int c, const QModelIndex &parent ) const;
  69     virtual QModelIndex parent( const QModelIndex &index ) const;
  70
  71     /* Drag and Drop */
  72     virtual Qt::DropActions supportedDropActions() const;
  73     virtual QMimeData* mimeData( const QModelIndexList &indexes ) const;
  74     virtual bool dropMimeData( const QMimeData *data, Qt::DropAction action,
  75                       int row, int column, const QModelIndex &target );
  76     virtual QStringList mimeTypes() const;
  77
  78     /**** Custom ****/
  79
  80     /* Lookups */
  81     QStringList selectedURIs();
  82     QModelIndex index( PLItem *, const int c ) const;
  83     QModelIndex index( const int i_id, const int c );
  84     virtual QModelIndex currentIndex() const;
  85     bool isParent( const QModelIndex &index, const QModelIndex &current) const;
  86     bool isCurrent( const QModelIndex &index ) const;
  87     int itemId( const QModelIndex &index ) const;
  88
  89     /* Actions */
  90     virtual bool popup( const QModelIndex & index, const QPoint &point, const QModelIndexList &list );
  91     virtual void doDelete( QModelIndexList selected );
  92     void search( const QString& search_text, const QModelIndex & root, bool b_recursive );
  93     void sort( const int column, Qt::SortOrder order );
  94     void sort( const int i_root_id, const int column, Qt::SortOrder order );
  95     void rebuild( playlist_item_t * p = NULL );
  96
  97     inline PLItem *getItem( QModelIndex index ) const
  98     {
  99         if( index.isValid() )
 100             return static_cast<PLItem*>( index.internalPointer() );
 101         else return rootItem;
 102     }
 103     virtual int getId( QModelIndex index ) const
 104     {
 105         return getItem( index )->id();
 106     }
 107
 108 signals:
 109     void currentChanged( const QModelIndex& );
 110     void rootChanged();
 111
 112 public slots:
 113     virtual void activateItem( const QModelIndex &index );
 114     void activateItem( playlist_item_t *p_item );
 115
 116 private:
 117     /* General */
 118     PLItem *rootItem;
 119
 120     playlist_t *p_playlist;
 121
 122     static QIcon icons[ITEM_TYPE_NUMBER];
 123
 124     /* Shallow actions (do not affect core playlist) */
 125     void updateTreeItem( PLItem * );
 126     void removeItem ( PLItem * );
 127     void removeItem( int );
 128     void recurseDelete( QList<PLItem*> children, QModelIndexList *fullList );
 129     void takeItem( PLItem * ); //will not delete item
 130     void insertChildren( PLItem *node, QList<PLItem*>& items, int i_pos );
 131     /* ...of which  the following will not update the views */
 132     void updateChildren( PLItem * );
 133     void updateChildren( playlist_item_t *, PLItem * );
 134
 135     /* Deep actions (affect core playlist) */
 136     void dropAppendCopy( const PlMimeData * data, PLItem *target, int pos );
 137     void dropMove( const PlMimeData * data, PLItem *target, int new_pos );
 138
 139     /* Popup */
 140     int i_popup_item, i_popup_parent, i_popup_column;
 141     QModelIndexList current_selection;
 142     QMenu *sortingMenu;
 143     QSignalMapper *sortingMapper;
 144
 145     /* Lookups */
 146     PLItem *findById( PLItem *, int ) const;
 147     PLItem *findByInput( PLItem *, int ) const;
 148     PLItem *findInner(PLItem *, int , bool ) const;
 149     bool canEdit() const;
 150
 151     PLItem *p_cached_item;
 152     PLItem *p_cached_item_bi;
 153     int i_cached_id;
 154     int i_cached_input_id;
 155
 156 private slots:
 157     void popupPlay();
 158     void popupDel();
 159     void popupInfo();
 160     void popupStream();
 161     void popupSave();
 162     void popupExplore();
 163     void popupAddNode();
 164     void popupSort( int column );
 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 class PlMimeData : public QMimeData
 172 {
 173     Q_OBJECT
 174
 175 public:
 176     PlMimeData() {}
 177     ~PlMimeData();
 178     void appendItem( input_item_t *p_item );
 179     QList<input_item_t*> inputItems() const;
 180     QStringList formats () const;
 181
 182 private:
 183     QList<input_item_t*> _inputItems;
 184     QMimeData *_mimeData;
 185 };
 186
 187 #endif