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

okular

  • Okular
  • AnnotationProxy
Public Types | Public Member Functions | List of all members
Okular::AnnotationProxy Class Referenceabstract

#include <annotations.h>

Public Types

enum  Capability { Addition, Modification, Removal }
 

Public Member Functions

virtual ~AnnotationProxy ()
 
virtual void notifyAddition (Annotation *annotation, int page)=0
 
virtual void notifyModification (const Annotation *annotation, int page, bool appearanceChanged)=0
 
virtual void notifyRemoval (Annotation *annotation, int page)=0
 
virtual bool supports (Capability capability) const =0
 

Detailed Description

Native annotation interface.

Generators can subclass it to provide native annotation support. Generators can use Annotation::setNativeId to store per-annotation data.

Since
0.15 (KDE 4.9)

Definition at line 686 of file annotations.h.

Member Enumeration Documentation

enum Okular::AnnotationProxy::Capability
Enumerator
Addition 

Generator can create native annotations.

Modification 

Generator can edit native annotations.

Removal 

Generator can remove native annotations.

Definition at line 689 of file annotations.h.

Constructor & Destructor Documentation

AnnotationProxy::~AnnotationProxy ( )
virtual

Destroys the annotation proxy.

Definition at line 171 of file annotations.cpp.

Member Function Documentation

virtual void Okular::AnnotationProxy::notifyAddition ( Annotation *  annotation,
int  page 
)
pure virtual

Called when a new annotation is added to a page.

Note
Only called if supports(Addition) == true
virtual void Okular::AnnotationProxy::notifyModification ( const Annotation *  annotation,
int  page,
bool  appearanceChanged 
)
pure virtual

Called after an existing annotation at a given page is modified.

Generator can call annotation getters to get the new values. appearanceChanged tells if a non-visible property was modifed

Note
Only called if supports(Modification) == true
virtual void Okular::AnnotationProxy::notifyRemoval ( Annotation *  annotation,
int  page 
)
pure virtual

Called when an existing annotation at a given page is removed.

Note
Only called if supports(Removal) == true
virtual bool Okular::AnnotationProxy::supports ( Capability  capability) const
pure virtual

Query for the supported capabilities.


The documentation for this class was generated from the following files:
  • annotations.h
  • annotations.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:45:03 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