okular/core/global.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Tobias Koenig <tokoe@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_GLOBAL_H
  11 #define OKULAR_GLOBAL_H
  12
  13 #include <QtCore/QGlobalStatic>
  14
  15 namespace Okular {
  16
  17 /**
  18  * Describes the DRM capabilities.
  19  */
  20 enum Permission
  21 {
  22     AllowModify = 1,  ///< Allows to modify the document
  23     AllowCopy = 2,    ///< Allows to copy the document
  24     AllowPrint = 4,   ///< Allows to print the document
  25     AllowNotes = 8,   ///< Allows to add annotations to the document
  26     AllowFillForms = 16     ///< Allows to fill the forms in the document
  27 };
  28 Q_DECLARE_FLAGS( Permissions, Permission )
  29
  30 /**
  31  * Describes the direction of searching.
  32  */
  33 enum SearchDirection
  34 {
  35     FromTop,        ///< Searching from top of the page, next result is to be found, there was no earlier search result.
  36     FromBottom,     ///< Searching from bottom of the page, next result is to be found, there was no earlier search result.
  37     NextResult,     ///< Searching for the next result on the page, earlier result should be located so we search from the last result not from the beginning of the page.
  38     PreviousResult  ///< Searching for the previous result on the page, earlier result should be located so we search from the last result not from the beginning of the page.
  39 };
  40
  41 /**
  42  * A rotation.
  43  */
  44 enum Rotation
  45 {
  46     Rotation0 = 0,    ///< Not rotated.
  47     Rotation90 = 1,   ///< Rotated 90 degrees clockwise.
  48     Rotation180 = 2,  ///< Rotated 180 degrees clockwise.
  49     Rotation270 = 3   ///< Rotated 2700 degrees clockwise.
  50 };
  51
  52 /**
  53  * Describes the type of generation of objects
  54  */
  55 enum GenerationType
  56 {
  57     Synchronous,      ///< Will create the object in a synchronous way
  58     Asynchronous      ///< Will create the object in an asynchronous way
  59 };
  60
  61 /**
  62  * The side(s) to be considered when merging areas.
  63  */
  64 enum MergeSide
  65 {
  66     MergeRight = 0,    ///< Merge only if the right side of the first area intersect.
  67     MergeBottom = 1,   ///< Merge only if the bottom side of the first area intersect.
  68     MergeLeft = 2,  ///< Merge only if the left side of the first area intersect.
  69     MergeTop = 3,   ///< Merge only if the top side of the first area intersect.
  70     MergeAll = 4   ///< Merge if the areas intersects, no matter which side(s).
  71 };
  72
  73 /**
  74  * Describes the possible script types.
  75  */
  76 enum ScriptType
  77 {
  78     JavaScript = 0           ///< JavaScript code
  79 };
  80
  81 }
  82
  83 #endif