okular/ui/tocmodel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Pino Toscano <pino@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
  10 #include "tocmodel.h"
  11
  12 #include <qapplication.h>
  13 #include <qdom.h>
  14 #include <qlist.h>
  15
  16 #include <kicon.h>
  17
  18 #include "pageitemdelegate.h"
  19 #include "core/document.h"
  20 #include "core/page.h"
  21
  22 Q_DECLARE_METATYPE( QModelIndex )
  23
  24 struct TOCItem
  25 {
  26     TOCItem();
  27     TOCItem( TOCItem *parent, const QDomElement &e );
  28     ~TOCItem();
  29
  30     QString text;
  31     Okular::DocumentViewport viewport;
  32     QString extFileName;
  33     bool highlight : 1;
  34     TOCItem *parent;
  35     QList< TOCItem* > children;
  36     TOCModelPrivate *model;
  37 };
  38
  39
  40 class TOCModelPrivate
  41 {
  42 public:
  43     TOCModelPrivate( TOCModel *qq );
  44     ~TOCModelPrivate();
  45
  46     void addChildren( const QDomNode &parentNode, TOCItem * parentItem );
  47     QModelIndex indexForItem( TOCItem *item ) const;
  48     void findViewport( const Okular::DocumentViewport &viewport, TOCItem *item, QList< TOCItem* > &list ) const;
  49
  50     TOCModel *q;
  51     TOCItem *root;
  52     bool dirty : 1;
  53     Okular::Document *document;
  54     QList< TOCItem* > itemsToOpen;
  55     QList< TOCItem* > currentPage;
  56 };
  57
  58
  59 TOCItem::TOCItem()
  60     : highlight( false ), parent( 0 ), model( 0 )
  61 {
  62 }
  63
  64 TOCItem::TOCItem( TOCItem *_parent, const QDomElement &e )
  65     : highlight( false ), parent( _parent )
  66 {
  67     parent->children.append( this );
  68     model = parent->model;
  69     text = e.tagName();
  70
  71     // viewport loading
  72     if ( e.hasAttribute( "Viewport" ) )
  73     {
  74         // if the node has a viewport, set it
  75         viewport = Okular::DocumentViewport( e.attribute( "Viewport" ) );
  76     }
  77     else if ( e.hasAttribute( "ViewportName" ) )
  78     {
  79         // if the node references a viewport, get the reference and set it
  80         const QString & page = e.attribute( "ViewportName" );
  81         QString viewport_string = model->document->metaData( "NamedViewport", page ).toString();
  82         if ( !viewport_string.isEmpty() )
  83             viewport = Okular::DocumentViewport( viewport_string );
  84     }
  85
  86     extFileName = e.attribute( "ExternalFileName" );
  87 }
  88
  89 TOCItem::~TOCItem()
  90 {
  91     qDeleteAll( children );
  92 }
  93
  94
  95 TOCModelPrivate::TOCModelPrivate( TOCModel *qq )
  96     : q( qq ), root( new TOCItem ), dirty( false )
  97 {
  98     root->model = this;
  99 }
 100
 101 TOCModelPrivate::~TOCModelPrivate()
 102 {
 103     delete root;
 104 }
 105
 106 void TOCModelPrivate::addChildren( const QDomNode & parentNode, TOCItem * parentItem )
 107 {
 108     TOCItem * currentItem = 0;
 109     QDomNode n = parentNode.firstChild();
 110     while( !n.isNull() )
 111     {
 112         // convert the node to an element (sure it is)
 113         QDomElement e = n.toElement();
 114
 115         // insert the entry as top level (listview parented) or 2nd+ level
 116         currentItem = new TOCItem( parentItem, e );
 117
 118         // descend recursively and advance to the next node
 119         if ( e.hasChildNodes() )
 120             addChildren( n, currentItem );
 121
 122         // open/keep close the item
 123         bool isOpen = false;
 124         if ( e.hasAttribute( "Open" ) )
 125             isOpen = QVariant( e.attribute( "Open" ) ).toBool();
 126         if ( isOpen )
 127             itemsToOpen.append( currentItem );
 128
 129         n = n.nextSibling();
 130     }
 131 }
 132
 133 QModelIndex TOCModelPrivate::indexForItem( TOCItem *item ) const
 134 {
 135     if ( item->parent )
 136     {
 137         int id = item->parent->children.indexOf( item );
 138         if ( id >= 0 && id < item->parent->children.count() )
 139            return q->createIndex( id, 0, item );
 140     }
 141     return QModelIndex();
 142 }
 143
 144 void TOCModelPrivate::findViewport( const Okular::DocumentViewport &viewport, TOCItem *item, QList< TOCItem* > &list ) const
 145 {
 146     if ( item->viewport.isValid() && item->viewport.pageNumber == viewport.pageNumber )
 147         list.append( item );
 148
 149     foreach ( TOCItem *child, item->children )
 150         findViewport( viewport, child, list );
 151 }
 152
 153
 154 TOCModel::TOCModel( Okular::Document *document, QObject *parent )
 155     : QAbstractItemModel( parent ), d( new TOCModelPrivate( this ) )
 156 {
 157     d->document = document;
 158
 159     qRegisterMetaType< QModelIndex >();
 160 }
 161
 162 TOCModel::~TOCModel()
 163 {
 164     delete d;
 165 }
 166
 167 int TOCModel::columnCount( const QModelIndex &parent ) const
 168 {
 169     Q_UNUSED( parent )
 170     return 1;
 171 }
 172
 173 QVariant TOCModel::data( const QModelIndex &index, int role ) const
 174 {
 175     if ( !index.isValid() )
 176         return QVariant();
 177
 178     TOCItem *item = static_cast< TOCItem* >( index.internalPointer() );
 179     switch ( role )
 180     {
 181         case Qt::DisplayRole:
 182         case Qt::ToolTipRole:
 183             return item->text;
 184             break;
 185         case Qt::DecorationRole:
 186             if ( item->highlight )
 187                 return KIcon( QApplication::layoutDirection() == Qt::RightToLeft ? "arrow-left" : "arrow-right" );
 188             break;
 189         case PageItemDelegate::PageRole:
 190             if ( item->viewport.isValid() )
 191                 return item->viewport.pageNumber + 1;
 192             break;
 193         case PageItemDelegate::PageLabelRole:
 194             if ( item->viewport.isValid() )
 195                 return d->document->page( item->viewport.pageNumber )->label();
 196             break;
 197     }
 198     return QVariant();
 199 }
 200
 201 bool TOCModel::hasChildren( const QModelIndex &parent ) const
 202 {
 203     if ( !parent.isValid() )
 204         return true;
 205
 206     TOCItem *item = static_cast< TOCItem* >( parent.internalPointer() );
 207     return !item->children.isEmpty();
 208 }
 209
 210 QVariant TOCModel::headerData( int section, Qt::Orientation orientation, int role ) const
 211 {
 212     if ( orientation != Qt::Horizontal )
 213         return QVariant();
 214
 215     if ( section == 0 && role == Qt::DisplayRole )
 216         return "Topics";
 217
 218     return QVariant();
 219 }
 220
 221 QModelIndex TOCModel::index( int row, int column, const QModelIndex &parent ) const
 222 {
 223     if ( row < 0 || column != 0 )
 224         return QModelIndex();
 225
 226     TOCItem *item = parent.isValid() ? static_cast< TOCItem* >( parent.internalPointer() ) : d->root;
 227     if ( row < item->children.count() )
 228         return createIndex( row, column, item->children.at( row ) );
 229
 230     return QModelIndex();
 231 }
 232
 233 QModelIndex TOCModel::parent( const QModelIndex &index ) const
 234 {
 235     if ( !index.isValid() )
 236         return QModelIndex();
 237
 238     TOCItem *item = static_cast< TOCItem* >( index.internalPointer() );
 239     return d->indexForItem( item->parent );
 240 }
 241
 242 int TOCModel::rowCount( const QModelIndex &parent ) const
 243 {
 244     TOCItem *item = parent.isValid() ? static_cast< TOCItem* >( parent.internalPointer() ) : d->root;
 245     return item->children.count();
 246 }
 247
 248 void TOCModel::fill( const Okular::DocumentSynopsis *toc )
 249 {
 250     if ( !toc )
 251         return;
 252
 253     clear();
 254     emit layoutAboutToBeChanged();
 255     d->addChildren( *toc, d->root );
 256     d->dirty = true;
 257     emit layoutChanged();
 258     foreach ( TOCItem *item, d->itemsToOpen )
 259     {
 260         QModelIndex index = d->indexForItem( item );
 261         if ( !index.isValid() )
 262             continue;
 263
 264         QMetaObject::invokeMethod( QObject::parent(), "expand", Qt::QueuedConnection, Q_ARG( QModelIndex, index ) );
 265     }
 266     d->itemsToOpen.clear();
 267 }
 268
 269 void TOCModel::clear()
 270 {
 271     if ( !d->dirty )
 272        return;
 273
 274     qDeleteAll( d->root->children );
 275     d->root->children.clear();
 276     d->currentPage.clear();
 277     reset();
 278     d->dirty = false;
 279 }
 280
 281 void TOCModel::setCurrentViewport( const Okular::DocumentViewport &viewport )
 282 {
 283     foreach ( TOCItem* item, d->currentPage )
 284     {
 285         QModelIndex index = d->indexForItem( item );
 286         if ( !index.isValid() )
 287             continue;
 288
 289         item->highlight = false;
 290         emit dataChanged( index, index );
 291     }
 292     d->currentPage.clear();
 293
 294     QList< TOCItem* > newCurrentPage;
 295     d->findViewport( viewport, d->root, newCurrentPage );
 296     // HACK: for now, support only the first item found
 297     if ( newCurrentPage.count() > 0 )
 298     {
 299         TOCItem *first = newCurrentPage.first();
 300         newCurrentPage.clear();
 301         newCurrentPage.append( first );
 302     }
 303
 304     d->currentPage = newCurrentPage;
 305
 306     foreach ( TOCItem* item, d->currentPage )
 307     {
 308         QModelIndex index = d->indexForItem( item );
 309         if ( !index.isValid() )
 310             continue;
 311
 312         item->highlight = true;
 313         emit dataChanged( index, index );
 314     }
 315 }
 316
 317 bool TOCModel::isEmpty() const
 318 {
 319     return d->root->children.isEmpty();
 320 }
 321
 322 QString TOCModel::externalFileNameForIndex( const QModelIndex &index ) const
 323 {
 324     if ( !index.isValid() )
 325         return QString();
 326
 327     TOCItem *item = static_cast< TOCItem* >( index.internalPointer() );
 328     return item->extFileName;
 329 }
 330
 331 Okular::DocumentViewport TOCModel::viewportForIndex( const QModelIndex &index ) const
 332 {
 333     if ( !index.isValid() )
 334         return Okular::DocumentViewport();
 335
 336     TOCItem *item = static_cast< TOCItem* >( index.internalPointer() );
 337     return item->viewport;
 338 }
 339
 340 #include "tocmodel.moc"