Okular

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

KDE's Doxygen guidelines are available online.