PdfLinkAnnot Struct Reference

PdfLinkAnnot class. More...

Inheritance diagram for PdfLinkAnnot:

Public Member Functions
virtual int	GetNumQuads ()=0
	Gets the number of quads for the link. More...
virtual void	GetQuad (int index, PdfQuad *quad)=0
virtual bool	AddQuad (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...
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

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

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  )

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