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 706 of file annotations.h.

Member Enumeration Documentation

◆ Capability

Enumerator
Addition 

Generator can create native annotations.

Modification 

Generator can edit native annotations.

Removal 

Generator can remove native annotations.

Definition at line 709 of file annotations.h.

Constructor & Destructor Documentation

◆ ~AnnotationProxy()

AnnotationProxy::~AnnotationProxy ( )
virtual

Destroys the annotation proxy.

Definition at line 211 of file annotations.cpp.

Member Function Documentation

◆ notifyAddition()

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

◆ notifyModification()

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

◆ notifyRemoval()

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

◆ supports()

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-2022 The KDE developers.
Generated on Fri Aug 19 2022 04:10:35 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.