okular/core/view.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 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 #ifndef OKULAR_VIEW_H
  11 #define OKULAR_VIEW_H
  12
  13 #include "okular_export.h"
  14
  15 class QString;
  16 class QVariant;
  17
  18 namespace Okular {
  19
  20 class Document;
  21 class DocumentPrivate;
  22 class ViewPrivate;
  23
  24 /**
  25  * @short View on the document
  26  *
  27  * The View class represents a "view" on a document.
  28  * A view can be registered with only a document at a time.
  29  *
  30  * @since 0.7 (KDE 4.1)
  31  */
  32 class OKULAR_EXPORT View
  33 {
  34     /// @cond PRIVATE
  35     friend class Document;
  36     friend class DocumentPrivate;
  37     /// @endcond
  38
  39     public:
  40         /**
  41          * The capabilities of a view
  42          */
  43         enum ViewCapability
  44         {
  45             Zoom,                ///< Possibility to get/set the zoom of the view
  46             ZoomModality         ///< Possibility to get/set the zoom mode of the view
  47         };
  48
  49         /**
  50          * The access type of a capability
  51          */
  52         enum CapabilityFlag
  53         {
  54             NoFlag = 0,
  55             CapabilityRead = 0x01,      ///< Possibility to read a capability
  56             CapabilityWrite = 0x02,     ///< Possibility to write a capability
  57             CapabilitySerializable = 0x04  ///< The capability is suitable for being serialized/deserialized
  58         };
  59         Q_DECLARE_FLAGS( CapabilityFlags, CapabilityFlag )
  60
  61         virtual ~View();
  62
  63         /**
  64          * Return the document which this view is associated to,
  65          * or null if it is not associated with any document.
  66          */
  67         Document* viewDocument() const;
  68
  69         /**
  70          * Return the name of this view.
  71          */
  72         QString name() const;
  73
  74         /**
  75          * Must return an unique ID for each view.
  76          */
  77         virtual uint viewId() const = 0;
  78
  79         /**
  80          * Query whether the view support the specified @p capability.
  81          */
  82         virtual bool supportsCapability( ViewCapability capability ) const;
  83
  84         /**
  85          * Query the flags for the specified @p capability.
  86          */
  87         virtual CapabilityFlags capabilityFlags( ViewCapability capability ) const;
  88
  89         /**
  90          * Query the value of the specified @p capability.
  91          */
  92         virtual QVariant capability( ViewCapability capability ) const;
  93
  94         /**
  95          * Sets a new value for the specified @p capability.
  96          */
  97         virtual void setCapability( ViewCapability capability, const QVariant &option );
  98
  99     protected:
 100         /**
 101          * Construct a new view with the specified @p name.
 102          */
 103         View( const QString &name );
 104
 105         /// @cond PRIVATE
 106         Q_DECLARE_PRIVATE( View )
 107         ViewPrivate *d_ptr;
 108         /// @endcond
 109
 110     private:
 111         Q_DISABLE_COPY( View )
 112 };
 113
 114 }
 115
 116 Q_DECLARE_OPERATORS_FOR_FLAGS( Okular::View::CapabilityFlags )
 117
 118 #endif