My Project
|
Public Member Functions | |
Line () | |
Constructor. | |
Line (const Annot &annot) | |
Constructor, with parent class object. More... | |
~Line () | |
Destructor. | |
void | EnableCaption (bool cap) |
Set the flag which is used to decide whether the content of current line annotation should be replicated as a caption in the appearance or not. More... | |
Offset | GetCaptionOffset () const |
Get caption offset values. More... | |
CapPos | GetCaptionPositionType () const |
Get the position type of caption. More... | |
PointF | GetEndPoint () const |
Get the end point. More... | |
float | GetLeaderLineExtensionLength () const |
Get the length of leader line extension. More... | |
float | GetLeaderLineLength () const |
Get the length of leader line. More... | |
float | GetLeaderLineOffset () const |
Get the length of leader line offset. More... | |
EndingStyle | GetLineEndStyle () const |
Get line ending style of the end point. More... | |
EndingStyle | GetLineStartStyle () const |
Get line ending style of the start point. More... | |
float | GetMeasureConversionFactor (int measure_type) |
Get the conversion factor for measuring. More... | |
String | GetMeasureRatio () |
Get the scale ratio string for measuring. More... | |
String | GetMeasureUnit (int measure_type) |
Get the label for displaying the units for measuring. More... | |
PointF | GetStartPoint () const |
Get the start point. More... | |
RGB | GetStyleFillColor () const |
Get fill color for ending styles. More... | |
bool | HasCaption () const |
Check whether the content of current line annotation should be replicated as a caption in the appearance or not. More... | |
void | SetCaptionOffset (const Offset &offset) |
Set caption offset values. More... | |
void | SetCaptionPositionType (CapPos cap_position) |
Set the position type of caption. More... | |
void | SetEndPoint (const PointF &point) |
Set the end point. More... | |
void | SetLeaderLineExtensionLength (float extension_length) |
Set the length of leader line extension. More... | |
void | SetLeaderLineLength (float length) |
Set the length of leader line. More... | |
void | SetLeaderLineOffset (float offset) |
Set the length of leader line offset. More... | |
void | SetLineEndStyle (EndingStyle ending_style) |
Set line ending style of the end point. More... | |
void | SetLineStartStyle (EndingStyle ending_style) |
Set line ending style of the start point. More... | |
void | SetMeasureConversionFactor (int 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 (int measure_type, const String &unit) |
Set the label for displaying the units for measuring. More... | |
void | SetStartPoint (const PointF &point) |
Set the start point. More... | |
void | SetStyleFillColor (RGB color) |
Set fill color for ending styles. 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 line annotation displays a single straight line on the page.
Line annotation is a kind of markup annotation, so class Line is derived from class Markup, and also offers functions to get/set line annotation's properties and reset appearance stream of a line annotation.
For a line annotation, start point and end point are required. So please ensure that a line annotation has valid start point and end point before resetting its appearance stream; otherwise the line annotation cannot be reset appearance stream.
|
explicit |
Constructor, with parent class object.
[in] | annot | Parent class object. |
void foxit::pdf::annots::Line::EnableCaption | ( | bool | cap | ) |
Set the flag which is used to decide whether the content of current line annotation should be replicated as a caption in the appearance or not.
This property has effect on line annotation's appearance. If user wants the effect to be shown in annotation's appearance, please call function Annot::ResetAppearanceStream after this function.
[in] | cap | true means the content should be replicated as a caption in the appearance of current line annotation, while false means not. |
Offset foxit::pdf::annots::Line::GetCaptionOffset | ( | ) | const |
Get caption offset values.
Caption offset is the offset of caption from its normal position.
Only when current line annotation have a caption, this property is meaningful and has effect on line's annotation's appearance. Function Line::HasCaption can be used to check if current line annotation should have a caption, and function Line::EnableCaption can be used to change the status.
CapPos foxit::pdf::annots::Line::GetCaptionPositionType | ( | ) | const |
Get the position type of caption.
Only when current line annotation have a caption, this property is meaningful and has effect on line's annotation's appearance. Function Line::HasCaption can be used to check if current line annotation should have a caption, and function Line::EnableCaption can be used to change the status.
PointF foxit::pdf::annots::Line::GetEndPoint | ( | ) | const |
Get the end point.
Start point and end point are required for a line annotation. They have effect on line annotation's appearance.
float foxit::pdf::annots::Line::GetLeaderLineExtensionLength | ( | ) | const |
Get the length of leader line extension.
Leader line extensions extend from the line proper 180 degrees from the leader lines.
For more details, please refer to "Line Annotations" in Section 8.4.5 "Annotation Types" of <PDF reference 1.7> .
float foxit::pdf::annots::Line::GetLeaderLineLength | ( | ) | const |
Get the length of leader line.
Leader lines extend from each endpoint of a line perpendicular to the line itself. A positive value means that the leader lines appear in the direction that is clockwise when traversing the line from its start point to its end point; a negative value indicates the opposite direction. Specially, even the length of leader line is 0, the line annotation can still have leader line extension and leader line offset. For this case, the direction of leader line is same as positive length value in order that the direction or position of leader line extension and offset can still be judged.
For more details, please refer to "Line Annotations" in Section 8.4.5 "Annotation Types" of <PDF reference 1.7> .
float foxit::pdf::annots::Line::GetLeaderLineOffset | ( | ) | const |
Get the length of leader line offset.
Leader line offset is the amount of empty space between the endpoints of the line annotation and the beginning of the leader lines.
For more details, please refer to "Line Annotations" in Section 8.4.5 "Annotation Types" of <PDF reference 1.7> .
EndingStyle foxit::pdf::annots::Line::GetLineEndStyle | ( | ) | const |
Get line ending style of the end point.
This property has effect on line annotation's appearance.
EndingStyle foxit::pdf::annots::Line::GetLineStartStyle | ( | ) | const |
Get line ending style of the start point.
This property has effect on line annotation's appearance.
float foxit::pdf::annots::Line::GetMeasureConversionFactor | ( | int | measure_type | ) |
Get the conversion factor for measuring.
A line 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. Currently it should be 0, which means distance measurement. |
String foxit::pdf::annots::Line::GetMeasureRatio | ( | ) |
Get the scale ratio string for measuring.
A line 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::Line::GetMeasureUnit | ( | int | measure_type | ) |
Get the label for displaying the units for measuring.
A line 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. Currently it should be 0, which means distance measurement. |
PointF foxit::pdf::annots::Line::GetStartPoint | ( | ) | const |
Get the start point.
Start point and end point are required for a line annotation. They have effect on line annotation's appearance.
RGB foxit::pdf::annots::Line::GetStyleFillColor | ( | ) | const |
Get fill color for ending styles.
This property has effect on line annotation's appearance. Fill color is used for some line ending styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".
bool foxit::pdf::annots::Line::HasCaption | ( | ) | const |
Check whether the content of current line annotation should be replicated as a caption in the appearance or not.
void foxit::pdf::annots::Line::SetCaptionOffset | ( | const Offset & | offset | ) |
Set caption offset values.
Caption offset is the offset of caption from its normal position.
Only when current line annotation have a caption, this property is meaningful and has effect on line's annotation's appearance. Function Line::HasCaption can be used to check if current line annotation should have a caption, and function Line::EnableCaption can be used to change the status.
If user wants the effect to be shown in annotation's appearance, please call function Annot::ResetAppearanceStream after this function.
[in] | offset | New offset values . |
void foxit::pdf::annots::Line::SetCaptionPositionType | ( | CapPos | cap_position | ) |
Set the position type of caption.
Only when current line annotation have a caption, this property is meaningful and has effect on line's annotation's appearance. Function Line::HasCaption can be used to check if current line annotation should have a caption, and function Line::EnableCaption can be used to change the status.
If user wants the effect to be shown in annotation's appearance, please call function Annot::ResetAppearanceStream after this function.
[in] | cap_position | The position type of caption. Please refer to values starting from Line::e_CapPosInline and this should be one of these values. |
void foxit::pdf::annots::Line::SetEndPoint | ( | const PointF & | point | ) |
Set the end point.
Start point and end point are required for a line annotation. They have effect on line annotation's appearance.
If user wants the new end point has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting new end point.
[in] | point | New point that specifies the end point. |
void foxit::pdf::annots::Line::SetLeaderLineExtensionLength | ( | float | extension_length | ) |
Set the length of leader line extension.
Leader line extensions extend from the line proper 180 degrees from the leader lines.
For more details, please refer to "Line Annotations" in Section 8.4.5 "Annotation Types" of <PDF reference 1.7> .
[in] | extension_length | The length of leader line extension. It should be a non-negative value. 0 means no leader line extension. |
void foxit::pdf::annots::Line::SetLeaderLineLength | ( | float | length | ) |
Set the length of leader line.
Leader lines extend from each endpoint of a line perpendicular to the line itself. A positive value means that the leader lines appear in the direction that is clockwise when traversing the line from its start point to its end point; a negative value indicates the opposite direction. Specially, even the length of leader line is 0, the line annotation can still have leader line extension and leader line offset. For this case, the direction of leader line is same as positive length value in order that the direction or position of leader line extension and offset can still be judged.
For more details, please refer to "Line Annotations" in Section 8.4.5 "Annotation Types" of <PDF reference 1.7> .
[in] | length | The length of leader lines. See details part for more details. 0 means no leader line. |
void foxit::pdf::annots::Line::SetLeaderLineOffset | ( | float | offset | ) |
Set the length of leader line offset.
Leader line offset is the amount of empty space between the endpoints of the line annotation and the beginning of the leader lines.
For more details, please refer to "Line Annotations" in Section 8.4.5 "Annotation Types" of <PDF reference 1.7> .
[in] | offset | The length of leader line offset. It should be a non-negative value. 0 means no leader line extension. |
void foxit::pdf::annots::Line::SetLineEndStyle | ( | EndingStyle | ending_style | ) |
Set line ending style of the end point.
This property has effect on line annotation's appearance. If user wants the new line ending style has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting new line ending style.
[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::Line::SetLineStartStyle | ( | EndingStyle | ending_style | ) |
Set line ending style of the start point.
This property has effect on line annotation's appearance. If user wants the new line ending style has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting new line ending style.
[in] | ending_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::Line::SetMeasureConversionFactor | ( | int | measure_type, |
float | factor | ||
) |
Set the conversion factor for measuring.
A line 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. Currently it should be 0, which means distance measurement. |
[in] | factor | The conversion factor. |
void foxit::pdf::annots::Line::SetMeasureRatio | ( | const String & | ratio | ) |
Set the scale ratio string for measuring.
A line 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 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::Line::SetMeasureUnit | ( | int | measure_type, |
const String & | unit | ||
) |
Set the label for displaying the units for measuring.
A line 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. Currently it should be 0, which means distance measurement. |
[in] | unit | A text string that specifies a label for displaying the units. |
void foxit::pdf::annots::Line::SetStartPoint | ( | const PointF & | point | ) |
Set the start point.
Start point and end point are required for a line annotation. They have effect on line annotation's appearance.
If user wants the new start point has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting new start point.
[in] | point | New point that specifies the start point. |
void foxit::pdf::annots::Line::SetStyleFillColor | ( | RGB | color | ) |
Set fill color for ending styles.
This property has effect on line annotation's appearance. Fill color is used for some line ending styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".
If user wants the new fill color has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting new fill color.
[in] | color | New fill color of ending style. Format: 0xRRGGBB. |