Okular::AnnotationProxy

Search for usage in LXR

Okular::AnnotationProxy Class Referenceabstract

#include <annotations.h>

Public Types

enum  Capability { Addition, Modification, Removal }
 

Public Member Functions

 AnnotationProxy (const AnnotationProxy &)=delete
 
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
 
AnnotationProxyoperator= (const AnnotationProxy &)=delete
 
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 707 of file annotations.h.

Member Enumeration Documentation

Enumerator
Addition 

Generator can create native annotations.

Modification 

Generator can edit native annotations.

Removal 

Generator can remove native annotations.

Definition at line 710 of file annotations.h.

Constructor & Destructor Documentation

AnnotationProxy::~AnnotationProxy ( )
virtual

Destroys the annotation proxy.

Definition at line 208 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 modified

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:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Fri Oct 22 2021 22:36:52 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.