PDFix SDK  7.2.0
Loading...
Searching...
No Matches
PdfAnnotHandler Struct Referenceabstract

PdfAnnotHandler class. More...

#include <pdfix.h>

Public Member Functions

virtual int GetType (wchar_t *buffer, int len) const =0
 
virtual void Destroy ()=0
 Destroys annot handler's resources. More...
 
virtual void SetCanCopyProc (PdfAnnotHandlerCanCopyProc proc)=0
 Sets a user-supplied procedure to call when the PdfAnnot::CanCopy is called. More...
 
virtual void SetCopyProc (PdfAnnotHandlerCopyProc proc)=0
 Sets a user-supplied procedure to call when the PdfAnnot::Copy is called. More...
 
virtual void SetCanPasteProc (PdfAnnotHandlerCanPasteProc proc)=0
 Sets a user-supplied procedure to call when the PdfAnnot::CanPaste is called. More...
 
virtual void SetPasteProc (PdfAnnotHandlerPasteProc proc)=0
 Sets a user-supplied procedure to call when the PdfAnnot::Paste is called. More...
 
virtual void SetDestroyDataProc (PdfAnnotHandlerDestroyDataProc proc)=0
 Sets a user-supplied procedure to call when the PdfAnnot::DestroyClipboardData is called. More...
 
virtual void SetDestroyProc (PdfAnnotHandlerDestroyProc proc)=0
 Sets a user-supplied procedure to call when the PdfAnnotHandler::Destroy is called. More...
 

Detailed Description

PdfAnnotHandler class.

The callbacks provide copy-and-paste functionality for a particular type of annotation.

Member Function Documentation

◆ Destroy()

virtual void PdfAnnotHandler::Destroy ( )
pure virtual

Destroys annot handler's resources.

See also
PdfPdfix::RegisterAnnotHandler

◆ GetType()

virtual int PdfAnnotHandler::GetType ( wchar_t *  buffer,
int  len 
) const
pure virtual

Gets the annotation type for which the handler is responsible. This corresponds to the annotation's Subtype key in the PDF file.

Parameters
buffer(filled by method) If the buffer is null function returns required length of string
lenLength of a buffer to be filled in.
Returns
Number of characters written into buffer of required length.

◆ SetCanCopyProc()

virtual void PdfAnnotHandler::SetCanCopyProc ( PdfAnnotHandlerCanCopyProc  proc)
pure virtual

Sets a user-supplied procedure to call when the PdfAnnot::CanCopy is called.

Parameters
procA user-supplied callback to call when the rPdfAnnot::CanCopy is called.

◆ SetCanPasteProc()

virtual void PdfAnnotHandler::SetCanPasteProc ( PdfAnnotHandlerCanPasteProc  proc)
pure virtual

Sets a user-supplied procedure to call when the PdfAnnot::CanPaste is called.

Parameters
procA user-supplied callback to call when the PdfAnnot::CanPaste is called.

◆ SetCopyProc()

virtual void PdfAnnotHandler::SetCopyProc ( PdfAnnotHandlerCopyProc  proc)
pure virtual

Sets a user-supplied procedure to call when the PdfAnnot::Copy is called.

Parameters
procA user-supplied callback to call when the rPdfAnnot::Copy is called.

◆ SetDestroyDataProc()

virtual void PdfAnnotHandler::SetDestroyDataProc ( PdfAnnotHandlerDestroyDataProc  proc)
pure virtual

Sets a user-supplied procedure to call when the PdfAnnot::DestroyClipboardData is called.

Parameters
procA user-supplied callback to call when the PdfAnnot::DestroyClipboardData is called.

◆ SetDestroyProc()

virtual void PdfAnnotHandler::SetDestroyProc ( PdfAnnotHandlerDestroyProc  proc)
pure virtual

Sets a user-supplied procedure to call when the PdfAnnotHandler::Destroy is called.

Parameters
procA user-supplied callback to call when the PdfAnnotHandler::Destroy is called.

◆ SetPasteProc()

virtual void PdfAnnotHandler::SetPasteProc ( PdfAnnotHandlerPasteProc  proc)
pure virtual

Sets a user-supplied procedure to call when the PdfAnnot::Paste is called.

Parameters
procA user-supplied callback to call when the PdfAnnot::Paste is called.