Foxit PDF SDK
|
Public Member Functions | |
Polygon () | |
Constructor. | |
Polygon (const Annot &annot) | |
Constructor, with parent class object. More... | |
~Polygon () | |
Destructor. | |
RGB | GetFillColor () const |
Get fill color. More... | |
float | GetMeasureConversionFactor (MeasureType measure_type) |
Get the conversion factor for measuring. More... | |
String | GetMeasureRatio () |
Get the scale ratio string for measuring. More... | |
WString | GetMeasureRatioW () |
Get the scale ratio Unicode string for measuring. More... | |
String | GetMeasureUnit (MeasureType measure_type) |
Get the label for displaying the units for measuring. More... | |
WString | GetMeasureUnitW (MeasureType measure_type) |
Get the label (in Unicode string) for displaying the units for measuring. More... | |
PointFArray | GetVertexes () |
Get vertexes. More... | |
void | SetFillColor (RGB fill_color) |
Set fill color. More... | |
void | SetMeasureConversionFactor (MeasureType measure_type, float factor) |
Set the conversion factor for measuring. More... | |
void | SetMeasureRatio (const String &ratio) |
Set the scale ratio string for measuring. More... | |
void | SetMeasureUnit (MeasureType measure_type, const String &unit) |
Set the label for displaying the units for measuring. 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 (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 polygon annotation displays a closed polygon on the page.
Polygon annotation is a kind of markup annotation, so class Polygon is derived from class Markup, and also offers functions to get/set polygon annotation's properties and reset appearance stream of a polygon annotation.
For a polygon annotation, vertexes property is required. So please ensure that a polygon annotation has valid vertexes property before resetting its appearance stream; otherwise the polygon annotation cannot be reset appearance stream.
|
explicit |
Constructor, with parent class object.
[in] | annot | Parent class object. |
RGB foxit::pdf::annots::Polygon::GetFillColor | ( | ) | const |
Get fill color.
This property has effect on polygon annotation's appearance.
float foxit::pdf::annots::Polygon::GetMeasureConversionFactor | ( | MeasureType | measure_type | ) |
Get the conversion factor for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
[in] | measure_type | Measure type. Please refer to values starting from Markup::e_MeasureTypeX and this would be one of these values. |
String foxit::pdf::annots::Polygon::GetMeasureRatio | ( | ) |
Get the scale ratio string for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Scale ratio string expresses the scale radio of the drawing in the region. Please refer to P745 in <PDF Reference 1.7> for more details.
WString foxit::pdf::annots::Polygon::GetMeasureRatioW | ( | ) |
Get the scale ratio Unicode string for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Scale ratio string expresses the scale radio of the drawing in the region. Please refer to P745 in <PDF Reference 1.7> for more details.
String foxit::pdf::annots::Polygon::GetMeasureUnit | ( | MeasureType | measure_type | ) |
Get the label for displaying the units for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
[in] | measure_type | Measure type. Please refer to values starting from Markup::e_MeasureTypeX and this should be one of these values. |
WString foxit::pdf::annots::Polygon::GetMeasureUnitW | ( | MeasureType | measure_type | ) |
Get the label (in Unicode string) for displaying the units for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
[in] | measure_type | Measure type. Please refer to values starting from Markup::e_MeasureTypeX and this should be one of these values. |
PointFArray foxit::pdf::annots::Polygon::GetVertexes | ( | ) |
Get vertexes.
Vertexes property is required for a polygon annotation and this property has effect on polygon annotation's appearance.
void foxit::pdf::annots::Polygon::SetFillColor | ( | RGB | fill_color | ) |
Set fill color.
This property has effect on polygon annotation's appearance. If user wants the new fill color has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting the new fill color.
[in] | fill_color | New fill color to be set. Format: 0xRRGGBB. |
void foxit::pdf::annots::Polygon::SetMeasureConversionFactor | ( | MeasureType | measure_type, |
float | factor | ||
) |
Set the conversion factor for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
[in] | measure_type | Measure type. Please refer to values starting from Markup::e_MeasureTypeX and this would be one of these values. |
[in] | factor | The conversion factor. |
void foxit::pdf::annots::Polygon::SetMeasureRatio | ( | const String & | ratio | ) |
Set the scale ratio string for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Scale ratio string expresses the scale radio of the drawing in the region. Please refer to P745 in <PDF Reference 1.7> for more details.
[in] | ratio | A UTF-8 byte string expressing the scale ratio. The string should be like: "1/4 in = 1 ft", indicating that 1/4 inches in default user space is equivalent to 1 foot in real-world measurements. |
void foxit::pdf::annots::Polygon::SetMeasureUnit | ( | MeasureType | measure_type, |
const String & | unit | ||
) |
Set the label for displaying the units for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
[in] | measure_type | Measure type. Please refer to values starting from Markup::e_MeasureTypeX and this should be one of these values. |
[in] | unit | A UTF-8 text string that specifies a label for displaying the units. |
void foxit::pdf::annots::Polygon::SetVertexes | ( | const PointFArray & | vertexes | ) |
Set vertexes.
Vertexes property is required for a polygon annotation and this property has effect on polygon 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 for vertexes. It should contains at least 2 points as vertexes. |