git.sesse.net Git - vlc/blob - modules/gui/qt4/components/playlist/standardpanel.cpp

   1 /*****************************************************************************
   2  * standardpanel.cpp : The "standard" playlist panel : just a treeview
   3  ****************************************************************************
   4  * Copyright (C) 2000-2009 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          JB Kempf <jb@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 #ifdef HAVE_CONFIG_H
  26 # include "config.h"
  27 #endif
  28
  29 #include "dialogs_provider.hpp"
  30
  31 #include "components/playlist/playlist_model.hpp"
  32 #include "components/playlist/standardpanel.hpp"
  33 #include "components/playlist/icon_view.hpp"
  34 #include "util/customwidgets.hpp"
  35 #include "menus.hpp"
  36
  37 #include <vlc_intf_strings.h>
  38
  39 #include <QPushButton>
  40 #include <QHeaderView>
  41 #include <QKeyEvent>
  42 #include <QModelIndexList>
  43 #include <QLabel>
  44 #include <QMenu>
  45 #include <QSignalMapper>
  46 #include <QWheelEvent>
  47 #include <QToolButton>
  48 #include <QFontMetrics>
  49 #include <QPainter>
  50
  51 #include <assert.h>
  52
  53 #include "sorting.h"
  54
  55 static const QString viewNames[] = { qtr( "Detailed View" ),
  56                                      qtr( "Icon View" ),
  57                                      qtr( "List View" ) };
  58
  59 StandardPLPanel::StandardPLPanel( PlaylistWidget *_parent,
  60                                   intf_thread_t *_p_intf,
  61                                   playlist_t *p_playlist,
  62                                   playlist_item_t *p_root ):
  63                                   QWidget( _parent ), p_intf( _p_intf )
  64 {
  65     layout = new QGridLayout( this );
  66     layout->setSpacing( 0 ); layout->setMargin( 0 );
  67     setMinimumWidth( 300 );
  68
  69     iconView = NULL;
  70     treeView = NULL;
  71     listView = NULL;
  72
  73     model = new PLModel( p_playlist, p_intf, p_root, this );
  74     currentRootId = -1;
  75     currentRootIndexId = -1;
  76     lastActivatedId = -1;
  77
  78     locationBar = new LocationBar( model );
  79     locationBar->setSizePolicy( QSizePolicy::Ignored, QSizePolicy::Preferred );
  80     layout->addWidget( locationBar, 0, 0 );
  81     layout->setColumnStretch( 0, 5 );
  82     CONNECT( locationBar, invoked( const QModelIndex & ),
  83              this, browseInto( const QModelIndex & ) );
  84
  85     searchEdit = new SearchLineEdit( this );
  86     searchEdit->setMaximumWidth( 250 );
  87     searchEdit->setMinimumWidth( 80 );
  88     layout->addWidget( searchEdit, 0, 2 );
  89     CONNECT( searchEdit, textChanged( const QString& ),
  90              this, search( const QString& ) );
  91     layout->setColumnStretch( 2, 3 );
  92
  93     /* Button to switch views */
  94     QToolButton *viewButton = new QToolButton( this );
  95     viewButton->setIcon( style()->standardIcon( QStyle::SP_FileDialogDetailedView ) );
  96     layout->addWidget( viewButton, 0, 1 );
  97
  98     /* View selection menu */
  99     viewSelectionMapper = new QSignalMapper( this );
 100     CONNECT( viewSelectionMapper, mapped( int ), this, showView( int ) );
 101
 102     QActionGroup *actionGroup = new QActionGroup( this );
 103
 104     for( int i = 0; i < VIEW_COUNT; i++ )
 105     {
 106         viewActions[i] = actionGroup->addAction( viewNames[i] );
 107         viewActions[i]->setCheckable( true );
 108         viewSelectionMapper->setMapping( viewActions[i], i );
 109         CONNECT( viewActions[i], triggered(), viewSelectionMapper, map() );
 110     }
 111
 112     BUTTONACT( viewButton, cycleViews() );
 113     QMenu *viewMenu = new QMenu( this );
 114     viewMenu->addActions( actionGroup->actions() );
 115
 116     viewButton->setMenu( viewMenu );
 117
 118     /* Saved Settings */
 119     getSettings()->beginGroup("Playlist");
 120
 121     int i_viewMode = getSettings()->value( "view-mode", TREE_VIEW ).toInt();
 122     showView( i_viewMode );
 123
 124     getSettings()->endGroup();
 125
 126     CONNECT( THEMIM, leafBecameParent( input_item_t *),
 127              this, browseInto( input_item_t * ) );
 128
 129     CONNECT( model, currentChanged( const QModelIndex& ),
 130              this, handleExpansion( const QModelIndex& ) );
 131     CONNECT( model, rootChanged(), this, handleRootChange() );
 132 }
 133
 134 StandardPLPanel::~StandardPLPanel()
 135 {
 136     getSettings()->beginGroup("Playlist");
 137     if( treeView )
 138         getSettings()->setValue( "headerStateV2", treeView->header()->saveState() );
 139     if( currentView == treeView )
 140         getSettings()->setValue( "view-mode", TREE_VIEW );
 141     else if( currentView == listView )
 142         getSettings()->setValue( "view-mode", LIST_VIEW );
 143     else if( currentView == iconView )
 144         getSettings()->setValue( "view-mode", ICON_VIEW );
 145     getSettings()->endGroup();
 146 }
 147
 148 /* Unused anymore, but might be useful, like in right-click menu */
 149 void StandardPLPanel::gotoPlayingItem()
 150 {
 151     currentView->scrollTo( model->currentIndex() );
 152 }
 153
 154 void StandardPLPanel::handleExpansion( const QModelIndex& index )
 155 {
 156     assert( currentView );
 157     currentView->scrollTo( index );
 158 }
 159
 160 void StandardPLPanel::handleRootChange()
 161 {
 162     browseInto();
 163 }
 164
 165 void StandardPLPanel::popupPlView( const QPoint &point )
 166 {
 167     QModelIndex index = currentView->indexAt( point );
 168     QPoint globalPoint = currentView->viewport()->mapToGlobal( point );
 169     QItemSelectionModel *selection = currentView->selectionModel();
 170     QModelIndexList list = selection->selectedIndexes();
 171
 172     if( !model->popup( index, globalPoint, list ) )
 173         QVLCMenu::PopupMenu( p_intf, true );
 174 }
 175
 176 void StandardPLPanel::popupSelectColumn( QPoint pos )
 177 {
 178     QMenu menu;
 179     assert( treeView );
 180
 181     /* We do not offer the option to hide index 0 column, or
 182     * QTreeView will behave weird */
 183     int i, j;
 184     for( i = 1 << 1, j = 1; i < COLUMN_END; i <<= 1, j++ )
 185     {
 186         QAction* option = menu.addAction(
 187             qfu( psz_column_title( i ) ) );
 188         option->setCheckable( true );
 189         option->setChecked( !treeView->isColumnHidden( j ) );
 190         selectColumnsSigMapper->setMapping( option, j );
 191         CONNECT( option, triggered(), selectColumnsSigMapper, map() );
 192     }
 193     menu.exec( QCursor::pos() );
 194 }
 195
 196 void StandardPLPanel::toggleColumnShown( int i )
 197 {
 198     treeView->setColumnHidden( i, !treeView->isColumnHidden( i ) );
 199 }
 200
 201 /* Search in the playlist */
 202 void StandardPLPanel::search( const QString& searchText )
 203 {
 204     bool flat = currentView == iconView || currentView == listView;
 205     model->search( searchText,
 206                    flat ? currentView->rootIndex() : QModelIndex(),
 207                    !flat );
 208 }
 209
 210 /* Set the root of the new Playlist */
 211 /* This activated by the selector selection */
 212 void StandardPLPanel::setRoot( playlist_item_t *p_item )
 213 {
 214     model->rebuild( p_item );
 215 }
 216
 217 void StandardPLPanel::browseInto( const QModelIndex &index )
 218 {
 219     if( currentView == iconView || currentView == listView )
 220     {
 221         currentRootIndexId = model->itemId( index );;
 222         currentView->setRootIndex( index );
 223     }
 224
 225     locationBar->setIndex( index );
 226     model->search( QString(), index, false );
 227     searchEdit->clear();
 228 }
 229
 230 void StandardPLPanel::browseInto( )
 231 {
 232     browseInto( currentRootIndexId != -1 && currentView != treeView ?
 233                 model->index( currentRootIndexId, 0 ) :
 234                 QModelIndex() );
 235 }
 236
 237 void StandardPLPanel::wheelEvent( QWheelEvent *e )
 238 {
 239     // Accept this event in order to prevent unwanted volume up/down changes
 240     e->accept();
 241 }
 242
 243 bool StandardPLPanel::eventFilter ( QObject * watched, QEvent * event )
 244 {
 245     if (event->type() == QEvent::KeyPress)
 246     {
 247         QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
 248         if( keyEvent->key() == Qt::Key_Delete ||
 249             keyEvent->key() == Qt::Key_Backspace )
 250         {
 251             deleteSelection();
 252             return true;
 253         }
 254     }
 255     return false;
 256 }
 257
 258 void StandardPLPanel::deleteSelection()
 259 {
 260     QItemSelectionModel *selection = currentView->selectionModel();
 261     QModelIndexList list = selection->selectedIndexes();
 262     model->doDelete( list );
 263 }
 264
 265 void StandardPLPanel::createIconView()
 266 {
 267     iconView = new PlIconView( model, this );
 268     iconView->setContextMenuPolicy( Qt::CustomContextMenu );
 269     CONNECT( iconView, customContextMenuRequested( const QPoint & ),
 270              this, popupPlView( const QPoint & ) );
 271     CONNECT( iconView, activated( const QModelIndex & ),
 272              this, activate( const QModelIndex & ) );
 273     iconView->installEventFilter( this );
 274     layout->addWidget( iconView, 1, 0, 1, -1 );
 275 }
 276
 277 void StandardPLPanel::createListView()
 278 {
 279     listView = new PlListView( model, this );
 280     listView->setContextMenuPolicy( Qt::CustomContextMenu );
 281     CONNECT( listView, customContextMenuRequested( const QPoint & ),
 282              this, popupPlView( const QPoint & ) );
 283     CONNECT( listView, activated( const QModelIndex & ),
 284              this, activate( const QModelIndex & ) );
 285     listView->installEventFilter( this );
 286     layout->addWidget( listView, 1, 0, 1, -1 );
 287 }
 288
 289
 290 void StandardPLPanel::createTreeView()
 291 {
 292     /* Create and configure the QTreeView */
 293     treeView = new QTreeView;
 294
 295     treeView->setIconSize( QSize( 20, 20 ) );
 296     treeView->setAlternatingRowColors( true );
 297     treeView->setAnimated( true );
 298     treeView->setUniformRowHeights( true );
 299     treeView->setSortingEnabled( true );
 300     treeView->header()->setSortIndicator( -1 , Qt::AscendingOrder );
 301     treeView->header()->setSortIndicatorShown( true );
 302     treeView->header()->setClickable( true );
 303     treeView->header()->setContextMenuPolicy( Qt::CustomContextMenu );
 304
 305     treeView->setSelectionBehavior( QAbstractItemView::SelectRows );
 306     treeView->setSelectionMode( QAbstractItemView::ExtendedSelection );
 307     treeView->setDragEnabled( true );
 308     treeView->setAcceptDrops( true );
 309     treeView->setDropIndicatorShown( true );
 310     treeView->setContextMenuPolicy( Qt::CustomContextMenu );
 311
 312     /* setModel after setSortingEnabled(true), or the model will sort immediately! */
 313     treeView->setModel( model );
 314
 315     if( getSettings()->contains( "headerStateV2" ) )
 316     {
 317         treeView->header()->restoreState(
 318                 getSettings()->value( "headerStateV2" ).toByteArray() );
 319     }
 320     else
 321     {
 322         for( int m = 1, c = 0; m != COLUMN_END; m <<= 1, c++ )
 323         {
 324             treeView->setColumnHidden( c, !( m & COLUMN_DEFAULT ) );
 325             if( m == COLUMN_TITLE ) treeView->header()->resizeSection( c, 200 );
 326             else if( m == COLUMN_DURATION ) treeView->header()->resizeSection( c, 80 );
 327         }
 328     }
 329
 330     /* Connections for the TreeView */
 331     CONNECT( treeView, activated( const QModelIndex& ),
 332              this, activate( const QModelIndex& ) );
 333     CONNECT( treeView->header(), customContextMenuRequested( const QPoint & ),
 334              this, popupSelectColumn( QPoint ) );
 335     CONNECT( treeView, customContextMenuRequested( const QPoint & ),
 336              this, popupPlView( const QPoint & ) );
 337     treeView->installEventFilter( this );
 338
 339     /* SignalMapper for columns */
 340     selectColumnsSigMapper = new QSignalMapper( this );
 341     CONNECT( selectColumnsSigMapper, mapped( int ),
 342              this, toggleColumnShown( int ) );
 343
 344     /* Finish the layout */
 345     layout->addWidget( treeView, 1, 0, 1, -1 );
 346 }
 347
 348 void StandardPLPanel::showView( int i_view )
 349 {
 350     switch( i_view )
 351     {
 352     case TREE_VIEW:
 353     {
 354         if( treeView == NULL )
 355             createTreeView();
 356         if( iconView ) iconView->hide();
 357         if( listView ) listView->hide();
 358         treeView->show();
 359         currentView = treeView;
 360         viewActions[i_view]->setChecked( true );
 361         break;
 362     }
 363     case ICON_VIEW:
 364     {
 365         if( iconView == NULL )
 366             createIconView();
 367
 368         if( treeView ) treeView->hide();
 369         if( listView ) listView->hide();
 370         iconView->show();
 371         currentView = iconView;
 372         viewActions[i_view]->setChecked( true );
 373         break;
 374     }
 375     case LIST_VIEW:
 376     {
 377         if( listView == NULL )
 378             createListView();
 379
 380         if( treeView ) treeView->hide();
 381         if( iconView ) iconView->hide();
 382         listView->show();
 383         currentView = listView;
 384         viewActions[i_view]->setChecked( true );
 385         break;
 386     }
 387     default: return;
 388     }
 389
 390     browseInto();
 391     gotoPlayingItem();
 392 }
 393
 394 void StandardPLPanel::cycleViews()
 395 {
 396     if( currentView == iconView )
 397         showView( TREE_VIEW );
 398     else if( currentView == treeView )
 399         showView( LIST_VIEW );
 400     else if( currentView == listView )
 401         showView( ICON_VIEW );
 402     else
 403         assert( 0 );
 404 }
 405
 406 void StandardPLPanel::activate( const QModelIndex &index )
 407 {
 408     if( model->hasChildren( index ) )
 409     {
 410         if( currentView != treeView )
 411             browseInto( index );
 412     }
 413     else
 414     {
 415         playlist_Lock( THEPL );
 416         playlist_item_t *p_item = playlist_ItemGetById( THEPL, model->itemId( index ) );
 417         p_item->i_flags |= PLAYLIST_SUBITEM_STOP_FLAG;
 418         lastActivatedId = p_item->p_input->i_id;
 419         playlist_Unlock( THEPL );
 420         model->activateItem( index );
 421     }
 422 }
 423
 424 void StandardPLPanel::browseInto( input_item_t *p_input )
 425 {
 426
 427     if( p_input->i_id != lastActivatedId ) return;
 428
 429     playlist_Lock( THEPL );
 430
 431     playlist_item_t *p_item = playlist_ItemGetByInput( THEPL, p_input );
 432     if( !p_item )
 433     {
 434         playlist_Unlock( THEPL );
 435         return;
 436     }
 437
 438     QModelIndex index = model->index( p_item->i_id, 0 );
 439
 440     playlist_Unlock( THEPL );
 441
 442     if( currentView == treeView )
 443         treeView->setExpanded( index, true );
 444     else
 445         browseInto( index );
 446
 447     lastActivatedId = -1;
 448
 449
 450 }
 451
 452 LocationBar::LocationBar( PLModel *m )
 453 {
 454     model = m;
 455     mapper = new QSignalMapper( this );
 456     CONNECT( mapper, mapped( int ), this, invoke( int ) );
 457
 458     box = new QHBoxLayout;
 459     box->setSpacing( 0 );
 460     box->setContentsMargins( 0, 0, 0, 0 );
 461     setLayout( box );
 462 }
 463
 464 void LocationBar::setIndex( const QModelIndex &index )
 465 {
 466     qDeleteAll( buttons );
 467     buttons.clear();
 468     QModelIndex i = index;
 469     bool bold = true;
 470     box->addStretch();
 471     while( true )
 472     {
 473         PLItem *item = model->getItem( i );
 474
 475         char *fb_name = input_item_GetTitleFbName( item->inputItem() );
 476         QString text = qfu(fb_name);
 477         free(fb_name);
 478         QAbstractButton *btn = new LocationButton( text, bold, i.isValid() );
 479         btn->setSizePolicy( QSizePolicy::Maximum, QSizePolicy::Fixed );
 480         box->insertWidget( 0, btn );
 481         buttons.append( btn );
 482
 483         mapper->setMapping( btn, item->id() );
 484         CONNECT( btn, clicked( ), mapper, map( ) );
 485
 486         bold = false;
 487
 488         if( i.isValid() ) i = i.parent();
 489         else break;
 490     }
 491 }
 492
 493 void LocationBar::setRootIndex()
 494 {
 495     setIndex( QModelIndex() );
 496 }
 497
 498 void LocationBar::invoke( int i_id )
 499 {
 500     QModelIndex index = model->index( i_id, 0 );
 501     emit invoked ( index );
 502 }
 503
 504 LocationButton::LocationButton( const QString &text, bool bold, bool arrow )
 505   : b_arrow( arrow )
 506 {
 507     QFont font;
 508     font.setBold( bold );
 509     setFont( font );
 510     setText( text );
 511 }
 512
 513 #define PADDING 4
 514
 515 void LocationButton::paintEvent ( QPaintEvent * event )
 516 {
 517     QStyleOptionButton option;
 518     option.initFrom( this );
 519     option.state |= QStyle::State_Enabled;
 520     QPainter p( this );
 521
 522     if( underMouse() )
 523         style()->drawControl( QStyle::CE_PushButtonBevel, &option, &p );
 524
 525     int margin = style()->pixelMetric(QStyle::PM_DefaultFrameWidth,0,this) + PADDING;
 526
 527     QRect rect = option.rect.adjusted( b_arrow ? 15 + margin : margin, 0, -margin, 0 );
 528
 529     QString str( text() );
 530     /* This check is absurd, but either it is not done properly inside elidedText(),
 531        or boundingRect() is wrong */
 532     if( rect.width() < fontMetrics().boundingRect( text() ).width() )
 533         str = fontMetrics().elidedText( text(), Qt::ElideRight, rect.width() );
 534     p.drawText( rect, Qt::AlignVCenter | Qt::AlignLeft, str );
 535
 536     if( b_arrow )
 537     {
 538         option.rect.setX( margin );
 539         option.rect.setWidth( 8 );
 540         style()->drawPrimitive( QStyle::PE_IndicatorArrowRight, &option, &p );
 541     }
 542 }
 543
 544 QSize LocationButton::sizeHint() const
 545 {
 546     int frameWidth = style()->pixelMetric(QStyle::PM_DefaultFrameWidth,0,this);
 547     QSize s( fontMetrics().boundingRect( text() ).size() );
 548     /* Add two pixels to width: font metrics are buggy, if you pass text through elidation
 549        with exactly the width of its bounding rect, sometimes it still elides */
 550     s.setWidth( s.width() + ( 2 * frameWidth ) + ( 2 * PADDING ) + ( b_arrow ? 15 : 0 ) + 2 );
 551     s.setHeight( QPushButton::sizeHint().height() );
 552     return s;
 553 }
 554
 555 #undef PADDING