PdfTextAnnot Struct Reference

PdfTextAnnot class. More...

#include <pdfix.h>

Inheritance diagram for PdfTextAnnot:

Additional Inherited Members
Public Member Functions inherited from PdfMarkupAnnot
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.
virtual bool	SetAuthor (const wchar_t *author)=0
	Sets the author of the markup annotation.
virtual int	GetNumReplies () const =0
	Both annotations must be on the same page of the document.
virtual PdfAnnot *	GetReply (int index)=0
	Both annotations must be on the same page of the document.
virtual PdfAnnot *	AddReply (const wchar_t *author, const wchar_t *text)=0
	Adds a new reply to the markup annotation.
Public Member Functions inherited from PdfAnnot
virtual PdfAnnotSubtype	GetSubtype () const =0
	Gets an annotation's subtype.
virtual PdfAnnotFlags	GetFlags () const =0
	Gets an annotation's flags.
virtual bool	SetFlags (PdfAnnotFlags flags)=0
	Sets an annotation's flags.
virtual void	GetAppearance (PdfAnnotAppearance *appearance)=0
	Gets an annotation's appearance.
virtual PdsStream *	GetAppearanceXObject (PdfAnnotAppearanceMode mode)=0
	Gets an annotation's appearance stream.
virtual bool	SetAppearanceFromXObject (PdsStream *xobj, PdfAnnotAppearanceMode mode)=0
	Set an annotation's appearance from an XObject.
virtual bool	RefreshAppearance ()=0
	Regenerates the appearance stream for the annotation.
virtual void	GetBBox (PdfRect *bbox) const =0
	Gets the annotation bounding box.
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.
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.
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.
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.
virtual bool	SetStateFlags (PdfStateFlags flags)=0
	Set the annotation state flags.
virtual PdsDictionary *	GetPageObject ()=0
	Get the annotation page object.

Detailed Description

PdfTextAnnot class.

A text annotation represents a 'sticky note' attached to a point in the PDF document. When closed, the annotation appears as an icon; when open, it displays a pop-up window containing the text of the note in a font and size chosen by the viewer application. Text annotations do not scale and rotate with the page.