#include <document.h>

Public Types
enum	Position { Center = 1, TopLeft = 2 }

Public Member Functions
	DocumentViewport (int number=-1)

	DocumentViewport (const QString &description)

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

Member Enumeration Documentation

enum Okular::DocumentViewport::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 1040 of file document.h.

Constructor & Destructor Documentation

DocumentViewport::DocumentViewport ( int number = -1 )

Creates a new viewport for the given page number.

DocumentViewport.

Definition at line 4491 of file document.cpp.

DocumentViewport::DocumentViewport ( const QString & description )

Creates a new viewport from the given xml description.

Definition at line 4504 of file document.cpp.

Member Function Documentation

bool DocumentViewport::isValid ( ) const

Returns whether the viewport is valid.

Definition at line 4576 of file document.cpp.

bool DocumentViewport::operator< ( const DocumentViewport & other ) const

Definition at line 4599 of file document.cpp.

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

Definition at line 4581 of file document.cpp.

QString DocumentViewport::toString ( ) const

Returns the viewport as xml description.

Definition at line 4560 of file document.cpp.

Member Data Documentation

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

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

bool Okular::DocumentViewport::enabled

Definition at line 1051 of file document.h.

bool Okular::DocumentViewport::height

Definition at line 1063 of file document.h.

double Okular::DocumentViewport::normalizedX

Definition at line 1052 of file document.h.

double Okular::DocumentViewport::normalizedY

Definition at line 1053 of file document.h.

int Okular::DocumentViewport::pageNumber

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

Definition at line 1035 of file document.h.

Position Okular::DocumentViewport::pos

Definition at line 1054 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.

bool Okular::DocumentViewport::width

Definition at line 1062 of file document.h.

The documentation for this class was generated from the following files:

okular

Public Types

Public Member Functions

Public Attributes