okular/ui/side_reviews.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Enrico Ros <eros.kde@email.it>                  *
   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
  10 #include "side_reviews.h"
  11
  12 // qt/kde includes
  13 #include <QtCore/QStringList>
  14 #include <QtGui/QHeaderView>
  15 #include <QtGui/QLayout>
  16 #include <QtGui/QPaintEvent>
  17 #include <QtGui/QPainter>
  18 #include <QtGui/QSizePolicy>
  19 #include <QtGui/QTextDocument>
  20 #include <QtGui/QToolBar>
  21 #include <QtGui/QTreeView>
  22
  23 #include <kaction.h>
  24 #include <klocale.h>
  25 #include <kiconloader.h>
  26 #include <kicon.h>
  27
  28 // local includes
  29 #include "core/annotations.h"
  30 #include "core/document.h"
  31 #include "core/page.h"
  32 #include "settings.h"
  33 #include "annotationpopup.h"
  34 #include "annotationproxymodels.h"
  35 #include "annotationmodel.h"
  36 #include "ktreeviewsearchline.h"
  37
  38 class TreeView : public QTreeView
  39 {
  40   public:
  41     TreeView( Okular::Document *document, QWidget *parent = 0 )
  42       : QTreeView( parent ), m_document( document )
  43     {
  44     }
  45
  46   protected:
  47     virtual void paintEvent( QPaintEvent *event )
  48     {
  49       bool hasAnnotations = false;
  50       for ( uint i = 0; i < m_document->pages(); ++i )
  51         if ( m_document->page( i )->hasAnnotations() ) {
  52           hasAnnotations = true;
  53           break;
  54         }
  55       if ( !hasAnnotations ) {
  56         QPainter p( viewport() );
  57         p.setRenderHint( QPainter::Antialiasing, true );
  58         p.setClipRect( event->rect() );
  59
  60         QTextDocument document;
  61         document.setHtml( i18n( "<div align=center><h3>No annotations</h3>"
  62                                 "To create new annotations press F6 or select <i>Tools -&gt; Review</i>"
  63                                 " from the menu.</div>" ) );
  64         document.setTextWidth( width() - 50 );
  65
  66         const uint w = document.size().width() + 20;
  67         const uint h = document.size().height() + 20;
  68
  69         p.setBrush( palette().background() );
  70         p.translate( 0.5, 0.5 );
  71         p.drawRoundRect( 15, 15, w, h, (8*200)/w, (8*200)/h );
  72         p.translate( 20, 20 );
  73         document.drawContents( &p );
  74
  75       } else {
  76         QTreeView::paintEvent( event );
  77       }
  78     }
  79
  80   private:
  81     Okular::Document *m_document;
  82 };
  83
  84
  85 Reviews::Reviews( QWidget * parent, Okular::Document * document )
  86     : QWidget( parent ), m_document( document )
  87 {
  88     // create widgets and layout them vertically
  89     QVBoxLayout * vLayout = new QVBoxLayout( this );
  90     vLayout->setMargin( 0 );
  91     vLayout->setSpacing( 6 );
  92
  93     m_view = new TreeView( m_document, this );
  94     m_view->setAlternatingRowColors( true );
  95     m_view->setSelectionMode( QAbstractItemView::ExtendedSelection );
  96     m_view->header()->hide();
  97
  98     QToolBar *toolBar = new QToolBar( this );
  99     toolBar->setObjectName( "reviewOptsBar" );
 100     QSizePolicy sp = toolBar->sizePolicy();
 101     sp.setVerticalPolicy( QSizePolicy::Minimum );
 102     toolBar->setSizePolicy( sp );
 103
 104     m_model = new AnnotationModel( m_document, m_view );
 105
 106     m_filterProxy = new PageFilterProxyModel( m_view );
 107     m_groupProxy = new PageGroupProxyModel( m_view );
 108     m_authorProxy  = new AuthorGroupProxyModel( m_view );
 109
 110     m_filterProxy->setSourceModel( m_model );
 111     m_groupProxy->setSourceModel( m_filterProxy );
 112     m_authorProxy->setSourceModel( m_groupProxy );
 113
 114
 115     m_view->setModel( m_authorProxy );
 116
 117     vLayout->addWidget( new KTreeViewSearchLine( this, m_view ) );
 118     vLayout->addWidget( m_view );
 119     vLayout->addWidget( toolBar );
 120
 121     toolBar->setIconSize( QSize( 16, 16 ) );
 122     toolBar->setMovable( false );
 123     // - add Page button
 124     QAction * groupByPageAction = toolBar->addAction( KIcon( "text-x-generic" ), i18n( "Group by Page" ) );
 125     groupByPageAction->setCheckable( true );
 126     connect( groupByPageAction, SIGNAL( toggled( bool ) ), this, SLOT( slotPageEnabled( bool ) ) );
 127     groupByPageAction->setChecked( Okular::Settings::groupByPage() );
 128     // - add Author button
 129     QAction * groupByAuthorAction = toolBar->addAction( KIcon( "user-identity" ), i18n( "Group by Author" ) );
 130     groupByAuthorAction->setCheckable( true );
 131     connect( groupByAuthorAction, SIGNAL( toggled( bool ) ), this, SLOT( slotAuthorEnabled( bool ) ) );
 132     groupByAuthorAction->setChecked( Okular::Settings::groupByAuthor() );
 133
 134     // - add separator
 135     toolBar->addSeparator();
 136     // - add Current Page Only button
 137     QAction * curPageOnlyAction = toolBar->addAction( KIcon( "arrow-down" ), i18n( "Show reviews for current page only" ) );
 138     curPageOnlyAction->setCheckable( true );
 139     connect( curPageOnlyAction, SIGNAL( toggled( bool ) ), this, SLOT( slotCurrentPageOnly( bool ) ) );
 140     curPageOnlyAction->setChecked( Okular::Settings::currentPageOnly() );
 141
 142     connect( m_view, SIGNAL( activated( const QModelIndex& ) ),
 143              this, SLOT( activated( const QModelIndex& ) ) );
 144
 145     m_view->setContextMenuPolicy( Qt::CustomContextMenu );
 146     connect( m_view, SIGNAL( customContextMenuRequested( const QPoint& ) ),
 147              this, SLOT( contextMenuRequested( const QPoint& ) ) );
 148
 149 }
 150
 151 Reviews::~Reviews()
 152 {
 153     m_document->removeObserver( this );
 154 }
 155
 156 //BEGIN DocumentObserver Notifies
 157 void Reviews::notifyViewportChanged( bool )
 158 {
 159     m_filterProxy->setCurrentPage( m_document->currentPage() );
 160 }
 161 //END DocumentObserver Notifies
 162
 163 //BEGIN GUI Slots -> requestListViewUpdate
 164 void Reviews::slotPageEnabled( bool on )
 165 {
 166     // store toggle state in Settings and update the listview
 167     Okular::Settings::setGroupByPage( on );
 168     m_groupProxy->groupByPage( on );
 169
 170     m_view->expandAll();
 171 }
 172
 173 void Reviews::slotAuthorEnabled( bool on )
 174 {
 175     // store toggle state in Settings and update the listview
 176     Okular::Settings::setGroupByAuthor( on );
 177     m_authorProxy->groupByAuthor( on );
 178
 179     m_view->expandAll();
 180 }
 181
 182 void Reviews::slotCurrentPageOnly( bool on )
 183 {
 184     // store toggle state in Settings and update the listview
 185     Okular::Settings::setCurrentPageOnly( on );
 186     m_filterProxy->groupByCurrentPage( on );
 187
 188     m_view->expandAll();
 189 }
 190 //END GUI Slots
 191
 192
 193 void Reviews::activated( const QModelIndex &index )
 194 {
 195     const QModelIndex authorIndex = m_authorProxy->mapToSource( index );
 196     const QModelIndex filterIndex = m_groupProxy->mapToSource( authorIndex );
 197     const QModelIndex annotIndex = m_filterProxy->mapToSource( filterIndex );
 198
 199     Okular::Annotation *annotation = m_model->annotationForIndex( annotIndex );
 200     if ( !annotation )
 201       return;
 202
 203     int pageNumber = m_model->data( annotIndex, AnnotationModel::PageRole ).toInt();
 204     const Okular::Page * page = m_document->page( pageNumber );
 205
 206     // calculating the right coordinates to center the view on the annotation
 207     QRect rect = Okular::AnnotationUtils::annotationGeometry( annotation, page->width(), page->height() );
 208     Okular::NormalizedRect nr( rect, (int)page->width(), (int)page->height() );
 209     // set the viewport parameters
 210     Okular::DocumentViewport vp;
 211     vp.pageNumber = pageNumber;
 212     vp.rePos.enabled = true;
 213     vp.rePos.pos = Okular::DocumentViewport::Center;
 214     vp.rePos.normalizedX = ( nr.right + nr.left ) / 2.0;
 215     vp.rePos.normalizedY = ( nr.bottom + nr.top ) / 2.0;
 216     // setting the viewport
 217     m_document->setViewport( vp, -1, true );
 218 }
 219
 220 QModelIndexList Reviews::retrieveAnnotations(const QModelIndex& idx) const
 221 {
 222     QModelIndexList ret;
 223     if ( idx.isValid() )
 224     {
 225         if ( idx.model()->hasChildren( idx ) )
 226         {
 227             int rowCount = idx.model()->rowCount( idx );
 228             for ( int i = 0; i < rowCount; i++ )
 229             {
 230                 ret += retrieveAnnotations( idx.child( i, idx.column() ) );
 231             }
 232         }
 233         else
 234         {
 235             ret += idx;
 236         }
 237     }
 238
 239     return ret;
 240 }
 241
 242 void Reviews::contextMenuRequested( const QPoint &pos )
 243 {
 244     AnnotationPopup popup( m_document, this );
 245     connect( &popup, SIGNAL( setAnnotationWindow( Okular::Annotation* ) ),
 246              this, SIGNAL( setAnnotationWindow( Okular::Annotation* ) ) );
 247     connect( &popup, SIGNAL( removeAnnotationWindow( Okular::Annotation* ) ),
 248              this, SIGNAL( removeAnnotationWindow( Okular::Annotation* ) ) );
 249
 250     QModelIndexList indexes = m_view->selectionModel()->selectedIndexes();
 251     Q_FOREACH ( const QModelIndex &index, indexes )
 252     {
 253         QModelIndexList annotations = retrieveAnnotations(index);
 254         Q_FOREACH ( const QModelIndex &idx, annotations )
 255         {
 256             const QModelIndex authorIndex = m_authorProxy->mapToSource( idx );
 257             const QModelIndex filterIndex = m_groupProxy->mapToSource( authorIndex );
 258             const QModelIndex annotIndex = m_filterProxy->mapToSource( filterIndex );
 259             Okular::Annotation *annotation = m_model->annotationForIndex( annotIndex );
 260             if ( annotation )
 261             {
 262                 const int pageNumber = m_model->data( annotIndex, AnnotationModel::PageRole ).toInt();
 263                 popup.addAnnotation( annotation, pageNumber );
 264             }
 265         }
 266     }
 267
 268     popup.exec( m_view->viewport()->mapToGlobal( pos ) );
 269 }
 270
 271 #include "side_reviews.moc"