• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • kdegraphics
  • Sitemap
  • Contact Us
 

okular

Okular::DocumentViewport

Okular::DocumentViewport Class Reference

#include <document.h>

List of all members.


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


Public Types

enum  Position { Center = 1, TopLeft = 2 }

Public Member Functions

 DocumentViewport (int number=-1)
 DocumentViewport (const QString &description)
QString toString () const
bool isValid () const
bool operator== (const DocumentViewport &other) const

Public Attributes

int pageNumber
struct {
   bool   enabled
   double   normalizedX
   double   normalizedY
   Position   pos
} rePos
struct {
   bool   enabled
   bool   width
   bool   height
} autoFit

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 667 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 2729 of file document.cpp.

DocumentViewport::DocumentViewport ( const QString &  description  ) 

Creates a new viewport from the given xml description.

Definition at line 2742 of file document.cpp.


Member Function Documentation

QString DocumentViewport::toString (  )  const

Returns the viewport as xml description.

Definition at line 2798 of file document.cpp.

bool DocumentViewport::isValid (  )  const

Returns whether the viewport is valid.

Definition at line 2814 of file document.cpp.

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

Definition at line 2819 of file document.cpp.


Member Data Documentation

int Okular::DocumentViewport::pageNumber

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

Definition at line 662 of file document.h.

bool Okular::DocumentViewport::enabled

Definition at line 678 of file document.h.

double Okular::DocumentViewport::normalizedX

Definition at line 679 of file document.h.

double Okular::DocumentViewport::normalizedY

Definition at line 680 of file document.h.

Position Okular::DocumentViewport::pos

Definition at line 681 of file document.h.

struct { ... } Okular::DocumentViewport::rePos

bool Okular::DocumentViewport::width

Definition at line 689 of file document.h.

bool Okular::DocumentViewport::height

Definition at line 690 of file document.h.

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


The documentation for this class was generated from the following files:
  • document.h
  • document.cpp

okular

Skip menu "okular"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdegraphics

Skip menu "kdegraphics"
  • okular
Generated for kdegraphics by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal