messagelist/pane.cpp

   1 /*
   2     Copyright (c) 2009 Kevin Ottens <ervin@kde.org>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17 */
  18
  19 #include "pane.h"
  20
  21 #include <KDE/KActionCollection>
  22 #include <KDE/KActionMenu>
  23 #include <KDE/KIcon>
  24 #include <KDE/KLocale>
  25 #include <KDE/KMenu>
  26 #include <KDE/KXMLGUIClient>
  27
  28 #include <QtCore/QAbstractItemModel>
  29 #include <QtGui/QAbstractProxyModel>
  30 #include <QtGui/QItemSelectionModel>
  31 #include <QtGui/QTabBar>
  32 #include <QtGui/QToolButton>
  33
  34 #include "storagemodel.h"
  35 #include "widget.h"
  36 #include "core/settings.h"
  37 #include "core/manager.h"
  38 #include "messagecore/messagestatus.h"
  39 #include "core/model.h"
  40
  41 namespace MessageList
  42 {
  43
  44 class Pane::Private
  45 {
  46 public:
  47   Private( Pane *owner )
  48     : q( owner ), mXmlGuiClient( 0 ), mActionMenu( 0 ) { }
  49
  50   void onSelectionChanged( const QItemSelection &selected, const QItemSelection &deselected );
  51   void onNewTabClicked();
  52   void onCloseTabClicked();
  53   void onCurrentTabChanged();
  54   void onTabContextMenuRequest( const QPoint &pos );
  55
  56   QItemSelection mapSelectionToSource( const QItemSelection &selection ) const;
  57   QItemSelection mapSelectionFromSource( const QItemSelection &selection ) const;
  58   void updateTabControls();
  59
  60   Pane * const q;
  61
  62   KXMLGUIClient *mXmlGuiClient;
  63   KActionMenu *mActionMenu;
  64
  65   QAbstractItemModel *mModel;
  66   QItemSelectionModel *mSelectionModel;
  67
  68   QHash<Widget*, QItemSelectionModel*> mWidgetSelectionHash;
  69   QList<const QAbstractProxyModel*> mProxyStack;
  70
  71   QToolButton *mNewTabButton;
  72   QToolButton *mCloseTabButton;
  73
  74 };
  75
  76 } // namespace MessageList
  77
  78 using namespace Akonadi;
  79 using namespace MessageList;
  80
  81
  82 Pane::Pane( QAbstractItemModel *model, QItemSelectionModel *selectionModel, QWidget *parent )
  83   : QTabWidget( parent ), d( new Private( this ) )
  84 {
  85   d->mModel = model;
  86   d->mSelectionModel = selectionModel;
  87
  88   // Build the proxy stack
  89   const QAbstractProxyModel *proxyModel = qobject_cast<const QAbstractProxyModel*>( d->mSelectionModel->model() );
  90
  91   while (proxyModel) {
  92     if (static_cast<const QAbstractItemModel*>(proxyModel) == d->mModel) {
  93       break;
  94     }
  95
  96     d->mProxyStack << proxyModel;
  97     const QAbstractProxyModel *nextProxyModel = qobject_cast<const QAbstractProxyModel*>(proxyModel->sourceModel());
  98
  99     if (!nextProxyModel) {
 100       // It's the final model in the chain, so it is necessarily the sourceModel.
 101       Q_ASSERT(qobject_cast<const QAbstractItemModel*>(proxyModel->sourceModel()) == d->mModel);
 102       break;
 103     }
 104     proxyModel = nextProxyModel;
 105   } // Proxy stack done
 106
 107   d->mNewTabButton = new QToolButton( this );
 108   d->mNewTabButton->setIcon( KIcon( "tab-new" ) );
 109   d->mNewTabButton->adjustSize();
 110   d->mNewTabButton->setToolTip( i18nc("@info:tooltip", "Open a new tab"));
 111   setCornerWidget( d->mNewTabButton, Qt::TopLeftCorner );
 112   connect( d->mNewTabButton, SIGNAL( clicked() ),
 113            SLOT( onNewTabClicked() ) );
 114
 115   d->mCloseTabButton = new QToolButton( this );
 116   d->mCloseTabButton->setIcon( KIcon( "tab-close" ) );
 117   d->mCloseTabButton->adjustSize();
 118   d->mCloseTabButton->setToolTip( i18nc("@info:tooltip", "Close the current tab"));
 119   setCornerWidget( d->mCloseTabButton, Qt::TopRightCorner );
 120   connect( d->mCloseTabButton, SIGNAL( clicked() ),
 121            SLOT( onCloseTabClicked() ) );
 122
 123   createNewTab();
 124   setMovable( true );
 125
 126   connect( d->mSelectionModel, SIGNAL(selectionChanged(QItemSelection, QItemSelection)),
 127            this, SLOT(onSelectionChanged(QItemSelection, QItemSelection)) );
 128   connect( this, SIGNAL(currentChanged(int)),
 129            this, SLOT(onCurrentTabChanged()) );
 130
 131   setContextMenuPolicy( Qt::CustomContextMenu );
 132   connect( this, SIGNAL(customContextMenuRequested(QPoint)),
 133            this, SLOT(onTabContextMenuRequest(QPoint)) );
 134
 135   connect( Core::Settings::self(), SIGNAL(configChanged()),
 136            this, SLOT(updateTabControls()) );
 137 }
 138
 139 Pane::~Pane()
 140 {
 141   delete d;
 142 }
 143
 144 void Pane::setXmlGuiClient( KXMLGUIClient *xmlGuiClient )
 145 {
 146   d->mXmlGuiClient = xmlGuiClient;
 147
 148   for ( int i=0; i<count(); i++ ) {
 149     Widget *w = qobject_cast<Widget *>( widget( i ) );
 150     w->setXmlGuiClient( d->mXmlGuiClient );
 151   }
 152
 153   // Setup "View->Message List" actions.
 154   if ( xmlGuiClient ) {
 155     if ( d->mActionMenu ) {
 156       d->mXmlGuiClient->actionCollection()->removeAction( d->mActionMenu );
 157     }
 158     d->mActionMenu = new KActionMenu( KIcon(), i18n( "Message List" ), this );
 159     d->mXmlGuiClient->actionCollection()->addAction( "view_message_list", d->mActionMenu );
 160     const Widget * const w = static_cast<Widget*>( currentWidget() );
 161     w->view()->fillViewMenu( d->mActionMenu->menu() );
 162   }
 163 }
 164
 165 bool Pane::selectNextMessageItem( MessageList::Core::MessageTypeFilter messageTypeFilter,
 166                                   MessageList::Core::ExistingSelectionBehaviour existingSelectionBehaviour,
 167                                   bool centerItem,
 168                                   bool loop )
 169 {
 170   Widget *w = static_cast<Widget*>( currentWidget() );
 171
 172   if ( w ) {
 173     if ( w->view()->model()->isLoading() )
 174       return true;
 175
 176     return w->selectNextMessageItem( messageTypeFilter, existingSelectionBehaviour, centerItem, loop );
 177   } else {
 178     return false;
 179   }
 180 }
 181
 182 bool Pane::selectPreviousMessageItem( MessageList::Core::MessageTypeFilter messageTypeFilter,
 183                                       MessageList::Core::ExistingSelectionBehaviour existingSelectionBehaviour,
 184                                       bool centerItem,
 185                                       bool loop )
 186 {
 187   Widget *w = static_cast<Widget*>( currentWidget() );
 188
 189   if ( w ) {
 190     if ( w->view()->model()->isLoading() )
 191       return true;
 192
 193     return w->selectPreviousMessageItem( messageTypeFilter, existingSelectionBehaviour, centerItem, loop );
 194   } else {
 195     return false;
 196   }
 197 }
 198
 199 bool Pane::focusNextMessageItem( MessageList::Core::MessageTypeFilter messageTypeFilter, bool centerItem, bool loop )
 200 {
 201   Widget *w = static_cast<Widget*>( currentWidget() );
 202
 203   if ( w ) {
 204     if ( w->view()->model()->isLoading() )
 205       return true;
 206
 207     return w->focusNextMessageItem( messageTypeFilter, centerItem, loop );
 208   } else {
 209     return false;
 210   }
 211 }
 212
 213 bool Pane::focusPreviousMessageItem( MessageList::Core::MessageTypeFilter messageTypeFilter, bool centerItem, bool loop )
 214 {
 215   Widget *w = static_cast<Widget*>( currentWidget() );
 216
 217   if ( w ) {
 218     if ( w->view()->model()->isLoading() )
 219       return true;
 220
 221     return w->focusNextMessageItem( messageTypeFilter, centerItem, loop );
 222   } else {
 223     return false;
 224   }
 225 }
 226
 227 void Pane::selectFocusedMessageItem( bool centerItem )
 228 {
 229   Widget *w = static_cast<Widget*>( currentWidget() );
 230
 231   if ( w ) {
 232     if ( w->view()->model()->isLoading() )
 233       return;
 234
 235     w->selectFocusedMessageItem( centerItem );
 236   }
 237 }
 238
 239 bool Pane::selectFirstMessageItem( MessageList::Core::MessageTypeFilter messageTypeFilter, bool centerItem )
 240 {
 241   Widget *w = static_cast<Widget*>( currentWidget() );
 242
 243   if ( w ) {
 244     if ( w->view()->model()->isLoading() )
 245       return true;
 246
 247     return w->selectFirstMessageItem( messageTypeFilter, centerItem );
 248   } else {
 249     return false;
 250   }
 251 }
 252
 253 void Pane::selectAll()
 254 {
 255   Widget *w = static_cast<Widget*>( currentWidget() );
 256
 257   if ( w ) {
 258     if ( w->view()->model()->isLoading() )
 259       return;
 260
 261     w->selectAll();
 262   }
 263 }
 264
 265
 266 void Pane::setCurrentThreadExpanded( bool expand )
 267 {
 268   Widget *w = static_cast<Widget*>( currentWidget() );
 269
 270   if ( w ) {
 271     if ( w->view()->model()->isLoading() )
 272       return;
 273
 274     w->setCurrentThreadExpanded(expand );
 275   }
 276 }
 277
 278 void Pane::setAllThreadsExpanded( bool expand )
 279 {
 280   Widget *w = static_cast<Widget*>( currentWidget() );
 281
 282   if ( w ) {
 283     if ( w->view()->model()->isLoading() )
 284       return;
 285
 286     w->setAllThreadsExpanded( expand );
 287   }
 288 }
 289
 290 void Pane::setAllGroupsExpanded( bool expand )
 291 {
 292   Widget *w = static_cast<Widget*>( currentWidget() );
 293
 294   if ( w ) {
 295     if ( w->view()->model()->isLoading() )
 296       return;
 297
 298     w->setAllGroupsExpanded(expand);
 299   }
 300 }
 301
 302 void Pane::focusQuickSearch()
 303 {
 304   Widget *w = static_cast<Widget*>( currentWidget() );
 305
 306   if ( w ) {
 307     w->focusQuickSearch();
 308   }
 309 }
 310
 311 void Pane::Private::onSelectionChanged( const QItemSelection &selected, const QItemSelection &deselected )
 312 {
 313   Widget *w = static_cast<Widget*>( q->currentWidget() );
 314   QItemSelectionModel *s = mWidgetSelectionHash[w];
 315
 316   s->select( mapSelectionToSource( selected ), QItemSelectionModel::Select );
 317   s->select( mapSelectionToSource( deselected ), QItemSelectionModel::Deselect );
 318
 319   QString label;
 320   QIcon icon = KIcon( "folder" );
 321   foreach ( const QModelIndex &index, s->selectedRows() ) {
 322     label+= index.data( Qt::DisplayRole ).toString()+", ";
 323   }
 324   label.chop( 2 );
 325
 326   if ( label.isEmpty() ) {
 327     label = i18nc( "@title:tab Empty messagelist", "Empty" );
 328     icon = QIcon();
 329   } else if ( s->selectedRows().size()==1 ) {
 330     icon = s->selectedRows().first().data( Qt::DecorationRole ).value<QIcon>();
 331   }
 332
 333   int index = q->indexOf( w );
 334   q->setTabText( index, label );
 335   q->setTabIcon( index, icon );
 336 }
 337
 338 void Pane::Private::onNewTabClicked()
 339 {
 340   q->createNewTab();
 341   updateTabControls();
 342 }
 343
 344 void Pane::Private::onCloseTabClicked()
 345 {
 346   Widget *w = static_cast<Widget*>( q->currentWidget() );
 347   if ( !w || (q->count() < 2) ) {
 348     return;
 349   }
 350
 351   delete w;
 352   updateTabControls();
 353 }
 354
 355 void Pane::Private::onCurrentTabChanged()
 356 {
 357   Widget *w = static_cast<Widget*>( q->currentWidget() );
 358   QItemSelectionModel *s = mWidgetSelectionHash[w];
 359
 360   disconnect( mSelectionModel, SIGNAL(selectionChanged(QItemSelection, QItemSelection)),
 361               q, SLOT(onSelectionChanged(QItemSelection, QItemSelection)) );
 362
 363   mSelectionModel->select( mapSelectionFromSource( s->selection() ),
 364                            QItemSelectionModel::ClearAndSelect );
 365
 366   connect( mSelectionModel, SIGNAL(selectionChanged(QItemSelection, QItemSelection)),
 367            q, SLOT(onSelectionChanged(QItemSelection, QItemSelection)) );
 368 }
 369
 370 void Pane::Private::onTabContextMenuRequest( const QPoint &pos )
 371 {
 372   QTabBar *bar = q->tabBar();
 373   int index = bar->tabAt( bar->mapFrom( q, pos ) );
 374   if ( index == -1 ) return;
 375
 376   Widget *w = qobject_cast<Widget *>( q->widget( index ) );
 377   if ( !w ) return;
 378
 379   KMenu menu( q );
 380   QAction *action;
 381
 382   action = menu.addAction( i18nc( "@action:inmenu", "Close Tab" ) );
 383   action->setEnabled( q->count() > 1 );
 384   action->setIcon( KIcon( "tab-close" ) );
 385   connect( action, SIGNAL(triggered(bool)),
 386            q, SLOT(onCloseTabClicked()) ); // Reuse the logic...
 387
 388   QAction *allOther = menu.addAction( i18nc("@action:inmenu", "Close All Other Tabs" ) );
 389   allOther->setEnabled( q->count() > 1 );
 390   allOther->setIcon( KIcon( "tab-close-other" ) );
 391
 392   action = menu.exec( q->mapToGlobal( pos ) );
 393
 394   if ( action == allOther ) { // Close all other tabs
 395     QList<Widget *> widgets;
 396     int index = q->indexOf( w );
 397
 398     for ( int i=0; i<q->count(); i++ ) {
 399       if ( i==index) continue; // Skip the current one
 400
 401       Widget *other = qobject_cast<Widget *>( q->widget( i ) );
 402       widgets << other;
 403     }
 404
 405     foreach ( Widget *other, widgets ) {
 406       delete other;
 407     }
 408
 409     updateTabControls();
 410   }
 411 }
 412
 413 void Pane::setCurrentFolder( const Akonadi::Collection &col, bool preferEmptyTab, Core::PreSelectionMode preSelectionMode, const QString &overrideLabel )
 414 {
 415   Widget *w = static_cast<Widget*>( currentWidget() );
 416
 417   if ( w ) {
 418     QItemSelectionModel *s = d->mWidgetSelectionHash[w];
 419     MessageList::StorageModel *m = new MessageList::StorageModel( d->mModel, s, w );
 420     w->setStorageModel( m, preSelectionMode );
 421     if ( !overrideLabel.isEmpty() ) {
 422        int index = indexOf( w );
 423        setTabText( index, overrideLabel );
 424     }
 425   }
 426 }
 427
 428 void Pane::createNewTab()
 429 {
 430   Widget * w = new Widget( this );
 431   w->setXmlGuiClient( d->mXmlGuiClient );
 432   addTab( w, i18nc( "@title:tab Empty messagelist", "Empty" ) );
 433
 434   QItemSelectionModel *s = new QItemSelectionModel( d->mModel, w );
 435   MessageList::StorageModel *m = new MessageList::StorageModel( d->mModel, s, w );
 436   w->setStorageModel( m );
 437
 438   d->mWidgetSelectionHash[w] = s;
 439
 440   connect( w, SIGNAL(messageSelected(Akonadi::Item)),
 441            this, SIGNAL(messageSelected(Akonadi::Item)) );
 442   connect( w, SIGNAL(messageActivated(Akonadi::Item)),
 443            this, SIGNAL(messageActivated(Akonadi::Item)) );
 444   connect( w, SIGNAL(selectionChanged()),
 445            this, SIGNAL(selectionChanged()) );
 446   connect( w, SIGNAL(messageStatusChangeRequest(Akonadi::Item, KPIM::MessageStatus, KPIM::MessageStatus)),
 447            this, SIGNAL(messageStatusChangeRequest(Akonadi::Item, KPIM::MessageStatus, KPIM::MessageStatus)) );
 448
 449   connect( w, SIGNAL(statusMessage(QString)),
 450            this, SIGNAL(statusMessage(QString)) );
 451
 452   connect( w, SIGNAL( fullSearchRequest() ), this, SIGNAL( fullSearchRequest() ) );
 453   d->updateTabControls();
 454   setCurrentWidget( w );
 455 }
 456
 457 QItemSelection Pane::Private::mapSelectionToSource( const QItemSelection &selection ) const
 458 {
 459   QItemSelection result = selection;
 460
 461   foreach ( const QAbstractProxyModel *proxy, mProxyStack ) {
 462     result = proxy->mapSelectionToSource( result );
 463   }
 464
 465   return result;
 466 }
 467
 468 QItemSelection Pane::Private::mapSelectionFromSource( const QItemSelection &selection ) const
 469 {
 470   QItemSelection result = selection;
 471
 472   typedef QList<const QAbstractProxyModel*>::ConstIterator Iterator;
 473
 474   for ( Iterator it = mProxyStack.end()-1; it!=mProxyStack.begin(); --it ) {
 475     result = (*it)->mapSelectionFromSource( result );
 476   }
 477   result = mProxyStack.first()->mapSelectionFromSource( result );
 478
 479   return result;
 480 }
 481
 482 void Pane::Private::updateTabControls()
 483 {
 484   mCloseTabButton->setEnabled( q->count()>1 );
 485
 486   if ( Core::Settings::self()->autoHideTabBarWithSingleTab() ) {
 487     q->tabBar()->setVisible( q->count()>1 );
 488   } else {
 489     q->tabBar()->setVisible( true );
 490   }
 491 }
 492
 493 Item Pane::currentItem() const
 494 {
 495   Widget *w = static_cast<Widget*>( currentWidget() );
 496
 497   if ( w == 0 ) {
 498     return Item();
 499   }
 500
 501   return w->currentItem();
 502 }
 503
 504 KMime::Message::Ptr Pane::currentMessage() const
 505 {
 506   Widget *w = static_cast<Widget*>( currentWidget() );
 507
 508   if ( w == 0 ) {
 509     return KMime::Message::Ptr();
 510   }
 511
 512   return w->currentMessage();
 513 }
 514
 515 QList<KMime::Message::Ptr > Pane::selectionAsMessageList( bool includeCollapsedChildren ) const
 516 {
 517   Widget *w = static_cast<Widget*>( currentWidget() );
 518   if ( w == 0 ) {
 519     return QList<KMime::Message::Ptr>();
 520   }
 521   return w->selectionAsMessageList( includeCollapsedChildren );
 522 }
 523
 524 QList<Akonadi::Item> Pane::selectionAsMessageItemList( bool includeCollapsedChildren ) const
 525 {
 526   Widget *w = static_cast<Widget*>( currentWidget() );
 527   if ( w == 0 ) {
 528     return QList<Akonadi::Item>();
 529   }
 530   return w->selectionAsMessageItemList( includeCollapsedChildren );
 531 }
 532
 533
 534 QList<Akonadi::Item> Pane::currentThreadAsMessageList() const
 535 {
 536   Widget *w = static_cast<Widget*>( currentWidget() );
 537   if ( w == 0 ) {
 538     return QList<Akonadi::Item>();
 539   }
 540   return w->currentThreadAsMessageList();
 541 }
 542
 543 QList<Akonadi::Item> Pane::itemListFromPersistentSet( MessageList::Core::MessageItemSetReference ref )
 544 {
 545   Widget *w = static_cast<Widget*>( currentWidget() );
 546   if ( w == 0 ) {
 547     return QList<Akonadi::Item>();
 548   }
 549   return w->itemListFromPersistentSet(ref);
 550
 551 }
 552
 553 void Pane::deletePersistentSet( MessageList::Core::MessageItemSetReference ref )
 554 {
 555   Widget *w = static_cast<Widget*>( currentWidget() );
 556   if ( w ) {
 557     w->deletePersistentSet( ref );
 558   }
 559 }
 560
 561 void Pane::markMessageItemsAsAboutToBeRemoved( MessageList::Core::MessageItemSetReference ref, bool bMark )
 562 {
 563   Widget *w = static_cast<Widget*>( currentWidget() );
 564   if ( w ) {
 565     w->markMessageItemsAsAboutToBeRemoved( ref, bMark );
 566   }
 567 }
 568
 569 KPIM::MessageStatus Pane::currentFilterStatus() const
 570 {
 571   Widget *w = static_cast<Widget*>( currentWidget() );
 572   if ( w == 0 ) {
 573     return KPIM::MessageStatus();
 574   }
 575   return w->currentFilterStatus();
 576 }
 577
 578 QString Pane::currentFilterSearchString() const
 579 {
 580   Widget *w = static_cast<Widget*>( currentWidget() );
 581   if ( w == 0 ) {
 582     return QString();
 583   }
 584   return w->currentFilterSearchString();
 585 }
 586
 587 bool Pane::isThreaded() const
 588 {
 589   Widget *w = static_cast<Widget*>( currentWidget() );
 590   if ( w == 0 ) {
 591     return false;
 592   }
 593   return w->isThreaded();
 594 }
 595
 596 bool Pane::selectionEmpty() const
 597 {
 598   Widget *w = static_cast<Widget*>( currentWidget() );
 599   if ( w == 0 ) {
 600     return false;
 601   }
 602   return w->selectionEmpty();
 603 }
 604
 605 bool Pane::getSelectionStats( Akonadi::Item::List &selectedItems,
 606                               Akonadi::Item::List &selectedVisibleItems,
 607                               bool * allSelectedBelongToSameThread,
 608                               bool includeCollapsedChildren ) const
 609 {
 610   Widget * w = static_cast<Widget*>( currentWidget() );
 611   if ( w == 0 ) {
 612     return false;
 613   }
 614
 615   return w->getSelectionStats(
 616       selectedItems, selectedVisibleItems,
 617       allSelectedBelongToSameThread, includeCollapsedChildren
 618     );
 619 }
 620
 621 MessageList::Core::MessageItemSetReference Pane::selectionAsPersistentSet( bool includeCollapsedChildren ) const
 622 {
 623   Widget *w = static_cast<Widget*>( currentWidget() );
 624   if ( w == 0 )
 625     return -1;
 626   return w->selectionAsPersistentSet( includeCollapsedChildren );
 627 }
 628
 629 MessageList::Core::MessageItemSetReference Pane::currentThreadAsPersistentSet() const
 630 {
 631   Widget *w = static_cast<Widget*>( currentWidget() );
 632   if ( w == 0 )
 633     return -1;
 634   return w->currentThreadAsPersistentSet();
 635 }
 636
 637 void Pane::focusView()
 638 {
 639   Widget *w = static_cast<Widget*>( currentWidget() );
 640   if ( w ) {
 641     QWidget *view = w->view();
 642     if ( view )
 643       view->setFocus();
 644   }
 645 }
 646
 647 void Pane::reloadGlobalConfiguration()
 648 {
 649   d->updateTabControls();
 650
 651   Core::Settings::self()->writeConfig();
 652 }
 653
 654 #include "pane.moc"