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

okular

  • Okular
  • View
Public Types | Public Member Functions | Protected Member Functions | List of all members
Okular::View Class Reference

#include <view.h>

Inheritance diagram for Okular::View:
Inheritance graph
[legend]

Public Types

enum  CapabilityFlag { NoFlag = 0, CapabilityRead = 0x01, CapabilityWrite = 0x02, CapabilitySerializable = 0x04 }
 
enum  ViewCapability { Zoom, ZoomModality }
 

Public Member Functions

virtual ~View ()
 
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
 
Document * viewDocument () 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

enum Okular::View::CapabilityFlag

The access type of a capability.

Enumerator
NoFlag 
CapabilityRead 

Possibility to read a capability.

CapabilityWrite 

Possibility to write a capability.

CapabilitySerializable 

The capability is suitable for being serialized/deserialized.

Definition at line 52 of file view.h.

enum Okular::View::ViewCapability

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.

Definition at line 43 of file view.h.

Constructor & Destructor Documentation

View::~View ( )
virtual

Definition at line 34 of file view.cpp.

View::View ( const QString &  name)
protected

Construct a new view with the specified name.

Definition at line 28 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 66 of file view.cpp.

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

Query the flags for the specified capability.

Definition at line 60 of file view.cpp.

QString View::name ( ) const

Return the name of this view.

Definition at line 49 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 72 of file view.cpp.

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

Query whether the view support the specified capability.

Definition at line 54 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 44 of file view.cpp.


The documentation for this class was generated from the following files:
  • view.h
  • view.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:19:26 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

okular

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

kdegraphics API Reference

Skip menu "kdegraphics API Reference"
  •     libkdcraw
  •     libkexiv2
  •     libkipi
  •     libksane
  • okular

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal