Okular::DocumentViewport
#include <document.h>
Public Types | |
enum | Position { Center = 1, TopLeft = 2 } |
Public Member Functions | |
DocumentViewport (const QString &xmlDesc) | |
DocumentViewport (int number=-1) | |
bool | isValid () const |
bool | operator< (const DocumentViewport &other) const |
bool | operator== (const DocumentViewport &other) const |
QString | toString () const |
Public Attributes | |
struct { | |
bool enabled | |
bool height | |
bool width | |
} | autoFit |
int | pageNumber |
struct { | |
bool enabled | |
double normalizedX | |
double normalizedY | |
Position pos | |
} | rePos |
Detailed Description
A view on the document.
The Viewport structure is the 'current view' over the document. Contained data is broadcasted between observers to synchronize their viewports to get the 'I scroll one view and others scroll too' views.
Definition at line 1349 of file document.h.
Member Enumeration Documentation
◆ Position
Describes the relative position of the viewport.
Enumerator | |
---|---|
Center | Relative to the center of the page. |
TopLeft | Relative to the top left corner of the page. |
Definition at line 1386 of file document.h.
Constructor & Destructor Documentation
◆ DocumentViewport() [1/2]
|
explicit |
Creates a new viewport for the given page number
.
Definition at line 5580 of file document.cpp.
◆ DocumentViewport() [2/2]
|
explicit |
Creates a new viewport from the given xmlDesc
.
Definition at line 5593 of file document.cpp.
Member Function Documentation
◆ isValid()
bool DocumentViewport::isValid | ( | ) | const |
Returns whether the viewport is valid.
Definition at line 5661 of file document.cpp.
◆ operator==()
bool DocumentViewport::operator== | ( | const DocumentViewport & | other | ) | const |
Definition at line 5666 of file document.cpp.
◆ toString()
QString DocumentViewport::toString | ( | ) | const |
Returns the viewport as xml description.
Definition at line 5646 of file document.cpp.
Member Data Documentation
◆ autoFit
struct { ... } Okular::DocumentViewport::autoFit |
If 'autoFit.enabled == true' then the page must be autofit in the viewport.
◆ pageNumber
int Okular::DocumentViewport::pageNumber |
The number of the page nearest the center of the viewport.
Definition at line 1381 of file document.h.
◆ rePos
struct { ... } Okular::DocumentViewport::rePos |
If 'rePos.enabled == true' then this structure contains the viewport center or top left depending on the value of pos.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Sep 26 2023 04:06:53 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.