#include <Caret.h>

Inheritance diagram for pdftron::PDF::Annots::Caret:

Public Member Functions
	Caret (SDF::Obj d=0)
	Caret (const Annot &ann)
const char *	GetSymbol () const
void	SetSymbol (const char *symbol)
Public Member Functions inherited from pdftron::PDF::Annots::Markup
	Markup (SDF::Obj d=0)
	Markup (const Annot &ann)
UString	GetTitle ()
void	SetTitle (const UString &title)
void	SetTitle (const char *title)
Popup	GetPopup () const
void	SetPopup (const Popup &ppup)
double	GetOpacity () const
void	SetOpacity (double op)
UString	GetSubject () const
void	SetSubject (const UString &contents)
Date	GetCreationDates () const
void	SetCreationDates (const Date &dt)
BorderEffect	GetBorderEffect () const
void	SetBorderEffect (BorderEffect effect=e_None)
double	GetBorderEffectIntensity () const
void	SetBorderEffectIntensity (double intensity=0)
ColorPt	GetInteriorColor () const
int	GetInteriorColorCompNum () const
void	SetInteriorColor (const ColorPt &c, int CompNum)
Rect	GetContentRect () const
void	SetContentRect (const Rect &cr)
Rect	GetPadding () const
void	SetPadding (const Rect &rd)
void	SetPadding (double x)
void	RotateAppearance (double angle)
Public Member Functions inherited from pdftron::PDF::Annot
	Annot (SDF::Obj d=0)
	Annot (const Annot &d)
Annot &	operator= (const Annot &d)
bool	operator== (const Annot &d)
bool	IsValid () const
SDF::Obj	GetSDFObj () const
Type	GetType () const
Rect	GetRect () const
Rect	GetVisibleContentBox () const
bool	IsMarkup () const
void	SetRect (const Rect &pos)
Page	GetPage () const
void	SetPage (const Page &page)
SDF::Obj	GetUniqueID () const
void	SetUniqueID (const char *id, int id_buf_sz=0)
Date	GetDate () const
void	SetDate (const Date &date)
bool	GetFlag (Flag flag) const
void	SetFlag (Flag flag, bool value)
SDF::Obj	GetTriggerAction (Annot::ActionTriggerEvent trigger)
BorderStyle	GetBorderStyle () const
void	SetBorderStyle (const BorderStyle &bs, bool oldStyleOnly=false)
SDF::Obj	GetAppearance (AnnotationState annot_state=e_normal, const char *app_state=0)
void	SetAppearance (SDF::Obj app_stream, AnnotationState annot_state=e_normal, const char *app_state=0)
void	RemoveAppearance (AnnotationState annot_state=e_normal, const char *app_state=0)
void	Flatten (class Page page)
const char *	GetActiveAppearanceState () const
void	SetActiveAppearanceState (const char *astate)
ColorPt	GetColorAsRGB () const
ColorPt	GetColorAsCMYK () const
ColorPt	GetColorAsGray () const
int	GetColorCompNum () const
void	SetColor (const ColorPt &col, int numcomp=3)
int	GetStructParent () const
void	SetStructParent (const int parkeyval)
SDF::Obj	GetOptionalContent () const
void	SetOptionalContent (SDF::Obj content)
void	SetContents (const UString &contents)
UString	GetContents () const
int	GetRotation () const
void	SetRotation (int angle)
void	RefreshAppearance ()
void	RefreshAppearance (const RefreshOptions &options)
UString	GetCustomData (const UString &key) const
void	SetCustomData (const UString &key, const UString &value)
void	DeleteCustomData (const UString &key)
void	Resize (const Rect &newrect)
ptrdiff_t	GetHandleInternal ()

Static Public Member Functions
static Caret	Create (SDF::SDFDoc &doc, const Rect &pos)
static Caret	CreateAnnot (SDF::SDFDoc &doc, const Rect &pos)
static Caret	Create (SDF::SDFDoc &doc, const Rect &pos, Rect padding)
static Caret	CreateAnnot (SDF::SDFDoc &doc, const Rect &pos, Rect padding)
Static Public Member Functions inherited from pdftron::PDF::Annot
static Annot	Create (SDF::SDFDoc &doc, Type type, const Rect &pos)
static Annot *	CreateInternal (ptrdiff_t impl)

Additional Inherited Members
Public Types inherited from pdftron::PDF::Annots::Markup
enum	BorderEffect { e_None , e_Cloudy }
Public Types inherited from pdftron::PDF::Annot
enum	Type { e_Text , e_Link , e_FreeText , e_Line , e_Square , e_Circle , e_Polygon , e_Polyline , e_Highlight , e_Underline , e_Squiggly , e_StrikeOut , e_Stamp , e_Caret , e_Ink , e_Popup , e_FileAttachment , e_Sound , e_Movie , e_Widget , e_Screen , e_PrinterMark , e_TrapNet , e_Watermark , e_3D , e_Redact , e_Projection , e_RichMedia , e_Unknown }
enum	Flag { e_invisible , e_hidden , e_print , e_no_zoom , e_no_rotate , e_no_view , e_read_only , e_locked , e_toggle_no_view , e_locked_contents }
enum	ActionTriggerEvent { e_action_trigger_activate = 0 , e_action_trigger_annot_enter = 1 , e_action_trigger_annot_exit = 2 , e_action_trigger_annot_down = 3 , e_action_trigger_annot_up = 4 , e_action_trigger_annot_focus = 5 , e_action_trigger_annot_blur = 6 , e_action_trigger_annot_page_open = 7 , e_action_trigger_annot_page_close = 8 , e_action_trigger_annot_page_visible = 9 , e_action_trigger_annot_page_invisible = 10 }
enum	AnnotationState { e_normal , e_rollover , e_down }
typedef pdftron::PDF::BorderStyle	BorderStyle

Detailed Description

A Caret annotation (PDF 1.5) is a visual symbol that indicates the presence of text edits.

Definition at line 17 of file Caret.h.

Constructor & Destructor Documentation

◆ Caret() [1/2]

pdftron::PDF::Annots::Caret::Caret ( SDF::Obj d = 0 )

Creates an Caret annotation and initializes it using given Cos/SDF object.

Parameters

d	The Cos/SDF object to initialze the annotation with.

Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.

◆ Caret() [2/2]

pdftron::PDF::Annots::Caret::Caret ( const Annot & ann )

inline

Creates an Caret annotation and initializes it using given annotation object.

Parameters

ann	Annot object used to initialize the Caret annotation.

Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Definition at line 35 of file Caret.h.

Member Function Documentation

◆ Create() [1/2]

Caret pdftron::PDF::Annots::Caret::Create	(	SDF::SDFDoc &	doc,
		const Rect &	pos )

static

Creates a new Caret annotation in the specified document.

Parameters

doc	A document to which the Caret annotation is added.
pos	A rectangle specifying the Caret annotation's bounds in default user space units.

Returns: A newly created blank Caret annotation.

◆ Create() [2/2]

Caret pdftron::PDF::Annots::Caret::Create	(	SDF::SDFDoc &	doc,
		const Rect &	pos,
		Rect	padding )

static

Creates a new Caret annotation, in the specified document, specifying
a set of four numbers that shall describe the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying Caret.

Parameters

doc	A document to which the Caret annotation is added.
pos	A rectangle specifying the Caret annotation's bounds in default user space units.
padding	A set of four numbers(represented as a Rect object)specifying the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying Caret.

Returns: A newly created Caret annotation with rectangle difference specified.

◆ CreateAnnot() [1/2]

Caret pdftron::PDF::Annots::Caret::CreateAnnot	(	SDF::SDFDoc &	doc,
		const Rect &	pos )

static

◆ CreateAnnot() [2/2]

Caret pdftron::PDF::Annots::Caret::CreateAnnot	(	SDF::SDFDoc &	doc,
		const Rect &	pos,
		Rect	padding )

static

◆ GetSymbol()

const char * pdftron::PDF::Annots::Caret::GetSymbol ( ) const

Returns the paragraph symbol associated with the caret.

Returns: The name of the symbol. This can be either "P" (Use a new paragraph symbol) or "None" (Don't use any symbol). Default value: None.

◆ SetSymbol()

void pdftron::PDF::Annots::Caret::SetSymbol ( const char * symbol )

Sets the caret symbol.

Parameters

symbol The name of the symbol. This can be either "P" (Use a new paragraph symbol) or "None" (Don't use any symbol). Default value: None.

The documentation for this class was generated from the following file:

PDF/Annots/Caret.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Caret() [1/2]

◆ Caret() [2/2]

Member Function Documentation

◆ Create() [1/2]

◆ Create() [2/2]

◆ CreateAnnot() [1/2]

◆ CreateAnnot() [2/2]

◆ GetSymbol()

◆ SetSymbol()