Go to the documentation of this file.
36 class PagingSealSignature;
59 typedef enum _DefAPFlags {
210 typedef enum _CornerMarkStyle {
322 return !((*this) == style);
415 typedef enum _Style {
749 typedef enum _ScaleWayType {
753 e_ScaleWayAlways = 1,
755 e_ScaleWayBigger = 2,
757 e_ScaleWaySmaller = 3,
765 : scale_way_type(e_ScaleWayNone)
766 , is_proportional_scaling(false)
767 , horizontal_fraction(0)
768 , vertical_fraction(0)
769 , fit_bounds(false) {}
796 float vertical_fraction,
bool fit_bounds)
797 : scale_way_type(type)
798 , is_proportional_scaling(is_proportional_scaling)
799 , horizontal_fraction(horizontal_fraction)
800 , vertical_fraction(vertical_fraction)
801 , fit_bounds(fit_bounds) {}
809 : scale_way_type(icon_fit.scale_way_type)
810 , is_proportional_scaling(icon_fit.is_proportional_scaling)
811 , horizontal_fraction(icon_fit.horizontal_fraction)
812 , vertical_fraction(icon_fit.vertical_fraction)
813 , fit_bounds(icon_fit.fit_bounds) {}
889 float vertical_fraction,
bool fit_bounds) {
890 this->scale_way_type = type;
891 this->is_proportional_scaling = is_proportional_scaling;
892 this->horizontal_fraction = horizontal_fraction;
893 this->vertical_fraction = vertical_fraction;
894 this->fit_bounds = fit_bounds;
1046 typedef enum _Flags {
1126 typedef enum _HighlightingMode {
1144 typedef enum _Property {
1171 typedef enum _MKEntry {
1227 typedef enum _MKIconCaptionRelation {
1249 typedef enum _AppearanceType {
1269 #ifndef __EMSCRIPTEN_RENDER__
1279 #ifndef __EMSCRIPTEN_RENDER__
1305 #ifndef __EMSCRIPTEN_RENDER__
1451 bool Move(
const RectF& rect,
bool is_reset_appearance);
1637 : first_color(firstcolor)
1638 , second_color(secondcolor) {}
1642 : first_color(0xFFFFFFFF)
1643 , second_color(0xFFFFFFFF) {}
1651 : first_color(shading_color.first_color)
1652 , second_color(shading_color.second_color) {}
1698 this->first_color = firstcolor;
1699 this->second_color = secondcolor;
1772 #ifndef __EMSCRIPTEN_RENDER__
1800 RGB referenced_color,
int shading_index,
ShadingColor& out_shading_color) {
1866 typedef enum _StateModel {
1868 e_StateModelMarked = 1,
1870 e_StateModelReview = 2
1878 typedef enum _State {
1893 e_StateUnmarked = 2,
1898 e_StateAccepted = 3,
1903 e_StateRejected = 4,
1908 e_StateCancelled = 5,
1913 e_StateCompleted = 6,
1918 e_StateDeferred = 7,
1931 typedef enum _EndingStyle {
1933 e_EndingStyleNone = 0,
1935 e_EndingStyleSquare = 1,
1937 e_EndingStyleCircle = 2,
1939 e_EndingStyleDiamond = 3,
1941 e_EndingStyleOpenArrow = 4,
1947 e_EndingStyleClosedArrow = 5,
1949 e_EndingStyleButt = 6,
1951 e_EndingStyleROpenArrow = 7,
1953 e_EndingStyleRClosedArrow = 8,
1955 e_EndingStyleSlash = 9
1963 typedef enum _MeasureType {
2027 void SetPopup(
const Popup& popup);
2055 void SetTitle(
const WString& title);
2071 void SetSubject(
const WString& subject);
2081 float GetOpacity()
const;
2095 void SetOpacity(
float opacity);
2118 String GetIntent()
const;
2155 void SetIntent(
const String& intent);
2163 DateTime GetCreationDateTime()
const;
2172 void SetCreationDateTime(
const DateTime& date_time);
2179 int GetReplyCount();
2189 Note GetReply(
int index)
const;
2208 bool RemoveReply(
int index);
2215 bool RemoveAllReplies();
2305 NoteArray GetStateAnnots(StateModel model);
2343 Note AddStateAnnot(
const WString& title, StateModel model, State state);
2354 bool RemoveAllStateAnnots();
2362 int32 GetRichTextCount();
2387 void SetRichTextContent(
int32 index,
const WString& content);
2458 void RemoveRichText(
int index);
3617 typedef enum _CapPos {
4163 #ifndef __EMSCRIPTEN_RENDER__
5046 #ifndef __FSDK_NO_PSINK__
5103 typedef enum _LineSpacingStyle {
5127 #ifndef __EMSCRIPTEN_RENDER__
5670 #ifdef _SUPPORTWEBSDK_
5705 #ifndef __EMSCRIPTEN_RENDER__
5906 typedef enum _SampleEncodingFormat {
5931 #ifndef __EMSCRIPTEN_RENDER__
6039 #endif // FS_ANNOT_H_
Annotation type: caret annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1005
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Definition: fs_annot.h:4281
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:1013
~FileAttachment()
Destructor.
Definition: fs_annot.h:4935
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1001
RGB GetFillColor() const
Get fill color.
Definition: fs_annot.h:1628
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:1028
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:5910
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
~Note()
Destructor.
Definition: fs_annot.h:2496
Caption above the icon.
Definition: fs_annot.h:1235
FileAttachment()
Constructor.
Definition: fs_annot.h:4927
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1360
Annotation type: redact annotation.
Definition: fs_annot.h:1034
ShadingColor()
Constructor.
Definition: fs_annot.h:1641
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:987
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:2483
Circle()
Constructor.
Definition: fs_annot.h:3118
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:2745
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:731
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:1177
Definition: fs_action.h:418
void SetModifiedDateTime(const DateTime &date_time)
Set last modified date time.
Definition: fs_basictypes.h:452
Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1030
RectF GetRect() const
Get rectangle, in PDF coordinate system.
Annotation flag: locked contents.
Definition: fs_annot.h:1118
Definition: fs_annot.h:965
Annotation flag: hidden.
Definition: fs_annot.h:1059
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
No icon; captin only.
Definition: fs_annot.h:1229
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:578
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:343
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Annotation's rollover appearance.
Definition: fs_annot.h:1253
Definition: fs_annot.h:5899
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:1233
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:383
bool is_proportional_scaling
A boolean value which indicates whether use proportional scaling or not.
Definition: fs_annot.h:911
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5908
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:400
~Highlight()
Destructor.
Definition: fs_annot.h:2715
PointFArray GetVertexes()
Get vertexes.
Highlighting mode: Push, which is to display the annotation's down appearance, if any.
Definition: fs_annot.h:1134
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:2704
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:1022
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:2821
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:597
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:387
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:2707
Annotation property: fill color.
Definition: fs_annot.h:1163
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:2946
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:1239
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:510
PagingSeal(const Annot &annot)
Constructor.
Annotation flag: toggle no view.
Definition: fs_annot.h:1111
bool operator!=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:704
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:1813
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1744
bool ExecuteJavaScriptAction()
Execute the JavaScript action associated with the link annotation.
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:214
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1878
void SetOverlayTextAlignment(common::Alignment alignment)
Set alignment value of overlay text.
~PolyLine()
Destructor.
Definition: fs_annot.h:4662
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:795
void SetCaptionPositionType(CapPos cap_position)
Set the position type of caption.
Definition: fs_annot.h:2794
void SetContent(const WString &content)
Set content.
Annotation type: rich media annotation.
Definition: fs_annot.h:1036
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:370
Annotation flag: no zoom.
Definition: fs_annot.h:1074
Header file for common definitions and classes.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2649
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:2943
Screen()
Constructor.
Definition: fs_annot.h:4284
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1705
Border style: Cloudy.
Definition: fs_annot.h:451
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1032
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:983
Border style: Solid.
Definition: fs_annot.h:417
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:930
Definition: fs_annot.h:2734
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:4654
float GetLeaderLineOffset() const
Get the length of leader line offset.
Definition: fs_annot.h:4153
void Set(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Set value.
Definition: fs_annot.h:719
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:1130
~Circle()
Destructor.
Definition: fs_annot.h:3126
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1175
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:61
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:1636
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1697
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:5919
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:764
Border style: Dashed.
Definition: fs_annot.h:424
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:1067
void SetBorderColor(RGB color)
Set border color.
Annotation flag: no view.
Definition: fs_annot.h:1089
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.
void EnableAutoFontSize()
Enable auto font size for the overlay text.
Offset GetCaptionOffset() const
Get caption offset values.
~PSInk()
Destructor.
Definition: fs_annot.h:5079
Definition: fs_annot.h:3621
PSInk()
Constructor.
Definition: fs_annot.h:5069
Markup()
Constructor.
Definition: fs_annot.h:1988
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1703
Definition: fs_annot.h:1840
StateModel GetStateModel()
Get the state model.
No caption; icon only.
Definition: fs_annot.h:1231
Left alignment.
Definition: fs_common.h:77
Corner mark style: subscript.
Definition: fs_annot.h:216
Definition: fs_common.h:1958
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1011
RectF GetInnerRect() const
Get the inner rectangle.
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
virtual ~Screen()
Destructor.
Definition: fs_annot.h:4292
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:979
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
bool GetOpenStatus() const
Get open status.
Annotation type: unknown.
Definition: fs_annot.h:974
Stamp()
Constructor.
Definition: fs_annot.h:4156
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1650
Annotation flag: invisible.
Definition: fs_annot.h:1053
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Definition: fs_annot.h:2764
Definition: fs_annot.h:3298
Definition: fs_annot.h:1859
Definition: fs_annot.h:4040
Caret()
Constructor.
Definition: fs_annot.h:4876
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:625
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
μ-law-encoded samples.
Definition: fs_annot.h:5912
Line()
Constructor.
Definition: fs_annot.h:3626
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:100
Definition: fs_annot.h:3115
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:1219
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:59
void SetInkList(const common::Path &ink_list)
Set ink list data.
Definition: fs_annot.h:5693
Annotation flag: locked.
Definition: fs_annot.h:1105
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:902
PagingSealSignature GetPagingSealSignature()
Get the associated paging seal signature.
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:727
Caption overlaid directly on the icon.
Definition: fs_annot.h:1241
Annotation property: modified date.
Definition: fs_annot.h:1146
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:236
Definition: fs_annot.h:203
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:1769
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1197
void SetTitle(const WString &title)
Set title of current screen annotation.
RGB text_color
Text color. Format: 0xRRGGBB.
Definition: fs_annot.h:379
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:472
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:1249
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1202
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:1799
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1136
void RemoveAction()
Remove action.
Link()
Constructor.
Definition: fs_annot.h:2824
bool operator!=(const DefaultAppearance &default_appearance) const
Not equal operator.
Definition: fs_annot.h:141
Highlighting mode: No highlighting.
Definition: fs_annot.h:1128
Annotation flag: no rotate.
Definition: fs_annot.h:1081
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:1625
void SetBorderInfo(const BorderInfo &border)
Set border information.
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:1144
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
DefaultAppearance()
Constructor.
Definition: fs_annot.h:90
PDFPage GetPage() const
Get the related PDF page.
QuadPoints(const QuadPoints &quad_points)
Constructor, with another quadrilateral points object.
Definition: fs_annot.h:663
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:733
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:83
Annotation's normal appearance.
Definition: fs_annot.h:1251
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:995
Border style: Underline.
Definition: fs_annot.h:430
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:366
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:4472
WString GetMeasureRatioW()
Get the scale ratio string for measuring.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Definition: fs_annot.h:6016
BorderInfo()
Constructor.
Definition: fs_annot.h:481
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1866
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:1015
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:997
CornerMarkStyle
Enumeration for corner mark style.
Definition: fs_annot.h:210
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
EndingStyle
Enumeration for line ending style.
Definition: fs_annot.h:1931
Definition: fs_annot.h:408
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:4884
void SetFillColor(RGB fill_color)
Set fill color.
MKEntry
Enumeration for annotation's MK dictionary (an appearance characteristics) entry.
Definition: fs_annot.h:1171
bool operator!=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:321
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:2805
bool IsEmpty() const
Check whether current object is empty or not.
SampleEncodingFormat
Enumeration for encoding format of sound sample data.
Definition: fs_annot.h:5906
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:178
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:991
Annotation property: border color.
Definition: fs_annot.h:1157
bool RemoveProperty(Property property)
Remove a specified annotation's property.
StrikeOut()
Constructor.
Definition: fs_annot.h:2767
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:1132
Underline()
Constructor.
Definition: fs_annot.h:2737
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:65
common::Font font
A font for default appearance. It should be a valid font object when it is useful.
Definition: fs_annot.h:184
FreeText()
Constructor.
Definition: fs_annot.h:3301
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:375
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:692
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
Icon fit information entry. "IF" in MK dictionary.
Definition: fs_annot.h:1212
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
~StrikeOut()
Destructor.
Definition: fs_annot.h:2775
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:1733
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:749
Corner mark style: none.
Definition: fs_annot.h:212
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1173
Definition: fs_annot.h:638
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:1826
DateTime GetModifiedDateTime() const
Get last modified date time.
PointF second
Second point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:729
Definition: fs_annot.h:5066
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:888
bool operator!=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:546
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:63
Definition: fs_annot.h:4873
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:989
Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:985
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:1255
MKIconCaptionRelation
Enumeration for icon and caption relative position in annotation's MK dictionary.
Definition: fs_annot.h:1227
float vertical_fraction
The vertical fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:923
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1192
void SetLeaderLineLength(float length)
Set the length of leader line.
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1182
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1007
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:808
Definition: fs_annot.h:2638
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:526
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:3310
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1003
RGB GetFillColor() const
Get fill color.
Definition: fs_signature.h:2072
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:164
RichTextStyle(const RichTextStyle &style)
Constructor, with another style object.
Definition: fs_annot.h:264
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:610
float text_size
Text size for default appearance.
Definition: fs_annot.h:193
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:199
bool operator==(const RichTextStyle &style) const
Equal operator.
Definition: fs_annot.h:302
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:1098
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:1717
Border style: Beveled.
Definition: fs_annot.h:437
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:1020
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:1756
Definition: fs_pdfpage.h:411
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
~Markup()
Destructor.
Definition: fs_annot.h:1991
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:2641
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:395
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:3617
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:981
void SetOpenStatus(bool status)
Set open status.
Annotation type: trap network annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1026
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:5914
Definition: fs_image.h:448
PointF GetStartPoint() const
Get the start point.
void SetRotation(int angle)
Set rotation angle (in clockwise).
Definition: fs_annot.h:1836
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:999
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:972
void SetFillColor(RGB fill_color)
Set fill color.
Annotation type: paging seal annotation. A Foxit PDF SDK custom annotation type (not a standard annot...
Definition: fs_annot.h:1038
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Constructor, with parameters.
Definition: fs_annot.h:648
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:1009
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:1278
Definition: fs_common.h:1344
Down icon (or alternate icon) entry. "IX" in MK dictionary.
Definition: fs_annot.h:1207
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1024
float dash_phase
Dash phase.
Definition: fs_annot.h:617
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:677
Definition: fx_coordinates.h:1076
Caption to the right of the icon.
Definition: fs_annot.h:1237
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:1187
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:113
PointFArray GetVertexes()
Get vertexes.
QuadPoints()
Constructor.
Definition: fs_annot.h:656
void SetFillColor(RGB fill_color)
Set fill color.
Squiggly()
Constructor.
Definition: fs_annot.h:2797
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:249
~Polygon()
Destructor.
Definition: fs_annot.h:4480
Definition: fs_annot.h:4651
Definition: fs_annot.h:52
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:444
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:3610
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:591
Annotation type: polyline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:993
bool is_underline
A boolean value which indicates whether to underline text or not.
Definition: fs_annot.h:391
~BorderInfo()
Destructor.
Definition: fs_annot.h:488
~Ink()
Destructor.
Definition: fs_annot.h:4051
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:495
Definition: fs_annot.h:4469
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:415
float GetLeaderLineLength() const
Get the length of leader line.
MeasureType
Enumeration for annotation's measure type.
Definition: fs_annot.h:1963
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:2834
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:737
String GetIconName() const
Get icon name.
Definition: fs_basictypes.h:419
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1046
~Line()
Destructor.
Definition: fs_annot.h:3634
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:743
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:128
Note()
Constructor.
Definition: fs_annot.h:2486
Ink()
Constructor.
Definition: fs_annot.h:4043
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1126
SampleEncodingFormat GetSampleEncodingFormat() const
Get the encoding format for the sample data.
CapPos GetCaptionPositionType() const
Get the position type of caption.
Definition: fs_annot.h:3619
Annotation property: creation date.
Definition: fs_annot.h:1151
Definition: fs_annot.h:4924
bool Apply()
Apply current redact annotation: remove the text, graphics and annotations under annotation rectangle...
bool IsOverlayTextRepeated()
Check whether the overlay text is repeated or not.
Redact()
Constructor.
Definition: fs_annot.h:5696
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:282
float horizontal_fraction
The horizontal fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:917
common::Path GetInkList()
Get ink list data.
~Square()
Destructor.
Definition: fs_annot.h:2954
@2023 Foxit Software Incorporated. All rights reserved.