PdfTextMarkupAnnot Struct Reference

PdfTextMarkupAnnot class. More...

Inheritance diagram for PdfTextMarkupAnnot:

Public Member Functions
virtual int	GetNumQuads ()=0
	Gets the number of quads for the annotation. More...
virtual void	GetQuad (int index, PdfQuad *quad)=0
virtual bool	AddQuad (PdfQuad *quad)=0
	Adds a new quad to the text markup annot. More...
virtual bool	RemoveQuad (int index)=0
	Removes a quad with the specified index. More...
Public Member Functions inherited from PdfMarkupAnnot
virtual int	GetContents (wchar_t *buffer, int len)=0
virtual bool	SetContents (const wchar_t *contents)=0
virtual int	GetAuthor (wchar_t *buffer, int len)=0
	Gets the author of the markup annotation. More...
virtual bool	SetAuthor (const wchar_t *author)=0
	Sets the author of the markup annotation. More...
virtual int	GetNumReplies ()=0
	Both annotations must be on the same page of the document. More...
virtual PdfAnnot *	GetReply (int index)=0
	Both annotations must be on the same page of the document. More...
virtual PdfAnnot *	AddReply (const wchar_t *author, const wchar_t *text)=0
	Adds a new reply to the markup 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

PdfTextMarkupAnnot class.

Text markup annotations appear as highlights, underlines, strikeouts, or jagged ('squiggly') underlines in the text of a document.

Member Function Documentation

AddQuad()

virtual bool PdfTextMarkupAnnot::AddQuad ( PdfQuad *  quad )

pure virtual

Adds a new quad to the text markup annot.

Parameters

quad	Pointer to PdfQuad to add.

Returns

true if quad was added sucessfully, false otherwise.

See also

PdfTextMarkupAnnot::GetNumQuads

GetNumQuads()

virtual int PdfTextMarkupAnnot::GetNumQuads ( )

pure virtual

Gets the number of quads for the annotation.

Returns

Number of quads.

See also

PdfTextMarkupAnnot::GetQuad

GetQuad()

virtual void PdfTextMarkupAnnot::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 annotation should be activated.

Parameters

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

See also

PdfTextMarkupAnnot::GetNumQuads

RemoveQuad()

virtual bool PdfTextMarkupAnnot::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

PdfTextMarkupAnnot::GetNumQuads