Okular::View

Search for usage in LXR

#include <view.h>

Public Types

enum  CapabilityFlag { NoFlag = 0, CapabilityRead = 0x01, CapabilityWrite = 0x02, CapabilitySerializable = 0x04 }
 
typedef QFlags< CapabilityFlagCapabilityFlags
 
enum  ViewCapability {
  Zoom, ZoomModality, Continuous, ViewModeModality,
  TrimMargins
}
 

Public Member Functions

virtual QVariant capability (ViewCapability capability) const
 
virtual CapabilityFlags capabilityFlags (ViewCapability capability) const
 
QString name () const
 
virtual void setCapability (ViewCapability capability, const QVariant &option)
 
virtual bool supportsCapability (ViewCapability capability) const
 
DocumentviewDocument () const
 

Protected Member Functions

 View (const QString &name)
 

Detailed Description

View on the document.

The View class represents a "view" on a document. A view can be registered with only a document at a time.

Since
0.7 (KDE 4.1)

Definition at line 32 of file view.h.

Member Enumeration Documentation

The access type of a capability.

Enumerator
CapabilityRead 

Possibility to read a capability.

CapabilityWrite 

Possibility to write a capability.

CapabilitySerializable 

The capability is suitable for being serialized/deserialized.

Definition at line 54 of file view.h.

The capabilities of a view.

Enumerator
Zoom 

Possibility to get/set the zoom of the view.

ZoomModality 

Possibility to get/set the zoom mode of the view.

Continuous 

Possibility to toggle continuous mode.

Since
1.9
ViewModeModality 

Possibility to get/set the view mode.

Since
1.9
TrimMargins 

Possibility to toggle trim-margins mode.

Since
1.9

Definition at line 43 of file view.h.

Constructor & Destructor Documentation

View::View ( const QString name)
protected

Construct a new view with the specified name.

Definition at line 27 of file view.cpp.

Member Function Documentation

QVariant View::capability ( View::ViewCapability  capability) const
virtual

Query the value of the specified capability.

Definition at line 64 of file view.cpp.

View::CapabilityFlags View::capabilityFlags ( View::ViewCapability  capability) const
virtual

Query the flags for the specified capability.

Definition at line 58 of file view.cpp.

QString View::name ( ) const

Return the name of this view.

Definition at line 47 of file view.cpp.

void View::setCapability ( View::ViewCapability  capability,
const QVariant option 
)
virtual

Sets a new value for the specified capability.

Definition at line 70 of file view.cpp.

bool View::supportsCapability ( View::ViewCapability  capability) const
virtual

Query whether the view support the specified capability.

Definition at line 52 of file view.cpp.

Document * View::viewDocument ( ) const

Return the document which this view is associated to, or null if it is not associated with any document.

Definition at line 42 of file view.cpp.


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 Wed May 12 2021 22:35:30 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.