Okular

global.h
1 /*
2  SPDX-FileCopyrightText: 2007 Tobias Koenig <[email protected]>
3 
4  SPDX-License-Identifier: GPL-2.0-or-later
5 */
6 
7 #ifndef OKULAR_GLOBAL_H
8 #define OKULAR_GLOBAL_H
9 
10 #include <QGlobalStatic>
11 
12 /**
13  * \namespace Okular global.h
14  *
15  * \brief The documentation to the global Okular namespace.
16  */
17 
18 namespace Okular
19 {
20 /**
21  * Describes the DRM capabilities.
22  */
23 enum Permission {
24  AllowModify = 1, ///< Allows to modify the document
25  AllowCopy = 2, ///< Allows to copy the document
26  AllowPrint = 4, ///< Allows to print the document
27  AllowNotes = 8, ///< Allows to add annotations to the document
28  AllowFillForms = 16 ///< Allows to fill the forms in the document
29 };
30 Q_DECLARE_FLAGS(Permissions, Permission)
31 
32 /**
33  * Describes the direction of searching.
34  */
36  FromTop, ///< Searching from top of the page, next result is to be found, there was no earlier search result.
37  FromBottom, ///< Searching from bottom of the page, next result is to be found, there was no earlier search result.
38  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.
39  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.
40 };
41 
42 /**
43  * A rotation.
44  */
45 enum Rotation {
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  */
56  Synchronous, ///< Will create the object in a synchronous way
57  Asynchronous ///< Will create the object in an asynchronous way
58 };
59 
60 /**
61  * The side(s) to be considered when merging areas.
62  */
63 enum MergeSide {
64  MergeRight = 0, ///< Merge only if the right side of the first area intersect.
65  MergeBottom = 1, ///< Merge only if the bottom side of the first area intersect.
66  MergeLeft = 2, ///< Merge only if the left side of the first area intersect.
67  MergeTop = 3, ///< Merge only if the top side of the first area intersect.
68  MergeAll = 4 ///< Merge if the areas intersects, no matter which side(s).
69 };
70 
71 /**
72  * Describes the possible script types.
73  */
74 enum ScriptType {
75  JavaScript = 0 ///< JavaScript code
76 };
77 
78 }
79 
80 #endif
SearchDirection
Describes the direction of searching.
Definition: global.h:35
Rotation
A rotation.
Definition: global.h:45
Searching for the next result on the page, earlier result should be located so we search from the las...
Definition: global.h:38
Will create the object in a synchronous way.
Definition: global.h:56
GenerationType
Describes the type of generation of objects.
Definition: global.h:55
Merge only if the bottom side of the first area intersect.
Definition: global.h:65
Merge only if the left side of the first area intersect.
Definition: global.h:66
MergeSide
The side(s) to be considered when merging areas.
Definition: global.h:63
Allows to copy the document.
Definition: global.h:25
Merge only if the top side of the first area intersect.
Definition: global.h:67
Merge only if the right side of the first area intersect.
Definition: global.h:64
Rotated 180 degrees clockwise.
Definition: global.h:48
Allows to add annotations to the document.
Definition: global.h:27
global.h
Definition: action.h:16
Not rotated.
Definition: global.h:46
JavaScript code.
Definition: global.h:75
Searching from top of the page, next result is to be found, there was no earlier search result...
Definition: global.h:36
Searching from bottom of the page, next result is to be found, there was no earlier search result...
Definition: global.h:37
Searching for the previous result on the page, earlier result should be located so we search from the...
Definition: global.h:39
Allows to modify the document.
Definition: global.h:24
ScriptType
Describes the possible script types.
Definition: global.h:74
Rotated 2700 degrees clockwise.
Definition: global.h:49
Will create the object in an asynchronous way.
Definition: global.h:57
Merge if the areas intersects, no matter which side(s).
Definition: global.h:68
Allows to print the document.
Definition: global.h:26
Rotated 90 degrees clockwise.
Definition: global.h:47
Allows to fill the forms in the document.
Definition: global.h:28
Permission
Describes the DRM capabilities.
Definition: global.h:23
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Thu Jun 17 2021 22:35:42 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.