Search for usage in LXR

Okular::DocumentViewport Class Reference

#include <document.h>

Public Types

enum  Position { Center = 1, TopLeft = 2 }

Public Member Functions

 DocumentViewport (int number=-1)
 DocumentViewport (const QString &xmlDesc)
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
int pageNumber
struct {
   bool   enabled
   double   normalizedX
   double   normalizedY
   Position   pos

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 1301 of file document.h.

Member Enumeration Documentation

Describes the relative position of the viewport.


Relative to the center of the page.


Relative to the top left corner of the page.

Definition at line 1338 of file document.h.

Constructor & Destructor Documentation

DocumentViewport::DocumentViewport ( int  number = -1)

Creates a new viewport for the given page number.


Definition at line 5135 of file document.cpp.

DocumentViewport::DocumentViewport ( const QString xmlDesc)

Creates a new viewport from the given xmlDesc.

Definition at line 5148 of file document.cpp.

Member Function Documentation

bool DocumentViewport::isValid ( ) const

Returns whether the viewport is valid.

Definition at line 5211 of file document.cpp.

bool DocumentViewport::operator== ( const DocumentViewport other) const

Definition at line 5216 of file document.cpp.

QString DocumentViewport::toString ( ) const

Returns the viewport as xml description.

Definition at line 5198 of file document.cpp.

Member Data Documentation

struct { ... } Okular::DocumentViewport::autoFit

If 'autoFit.enabled == true' then the page must be autofit in the viewport.

int Okular::DocumentViewport::pageNumber

The number of the page nearest the center of the viewport.

Definition at line 1333 of file document.h.

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:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Sat Oct 23 2021 22:36:42 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.