#include <pdfix.h>

Inheritance diagram for PdfMarkupAnnot:

Public Member Functions
virtual int	GetContents (wchar_t *buffer, int len) const =0

virtual bool	SetContents (const wchar_t *contents)=0

virtual int	GetAuthor (wchar_t *buffer, int len) const =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 () const =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 () 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

PdfMarkupAnnot class.

Markup annotations represent a markup annotation in a pdf document.

Member Function Documentation

◆ AddReply()

virtual PdfAnnot * PdfMarkupAnnot::AddReply	(	const wchar_t *	author,
		const wchar_t *	text
	)

pure virtual

Adds a new reply to the markup annotation.

Parameters

author	The author of the reply.
text	The content of the reply to add.

Returns: Requested PdfAnnot that is reply to the current annotation or nullptr in case of error.

See also: PdfMarkupAnnot::AddReply Sample AddComment

◆ GetAuthor()

virtual int PdfMarkupAnnot::GetAuthor	(	wchar_t *	buffer,
		int	len
	)		const

pure virtual

Gets the author of the markup annotation.

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.

See also: PdfMarkupAnnot::GetAuthor

◆ GetContents()

virtual int PdfMarkupAnnot::GetContents	(	wchar_t *	buffer,
		int	len
	)		const

pure virtual

Gets the contents of the markup annotation. It's a text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human - readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.

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.

See also: PdfMarkupAnnot::GetContents

◆ GetNumReplies()

virtual int PdfMarkupAnnot::GetNumReplies ( ) const

pure virtual

Both annotations must be on the same page of the document.

Gets the requested reply. Reply is a reference to another PdfAnnot object that was created

Returns: Number of replies.

See also: PdfMarkupAnnot::GetNumReplies

◆ GetReply()

virtual PdfAnnot * PdfMarkupAnnot::GetReply ( int index )

pure virtual

Both annotations must be on the same page of the document.

Gets the requested reply. Reply is a reference to another PdfAnnot object that was created

Returns: Requested PdfAnnot that is reply to the current annotation.

See also: PdfMarkupAnnot::GetReply

◆ SetAuthor()

virtual bool PdfMarkupAnnot::SetAuthor ( const wchar_t * author )

pure virtual

Sets the author of the markup annotation.

Parameters

author The content string to be set.

Returns: true if the author was set, false otherwise.

See also: PdfMarkupAnnot::SetAuthor

◆ SetContents()

virtual bool PdfMarkupAnnot::SetContents ( const wchar_t * contents )

pure virtual

Sets the contents of the markup annotation. It's a text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human - readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.

Parameters

contens The content string to be set.

Returns: true if the content was set, false otherwise.

See also: PdfMarkupAnnot::SetContents

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddReply()

◆ GetAuthor()

◆ GetContents()

◆ GetNumReplies()

◆ GetReply()

◆ SetAuthor()

◆ SetContents()