#include <pdfix.h>

Inheritance diagram for PdfLinkAnnot:

Public Member Functions
virtual int	GetNumQuads () const =0
	Gets the number of quads for the link. More...

virtual void	GetQuad (int index, PdfQuad *quad) const =0

virtual bool	AddQuad (const PdfQuad *quad)=0
	Adds a new quad to the link annot. More...

virtual bool	RemoveQuad (int index)=0
	Removes a quad with the specified index. More...

virtual PdfAction *	GetAction ()=0
	Gets an link's action object. More...

virtual bool	SetAction (PdfAction *action)=0

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

PdfLinkAnnot class.

A link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed.

Member Function Documentation

◆ AddQuad()

virtual bool PdfLinkAnnot::AddQuad ( const PdfQuad * quad )

pure virtual

Adds a new quad to the link annot.

Parameters

quad	Pointer to PdfQuad to add.

Returns: true if quad was added sucessfully, false otherwise.

See also: PdfLinkAnnot::GetNumQuads

◆ GetAction()

virtual PdfAction * PdfLinkAnnot::GetAction ( )

pure virtual

Gets an link's action object.

Returns: The link's action object or nullptr if link does not have an action.

◆ GetNumQuads()

virtual int PdfLinkAnnot::GetNumQuads ( ) const

pure virtual

Gets the number of quads for the link.

Returns: Number of quads.

See also: PdfLinkAnnot::GetQuad

◆ GetQuad()

virtual void PdfLinkAnnot::GetQuad	(	int	index,
		PdfQuad *	quad
	)		const

pure virtual

Gets the requested quad. The coordinates of the quadrilaterals are in default user space that comprise the region in which the link should be activated.

Parameters

index	Index of an link quad to retrieve.
quad	(Filled by the method) Pointer to PdfQuad structure to fill.

See also: PdfLinkAnnot::GetNumQuads

◆ RemoveQuad()

virtual bool PdfLinkAnnot::RemoveQuad ( int index )

pure virtual

Removes a quad with the specified index.

Parameters

index The index of the quad to remove.

Returns: true if quad was removed, false otherwise.

See also: PdfLinkAnnot::GetNumQuads

◆ SetAction()

virtual bool PdfLinkAnnot::SetAction ( PdfAction * action )

pure virtual

Sets a link's action object. NOTE: If param action is null function removes action from link.

Parameters

action Pointer to PdfAction to add.

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddQuad()

◆ GetAction()

◆ GetNumQuads()

◆ GetQuad()

◆ RemoveQuad()

◆ SetAction()