Go to the documentation of this file.
58 typedef enum _DefAPFlags {
209 typedef enum _CornerMarkStyle {
321 return !((*this) == style);
414 typedef enum _Style {
748 typedef enum _ScaleWayType {
752 e_ScaleWayAlways = 1,
754 e_ScaleWayBigger = 2,
756 e_ScaleWaySmaller = 3,
764 : scale_way_type(e_ScaleWayNone)
765 , is_proportional_scaling(false)
766 , horizontal_fraction(0)
767 , vertical_fraction(0)
768 , fit_bounds(false) {}
795 float vertical_fraction,
bool fit_bounds)
796 : scale_way_type(type)
797 , is_proportional_scaling(is_proportional_scaling)
798 , horizontal_fraction(horizontal_fraction)
799 , vertical_fraction(vertical_fraction)
800 , fit_bounds(fit_bounds) {}
808 : scale_way_type(icon_fit.scale_way_type)
809 , is_proportional_scaling(icon_fit.is_proportional_scaling)
810 , horizontal_fraction(icon_fit.horizontal_fraction)
811 , vertical_fraction(icon_fit.vertical_fraction)
812 , fit_bounds(icon_fit.fit_bounds) {}
888 float vertical_fraction,
bool fit_bounds) {
889 this->scale_way_type = type;
890 this->is_proportional_scaling = is_proportional_scaling;
891 this->horizontal_fraction = horizontal_fraction;
892 this->vertical_fraction = vertical_fraction;
893 this->fit_bounds = fit_bounds;
1043 typedef enum _Flags {
1123 typedef enum _HighlightingMode {
1141 typedef enum _Property {
1168 typedef enum _MKEntry {
1224 typedef enum _MKIconCaptionRelation {
1246 typedef enum _AppearanceType {
1266 #ifndef __EMSCRIPTEN_RENDER__
1276 #ifndef __EMSCRIPTEN_RENDER__
1302 #ifndef __EMSCRIPTEN_RENDER__
1448 bool Move(
const RectF& rect,
bool is_reset_appearance);
1634 : first_color(firstcolor)
1635 , second_color(secondcolor) {}
1639 : first_color(0xFFFFFFFF)
1640 , second_color(0xFFFFFFFF) {}
1648 : first_color(shading_color.first_color)
1649 , second_color(shading_color.second_color) {}
1695 this->first_color = firstcolor;
1696 this->second_color = secondcolor;
1769 #ifndef __EMSCRIPTEN_RENDER__
1797 RGB referenced_color,
int shading_index,
ShadingColor& out_shading_color) {
1863 typedef enum _StateModel {
1865 e_StateModelMarked = 1,
1867 e_StateModelReview = 2
1875 typedef enum _State {
1890 e_StateUnmarked = 2,
1895 e_StateAccepted = 3,
1900 e_StateRejected = 4,
1905 e_StateCancelled = 5,
1910 e_StateCompleted = 6,
1915 e_StateDeferred = 7,
1928 typedef enum _EndingStyle {
1930 e_EndingStyleNone = 0,
1932 e_EndingStyleSquare = 1,
1934 e_EndingStyleCircle = 2,
1936 e_EndingStyleDiamond = 3,
1938 e_EndingStyleOpenArrow = 4,
1944 e_EndingStyleClosedArrow = 5,
1946 e_EndingStyleButt = 6,
1948 e_EndingStyleROpenArrow = 7,
1950 e_EndingStyleRClosedArrow = 8,
1952 e_EndingStyleSlash = 9
1960 typedef enum _MeasureType {
2024 void SetPopup(
const Popup& popup);
2052 void SetTitle(
const WString& title);
2068 void SetSubject(
const WString& subject);
2078 float GetOpacity()
const;
2092 void SetOpacity(
float opacity);
2115 String GetIntent()
const;
2152 void SetIntent(
const String& intent);
2160 DateTime GetCreationDateTime()
const;
2169 void SetCreationDateTime(
const DateTime& date_time);
2176 int GetReplyCount();
2186 Note GetReply(
int index)
const;
2205 bool RemoveReply(
int index);
2212 bool RemoveAllReplies();
2302 NoteArray GetStateAnnots(StateModel model);
2340 Note AddStateAnnot(
const WString& title, StateModel model, State state);
2351 bool RemoveAllStateAnnots();
2359 int32 GetRichTextCount();
2384 void SetRichTextContent(
int32 index,
const WString& content);
2455 void RemoveRichText(
int index);
3607 typedef enum _CapPos {
4153 #ifndef __EMSCRIPTEN_RENDER__
5036 #ifndef __FSDK_NO_PSINK__
5093 typedef enum _LineSpacingStyle {
5117 #ifndef __EMSCRIPTEN_RENDER__
5660 #ifdef _SUPPORTWEBSDK_
5695 #ifndef __EMSCRIPTEN_RENDER__
5888 typedef enum _SampleEncodingFormat {
5913 #ifndef __EMSCRIPTEN_RENDER__
5987 #endif // FS_ANNOT_H_
Annotation type: caret annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1004
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Definition: fs_annot.h:4271
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
Annotation type: sound annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1012
~FileAttachment()
Destructor.
Definition: fs_annot.h:4925
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1000
RGB GetFillColor() const
Get fill color.
Definition: fs_annot.h:1625
RGB GetStyleFillColor() const
Get fill color for some line ending styles.
Annotation type: watermark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1027
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
void SetLeaderLineExtensionLength(float extension_length)
Set the length of leader line extension.
objects::PDFDictionary * GetDict() const
Get annotation's dictionary object.
Twos-complement values.
Definition: fs_annot.h:5892
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
~Note()
Destructor.
Definition: fs_annot.h:2493
Caption above the icon.
Definition: fs_annot.h:1232
FileAttachment()
Constructor.
Definition: fs_annot.h:4917
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1360
Annotation type: redact annotation.
Definition: fs_annot.h:1033
ShadingColor()
Constructor.
Definition: fs_annot.h:1638
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
int GetIndex() const
Get the index of current annotation in the page which current annotation belongs to.
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
Annotation type: square annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:986
RectF GetInnerRect() const
Get the inner rectangle.
void SetAction(const actions::Action &action)
Set action.
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
Definition: fs_filespec.h:38
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:2480
Circle()
Constructor.
Definition: fs_annot.h:3108
Type GetType() const
Get actual annotation type of current annotation.
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
~Underline()
Destructor.
Definition: fs_annot.h:2742
String GetIconName() const
Get icon name.
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:730
void AllowTextOverflow(bool is_text_overflow)
Decide whether to allow the text of freetext to overflow or not.
void SetIconName(const char *icon_name)
Set icon name.
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:1174
Definition: fs_action.h:418
void SetModifiedDateTime(const DateTime &date_time)
Set last modified date time.
Definition: fs_basictypes.h:446
Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1029
RectF GetRect() const
Get rectangle, in PDF coordinate system.
Annotation flag: locked contents.
Definition: fs_annot.h:1115
Definition: fs_annot.h:964
Annotation flag: hidden.
Definition: fs_annot.h:1056
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
No icon; captin only.
Definition: fs_annot.h:1226
void EnableUseBezier(bool use_bezier)
Enable to use bezier spline to generate ink path for ink annotation's appearance.
void SetState(State state)
Set the state.
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_annot.h:577
void Set(const common::Font &font, float text_size, common::Alignment text_alignment, RGB text_color, bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style)
Set value.
Definition: fs_annot.h:342
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Annotation's rollover appearance.
Definition: fs_annot.h:1250
Definition: fs_annot.h:5881
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
Caption below the icon.
Definition: fs_annot.h:1230
void SetLeaderLineOffset(float offset)
Set the length of leader line offset.
bool is_bold
A boolean value which indicates whether to make text bold or not.
Definition: fs_annot.h:382
bool is_proportional_scaling
A boolean value which indicates whether use proportional scaling or not.
Definition: fs_annot.h:910
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5890
bool ResetAppearanceStream()
Reset appearance stream.
RGB GetFillColor() const
Get fill color.
CornerMarkStyle mark_style
Corner mark style. Corner mark style which can be used to make text as superscript or subscript or no...
Definition: fs_annot.h:399
~Highlight()
Destructor.
Definition: fs_annot.h:2712
PointFArray GetVertexes()
Get vertexes.
Highlighting mode: Push, which is to display the annotation's down appearance, if any.
Definition: fs_annot.h:1131
bool IsStateAnnot()
Check if current note annotation is used as a state annotation.
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
Definition: fs_annot.h:2701
CFX_Object Object
Object type.
Definition: fs_basictypes.h:217
bool IsMarkup() const
Check if current annotation is a markup annotation.
Annotation type: screen annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1021
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current screen annotation, with a specified frame index.
Definition: fs_annot.h:2818
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
WString GetOverlayText() const
Get the overlay text.
Style style
Border style. Please refer to values starting from BorderInfo::e_Solid and this should be one of thes...
Definition: fs_annot.h:596
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:386
virtual PDFPage GetIcon(Annot::Type annot_type, const char *icon_name, ARGB color)
A callback function used to get the icon as PDF page contents for a specified type.
Highlight()
Constructor.
Definition: fs_annot.h:2704
Annotation property: fill color.
Definition: fs_annot.h:1160
void SetCalloutLineEndingStyle(EndingStyle ending_style)
Set line ending style of the start point in a callout line.
void SetUniqueID(const WString &unique_id)
Set unique ID.
Square()
Constructor.
Definition: fs_annot.h:2936
void SetMKDict(pdf::objects::PDFDictionary *dict)
Set the appearance characteristics dictionary (known as "MK" dictionary as well).
void SetFillColor(RGB fill_color)
Set fill color.
void SetEndPoint(const PointF &point)
Set the end point.
Caption to the left of the icon.
Definition: fs_annot.h:1236
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:509
Annotation flag: toggle no view.
Definition: fs_annot.h:1108
bool operator!=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:703
void Rotate(common::Rotation rotation)
Rotate current annotation from current state with specified rotation value (in clockwise).
actions::Action GetAction()
Get action.
void SetLineStartStyle(EndingStyle ending_style)
Set line ending style of the start point.
virtual float GetDisplayWidth(Annot::Type annot_type, const char *icon_name)
A callback function used to get the width for display of a specified icon, in device size(pixel norma...
Definition: fs_annot.h:1810
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1741
void SetAlignment(common::Alignment alignment)
Set alignment value.
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
Corner mark style: superscript.
Definition: fs_annot.h:213
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1875
void SetOverlayTextAlignment(common::Alignment alignment)
Set alignment value of overlay text.
~PolyLine()
Destructor.
Definition: fs_annot.h:4652
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:794
void SetCaptionPositionType(CapPos cap_position)
Set the position type of caption.
Definition: fs_annot.h:2791
void SetContent(const WString &content)
Set content.
Annotation type: rich media annotation.
Definition: fs_annot.h:1035
pdf::objects::PDFDictionary * GetMKDict() const
Get the appearance characteristics dictionary (known as "MK" dictionary as well).
HighlightingMode GetHighlightingMode()
Get highlighting mode.
float text_size
Text size. It should not be negative value. 0 means text will not be shown.
Definition: fs_annot.h:369
Annotation flag: no zoom.
Definition: fs_annot.h:1071
Header file for common definitions and classes.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2646
void SetBitmap(const common::Bitmap &bitmap)
Set bitmap to current stamp annotation.
virtual ~Annot()
Destructor.
EndingStyle GetCalloutLineEndingStyle() const
Get line ending style of the start point in a callout line.
Definition: fs_annot.h:2933
Screen()
Constructor.
Definition: fs_annot.h:4274
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1702
Border style: Cloudy.
Definition: fs_annot.h:450
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1031
float GetLeaderLineExtensionLength() const
Get the length of leader line extension.
void EnableRepeatOverlayText(bool is_to_repeat_overlay_text)
Set the flag to decide whether to repeat the overlay text.
Annotation type: free text annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:982
Border style: Solid.
Definition: fs_annot.h:416
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
bool fit_bounds
A boolean value that indicates whether to scale button appearance to fit fully within bounds or not.
Definition: fs_annot.h:929
Definition: fs_annot.h:2731
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:75
int GetChannelCount() const
Get the count of sound channels.
PolyLine()
Constructor.
Definition: fs_annot.h:4644
float GetLeaderLineOffset() const
Get the length of leader line offset.
Definition: fs_annot.h:4143
void Set(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Set value.
Definition: fs_annot.h:718
bool HasCaption() const
Check whether the content of current line annotation should be replicated as a caption in the appeara...
Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
Definition: fs_annot.h:1127
~Circle()
Destructor.
Definition: fs_annot.h:3116
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1172
uint32 GetFlags() const
Get annotation flags.
Header file for file operation related definitions and functions.
Indicates property font of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:60
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
bool RemoveAction()
Remove action.
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1633
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1694
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
WString GetUniqueID() const
Get unique ID.
Sound()
Constructor.
Definition: fs_annot.h:5901
objects::PDFStream * GetSoundStream() const
Get the stream of sound data.
String GetMeasureRatio()
Get the scale ratio string for measuring.
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
IconFit()
Constructor.
Definition: fs_annot.h:763
Border style: Dashed.
Definition: fs_annot.h:423
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Annotation flag: print.
Definition: fs_annot.h:1064
void SetBorderColor(RGB color)
Set border color.
Annotation flag: no view.
Definition: fs_annot.h:1086
common::Alignment GetOverlayTextAlignment() const
Get alignment value of overlay text.
Matrix GetTextMatrix() const
Get matrix in default appearance data for text in current free text annotation.
Matrix GetDisplayMatrix(const Matrix &page_display_matrix)
Get the display matrix, from PDF coordinate system to targeted device coordinate system.
Offset GetCaptionOffset() const
Get caption offset values.
~PSInk()
Destructor.
Definition: fs_annot.h:5069
Definition: fs_annot.h:3611
PSInk()
Constructor.
Definition: fs_annot.h:5059
Markup()
Constructor.
Definition: fs_annot.h:1985
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1700
Definition: fs_annot.h:1837
StateModel GetStateModel()
Get the state model.
No caption; icon only.
Definition: fs_annot.h:1228
Left alignment.
Definition: fs_common.h:77
Corner mark style: subscript.
Definition: fs_annot.h:215
Definition: fs_common.h:1941
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1010
RectF GetInnerRect() const
Get the inner rectangle.
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
virtual ~Screen()
Destructor.
Definition: fs_annot.h:4282
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:978
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
bool GetOpenStatus() const
Get open status.
Annotation type: unknown.
Definition: fs_annot.h:973
Stamp()
Constructor.
Definition: fs_annot.h:4146
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1647
Annotation flag: invisible.
Definition: fs_annot.h:1050
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Definition: fs_annot.h:2761
Definition: fs_annot.h:3288
Definition: fs_annot.h:1856
Definition: fs_annot.h:4030
Caret()
Constructor.
Definition: fs_annot.h:4866
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:624
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
μ-law-encoded samples.
Definition: fs_annot.h:5894
Line()
Constructor.
Definition: fs_annot.h:3616
PointF GetEndPoint() const
Get the end point.
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
String GetMeasureRatio()
Get the scale ratio string for measuring.
DefaultAppearance(const DefaultAppearance &default_appearance)
Constructor, with another default appearance object.
Definition: fs_annot.h:99
Definition: fs_annot.h:3105
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:1216
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:58
void SetInkList(const common::Path &ink_list)
Set ink list data.
Definition: fs_annot.h:5683
Annotation flag: locked.
Definition: fs_annot.h:1102
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:901
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
RectI GetDeviceRect(const Matrix &matrix)
Get annotation rectangle in device coordinate system.
PointF first
First point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:726
Caption overlaid directly on the icon.
Definition: fs_annot.h:1238
Annotation property: modified date.
Definition: fs_annot.h:1143
RichTextStyle(const common::Font &font, float text_size, common::Alignment text_alignment, RGB text_color, bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style)
Constructor, with parameters.
Definition: fs_annot.h:235
Definition: fs_annot.h:202
virtual bool CanChangeColor(Annot::Type annot_type, const char *icon_name)
A callback function used to check if current icon provider supports to change color for a specified t...
Definition: fs_annot.h:1766
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1194
void SetTitle(const WString &title)
Set title of current screen annotation.
RGB text_color
Text color. Format: 0xRRGGBB.
Definition: fs_annot.h:378
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_annot.h:471
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
int GetRotation()
Get current rotation angle (in clockwise).
AppearanceType
Enumeration for the type of annotation's appearance.
Definition: fs_annot.h:1246
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1199
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
virtual bool GetShadingColor(Annot::Type annot_type, const char *icon_name, RGB referenced_color, int shading_index, ShadingColor &out_shading_color)
A callback function used to get the shading colors if current icon provider supports for a specified ...
Definition: fs_annot.h:1796
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1133
void RemoveAction()
Remove action.
Link()
Constructor.
Definition: fs_annot.h:2821
bool operator!=(const DefaultAppearance &default_appearance) const
Not equal operator.
Definition: fs_annot.h:140
Highlighting mode: No highlighting.
Definition: fs_annot.h:1125
Annotation flag: no rotate.
Definition: fs_annot.h:1078
String GetMeasureRatio()
Get the scale ratio string for measuring.
BYTE STRING CLASS.
Definition: fx_string.h:317
void SetLineStartStyle(EndingStyle starting_style)
Set line ending style of the start point.
String GetMeasureRatio()
Get the scale ratio string for measuring.
RectF GetInnerRect() const
Get the inner rectangle.
Definition: fs_annot.h:1622
void SetBorderInfo(const BorderInfo &border)
Set border information.
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:1141
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
DefaultAppearance()
Constructor.
Definition: fs_annot.h:89
PDFPage GetPage() const
Get the related PDF page.
QuadPoints(const QuadPoints &quad_points)
Constructor, with another quadrilateral points object.
Definition: fs_annot.h:662
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:732
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:82
Annotation's normal appearance.
Definition: fs_annot.h:1248
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:994
Border style: Underline.
Definition: fs_annot.h:429
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
common::Font font
A font used in rich text style. It should be a valid font object.
Definition: fs_annot.h:365
void SetRotation(common::Rotation rotate)
Set the rotation of the image used for the appearance of current screen annotation.
Polygon()
Constructor.
Definition: fs_annot.h:4462
WString GetMeasureRatioW()
Get the scale ratio string for measuring.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
BorderInfo()
Constructor.
Definition: fs_annot.h:480
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1863
bool SetFileSpec(const FileSpec &file_spec)
Set a file specification, which should specify an embedded file.
Definition: fx_coordinates.h:30
FileSpec GetFileSpec()
Get the file specification.
RGB GetBorderColor() const
Get border color.
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
Annotation type: movie annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1014
float GetSamplingRate() const
Get the sampling rate, in samples per second.
FileSpec GetFileSpec() const
Get the file specification object which represents an external sound file.
void SetOverlayText(const WString &overlay_text)
Set the overlay text.
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:996
CornerMarkStyle
Enumeration for corner mark style.
Definition: fs_annot.h:209
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
EndingStyle
Enumeration for line ending style.
Definition: fs_annot.h:1928
Definition: fs_annot.h:407
float GetOpacity() const
Get opacity value.
void SetMeasureUnit(MeasureType measure_type, const char *unit)
Set the label for displaying the units for measuring.
~Caret()
Destructor.
Definition: fs_annot.h:4874
void SetFillColor(RGB fill_color)
Set fill color.
MKEntry
Enumeration for annotation's MK dictionary (an appearance characteristics) entry.
Definition: fs_annot.h:1168
bool operator!=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:320
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
RGB GetStyleFillColor() const
Get fill color for ending styles.
BorderInfo GetBorderInfo() const
Get border information.
void SetApplyFillColor(RGB fill_color)
Set the filling color which is used for rollover appearance and will be used after redaction is appli...
objects::PDFDictionary * GetOptionalContent() const
Get the PDF dictionary of annotation's optional content.
~Squiggly()
Destructor.
Definition: fs_annot.h:2802
bool IsEmpty() const
Check whether current object is empty or not.
SampleEncodingFormat
Enumeration for encoding format of sound sample data.
Definition: fs_annot.h:5888
Header file for PDF object related definitions and classes.
uint32 flags
Flags to indicate which properties of default appearance are meaningful.
Definition: fs_annot.h:177
void SetCalloutLinePoints(const PointFArray &point_array)
Set points for callout line.
Annotation type: polygon annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:990
Annotation property: border color.
Definition: fs_annot.h:1154
bool RemoveProperty(Property property)
Remove a specified annotation's property.
StrikeOut()
Constructor.
Definition: fs_annot.h:2764
Foxit namespace.
Definition: fs_taggedpdf.h:27
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current stamp annotation, with a specified frame index.
Highlighting mode: Outline, which is to invert the annotation's border.
Definition: fs_annot.h:1129
Underline()
Constructor.
Definition: fs_annot.h:2734
void SetOpacity(float opacity)
Set opacity value.
WString GetTitle() const
Get title of current screen annotation.
Indicates property text size of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:64
common::Font font
A font for default appearance. It should be a valid font object when it is useful.
Definition: fs_annot.h:183
FreeText()
Constructor.
Definition: fs_annot.h:3291
void SetStartPoint(const PointF &point)
Set the start point.
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
common::Alignment text_alignment
Alignment value. Please refer to values starting from common::e_AlignmentLeft and this should be one ...
Definition: fs_annot.h:374
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:691
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
Icon fit information entry. "IF" in MK dictionary.
Definition: fs_annot.h:1209
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
~StrikeOut()
Destructor.
Definition: fs_annot.h:2772
RGB GetFillColor() const
Get fill color.
RGB GetFillColor() const
Get fill color.
virtual String GetProviderID()
A callback function used to get provider ID.
Definition: fs_annot.h:1730
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:748
Corner mark style: none.
Definition: fs_annot.h:211
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1170
Definition: fs_annot.h:637
Header file for image and bitmap related definitions and classes.
virtual float GetDisplayHeight(Annot::Type annot_type, const char *icon_name)
A callback function used to get the height for display of a specified icon, in device size(pixel norm...
Definition: fs_annot.h:1823
DateTime GetModifiedDateTime() const
Get last modified date time.
PointF second
Second point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:728
Definition: fs_annot.h:5056
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:887
bool operator!=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:545
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:62
Definition: fs_annot.h:4863
RectF GetInnerRect() const
Get the inner rectangle.
int GetBits() const
Get the number of bits per sample value per channel.
void SetStyleFillColor(RGB color)
Set fill color for ending styles.
Definition: fs_pdfobject.h:809
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:988
Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:984
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
bool operator!=(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are not equal.
Definition: fs_basictypes.h:140
Annotation's down appearance.
Definition: fs_annot.h:1252
MKIconCaptionRelation
Enumeration for icon and caption relative position in annotation's MK dictionary.
Definition: fs_annot.h:1224
float vertical_fraction
The vertical fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:922
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1189
void SetLeaderLineLength(float length)
Set the length of leader line.
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1179
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1006
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:807
Definition: fs_annot.h:2635
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:525
common::Rotation GetRotation()
Get current rotation value (in clockwise).
WString GetContent() const
Get content.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
~FreeText()
Destructor.
Definition: fs_annot.h:3300
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1002
RGB GetFillColor() const
Get fill color.
common::Bitmap GetBitmap()
Get the bitmap from current screen annotation.
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
void SetHighlightingMode(HighlightingMode mode)
Set highlighting mode.
bool Move(const RectF &rect)
Move current annotation to a new position, specified by a new rectangle in PDF coordinate system.
void Set(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Set value.
Definition: fs_annot.h:163
RichTextStyle(const RichTextStyle &style)
Constructor, with another style object.
Definition: fs_annot.h:263
PointFArray GetCalloutLinePoints() const
Get a point of callout line points.
Definition: fx_coordinates.h:771
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:609
float text_size
Text size for default appearance.
Definition: fs_annot.h:192
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:198
bool operator==(const RichTextStyle &style) const
Equal operator.
Definition: fs_annot.h:301
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
void SetFillColor(RGB fill_color)
Set fill color.
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
Annotation flag: read only.
Definition: fs_annot.h:1095
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:1714
Border style: Beveled.
Definition: fs_annot.h:436
String GetMeasureRatio()
Get the scale ratio string for measuring.
Annotation type: widget annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1019
virtual bool HasIcon(Annot::Type annot_type, const char *icon_name)
A callback function used to check if current icon provider supports icon for a specified type.
Definition: fs_annot.h:1753
Definition: fs_pdfpage.h:411
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
~Markup()
Destructor.
Definition: fs_annot.h:1988
void SetStyleFillColor(RGB fill_color)
Set fill color for some line ending styles.
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
virtual void Release()=0
A callback function used to release current callback object itself.
RGB GetApplyFillColor() const
Get the filling color which is used for rollover appearance and will be used after redaction is appli...
TextMarkup()
Constructor.
Definition: fs_annot.h:2638
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:194
bool is_strikethrough
A boolean value which indicates whether to cross text out with strike through or not.
Definition: fs_annot.h:394
String GetIconName() const
Get icon name.
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:3607
bool operator!=(const Annot &other) const
Not equal operator.
Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:980
void SetOpenStatus(bool status)
Set open status.
Annotation type: trap network annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1025
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
Annot & operator=(const Annot &annot)
Assign operator.
A-law-encoded samples.
Definition: fs_annot.h:5896
Definition: fs_image.h:445
PointF GetStartPoint() const
Get the start point.
void SetRotation(int angle)
Set rotation angle (in clockwise).
Definition: fs_annot.h:1833
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:998
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:971
void SetFillColor(RGB fill_color)
Set fill color.
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Constructor, with parameters.
Definition: fs_annot.h:647
void SetFlags(uint32 flags)
Set annotation flags.
objects::PDFStream * GetAppearanceStream(AppearanceType type, const char *appearance_state="") const
Get annotation's appearance stream with specified type and state.
Annotation type: pressure sensitive ink annotation.
Definition: fs_annot.h:1008
void SetMeasureUnit(MeasureType measure_type, const char *unit)
Set the label for displaying the units for measuring.
void SetAction(const actions::Action &action)
Set action.
Definition: fx_coordinates.h:596
Annot()
Constructor.
Definition: fs_annot.h:1275
Definition: fs_common.h:1344
Down icon (or alternate icon) entry. "IX" in MK dictionary.
Definition: fs_annot.h:1204
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1023
float dash_phase
Dash phase.
Definition: fs_annot.h:616
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:676
Definition: fx_coordinates.h:1076
Caption to the right of the icon.
Definition: fs_annot.h:1234
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:1184
bool operator==(const Annot &other) const
Equal operator.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
DefaultAppearance & operator=(const DefaultAppearance &default_appearance)
Assign operator.
Definition: fs_annot.h:112
PointFArray GetVertexes()
Get vertexes.
QuadPoints()
Constructor.
Definition: fs_annot.h:655
void SetFillColor(RGB fill_color)
Set fill color.
Squiggly()
Constructor.
Definition: fs_annot.h:2794
void SetTextMatrix(const Matrix &text_matrix)
Set matrix in default appearance data for text in current free text annotation.
RichTextStyle()
Constructor.
Definition: fs_annot.h:248
~Polygon()
Destructor.
Definition: fs_annot.h:4470
Definition: fs_annot.h:4641
Definition: fs_annot.h:51
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
Definition: fs_pdfobject.h:422
Border style: Inset.
Definition: fs_annot.h:443
WIDE STRING CLASS.
Definition: fx_string.h:1452
void EnableCaption(bool cap)
Set the flag which is used to decide whether the content of current line annotation should be replica...
CFX_ByteString String
Byte string.
Definition: fs_basictypes.h:221
Definition: fs_annot.h:3600
bool HasProperty(Property property) const
Whether current annotation has the specified annotation's property.
Definition: fs_image.h:36
actions::Action GetAction()
Get action.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
float width
Border width, in points.
Definition: fs_annot.h:590
Annotation type: polyline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:992
bool is_underline
A boolean value which indicates whether to underline text or not.
Definition: fs_annot.h:390
~BorderInfo()
Destructor.
Definition: fs_annot.h:487
~Ink()
Destructor.
Definition: fs_annot.h:4041
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
BorderInfo(const BorderInfo &border_info)
Constructor, with another border information object.
Definition: fs_annot.h:494
Definition: fs_annot.h:4459
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:414
float GetLeaderLineLength() const
Get the length of leader line.
MeasureType
Enumeration for annotation's measure type.
Definition: fs_annot.h:1960
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
common::Alignment GetAlignment() const
Get alignment value.
String GetCompressionFormat() const
Get the name of the sound compression format used on the sample data.
~Link()
Destructor.
Definition: fs_annot.h:2831
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
common::Rotation GetRotation()
Get the rotation of the image used for the appearance of current screen annotation.
Definition: fs_annot.h:736
String GetIconName() const
Get icon name.
Definition: fs_basictypes.h:413
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1043
~Line()
Destructor.
Definition: fs_annot.h:3624
void Rotate(int angle)
Rotate current annotation from current state with specified angle degree in clockwise.
State GetState()
Get the state.
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:742
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:127
Note()
Constructor.
Definition: fs_annot.h:2483
Ink()
Constructor.
Definition: fs_annot.h:4033
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1123
SampleEncodingFormat GetSampleEncodingFormat() const
Get the encoding format for the sample data.
CapPos GetCaptionPositionType() const
Get the position type of caption.
Definition: fs_annot.h:3609
Annotation property: creation date.
Definition: fs_annot.h:1148
Definition: fs_annot.h:4914
bool Apply()
Apply current redact annotation: remove the text or graphics under annotation rectangle permanently.
bool IsOverlayTextRepeated()
Check whether the overlay text is repeated or not.
Redact()
Constructor.
Definition: fs_annot.h:5686
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:281
float horizontal_fraction
The horizontal fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:916
common::Path GetInkList()
Get ink list data.
~Square()
Destructor.
Definition: fs_annot.h:2944
@2023 Foxit Software Incorporated. All rights reserved.