Foxit PDF SDK
|
Public Member Functions | |
Note () | |
Constructor. | |
Note (const Annot &annot) | |
Constructor, with parent class object. More... | |
~Note () | |
Destructor. | |
String | GetIconName () const |
Get icon name. More... | |
bool | GetOpenStatus () const |
Get open status. More... | |
Markup | GetReplyTo () |
Get the markup annotation, which current note annotation is in reply to. More... | |
State | GetState () |
Get the state. More... | |
StateModel | GetStateModel () |
Get the state model. More... | |
bool | IsStateAnnot () |
Check if current note annotation is used as a state annotation. More... | |
void | SetIconName (const char *icon_name) |
Set icon name. More... | |
void | SetOpenStatus (bool status) |
Set open status. More... | |
void | SetState (State state) |
Set the state. More... | |
![]() | |
Markup (const Annot &annot) | |
Constructor, with parent class object. More... | |
Markup () | |
Constructor. | |
~Markup () | |
Destructor. | |
Note | AddReply () |
Add a new reply to the end of reply list. More... | |
Note | AddStateAnnot (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... | |
Note | GetStateAnnot (StateModel model, int index) |
Get a state annotation, under a specified state model. More... | |
int | GetStateAnnotCount (StateModel model) |
Get the count of state annotations, under a specified state model. More... | |
WString | GetSubject () const |
Get subject string. More... | |
WString | GetTitle () const |
Get title string. 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 state annotations. More... | |
bool | RemoveReply (int index) |
Remove a reply 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 | 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 (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 (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 | 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 note annotation (known as "text" annotation in <PDF reference 1.7>) 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.
A note annotation can also be used as a reply to a markup annotation, or a state annotation:
Note annotation is a kind of markup annotation, so class Note is derived from class Markup. It offers functions to get/set note annotation's properties and reset appearance of a note annotation.
|
explicit |
Constructor, with parent class object.
[in] | annot | Parent class object. |
String foxit::pdf::annots::Note::GetIconName | ( | ) | const |
Get icon name.
This property has effect on note annotation's appearance. Note annotation has predefined standard icon names:
"Check", "Circle", "Comment", "Cross", "Help", "Insert", "Key", "NewParagraph", "Note", "Paragraph", "RightArrow", "RightPointer", "Star", "UpArrow", "UpLeftArrow".
An empty icon name string means current note annotation would be treated as "Note" icon.
bool foxit::pdf::annots::Note::GetOpenStatus | ( | ) | const |
Get open status.
Open status is a boolean value that specifies whether a note annotation should initially be displayed open:
Markup foxit::pdf::annots::Note::GetReplyTo | ( | ) |
Get the markup annotation, which current note annotation is in reply to.
This function is only useful when current note annotation is used as a reply.
State foxit::pdf::annots::Note::GetState | ( | ) |
Get the state.
This function can only be used when current note annotation is used as a state annotation. Function Note::IsStateAnnot can be used to check if current note annotation is used as a state annotation.
StateModel foxit::pdf::annots::Note::GetStateModel | ( | ) |
Get the state model.
This function can only be used when current note annotation is used as a state annotation. Function Note::IsStateAnnot can be used to check if current note annotation is used as a state annotation.
bool foxit::pdf::annots::Note::IsStateAnnot | ( | ) |
Check if current note annotation is used as a state annotation.
void foxit::pdf::annots::Note::SetIconName | ( | const char * | icon_name | ) |
Set icon name.
This property has effect on note annotation's appearance. Note annotation has predefined standard icon names:
"Check", "Circle", "Comment", "Cross", "Help", "Insert", "Key", "NewParagraph", "Note", "Paragraph", "RightArrow", "RightPointer", "Star", "UpArrow", "UpLeftArrow".
An empty icon name string means current note annotation would be treated as "Note" icon.
For a newly created note annotation, if current function is not called, icon name will be "Comment" by default.
If user wants the new icon name has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting the new icon name.
[in] | icon_name | New icon name string to be set. |
void foxit::pdf::annots::Note::SetOpenStatus | ( | bool | status | ) |
Set open status.
Open status is a boolean value that specifies whether a note annotation should initially be displayed open:
[in] | status | The new open status value. |
void foxit::pdf::annots::Note::SetState | ( | State | state | ) |
Set the state.
This function can only be used when current note annotation is used as a state annotation. Function Note::IsStateAnnot can be used to check if current note annotation is used as a state annotation.
[in] | state | New state. It should be one of following values:
|