PdfWidgetAnnot Struct Reference

PdfWidgetAnnot class. More...

Inheritance diagram for PdfWidgetAnnot:

Public Member Functions
virtual int	GetCaption (wchar_t *buffer, int len)=0
	Gets an annotation's caption. More...
virtual int	GetFontName (wchar_t *buffer, int len)=0
	Gets an annotation's font name used for the annotation's appearance. More...
virtual PdfAction *	GetAction ()=0
	Gets an annotation's action object. More...
virtual PdfAction *	GetAAction (PdfActionEventType event)=0
	Gets an annotation's additional action object. More...
virtual PdfFormField *	GetFormField ()=0
	Gets a PdfFormField object related to the annotation. Valid only for Widget annotation. More...
Public Member Functions inherited from PdfAnnot
virtual PdfAnnotSubtype	GetSubtype ()=0
	Gets an annotation's subtype. More...
virtual PdfAnnotFlags	GetFlags ()=0
	Gets an annotation's flags. More...
virtual void	GetAppearance (PdfAnnotAppearance *appearance)=0
	Gets an annotation's appearance. More...
virtual PdsStream *	GetAppearanceXObject (PdfAnnotAppearanceMode mode)=0
	Gets an annotation's appearance stream. More...
virtual bool	SetAppearanceFromXObject (PdsStream *xobj, PdfAnnotAppearanceMode mode)=0
	Set an annotation's appearance from an XObject. More...
virtual void	GetBBox (PdfRect *bbox)=0
	Gets the annotation bounding box. More...
virtual bool	PointInAnnot (PdfPoint *point)=0
virtual bool	RectInAnnot (PdfRect *rect)=0
virtual PdsObject *	GetStructObject (bool struct_parent)=0
virtual PdsDictionary *	GetObject ()=0
	Gets the annotation object dictionary. More...
virtual void	NotifyWillChange (const wchar_t *key)=0
	Broadcasts a PDAnnotWillChange() notification. Clients must call this method before making any change to a custom annotation. More...
virtual void	NotifyDidChange (const wchar_t *key, int err)=0
	Broadcasts a PDAnnotDidChange() notification. Clients must call this method after making any change to a custom annotation. More...
virtual bool	IsValid ()=0

Detailed Description

PdfWidgetAnnot class.

Interactive forms use widget annotations to represent the appearance of fields and to manage user interactions.

Member Function Documentation

GetAAction()

virtual PdfAction* PdfWidgetAnnot::GetAAction ( PdfActionEventType  event )

pure virtual

Gets an annotation's additional action object.

Parameters

event

The eventwhich additional action to get.

Returns

The annotation's additional action object or nullptr if annotation does not have an action for specified event type.

See also

PdfWidgetAnnot::GetAction

GetAction()

virtual PdfAction* PdfWidgetAnnot::GetAction ( )

pure virtual

Gets an annotation's action object.

Returns

The annotation's action object or nullptr if annotation does not have an action.

See also

PdfWidgetAnnot::GetAAction

GetCaption()

virtual int PdfWidgetAnnot::GetCaption ( wchar_t *  buffer, int  len  )

pure virtual

Gets an annotation's caption.

Parameters

buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns

Number of characters written into buffer of required length.

GetFontName()

virtual int PdfWidgetAnnot::GetFontName ( wchar_t *  buffer, int  len  )

pure virtual

Gets an annotation's font name used for the annotation's appearance.

Parameters

buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns

Number of characters written into buffer of required length.

GetFormField()

virtual PdfFormField* PdfWidgetAnnot::GetFormField ( )

pure virtual

Gets a PdfFormField object related to the annotation. Valid only for Widget annotation.

Returns

The PdfFormField object or nullptr if no such form field field object exists.