Public Member Functions | |
Link () | |
Constructor. | |
Link (const Annot &annot) | |
Constructor, with parent class object. More... | |
~Link () | |
Destructor. | |
actions::Action | GetAction () |
Get action. More... | |
HighlightingMode | GetHighlightingMode () |
Get highlighting mode. More... | |
QuadPointsArray | GetQuadPoints () const |
Get quadrilaterals. More... | |
bool | RemoveAction () |
Remove action. More... | |
void | SetAction (const actions::Action &action) |
Set action. More... | |
void | SetHighlightingMode (HighlightingMode mode) |
Set highlighting mode. More... | |
void | SetQuadPoints (const QuadPointsArray &quad_points_array) |
Set quadrilaterals. More... | |
![]() | |
Annot (const PDFPage &page, objects::PDFDictionary *annot_dict) | |
Constructor, with PDF page and annotation's PDF dictionary. More... | |
Annot (const Annot &annot) | |
Constructor, with another annotation object. More... | |
Annot () | |
Constructor. | |
virtual | ~Annot () |
Destructor. | |
objects::PDFStream * | GetAppearanceStream (AppearanceType type, const char *appearance_state="") const |
Get annotation's appearance stream with specified type and state. More... | |
RGB | GetBorderColor () const |
Get border color. More... | |
BorderInfo | GetBorderInfo () const |
Get border information. More... | |
WString | GetContent () const |
Get content. More... | |
RectI | GetDeviceRect (bool is_transform_icon, const Matrix &matrix) |
Get annotation rectangle in device coordinate system. More... | |
objects::PDFDictionary * | GetDict () const |
Get annotation's dictionary object. More... | |
uint32 | GetFlags () const |
Get annotation flags. More... | |
int | GetIndex () const |
Get the index of current annotation in the page which current annotation belongs to. More... | |
DateTime | GetModifiedDateTime () const |
Get last modified date time. More... | |
objects::PDFDictionary * | GetOptionalContent () const |
Get the PDF dictionary of annotation's optional content. More... | |
PDFPage | GetPage () const |
Get the related PDF page. More... | |
RectF | GetRect () const |
Get rectangle, in PDF coordinate system. More... | |
Type | GetType () const |
Get actual annotation type of current annotation. More... | |
WString | GetUniqueID () const |
Get unique ID. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | IsMarkup () const |
Check if current annotation is a markup annotation. More... | |
bool | Move (const RectF &rect) |
Move current annotation to a new position, specified by a new rectangle in PDF coordinate system. More... | |
bool | operator!= (const Annot &other) const |
Not equal operator. More... | |
Annot & | operator= (const Annot &annot) |
Assign operator. More... | |
bool | operator== (const Annot &other) const |
Equal operator. More... | |
bool | RemoveProperty (Property property) |
Remove a specified annotation's property. More... | |
bool | ResetAppearanceStream () |
Reset appearance stream. More... | |
void | SetBorderColor (RGB color) |
Set border color. More... | |
void | SetBorderInfo (const BorderInfo &border) |
Set border information. More... | |
void | SetContent (const WString &content) |
Set content. More... | |
void | SetFlags (uint32 flags) |
Set annotation flags. More... | |
void | SetModifiedDateTime (const DateTime &date_time) |
Set last modified date time. More... | |
void | SetUniqueID (const WString &unique_id) |
Set unique ID. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
A link annotation represents an action to be performed.
Class annots::Link is derived from Annot, and offers functions to get/set link annotation's properties and reset appearance stream of a link annotation.
|
explicit |
Constructor, with parent class object.
[in] | annot | Parent class object. |
actions::Action foxit::pdf::annots::Link::GetAction | ( | ) |
Get action.
HighlightingMode foxit::pdf::annots::Link::GetHighlightingMode | ( | ) |
Get highlighting mode.
QuadPointsArray foxit::pdf::annots::Link::GetQuadPoints | ( | ) | const |
Get quadrilaterals.
The order of points in a quadrilateral should be:
bool foxit::pdf::annots::Link::RemoveAction | ( | ) |
Remove action.
void foxit::pdf::annots::Link::SetAction | ( | const actions::Action & | action | ) |
Set action.
[in] | action | New action to be set. It should be valid. Currently only support following types as the new action: actions::Action::e_TypeGoto, actions::Action::e_TypeURI, actions::Action::e_TypeJavaScript, actions::Action::e_TypeNamed, actions::Action::e_TypeGoToR, actions::Action::e_TypeGoToE, actions::Action::e_TypeSubmitForm, actions::Action::e_TypeResetForm, actions::Action::e_TypeHide, actions::Action::e_TypeLaunch, actions::Action::e_TypeImportData, actions::Action::e_TypeRendition. |
void foxit::pdf::annots::Link::SetHighlightingMode | ( | HighlightingMode | mode | ) |
Set highlighting mode.
[in] | mode | New highlighting mode value. Please refer to values starting from Annot::e_HighlightingNone and this should be one of these values except Annot::e_HighlightingToggle. |
void foxit::pdf::annots::Link::SetQuadPoints | ( | const QuadPointsArray & | quad_points_array | ) |
Set quadrilaterals.
This property has effect on the link annotation's appearance.The order of points in a quadrilateral should be :
If user wants the new quadrilaterals has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting quadrilaterals.
[in] | quad_points_array | A valid array of quadrilaterals. It should not be an empty array. |