#include <pdfix.h>

Inheritance diagram for PdfWidgetAnnot:

Public Member Functions
virtual int	GetCaption (wchar_t *buffer, int len) const =0
	Gets an annotation's caption. More...

virtual int	GetFontName (wchar_t *buffer, int len) const =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 bool	SetAction (PdfAction *action)=0

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 () const =0
	Gets an annotation's subtype. More...

virtual PdfAnnotFlags	GetFlags () const =0
	Gets an annotation's flags. More...

virtual bool	SetFlags (PdfAnnotFlags flags)=0
	Sets 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 bool	RefreshAppearance ()=0
	Regenerates the appearance stream for the annotation. More...

virtual void	GetBBox (PdfRect *bbox) const =0
	Gets the annotation bounding box. More...

virtual bool	PointInAnnot (const PdfPoint *point) const =0

virtual bool	RectInAnnot (const PdfRect *rect) const =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

virtual void	NotifyDidChange (const wchar_t *key, int err)=0

virtual bool	IsValid () const =0

virtual bool	IsMarkup () const =0
	Tests whether an annotation is markup. More...

virtual bool	CanCopy ()=0

virtual bool	CanPaste (PdfPage dest_page, const PdfPoint center, void *data)=0

virtual void *	Copy ()=0
	Copies annotation object data to a clipboard structure, from which it can be pasted. More...

virtual PdfAnnot *	Paste (PdfPage dest_page, PdfPoint center, void *data)=0

virtual void	DestroyClipboardData (void *data)=0

virtual int	GetStateFlags () const =0
	Get the annotation state flags. More...

virtual bool	SetStateFlags (PdfStateFlags flags)=0
	Set the annotation state flags. More...

virtual PdsDictionary *	GetPageObject ()=0
	Get the annotation page object. More...

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
	)		const

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
	)		const

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.

◆ SetAction()

virtual bool PdfWidgetAnnot::SetAction ( PdfAction * action )

pure virtual

Sets an annotation's action object. NOTE: If param action is null function removes action from annotation.

Parameters

action Pointer to PdfAction to add.

Returns: true if action was successfully set, false otherwise.

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetAAction()

◆ GetAction()

◆ GetCaption()

◆ GetFontName()

◆ GetFormField()

◆ SetAction()