okular/core/observer.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Enrico Ros <eros.kde@email.it>                  *
   3  *   Copyright (C) 2005 by Albert Astals Cid <tsdgeos@terra.es>            *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  ***************************************************************************/
  10
  11 #ifndef _OKULAR_DOCUMENTOBSERVER_H_
  12 #define _OKULAR_DOCUMENTOBSERVER_H_
  13
  14 #include <QtCore/QVector>
  15
  16 #include <okular/core/okular_export.h>
  17
  18 namespace Okular {
  19
  20 /** IDs for observers. Globally defined here. **/
  21 #define PRESENTATION_ID 1
  22 #define PART_ID 2
  23 #define PAGEVIEW_ID 3
  24 #define THUMBNAILS_ID 4
  25 #define TOC_ID 5
  26 #define MINIBAR_ID 6
  27 #define REVIEWS_ID 7
  28 #define PROGRESSWIDGET_ID 8
  29 #define PAGESIZELABEL_ID 9
  30 #define BOOKMARKLIST_ID 10
  31 #define ANNOTATIONMODEL_ID 11
  32
  33 // the biggest id, useful for ignoring wrong id request
  34 #define MAX_OBSERVER_ID 12
  35
  36 /** PRIORITIES for requests. Globally defined here. **/
  37 #define PAGEVIEW_PRIO 1
  38 #define PAGEVIEW_PRELOAD_PRIO 4
  39 #define THUMBNAILS_PRIO 2
  40 #define THUMBNAILS_PRELOAD_PRIO 5
  41 #define PRESENTATION_PRIO 0
  42 #define PRESENTATION_PRELOAD_PRIO 3
  43
  44 class Page;
  45
  46 /**
  47  * @short Base class for objects being notified when something changes.
  48  *
  49  * Inherit this class and call Document->addObserver( yourClass ) to get
  50  * notified of asynchronous events (new pixmap generated, or changed, etc..).
  51  */
  52 class OKULAR_EXPORT DocumentObserver
  53 {
  54     public:
  55         DocumentObserver();
  56         /**
  57          * Destroys the document observer.
  58          */
  59         virtual ~DocumentObserver();
  60
  61         /**
  62          * Must return an unique ID for each observer (used for notifications).
  63          */
  64         virtual uint observerId() const = 0;
  65
  66         /**
  67          * Flags that can be sent from the document to all observers to
  68          * inform them about the type of object that has been changed.
  69          */
  70         enum ChangedFlags {
  71             Pixmap = 1,           ///< Pixmaps has been changed
  72             Bookmark = 2,         ///< Bookmarks has been changed
  73             Highlights = 4,       ///< Highlighting information has been changed
  74             TextSelection = 8,    ///< Text selection has been changed
  75             Annotations = 16,     ///< Annotations has been changed
  76             BoundingBox = 32      ///< Bounding boxes have been changed
  77         };
  78
  79         /**
  80          * ...
  81          */
  82         enum SetupFlags {
  83             DocumentChanged = 1,    ///< The document is a new document.
  84             NewLayoutForPages = 2   ///< All the pages have
  85         };
  86
  87         /**
  88          * This method is called whenever the document is initialized or reconstructed.
  89          *
  90          * @param pages The vector of pages of the document.
  91          * @param setupFlags the flags with the information about the setup
  92          */
  93         virtual void notifySetup( const QVector< Okular::Page * > &pages, int setupFlags );
  94
  95         /**
  96          * This method is called whenever the viewport has been changed.
  97          *
  98          * @param smoothMove If true, the move shall be animated.
  99          */
 100         virtual void notifyViewportChanged( bool smoothMove );
 101
 102         /**
 103          * This method is called whenever the content on @p page described by the
 104          * passed @p flags has been changed.
 105          */
 106         virtual void notifyPageChanged( int page, int flags );
 107
 108         /**
 109          * This method is called whenever the content described by the passed @p flags
 110          * has been cleared.
 111          */
 112         virtual void notifyContentsCleared( int flags );
 113
 114         /**
 115          * This method is called whenever the visible rects have been changed.
 116          */
 117         virtual void notifyVisibleRectsChanged();
 118
 119         /**
 120          * This method is called whenever the zoom of the document has been changed.
 121          */
 122         virtual void notifyZoom( int factor );
 123
 124         /**
 125          * Returns whether the observer agrees that all pixmaps for the given
 126          * @p page can be unloaded to improve memory usage.
 127          *
 128          * Returns true per default.
 129          */
 130         virtual bool canUnloadPixmap( int page ) const;
 131
 132     private:
 133         class Private;
 134         const Private* d;
 135 };
 136
 137 }
 138
 139 #endif