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::Maximum, QSizePolicy::Preferred );
  80     layout->addWidget( locationBar, 0, 1 );
  81     layout->setColumnStretch( 1, 100 );
  82     CONNECT( locationBar, invoked( const QModelIndex & ),
  83              this, browseInto( const QModelIndex & ) );
  84
  85     layout->setColumnStretch( 2, 1 );
  86
  87     searchEdit = new SearchLineEdit( this );
  88     searchEdit->setMaximumWidth( 250 );
  89     searchEdit->setMinimumWidth( 80 );
  90     layout->addWidget( searchEdit, 0, 3 );
  91     CONNECT( searchEdit, textChanged( const QString& ),
  92              this, search( const QString& ) );
  93     layout->setColumnStretch( 3, 50 );
  94
  95     /* Add item to the playlist button */
  96     addButton = new QToolButton;
  97     addButton->setIcon( QIcon( ":/buttons/playlist/playlist_add" ) );
  98     addButton->setMaximumWidth( 30 );
  99     BUTTONACT( addButton, popupAdd() );
 100     layout->addWidget( addButton, 0, 0 );
 101
 102     /* Button to switch views */
 103     QToolButton *viewButton = new QToolButton( this );
 104     viewButton->setIcon( style()->standardIcon( QStyle::SP_FileDialogDetailedView ) );
 105     layout->addWidget( viewButton, 0, 4 );
 106
 107     /* View selection menu */
 108     viewSelectionMapper = new QSignalMapper( this );
 109     CONNECT( viewSelectionMapper, mapped( int ), this, showView( int ) );
 110
 111     QActionGroup *actionGroup = new QActionGroup( this );
 112
 113     for( int i = 0; i < VIEW_COUNT; i++ )
 114     {
 115         viewActions[i] = actionGroup->addAction( viewNames[i] );
 116         viewActions[i]->setCheckable( true );
 117         viewSelectionMapper->setMapping( viewActions[i], i );
 118         CONNECT( viewActions[i], triggered(), viewSelectionMapper, map() );
 119     }
 120
 121     BUTTONACT( viewButton, cycleViews() );
 122     QMenu *viewMenu = new QMenu( this );
 123     viewMenu->addActions( actionGroup->actions() );
 124
 125     viewButton->setMenu( viewMenu );
 126
 127     /* Saved Settings */
 128     getSettings()->beginGroup("Playlist");
 129
 130     int i_viewMode = getSettings()->value( "view-mode", TREE_VIEW ).toInt();
 131     showView( i_viewMode );
 132
 133     getSettings()->endGroup();
 134
 135     CONNECT( THEMIM, leafBecameParent( input_item_t *),
 136              this, browseInto( input_item_t * ) );
 137
 138     CONNECT( model, currentChanged( const QModelIndex& ),
 139              this, handleExpansion( const QModelIndex& ) );
 140     CONNECT( model, rootChanged(), this, handleRootChange() );
 141 }
 142
 143 StandardPLPanel::~StandardPLPanel()
 144 {
 145     getSettings()->beginGroup("Playlist");
 146     if( treeView )
 147         getSettings()->setValue( "headerStateV2", treeView->header()->saveState() );
 148     if( currentView == treeView )
 149         getSettings()->setValue( "view-mode", TREE_VIEW );
 150     else if( currentView == listView )
 151         getSettings()->setValue( "view-mode", LIST_VIEW );
 152     else if( currentView == iconView )
 153         getSettings()->setValue( "view-mode", ICON_VIEW );
 154     getSettings()->endGroup();
 155 }
 156
 157 /* Unused anymore, but might be useful, like in right-click menu */
 158 void StandardPLPanel::gotoPlayingItem()
 159 {
 160     currentView->scrollTo( model->currentIndex() );
 161 }
 162
 163 void StandardPLPanel::handleExpansion( const QModelIndex& index )
 164 {
 165     assert( currentView );
 166     currentView->scrollTo( index );
 167 }
 168
 169 void StandardPLPanel::handleRootChange()
 170 {
 171     /* needed for popupAdd() */
 172     PLItem *root = model->getItem( QModelIndex() );
 173     currentRootId = root->id();
 174
 175     browseInto();
 176
 177     /* enable/disable adding */
 178     if( currentRootId == THEPL->p_playing->i_id )
 179     {
 180         addButton->setEnabled( true );
 181         addButton->setToolTip( qtr(I_PL_ADDPL) );
 182     }
 183     else if( THEPL->p_media_library &&
 184              currentRootId == THEPL->p_media_library->i_id )
 185     {
 186         addButton->setEnabled( true );
 187         addButton->setToolTip( qtr(I_PL_ADDML) );
 188     }
 189     else
 190         addButton->setEnabled( false );
 191 }
 192
 193 /* PopupAdd Menu for the Add Menu */
 194 void StandardPLPanel::popupAdd()
 195 {
 196     QMenu popup;
 197     if( currentRootId == THEPL->p_playing->i_id )
 198     {
 199         popup.addAction( qtr(I_PL_ADDF), THEDP, SLOT( simplePLAppendDialog()) );
 200         popup.addAction( qtr(I_PL_ADDDIR), THEDP, SLOT( PLAppendDir()) );
 201         popup.addAction( qtr(I_OP_ADVOP), THEDP, SLOT( PLAppendDialog()) );
 202     }
 203     else if( THEPL->p_media_library &&
 204                 currentRootId == THEPL->p_media_library->i_id )
 205     {
 206         popup.addAction( qtr(I_PL_ADDF), THEDP, SLOT( simpleMLAppendDialog()) );
 207         popup.addAction( qtr(I_PL_ADDDIR), THEDP, SLOT( MLAppendDir() ) );
 208         popup.addAction( qtr(I_OP_ADVOP), THEDP, SLOT( MLAppendDialog() ) );
 209     }
 210
 211     popup.exec( QCursor::pos() - addButton->mapFromGlobal( QCursor::pos() )
 212                         + QPoint( 0, addButton->height() ) );
 213 }
 214
 215 void StandardPLPanel::popupPlView( const QPoint &point )
 216 {
 217     QModelIndex index = currentView->indexAt( point );
 218     QPoint globalPoint = currentView->viewport()->mapToGlobal( point );
 219     if( !index.isValid() ){
 220         QVLCMenu::PopupMenu( p_intf, true );
 221     }
 222     else
 223     {
 224         QItemSelectionModel *selection = currentView->selectionModel();
 225         QModelIndexList list = selection->selectedIndexes();
 226         model->popup( index, globalPoint, list );
 227     }
 228 }
 229
 230 void StandardPLPanel::popupSelectColumn( QPoint pos )
 231 {
 232     QMenu menu;
 233     assert( treeView );
 234
 235     /* We do not offer the option to hide index 0 column, or
 236     * QTreeView will behave weird */
 237     int i, j;
 238     for( i = 1 << 1, j = 1; i < COLUMN_END; i <<= 1, j++ )
 239     {
 240         QAction* option = menu.addAction(
 241             qfu( psz_column_title( i ) ) );
 242         option->setCheckable( true );
 243         option->setChecked( !treeView->isColumnHidden( j ) );
 244         selectColumnsSigMapper->setMapping( option, j );
 245         CONNECT( option, triggered(), selectColumnsSigMapper, map() );
 246     }
 247     menu.exec( QCursor::pos() );
 248 }
 249
 250 void StandardPLPanel::toggleColumnShown( int i )
 251 {
 252     treeView->setColumnHidden( i, !treeView->isColumnHidden( i ) );
 253 }
 254
 255 /* Search in the playlist */
 256 void StandardPLPanel::search( const QString& searchText )
 257 {
 258     bool flat = currentView == iconView || currentView == listView;
 259     model->search( searchText,
 260                    flat ? currentView->rootIndex() : QModelIndex(),
 261                    !flat );
 262 }
 263
 264 /* Set the root of the new Playlist */
 265 /* This activated by the selector selection */
 266 void StandardPLPanel::setRoot( playlist_item_t *p_item )
 267 {
 268     model->rebuild( p_item );
 269 }
 270
 271 void StandardPLPanel::browseInto( const QModelIndex &index )
 272 {
 273     if( currentView == iconView || currentView == listView )
 274     {
 275         currentRootIndexId = model->itemId( index );;
 276         currentView->setRootIndex( index );
 277     }
 278
 279     locationBar->setIndex( index );
 280     model->search( QString(), index, false );
 281     searchEdit->clear();
 282 }
 283
 284 void StandardPLPanel::browseInto( )
 285 {
 286     browseInto( currentRootIndexId != -1 && currentView != treeView ?
 287                 model->index( currentRootIndexId, 0 ) :
 288                 QModelIndex() );
 289 }
 290
 291 /* Delete and Suppr key remove the selection
 292    FilterKey function and code function */
 293 void StandardPLPanel::keyPressEvent( QKeyEvent *e )
 294 {
 295     switch( e->key() )
 296     {
 297     case Qt::Key_Back:
 298     case Qt::Key_Delete:
 299         deleteSelection();
 300         break;
 301     }
 302 }
 303
 304 void StandardPLPanel::deleteSelection()
 305 {
 306     QItemSelectionModel *selection = currentView->selectionModel();
 307     QModelIndexList list = selection->selectedIndexes();
 308     model->doDelete( list );
 309 }
 310
 311 void StandardPLPanel::createIconView()
 312 {
 313     iconView = new PlIconView( model, this );
 314     iconView->setContextMenuPolicy( Qt::CustomContextMenu );
 315     CONNECT( iconView, customContextMenuRequested( const QPoint & ),
 316              this, popupPlView( const QPoint & ) );
 317     CONNECT( iconView, activated( const QModelIndex & ),
 318              this, activate( const QModelIndex & ) );
 319
 320     layout->addWidget( iconView, 1, 0, 1, -1 );
 321 }
 322
 323 void StandardPLPanel::createListView()
 324 {
 325     listView = new PlListView( model, this );
 326     listView->setContextMenuPolicy( Qt::CustomContextMenu );
 327     CONNECT( listView, customContextMenuRequested( const QPoint & ),
 328              this, popupPlView( const QPoint & ) );
 329     CONNECT( listView, activated( const QModelIndex & ),
 330              this, activate( const QModelIndex & ) );
 331
 332     layout->addWidget( listView, 1, 0, 1, -1 );
 333 }
 334
 335
 336 void StandardPLPanel::createTreeView()
 337 {
 338     /* Create and configure the QTreeView */
 339     treeView = new QTreeView;
 340
 341     treeView->setIconSize( QSize( 20, 20 ) );
 342     treeView->setAlternatingRowColors( true );
 343     treeView->setAnimated( true );
 344     treeView->setUniformRowHeights( true );
 345     treeView->setSortingEnabled( true );
 346     treeView->header()->setSortIndicator( -1 , Qt::AscendingOrder );
 347     treeView->header()->setSortIndicatorShown( true );
 348     treeView->header()->setClickable( true );
 349     treeView->header()->setContextMenuPolicy( Qt::CustomContextMenu );
 350
 351     treeView->setSelectionBehavior( QAbstractItemView::SelectRows );
 352     treeView->setSelectionMode( QAbstractItemView::ExtendedSelection );
 353     treeView->setDragEnabled( true );
 354     treeView->setAcceptDrops( true );
 355     treeView->setDropIndicatorShown( true );
 356     treeView->setContextMenuPolicy( Qt::CustomContextMenu );
 357
 358     /* setModel after setSortingEnabled(true), or the model will sort immediately! */
 359     treeView->setModel( model );
 360
 361     if( getSettings()->contains( "headerStateV2" ) )
 362     {
 363         treeView->header()->restoreState(
 364                 getSettings()->value( "headerStateV2" ).toByteArray() );
 365     }
 366     else
 367     {
 368         for( int m = 1, c = 0; m != COLUMN_END; m <<= 1, c++ )
 369         {
 370             treeView->setColumnHidden( c, !( m & COLUMN_DEFAULT ) );
 371             if( m == COLUMN_TITLE ) treeView->header()->resizeSection( c, 200 );
 372             else if( m == COLUMN_DURATION ) treeView->header()->resizeSection( c, 80 );
 373         }
 374     }
 375
 376     /* Connections for the TreeView */
 377     CONNECT( treeView, activated( const QModelIndex& ),
 378              this, activate( const QModelIndex& ) );
 379     CONNECT( treeView->header(), customContextMenuRequested( const QPoint & ),
 380              this, popupSelectColumn( QPoint ) );
 381     CONNECT( treeView, customContextMenuRequested( const QPoint & ),
 382              this, popupPlView( const QPoint & ) );
 383
 384     /* SignalMapper for columns */
 385     selectColumnsSigMapper = new QSignalMapper( this );
 386     CONNECT( selectColumnsSigMapper, mapped( int ),
 387              this, toggleColumnShown( int ) );
 388
 389     /* Finish the layout */
 390     layout->addWidget( treeView, 1, 0, 1, -1 );
 391 }
 392
 393 void StandardPLPanel::showView( int i_view )
 394 {
 395     switch( i_view )
 396     {
 397     case TREE_VIEW:
 398     {
 399         if( treeView == NULL )
 400             createTreeView();
 401         if( iconView ) iconView->hide();
 402         if( listView ) listView->hide();
 403         treeView->show();
 404         currentView = treeView;
 405         viewActions[i_view]->setChecked( true );
 406         break;
 407     }
 408     case ICON_VIEW:
 409     {
 410         if( iconView == NULL )
 411             createIconView();
 412
 413         if( treeView ) treeView->hide();
 414         if( listView ) listView->hide();
 415         iconView->show();
 416         currentView = iconView;
 417         viewActions[i_view]->setChecked( true );
 418         break;
 419     }
 420     case LIST_VIEW:
 421     {
 422         if( listView == NULL )
 423             createListView();
 424
 425         if( treeView ) treeView->hide();
 426         if( iconView ) iconView->hide();
 427         listView->show();
 428         currentView = listView;
 429         viewActions[i_view]->setChecked( true );
 430         break;
 431     }
 432     default: return;
 433     }
 434
 435     browseInto();
 436 }
 437
 438 void StandardPLPanel::cycleViews()
 439 {
 440     if( currentView == iconView )
 441         showView( TREE_VIEW );
 442     else if( currentView == treeView )
 443         showView( LIST_VIEW );
 444     else if( currentView == listView )
 445         showView( ICON_VIEW );
 446     else
 447         assert( 0 );
 448 }
 449
 450 void StandardPLPanel::wheelEvent( QWheelEvent *e )
 451 {
 452     // Accept this event in order to prevent unwanted volume up/down changes
 453     e->accept();
 454 }
 455
 456 void StandardPLPanel::activate( const QModelIndex &index )
 457 {
 458     if( model->hasChildren( index ) )
 459     {
 460         if( currentView != treeView )
 461             browseInto( index );
 462     }
 463     else
 464     {
 465         playlist_Lock( THEPL );
 466         playlist_item_t *p_item = playlist_ItemGetById( THEPL, model->itemId( index ) );
 467         p_item->i_flags |= PLAYLIST_SUBITEM_STOP_FLAG;
 468         lastActivatedId = p_item->p_input->i_id;
 469         playlist_Unlock( THEPL );
 470         model->activateItem( index );
 471     }
 472 }
 473
 474 void StandardPLPanel::browseInto( input_item_t *p_input )
 475 {
 476
 477     if( p_input->i_id != lastActivatedId ) return;
 478
 479     playlist_Lock( THEPL );
 480
 481     playlist_item_t *p_item = playlist_ItemGetByInput( THEPL, p_input );
 482     if( !p_item )
 483     {
 484         playlist_Unlock( THEPL );
 485         return;
 486     }
 487
 488     QModelIndex index = model->index( p_item->i_id, 0 );
 489
 490     playlist_Unlock( THEPL );
 491
 492     if( currentView == treeView )
 493         treeView->setExpanded( index, true );
 494     else
 495         browseInto( index );
 496
 497     lastActivatedId = -1;
 498
 499
 500 }
 501
 502 LocationBar::LocationBar( PLModel *m )
 503 {
 504     model = m;
 505     mapper = new QSignalMapper( this );
 506     CONNECT( mapper, mapped( int ), this, invoke( int ) );
 507
 508     box = new QHBoxLayout;
 509     box->setSpacing( 0 );
 510     box->setContentsMargins( 0, 0, 0, 0 );
 511     setLayout( box );
 512 }
 513
 514 void LocationBar::setIndex( const QModelIndex &index )
 515 {
 516     qDeleteAll( buttons );
 517     buttons.clear();
 518     QModelIndex i = index;
 519     bool bold = true;
 520     while( true )
 521     {
 522         PLItem *item = model->getItem( i );
 523
 524         char *fb_name = input_item_GetTitleFbName( item->inputItem() );
 525         QString text = qfu(fb_name);
 526         free(fb_name);
 527         QAbstractButton *btn = new LocationButton( text, bold, i.isValid() );
 528         btn->setSizePolicy( QSizePolicy::Maximum, QSizePolicy::Fixed );
 529         box->insertWidget( 0, btn, bold ? 1 : 0 );
 530         buttons.append( btn );
 531
 532         mapper->setMapping( btn, item->id() );
 533         CONNECT( btn, clicked( ), mapper, map( ) );
 534
 535         bold = false;
 536
 537         if( i.isValid() ) i = i.parent();
 538         else break;
 539     }
 540 }
 541
 542 void LocationBar::setRootIndex()
 543 {
 544     setIndex( QModelIndex() );
 545 }
 546
 547 void LocationBar::invoke( int i_id )
 548 {
 549     QModelIndex index = model->index( i_id, 0 );
 550     emit invoked ( index );
 551 }
 552
 553 LocationButton::LocationButton( const QString &text, bool bold, bool arrow )
 554   : b_arrow( arrow )
 555 {
 556     QFont font;
 557     font.setBold( bold );
 558     setFont( font );
 559     setText( text );
 560 }
 561
 562 #define PADDING 4
 563
 564 void LocationButton::paintEvent ( QPaintEvent * event )
 565 {
 566     QStyleOptionButton option;
 567     option.initFrom( this );
 568     option.state |= QStyle::State_Enabled;
 569     QPainter p( this );
 570
 571     if( underMouse() )
 572         style()->drawControl( QStyle::CE_PushButtonBevel, &option, &p );
 573
 574     int margin = style()->pixelMetric(QStyle::PM_DefaultFrameWidth,0,this) + PADDING;
 575
 576     QRect rect = option.rect.adjusted( b_arrow ? 15 + margin : margin, 0, margin * -1, 0 );
 577     p.drawText( rect, Qt::AlignVCenter,
 578                 fontMetrics().elidedText( text(), Qt::ElideRight, rect.width() ) );
 579
 580     if( b_arrow )
 581     {
 582         option.rect.setX( margin );
 583         option.rect.setWidth( 8 );
 584         style()->drawPrimitive( QStyle::PE_IndicatorArrowRight, &option, &p );
 585     }
 586 }
 587
 588 QSize LocationButton::sizeHint() const
 589 {
 590     int frameWidth = style()->pixelMetric(QStyle::PM_DefaultFrameWidth,0,this);
 591     QSize s( fontMetrics().boundingRect( text() ).size() );
 592     s.setWidth( s.width() + ( 2 * frameWidth ) + ( 2 * PADDING ) + ( b_arrow ? 15 : 0 ) );
 593     s.setHeight( QPushButton::sizeHint().height() );
 594     return s;
 595 }
 596
 597 #undef PADDING