InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPDFAnnotationHandler Class Referenceabstract

#include <IPDFAnnotationHandler.h>

Inheritance diagram for IPDFAnnotationHandler:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPDFANNOTATIONHANDLER }
 

Public Member Functions

virtual void HandlePDFAnnotationEvent (const ClassID &theChange, ISubject *theSubject, const PMIID &protocol, void *changedBy, const UIDList &inPDFAnnotationItems)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

A service interface that is notified when a PDF annotation type item (form field/movie/sound) is added or removed from the hierarchy. A list of the affected annotations is provided. To use, create a boss that implements IID_IK2SERVICEPROVIDER as kPDFAnnotationEventProviderImpl, and IID_IPDFANNOTATIONHANDLER as a custom implementation of IPDFAnnotationHandler.

Member Function Documentation

virtual void IPDFAnnotationHandler::HandlePDFAnnotationEvent (const ClassIDtheChange,
ISubjecttheSubject,
const PMIIDprotocol,
void * changedBy,
const UIDListinPDFAnnotationItems 
)
pure virtual

Called when a PDF annotation type item (form field/movie/sound) is added or removed from the hierarchy

Parameters
theChangeFrom Update call in a doc observer. The Command that did the change. kAddToHierarchyCmdBoss or kRemoveFromHierarchyCmdBoss
theSubjectFrom Update call in a doc observer. The item that is being changed.
protocolFrom Update call in a doc observer. The protocol that is being changed. Should be IID_IHIERARCHY_DOCUMENT
changedByFrom Update call in a doc observer. Pointer to ICommand doing the change.
inPDFAnnotationItemsa list of PDF annotation page items being added (kAddToHierarchyCmdBoss) or removed (kRemoveFromHierarchyCmdBoss)