My Project
|
Public Member Functions | |
PolyLine () | |
Constructor. | |
PolyLine (const Annot &annot) | |
Constructor, with parent class object. More... | |
~PolyLine () | |
Destructor. | |
EndingStyle | GetLineEndStyle () const |
Get line ending style of the end point. More... | |
EndingStyle | GetLineStartStyle () const |
Get line ending style of the start point. More... | |
RGB | GetStyleFillColor () const |
Get fill color for some line ending styles. More... | |
PointFArray | GetVertexes () |
Get vertexes. More... | |
void | SetLineEndStyle (EndingStyle ending_style) |
Set line ending style of the end point. More... | |
void | SetLineStartStyle (EndingStyle starting_style) |
Set line ending style of the start point. More... | |
void | SetStyleFillColor (RGB fill_color) |
Set fill color for some line ending styles. More... | |
void | SetVertexes (const PointFArray &vertexes) |
Set vertexes. 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 (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 polyline annotation (PDF 1.5) is similar to a polygon, except that the first and last vertex are not implicitly connected.
Polyline annotation is a kind of markup annotation, so class PolyLine is derived from class Markup, and also offers functions to get/set polyline annotation's properties and reset appearance stream of a polyline annotation.
For a polyline annotation, vertexes property is required. So please ensure that a polyline annotation has valid vertexes property before resetting its appearance stream; otherwise the polyline annotation cannot be reset appearance stream.
|
explicit |
Constructor, with parent class object.
[in] | annot | Parent class object. |
EndingStyle foxit::pdf::annots::PolyLine::GetLineEndStyle | ( | ) | const |
Get line ending style of the end point.
This property has effect on polyline annotation's appearance.
EndingStyle foxit::pdf::annots::PolyLine::GetLineStartStyle | ( | ) | const |
Get line ending style of the start point.
This property has effect on polyline annotation's appearance.
RGB foxit::pdf::annots::PolyLine::GetStyleFillColor | ( | ) | const |
Get fill color for some line ending styles.
This property has effect on polyline annotation's appearance when the line ending style is one of following styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".
PointFArray foxit::pdf::annots::PolyLine::GetVertexes | ( | ) |
Get vertexes.
Vertexes property is required for a polyline annotation and this property has effect on polyline annotation's appearance.
void foxit::pdf::annots::PolyLine::SetLineEndStyle | ( | EndingStyle | ending_style | ) |
Set line ending style of the end point.
This property has effect on polyline annotation's appearance. If user wants the new line ending style of end point has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting the new line ending style of end point.
[in] | ending_style | The line ending style for the end point to be set. Please refer to values starting from Markup::e_EndingStyleNone and this should be one of these values. |
void foxit::pdf::annots::PolyLine::SetLineStartStyle | ( | EndingStyle | starting_style | ) |
Set line ending style of the start point.
This property has effect on polyline annotation's appearance. If user wants the new line ending style of start point has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting the new line ending style of start point.
[in] | starting_style | The line ending style for the start point to be set.Please refer to values starting from Markup::e_EndingStyleNone and this should be one of these values. |
void foxit::pdf::annots::PolyLine::SetStyleFillColor | ( | RGB | fill_color | ) |
Set fill color for some line ending styles.
This property has effect on polyline annotation's appearance when the line ending style of start point or end point is one of following styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".
[in] | fill_color | New fill color to be set. Format: 0xRRGGBB. |
void foxit::pdf::annots::PolyLine::SetVertexes | ( | const PointFArray & | vertexes | ) |
Set vertexes.
Vertexes property is required for a polyline annotation and this property has effect on polyline annotation's appearance. If user wants the new vertexes have effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting the new vertexes.
[in] | vertexes | A valid point array of vertexes. It should contains at least 2 points as vertexes. |