Foxit PDF SDK
|
Public Member Functions | |
Ink () | |
Constructor. | |
Ink (const Annot &annot) | |
Constructor, with parent class object. More... | |
~Ink () | |
Destructor. | |
void | EnableUseBezier (bool use_bezier) |
Enable to use bezier spline to generate ink path for ink annotation's appearance. More... | |
common::Path | GetInkList () |
Get ink list data. More... | |
void | SetInkList (const common::Path &ink_list) |
Set ink list data. More... | |
![]() | |
Markup () | |
Constructor. | |
Markup (const Annot &annot) | |
Constructor, with parent class object. More... | |
~Markup () | |
Destructor. | |
Note | AddReply () |
Add a new reply to the end of reply list. More... | |
void | AddRichText (const WString &content, const RichTextStyle &style) |
Add a new rich text string to the end. More... | |
Note | AddStateAnnot (const WString &title, StateModel model, State state) |
Add a new state annotation. More... | |
DateTime | GetCreationDateTime () const |
Get creation date time. More... | |
MarkupArray | GetGroupElements () |
Get an element (as markup annotation) from the group that current markup annotation belongs to. More... | |
Markup | GetGroupHeader () |
Get the header annotation (as primary annotation) of the group that current markup annotation belongs to. More... | |
String | GetIntent () const |
Get intent name. More... | |
float | GetOpacity () const |
Get opacity value. More... | |
Popup | GetPopup () |
Get related pop-up annotation. More... | |
Note | GetReply (int index) const |
Get a reply by index. More... | |
int | GetReplyCount () |
Count all replies. More... | |
WString | GetRichTextContent (int32 index) |
Get text string of a rich text string specified by index. More... | |
int32 | GetRichTextCount () |
Get the count of rich text strings. More... | |
RichTextStyle | GetRichTextStyle (int32 index) |
Get style data of a rich text string specified by index. More... | |
NoteArray | GetStateAnnots (StateModel model) |
Get all state annotations in a specified state model. More... | |
WString | GetSubject () const |
Get subject string. More... | |
WString | GetTitle () const |
Get title string. More... | |
void | InsertRichText (int32 index, const WString &content, const RichTextStyle &style) |
Insert a new rich text string to the place which is specified by index. More... | |
bool | IsGrouped () |
Check whether current markup annotation is in a group or not. More... | |
bool | RemoveAllReplies () |
Remove all the replies. More... | |
bool | RemoveAllStateAnnots () |
Remove all the state annotations. More... | |
bool | RemovePopup () |
Remove related pop-up annotation. More... | |
bool | RemoveReply (int index) |
Remove a reply by index. More... | |
void | RemoveRichText (int index) |
Remove a rich text string specified by index. More... | |
void | SetCreationDateTime (const DateTime &date_time) |
Set creation date time. More... | |
void | SetIntent (const String &intent) |
Set intent name. More... | |
void | SetOpacity (float opacity) |
Set opacity value. More... | |
void | SetPopup (const Popup &popup) |
Set related pop-up annotation. More... | |
void | SetRichTextContent (int32 index, const WString &content) |
Set text string of a rich text string specified by index. More... | |
void | SetRichTextStyle (int32 index, const RichTextStyle &style) |
Set style data of a rich text string specified by index. More... | |
void | SetSubject (const WString &subject) |
Set subject string. More... | |
void | SetTitle (const WString &title) |
Set title string. More... | |
bool | Ungroup () |
Ungroup current markup annotation from the group it belongs to. More... | |
![]() | |
Annot () | |
Constructor. | |
Annot (const Annot &annot) | |
Constructor, with another annotation object. More... | |
Annot (const PDFPage &page, objects::PDFDictionary *annot_dict) | |
Constructor, with PDF page and annotation's PDF dictionary. More... | |
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 (const Matrix &matrix) |
Get annotation rectangle in device coordinate system. More... | |
objects::PDFDictionary * | GetDict () const |
Get annotation's dictionary object. More... | |
Matrix | GetDisplayMatrix (const Matrix &page_display_matrix) |
Get the display matrix, from PDF coordinate system to targeted device coordinate system. 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 | HasProperty (Property property) const |
Whether current annotation has the specified annotation's property. 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 | Move (const RectF &rect, bool is_reset_appearance) |
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... | |
bool | ResetAppearanceStream (bool is_generate_new_appearance_obj) |
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... | |
An ink annotation represents a freehand "scribble" composed of one or more disjoint paths.
Ink annotation is a kind of markup annotation, so class Ink is derived from class Markup, offers functions to get/set ink annotation's properties and also and reset appearance stream of an ink annotation.
For an ink annotation, ink list property is required. So please ensure that an ink annotation has valid ink list property before resetting its appearance stream; otherwise the ink annotation cannot be reset appearance stream.
|
explicit |
Constructor, with parent class object.
[in] | annot | Parent class object. |
void foxit::pdf::annots::Ink::EnableUseBezier | ( | bool | use_bezier | ) |
Enable to use bezier spline to generate ink path for ink annotation's appearance.
If this function is not called, Foxit PDF SDK will use bezier spline to generate ink path by default.
[in] | use_bezier | A boolean to decide whether to use bezier spline or not: true means to use bezier spline to generate ink path, while false means to use straight line to connect adjacent points to generate ink path. |
common::Path foxit::pdf::annots::Ink::GetInkList | ( | ) |
Get ink list data.
Ink list property is required for an ink annotation and this property has effect on ink annotation's appearance. The ink list contains one or more stroked path.
In Foxit PDF SDK, class common::Path is used to represent the ink list data, but the point types for path object have been specially simplified for ink list. Only common::Path::e_TypeMoveTo and common::Path::e_TypeLineTo types are used for points in the ink list:
Operations such as move the ink annotation, or set a new ink path to this annotation will update the ink path data, so that the previous returned path object would become invalid. In this case, user should call this function again to obtain the new path object.
void foxit::pdf::annots::Ink::SetInkList | ( | const common::Path & | ink_list | ) |
Set ink list data.
Ink list property is required for an ink annotation and this property has effect on ink annotation's appearance. The ink list contains one or more stroked path.
In Foxit PDF SDK, class common::Path is used to represent the ink list data, but the point types for path object have been specially simplified for ink list. Only common::Path::e_TypeMoveTo and common::Path::e_TypeLineTo types are used for points in the ink list:
Specially, if input parameter ink_list contains bezier points (for example, added by function common::Path::CubicBezierTo), the control points will be ignored and only the target point will be used in the ink list data.
User is strongly recommended to pass a valid path object only with point types common::Path::e_TypeMoveTo and common::Path::e_TypeLineTo.
If user wants the effect to be shown in annotation's appearance, please call function Annot::ResetAppearanceStream after this function.
[in] | ink_list | New path object which specifies the new list data. |