okular/ui/ktreeviewsearchline.cpp

   1 /*
   2    Copyright (c) 2003 Scott Wheeler <wheeler@kde.org>
   3    Copyright (c) 2005 Rafal Rzepecki <divide@users.sourceforge.net>
   4    Copyright (c) 2006 Hamish Rodda <rodda@kde.org>
   5    Copyright 2007 Pino Toscano <pino@kde.org>
   6
   7    This library is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU Library General Public
   9    License version 2 as published by the Free Software Foundation.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Library General Public License for more details.
  15
  16    You should have received a copy of the GNU Library General Public License
  17    along with this library; see the file COPYING.LIB.  If not, write to
  18    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19    Boston, MA 02110-1301, USA.
  20 */
  21
  22 #include "ktreeviewsearchline.h"
  23
  24 #include <QtCore/QList>
  25 #include <QtCore/QTimer>
  26 #include <QtGui/QApplication>
  27 #include <QtGui/QContextMenuEvent>
  28 #include <QtGui/QHBoxLayout>
  29 #include <QtGui/QHeaderView>
  30 #include <QtGui/QLabel>
  31 #include <QtGui/QMenu>
  32 #include <QtGui/QToolButton>
  33 #include <QtGui/QTreeView>
  34
  35 #include <kdebug.h>
  36 #include <kiconloader.h>
  37 #include <klocale.h>
  38 #include <ktoolbar.h>
  39
  40 class KTreeViewSearchLine::Private
  41 {
  42   public:
  43     Private( KTreeViewSearchLine *_parent )
  44       : parent( _parent ),
  45         caseSensitive( Qt::CaseInsensitive ),
  46         activeSearch( false ),
  47         keepParentsVisible( true ),
  48         canChooseColumns( true ),
  49         queuedSearches( 0 )
  50     {
  51     }
  52
  53     KTreeViewSearchLine *parent;
  54     QList<QTreeView *> treeViews;
  55     Qt::CaseSensitivity caseSensitive;
  56     bool activeSearch;
  57     bool keepParentsVisible;
  58     bool canChooseColumns;
  59     QString search;
  60     int queuedSearches;
  61     QList<int> searchColumns;
  62
  63     void rowsInserted(const QModelIndex & parent, int start, int end) const;
  64     void treeViewDeleted( QObject *treeView );
  65     void slotColumnActivated(QAction* action);
  66     void slotAllVisibleColumns();
  67
  68     void checkColumns();
  69     void checkItemParentsNotVisible(QTreeView *treeView);
  70     bool checkItemParentsVisible(QTreeView *treeView, const QModelIndex &index);
  71 };
  72
  73 ////////////////////////////////////////////////////////////////////////////////
  74 // private slots
  75 ////////////////////////////////////////////////////////////////////////////////
  76
  77 void KTreeViewSearchLine::Private::rowsInserted( const QModelIndex & parentIndex, int start, int end ) const
  78 {
  79   QAbstractItemModel* model = qobject_cast<QAbstractItemModel*>( parent->sender() );
  80   if ( !model )
  81     return;
  82
  83   QTreeView* widget = 0L;
  84   foreach ( QTreeView* tree, treeViews )
  85     if ( tree->model() == model ) {
  86       widget = tree;
  87       break;
  88     }
  89
  90   if ( !widget )
  91     return;
  92
  93   for ( int i = start; i <= end; ++i ) {
  94      widget->setRowHidden( i, parentIndex, !parent->itemMatches( parentIndex, i, parent->text() ) );
  95   }
  96 }
  97
  98 void KTreeViewSearchLine::Private::treeViewDeleted( QObject *object )
  99 {
 100   treeViews.removeAll( static_cast<QTreeView *>( object ) );
 101   parent->setEnabled( treeViews.isEmpty() );
 102 }
 103
 104 void KTreeViewSearchLine::Private::slotColumnActivated( QAction *action )
 105 {
 106   if ( !action )
 107     return;
 108
 109   bool ok;
 110   int column = action->data().toInt( &ok );
 111
 112   if ( !ok )
 113     return;
 114
 115   if ( action->isChecked() ) {
 116     if ( !searchColumns.isEmpty() ) {
 117       if ( !searchColumns.contains( column ) )
 118         searchColumns.append( column );
 119
 120       if ( searchColumns.count() == treeViews.first()->header()->count() - treeViews.first()->header()->hiddenSectionCount() )
 121         searchColumns.clear();
 122
 123     } else {
 124       searchColumns.append( column );
 125     }
 126   } else {
 127     if ( searchColumns.isEmpty() ) {
 128       QHeaderView* const header = treeViews.first()->header();
 129
 130       for ( int i = 0; i < header->count(); i++ ) {
 131         if ( i != column && !header->isSectionHidden( i ) )
 132           searchColumns.append( i );
 133       }
 134
 135     } else if ( searchColumns.contains( column ) ) {
 136       searchColumns.removeAll( column );
 137     }
 138   }
 139
 140   parent->updateSearch();
 141 }
 142
 143 void KTreeViewSearchLine::Private::slotAllVisibleColumns()
 144 {
 145   if ( searchColumns.isEmpty() )
 146     searchColumns.append( 0 );
 147   else
 148     searchColumns.clear();
 149
 150   parent->updateSearch();
 151 }
 152
 153 ////////////////////////////////////////////////////////////////////////////////
 154 // private methods
 155 ////////////////////////////////////////////////////////////////////////////////
 156
 157
 158 void KTreeViewSearchLine::Private::checkColumns()
 159 {
 160   canChooseColumns = parent->canChooseColumnsCheck();
 161 }
 162
 163 void KTreeViewSearchLine::Private::checkItemParentsNotVisible( QTreeView *treeView )
 164 {
 165 // TODO: PORT ME
 166 #if 0
 167   QTreeWidgetItemIterator it( treeWidget );
 168
 169   for ( ; *it; ++it ) {
 170     QTreeWidgetItem *item = *it;
 171     item->treeWidget()->setItemHidden( item, !parent->itemMatches( item, search ) );
 172   }
 173 #endif
 174 }
 175
 176 #include <kvbox.h>
 177
 178 /** Check whether \p item, its siblings and their descendents should be shown. Show or hide the items as necessary.
 179  *
 180  *  \p item  The list view item to start showing / hiding items at. Typically, this is the first child of another item, or the
 181  *              the first child of the list view.
 182  *  \return \c true if an item which should be visible is found, \c false if all items found should be hidden. If this function
 183  *             returns true and \p highestHiddenParent was not 0, highestHiddenParent will have been shown.
 184  */
 185 bool KTreeViewSearchLine::Private::checkItemParentsVisible( QTreeView *treeView, const QModelIndex &index )
 186 {
 187   bool childMatch = false;
 188   const int rowcount = treeView->model()->rowCount( index );
 189   for ( int i = 0; i < rowcount; ++i )
 190     childMatch |= checkItemParentsVisible( treeView, treeView->model()->index( i, 0, index ) );
 191
 192   // Should this item be shown? It should if any children should be, or if it matches.
 193   const QModelIndex parentindex = index.parent();
 194   if ( childMatch || parent->itemMatches( parentindex, index.row(), search ) ) {
 195     treeView->setRowHidden( index.row(), parentindex, false );
 196     return true;
 197   }
 198
 199   treeView->setRowHidden( index.row(), parentindex, true );
 200
 201   return false;
 202 }
 203
 204
 205 ////////////////////////////////////////////////////////////////////////////////
 206 // public methods
 207 ////////////////////////////////////////////////////////////////////////////////
 208
 209 KTreeViewSearchLine::KTreeViewSearchLine( QWidget *parent, QTreeView *treeView )
 210   : KLineEdit( parent ), d( new Private( this ) )
 211 {
 212   connect( this, SIGNAL( textChanged( const QString& ) ),
 213            this, SLOT( queueSearch( const QString& ) ) );
 214
 215   setClearButtonShown( true );
 216   setTreeView( treeView );
 217
 218   if ( !treeView ) {
 219       setEnabled( false );
 220   }
 221 }
 222
 223 KTreeViewSearchLine::KTreeViewSearchLine( QWidget *parent,
 224                                               const QList<QTreeView *> &treeViews )
 225   : KLineEdit( parent ), d( new Private( this ) )
 226 {
 227   connect( this, SIGNAL( textChanged( const QString& ) ),
 228            this, SLOT( queueSearch( const QString& ) ) );
 229
 230   setClearButtonShown( true );
 231   setTreeViews( treeViews );
 232 }
 233
 234 KTreeViewSearchLine::~KTreeViewSearchLine()
 235 {
 236   delete d;
 237 }
 238
 239 Qt::CaseSensitivity KTreeViewSearchLine::caseSensitivity() const
 240 {
 241   return d->caseSensitive;
 242 }
 243
 244 QList<int> KTreeViewSearchLine::searchColumns() const
 245 {
 246   if ( d->canChooseColumns )
 247     return d->searchColumns;
 248   else
 249     return QList<int>();
 250 }
 251
 252 bool KTreeViewSearchLine::keepParentsVisible() const
 253 {
 254   return d->keepParentsVisible;
 255 }
 256
 257 QTreeView *KTreeViewSearchLine::treeView() const
 258 {
 259   if ( d->treeViews.count() == 1 )
 260     return d->treeViews.first();
 261   else
 262     return 0;
 263 }
 264
 265 QList<QTreeView *> KTreeViewSearchLine::treeViews() const
 266 {
 267   return d->treeViews;
 268 }
 269
 270
 271 ////////////////////////////////////////////////////////////////////////////////
 272 // public slots
 273 ////////////////////////////////////////////////////////////////////////////////
 274
 275 void KTreeViewSearchLine::addTreeView( QTreeView *treeView )
 276 {
 277   if ( treeView ) {
 278     connectTreeView( treeView );
 279
 280     d->treeViews.append( treeView );
 281     setEnabled( !d->treeViews.isEmpty() );
 282
 283     d->checkColumns();
 284   }
 285 }
 286
 287 void KTreeViewSearchLine::removeTreeView( QTreeView *treeView )
 288 {
 289   if ( treeView ) {
 290     int index = d->treeViews.indexOf( treeView );
 291
 292     if ( index != -1 ) {
 293       d->treeViews.removeAt( index );
 294       d->checkColumns();
 295
 296       disconnectTreeView( treeView );
 297
 298       setEnabled( !d->treeViews.isEmpty() );
 299     }
 300   }
 301 }
 302
 303 void KTreeViewSearchLine::updateSearch( const QString &pattern )
 304 {
 305   d->search = pattern.isNull() ? text() : pattern;
 306
 307   foreach ( QTreeView* treeView, d->treeViews )
 308     updateSearch( treeView );
 309 }
 310
 311 void KTreeViewSearchLine::updateSearch( QTreeView *treeView )
 312 {
 313   if ( !treeView || !treeView->model()->rowCount() )
 314     return;
 315
 316
 317   // If there's a selected item that is visible, make sure that it's visible
 318   // when the search changes too (assuming that it still matches).
 319
 320   QModelIndex currentIndex = treeView->currentIndex();
 321
 322   bool wasUpdateEnabled = treeView->updatesEnabled();
 323   treeView->setUpdatesEnabled( false );
 324   if ( d->keepParentsVisible )
 325     for ( int i = 0; i < treeView->model()->rowCount(); ++i )
 326       d->checkItemParentsVisible( treeView, treeView->rootIndex() );
 327   else
 328     d->checkItemParentsNotVisible( treeView );
 329   treeView->setUpdatesEnabled( wasUpdateEnabled );
 330
 331   if ( currentIndex.isValid() )
 332     treeView->scrollTo( currentIndex );
 333 }
 334
 335 void KTreeViewSearchLine::setCaseSensitivity( Qt::CaseSensitivity caseSensitive )
 336 {
 337   if ( d->caseSensitive != caseSensitive ) {
 338     d->caseSensitive = caseSensitive;
 339     updateSearch();
 340   }
 341 }
 342
 343 void KTreeViewSearchLine::setKeepParentsVisible( bool visible )
 344 {
 345   if ( d->keepParentsVisible != visible ) {
 346     d->keepParentsVisible = visible;
 347     updateSearch();
 348   }
 349 }
 350
 351 void KTreeViewSearchLine::setSearchColumns( const QList<int> &columns )
 352 {
 353   if ( d->canChooseColumns )
 354     d->searchColumns = columns;
 355 }
 356
 357 void KTreeViewSearchLine::setTreeView( QTreeView *treeView )
 358 {
 359   setTreeViews( QList<QTreeView *>() );
 360   addTreeView( treeView );
 361 }
 362
 363 void KTreeViewSearchLine::setTreeViews( const QList<QTreeView *> &treeViews )
 364 {
 365   foreach ( QTreeView* treeView, d->treeViews )
 366     disconnectTreeView( treeView );
 367
 368   d->treeViews = treeViews;
 369
 370   foreach ( QTreeView* treeView, d->treeViews )
 371     connectTreeView( treeView );
 372
 373   d->checkColumns();
 374
 375   setEnabled( !d->treeViews.isEmpty() );
 376 }
 377
 378 ////////////////////////////////////////////////////////////////////////////////
 379 // protected members
 380 ////////////////////////////////////////////////////////////////////////////////
 381
 382 bool KTreeViewSearchLine::itemMatches( const QModelIndex &index, int row, const QString &pattern ) const
 383 {
 384   if ( pattern.isEmpty() )
 385     return true;
 386
 387   if ( !index.isValid() )
 388     return false;
 389
 390   // If the search column list is populated, search just the columns
 391   // specifified.  If it is empty default to searching all of the columns.
 392
 393   const int columncount = index.model()->columnCount( index );
 394   if ( !d->searchColumns.isEmpty() ) {
 395     QList<int>::ConstIterator it = d->searchColumns.constBegin();
 396     for ( ; it != d->searchColumns.constEnd(); ++it ) {
 397       if ( *it < columncount &&
 398            index.child( row, *it ).data( Qt::DisplayRole ).toString().indexOf( pattern, 0, d->caseSensitive ) >= 0 )
 399         return true;
 400     }
 401   } else {
 402     for ( int i = 0; i < columncount; ++i) {
 403       if ( index.child( row, i ).data( Qt::DisplayRole ).toString().indexOf( pattern, 0, d->caseSensitive ) >= 0 )
 404         return true;
 405     }
 406   }
 407
 408   return false;
 409 }
 410
 411 void KTreeViewSearchLine::contextMenuEvent( QContextMenuEvent *event )
 412 {
 413   QMenu *popup = KLineEdit::createStandardContextMenu();
 414
 415   if ( d->canChooseColumns ) {
 416     popup->addSeparator();
 417     QMenu *subMenu = popup->addMenu( i18n("Search Columns") );
 418
 419     QAction* allVisibleColumnsAction = subMenu->addAction( i18n("All Visible Columns"),
 420                                                            this, SLOT( slotAllVisibleColumns() ) );
 421     allVisibleColumnsAction->setCheckable( true );
 422     allVisibleColumnsAction->setChecked( !d->searchColumns.count() );
 423     subMenu->addSeparator();
 424
 425     bool allColumnsAreSearchColumns = true;
 426
 427     QActionGroup* group = new QActionGroup( popup );
 428     group->setExclusive( false );
 429     connect( group, SIGNAL( triggered( QAction* ) ), SLOT( slotColumnActivated( QAction* ) ) );
 430
 431     QHeaderView* const header = d->treeViews.first()->header();
 432     for ( int j = 0; j < header->count(); j++ ) {
 433       int i = header->logicalIndex( j );
 434
 435       if ( header->isSectionHidden( i ) )
 436         continue;
 437
 438       QString columnText = header->model()->headerData( i, Qt::Horizontal, Qt::DisplayRole ).toString();
 439       QAction* columnAction = subMenu->addAction( qvariant_cast<QIcon>( header->model()->headerData( i, Qt::Horizontal, Qt::DecorationRole ) ), columnText );
 440       columnAction->setCheckable( true );
 441       columnAction->setChecked( d->searchColumns.isEmpty() || d->searchColumns.contains( i ) );
 442       columnAction->setData( i );
 443       columnAction->setActionGroup( group );
 444
 445       if ( d->searchColumns.isEmpty() || d->searchColumns.indexOf( i ) != -1 )
 446         columnAction->setChecked( true );
 447       else
 448         allColumnsAreSearchColumns = false;
 449     }
 450
 451     allVisibleColumnsAction->setChecked( allColumnsAreSearchColumns );
 452
 453     // searchColumnsMenuActivated() relies on one possible "all" representation
 454     if ( allColumnsAreSearchColumns && !d->searchColumns.isEmpty() )
 455       d->searchColumns.clear();
 456   }
 457
 458   popup->exec( event->globalPos() );
 459   delete popup;
 460 }
 461
 462 void KTreeViewSearchLine::connectTreeView( QTreeView *treeView )
 463 {
 464   connect( treeView, SIGNAL( destroyed( QObject* ) ),
 465            this, SLOT( treeViewDeleted( QObject* ) ) );
 466
 467   connect( treeView->model(), SIGNAL( rowsInserted( const QModelIndex&, int, int) ),
 468            this, SLOT( rowsInserted( const QModelIndex&, int, int ) ) );
 469 }
 470
 471 void KTreeViewSearchLine::disconnectTreeView( QTreeView *treeView )
 472 {
 473   disconnect( treeView, SIGNAL( destroyed( QObject* ) ),
 474               this, SLOT( treeViewDeleted( QObject* ) ) );
 475
 476   disconnect( treeView->model(), SIGNAL( rowsInserted( const QModelIndex&, int, int) ),
 477               this, SLOT( rowsInserted( const QModelIndex&, int, int ) ) );
 478 }
 479
 480 bool KTreeViewSearchLine::canChooseColumnsCheck()
 481 {
 482   // This is true if either of the following is true:
 483
 484   // there are no listviews connected
 485   if ( d->treeViews.isEmpty() )
 486     return false;
 487
 488   const QTreeView *first = d->treeViews.first();
 489
 490   const int numcols = first->model()->columnCount();
 491   // the listviews have only one column,
 492   if ( numcols < 2 )
 493     return false;
 494
 495   QStringList headers;
 496   for ( int i = 0; i < numcols; ++i )
 497     headers.append( first->header()->model()->headerData( i, Qt::Horizontal, Qt::DisplayRole ).toString() );
 498
 499   QList<QTreeView *>::ConstIterator it = d->treeViews.constBegin();
 500   for ( ++it /* skip the first one */; it != d->treeViews.constEnd(); ++it ) {
 501     // the listviews have different numbers of columns,
 502     if ( (*it)->model()->columnCount() != numcols )
 503       return false;
 504
 505     // the listviews differ in column labels.
 506     QStringList::ConstIterator jt;
 507     int i;
 508     for ( i = 0, jt = headers.constBegin(); i < numcols; ++i, ++jt ) {
 509       Q_ASSERT( jt != headers.constEnd() );
 510
 511       if ( (*it)->header()->model()->headerData( i, Qt::Horizontal, Qt::DisplayRole ).toString() != *jt )
 512         return false;
 513     }
 514   }
 515
 516   return true;
 517 }
 518
 519 ////////////////////////////////////////////////////////////////////////////////
 520 // protected slots
 521 ////////////////////////////////////////////////////////////////////////////////
 522
 523 void KTreeViewSearchLine::queueSearch( const QString &search )
 524 {
 525   d->queuedSearches++;
 526   d->search = search;
 527
 528   QTimer::singleShot( 200, this, SLOT( activateSearch() ) );
 529 }
 530
 531 void KTreeViewSearchLine::activateSearch()
 532 {
 533   --(d->queuedSearches);
 534
 535   if ( d->queuedSearches == 0 )
 536     updateSearch( d->search );
 537 }
 538
 539 ////////////////////////////////////////////////////////////////////////////////
 540 // KTreeViewSearchLineWidget
 541 ////////////////////////////////////////////////////////////////////////////////
 542
 543 class KTreeViewSearchLineWidget::Private
 544 {
 545   public:
 546     Private()
 547       : treeView( 0 ),
 548         searchLine( 0 )
 549     {
 550     }
 551
 552     QTreeView *treeView;
 553     KTreeViewSearchLine *searchLine;
 554 };
 555
 556 KTreeViewSearchLineWidget::KTreeViewSearchLineWidget( QWidget *parent, QTreeView *treeView )
 557   : QWidget( parent ), d( new Private )
 558 {
 559   d->treeView = treeView;
 560
 561   QTimer::singleShot( 0, this, SLOT( createWidgets() ) );
 562 }
 563
 564 KTreeViewSearchLineWidget::~KTreeViewSearchLineWidget()
 565 {
 566   delete d;
 567 }
 568
 569 KTreeViewSearchLine *KTreeViewSearchLineWidget::createSearchLine( QTreeView *treeView ) const
 570 {
 571   return new KTreeViewSearchLine( const_cast<KTreeViewSearchLineWidget*>(this), treeView );
 572 }
 573
 574 void KTreeViewSearchLineWidget::createWidgets()
 575 {
 576   QLabel *label = new QLabel( i18n("S&earch:"), this );
 577   label->setObjectName( QLatin1String("kde toolbar widget") );
 578
 579   searchLine()->show();
 580
 581   label->setBuddy( d->searchLine );
 582   label->show();
 583
 584   QHBoxLayout* layout = new QHBoxLayout( this );
 585   layout->setSpacing( 5 );
 586   layout->setMargin( 0 );
 587   layout->addWidget( label );
 588   layout->addWidget( d->searchLine );
 589 }
 590
 591 KTreeViewSearchLine *KTreeViewSearchLineWidget::searchLine() const
 592 {
 593   if ( !d->searchLine )
 594     d->searchLine = createSearchLine( d->treeView );
 595
 596   return d->searchLine;
 597 }
 598
 599 #include "ktreeviewsearchline.moc"