Go to the documentation of this file.
36 class PagingSealSignature;
59 typedef enum _DefAPFlags {
210 typedef enum _CornerMarkStyle {
334 return !((*this) == style);
449 typedef enum _Style {
780 typedef enum _ScaleWayType {
784 e_ScaleWayAlways = 1,
786 e_ScaleWayBigger = 2,
788 e_ScaleWaySmaller = 3,
796 : scale_way_type(e_ScaleWayNone)
797 , is_proportional_scaling(false)
798 , horizontal_fraction(0)
799 , vertical_fraction(0)
800 , fit_bounds(false) {}
827 float vertical_fraction,
bool fit_bounds)
828 : scale_way_type(type)
829 , is_proportional_scaling(is_proportional_scaling)
830 , horizontal_fraction(horizontal_fraction)
831 , vertical_fraction(vertical_fraction)
832 , fit_bounds(fit_bounds) {}
840 : scale_way_type(icon_fit.scale_way_type)
841 , is_proportional_scaling(icon_fit.is_proportional_scaling)
842 , horizontal_fraction(icon_fit.horizontal_fraction)
843 , vertical_fraction(icon_fit.vertical_fraction)
844 , fit_bounds(icon_fit.fit_bounds) {}
920 float vertical_fraction,
bool fit_bounds) {
921 this->scale_way_type = type;
922 this->is_proportional_scaling = is_proportional_scaling;
923 this->horizontal_fraction = horizontal_fraction;
924 this->vertical_fraction = vertical_fraction;
925 this->fit_bounds = fit_bounds;
1003 typedef enum _Type {
1077 typedef enum _Flags {
1157 typedef enum _HighlightingMode {
1175 typedef enum _Property {
1202 typedef enum _MKEntry {
1258 typedef enum _MKIconCaptionRelation {
1280 typedef enum _AppearanceType {
1300 #ifndef __EMSCRIPTEN_RENDER__
1310 #ifndef __EMSCRIPTEN_RENDER__
1336 #ifndef __EMSCRIPTEN_RENDER__
1482 bool Move(
const RectF& rect,
bool is_reset_appearance);
1668 : first_color(firstcolor)
1669 , second_color(secondcolor) {}
1673 : first_color(0xFFFFFFFF)
1674 , second_color(0xFFFFFFFF) {}
1682 : first_color(shading_color.first_color)
1683 , second_color(shading_color.second_color) {}
1729 this->first_color = firstcolor;
1730 this->second_color = secondcolor;
1803 #ifndef __EMSCRIPTEN_RENDER__
1831 RGB referenced_color,
int shading_index,
ShadingColor& out_shading_color) {
1897 typedef enum _StateModel {
1899 e_StateModelMarked = 1,
1901 e_StateModelReview = 2
1909 typedef enum _State {
1924 e_StateUnmarked = 2,
1929 e_StateAccepted = 3,
1934 e_StateRejected = 4,
1939 e_StateCancelled = 5,
1944 e_StateCompleted = 6,
1949 e_StateDeferred = 7,
1962 typedef enum _EndingStyle {
1964 e_EndingStyleNone = 0,
1966 e_EndingStyleSquare = 1,
1968 e_EndingStyleCircle = 2,
1970 e_EndingStyleDiamond = 3,
1972 e_EndingStyleOpenArrow = 4,
1978 e_EndingStyleClosedArrow = 5,
1980 e_EndingStyleButt = 6,
1982 e_EndingStyleROpenArrow = 7,
1984 e_EndingStyleRClosedArrow = 8,
1986 e_EndingStyleSlash = 9
1994 typedef enum _MeasureType {
2058 void SetPopup(
const Popup& popup);
2086 void SetTitle(
const WString& title);
2102 void SetSubject(
const WString& subject);
2112 float GetOpacity()
const;
2126 void SetOpacity(
float opacity);
2149 String GetIntent()
const;
2186 void SetIntent(
const String& intent);
2194 DateTime GetCreationDateTime()
const;
2203 void SetCreationDateTime(
const DateTime& date_time);
2210 int GetReplyCount();
2220 Note GetReply(
int index)
const;
2239 bool RemoveReply(
int index);
2246 bool RemoveAllReplies();
2336 NoteArray GetStateAnnots(StateModel model);
2374 Note AddStateAnnot(
const WString& title, StateModel model, State state);
2385 bool RemoveAllStateAnnots();
2393 int32 GetRichTextCount();
2418 void SetRichTextContent(
int32 index,
const WString& content);
2489 void RemoveRichText(
int index);
3648 typedef enum _CapPos {
4194 #ifndef __EMSCRIPTEN_RENDER__
5077 #ifndef __FSDK_NO_PSINK__
5134 typedef enum _LineSpacingStyle {
5158 #ifndef __EMSCRIPTEN_RENDER__
5701 #ifdef _SUPPORTWEBSDK_
5736 #ifndef __EMSCRIPTEN_RENDER__
5937 typedef enum _SampleEncodingFormat {
5962 #ifndef __EMSCRIPTEN_RENDER__
6070 #endif // FS_ANNOT_H_
Annotation type: caret annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1036
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Definition: fs_annot.h:4312
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:1044
~FileAttachment()
Destructor.
Definition: fs_annot.h:4966
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1032
RGB GetFillColor() const
Get fill color.
Definition: fs_annot.h:1659
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:1059
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:5941
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
~Note()
Destructor.
Definition: fs_annot.h:2527
Caption above the icon.
Definition: fs_annot.h:1266
FileAttachment()
Constructor.
Definition: fs_annot.h:4958
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1360
Annotation type: redact annotation.
Definition: fs_annot.h:1065
ShadingColor()
Constructor.
Definition: fs_annot.h:1672
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:1018
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:2514
Circle()
Constructor.
Definition: fs_annot.h:3149
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:2776
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:762
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:1208
Definition: fs_action.h:418
void SetModifiedDateTime(const DateTime &date_time)
Set last modified date time.
Definition: fs_basictypes.h:460
Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1061
RectF GetRect() const
Get rectangle, in PDF coordinate system.
Annotation flag: locked contents.
Definition: fs_annot.h:1149
Definition: fs_annot.h:996
Annotation flag: hidden.
Definition: fs_annot.h:1090
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
No icon; captin only.
Definition: fs_annot.h:1260
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:609
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Annotation's rollover appearance.
Definition: fs_annot.h:1284
Definition: fs_annot.h:5930
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:1264
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:403
bool is_proportional_scaling
A boolean value which indicates whether use proportional scaling or not.
Definition: fs_annot.h:942
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5939
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:424
~Highlight()
Destructor.
Definition: fs_annot.h:2746
PointFArray GetVertexes()
Get vertexes.
Highlighting mode: Push, which is to display the annotation's down appearance, if any.
Definition: fs_annot.h:1165
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:2735
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
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:1053
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:2852
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:628
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:408
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:2738
Annotation property: fill color.
Definition: fs_annot.h:1194
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:2977
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:1270
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:541
PagingSeal(const Annot &annot)
Constructor.
Annotation flag: toggle no view.
Definition: fs_annot.h:1142
bool operator!=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:735
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:1844
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1775
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:1909
void SetOverlayTextAlignment(common::Alignment alignment)
Set alignment value of overlay text.
~PolyLine()
Destructor.
Definition: fs_annot.h:4693
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:826
void SetCaptionPositionType(CapPos cap_position)
Set the position type of caption.
Definition: fs_annot.h:2825
void SetContent(const WString &content)
Set content.
Annotation type: rich media annotation.
Definition: fs_annot.h:1067
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:387
Annotation flag: no zoom.
Definition: fs_annot.h:1105
Header file for common definitions and classes.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2680
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:2974
Screen()
Constructor.
Definition: fs_annot.h:4315
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1736
Border style: Cloudy.
Definition: fs_annot.h:485
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1063
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:1014
Border style: Solid.
Definition: fs_annot.h:451
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:961
Definition: fs_annot.h:2765
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:4685
float GetLeaderLineOffset() const
Get the length of leader line offset.
Definition: fs_annot.h:4184
void Set(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Set value.
Definition: fs_annot.h:750
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:1161
~Circle()
Destructor.
Definition: fs_annot.h:3157
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1206
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:1667
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1728
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:5950
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:795
Border style: Dashed.
Definition: fs_annot.h:458
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:1098
void SetBorderColor(RGB color)
Set border color.
Annotation flag: no view.
Definition: fs_annot.h:1120
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:5110
Definition: fs_annot.h:3652
PSInk()
Constructor.
Definition: fs_annot.h:5100
Markup()
Constructor.
Definition: fs_annot.h:2019
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1734
Definition: fs_annot.h:1871
StateModel GetStateModel()
Get the state model.
No caption; icon only.
Definition: fs_annot.h:1262
Left alignment.
Definition: fs_common.h:77
Corner mark style: subscript.
Definition: fs_annot.h:216
Definition: fs_common.h:2005
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1042
RectF GetInnerRect() const
Get the inner rectangle.
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
virtual ~Screen()
Destructor.
Definition: fs_annot.h:4323
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:1010
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
bool GetOpenStatus() const
Get open status.
Annotation type: unknown.
Definition: fs_annot.h:1005
Stamp()
Constructor.
Definition: fs_annot.h:4187
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1681
Annotation flag: invisible.
Definition: fs_annot.h:1084
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Definition: fs_annot.h:2795
Definition: fs_annot.h:3329
Definition: fs_annot.h:1890
Definition: fs_annot.h:4071
Caret()
Constructor.
Definition: fs_annot.h:4907
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:656
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
μ-law-encoded samples.
Definition: fs_annot.h:5943
Line()
Constructor.
Definition: fs_annot.h:3657
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:3146
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:1250
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:5724
Annotation flag: locked.
Definition: fs_annot.h:1136
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:933
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:758
Caption overlaid directly on the icon.
Definition: fs_annot.h:1272
Annotation property: modified date.
Definition: fs_annot.h:1177
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:1800
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1228
void SetTitle(const WString &title)
Set title of current screen annotation.
RGB text_color
Text color. Format: 0xRRGGBB.
Definition: fs_annot.h:398
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:506
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:1280
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1233
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:1830
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1167
void RemoveAction()
Remove action.
Link()
Constructor.
Definition: fs_annot.h:2855
bool operator!=(const DefaultAppearance &default_appearance) const
Not equal operator.
Definition: fs_annot.h:141
Highlighting mode: No highlighting.
Definition: fs_annot.h:1159
Annotation flag: no rotate.
Definition: fs_annot.h:1112
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:1656
void SetBorderInfo(const BorderInfo &border)
Set border information.
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:1175
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:694
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:764
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:1282
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1026
Border style: Underline.
Definition: fs_annot.h:464
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:382
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:4503
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:6047
BorderInfo()
Constructor.
Definition: fs_annot.h:515
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1897
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:1046
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.
float char_space
The char space. It should not be negative value. It is only used in pdf::PDFPage::AddText.
Definition: fs_annot.h:429
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:1028
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:1962
Definition: fs_annot.h:442
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:4915
void SetFillColor(RGB fill_color)
Set fill color.
MKEntry
Enumeration for annotation's MK dictionary (an appearance characteristics) entry.
Definition: fs_annot.h:1202
bool operator!=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:333
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:2836
bool IsEmpty() const
Check whether current object is empty or not.
SampleEncodingFormat
Enumeration for encoding format of sound sample data.
Definition: fs_annot.h:5937
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:1022
Annotation property: border color.
Definition: fs_annot.h:1188
bool RemoveProperty(Property property)
Remove a specified annotation's property.
StrikeOut()
Constructor.
Definition: fs_annot.h:2798
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:1163
Underline()
Constructor.
Definition: fs_annot.h:2768
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:3332
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:393
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:723
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
Icon fit information entry. "IF" in MK dictionary.
Definition: fs_annot.h:1243
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
~StrikeOut()
Destructor.
Definition: fs_annot.h:2806
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:1764
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:780
Corner mark style: none.
Definition: fs_annot.h:212
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1204
Definition: fs_annot.h:669
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:1857
DateTime GetModifiedDateTime() const
Get last modified date time.
PointF second
Second point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:760
Definition: fs_annot.h:5097
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:919
bool operator!=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:577
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:63
Definition: fs_annot.h:4904
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:1020
Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1016
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:1286
MKIconCaptionRelation
Enumeration for icon and caption relative position in annotation's MK dictionary.
Definition: fs_annot.h:1258
float vertical_fraction
The vertical fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:954
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1223
void SetLeaderLineLength(float length)
Set the length of leader line.
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1213
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1038
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:839
Definition: fs_annot.h:2669
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:557
common::Rotation GetRotation()
Get current rotation value (in clockwise).
WString GetContent() const
Get content.
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, float char_space, float word_space)
Constructor, with parameters.
Definition: fs_annot.h:238
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
~FreeText()
Destructor.
Definition: fs_annot.h:3341
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1034
RGB GetFillColor() const
Get fill color.
Definition: fs_signature.h:2091
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:270
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:641
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:312
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:1129
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:1748
Border style: Beveled.
Definition: fs_annot.h:471
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:1051
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:1787
Definition: fs_pdfpage.h:412
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
~Markup()
Destructor.
Definition: fs_annot.h:2022
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:2672
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:418
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:3648
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:1012
void SetOpenStatus(bool status)
Set open status.
Annotation type: trap network annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1057
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:5945
Definition: fs_image.h:448
PointF GetStartPoint() const
Get the start point.
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, float char_space, float word_space)
Set value.
Definition: fs_annot.h:357
void SetRotation(int angle)
Set rotation angle (in clockwise).
Definition: fs_annot.h:1867
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1030
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:1003
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:1069
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Constructor, with parameters.
Definition: fs_annot.h:679
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:1040
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:1309
Definition: fs_common.h:1391
Down icon (or alternate icon) entry. "IX" in MK dictionary.
Definition: fs_annot.h:1238
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1055
float dash_phase
Dash phase.
Definition: fs_annot.h:648
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:708
Definition: fx_coordinates.h:1076
Caption to the right of the icon.
Definition: fs_annot.h:1268
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:1218
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:687
void SetFillColor(RGB fill_color)
Set fill color.
Squiggly()
Constructor.
Definition: fs_annot.h:2828
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:253
~Polygon()
Destructor.
Definition: fs_annot.h:4511
Definition: fs_annot.h:4682
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:478
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:225
Definition: fs_annot.h:3641
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:622
Annotation type: polyline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1024
bool is_underline
A boolean value which indicates whether to underline text or not.
Definition: fs_annot.h:413
~Ink()
Destructor.
Definition: fs_annot.h:4082
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:526
Definition: fs_annot.h:4500
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:449
float GetLeaderLineLength() const
Get the length of leader line.
MeasureType
Enumeration for annotation's measure type.
Definition: fs_annot.h:1994
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:2865
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:768
String GetIconName() const
Get icon name.
Definition: fs_basictypes.h:427
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1077
~Line()
Destructor.
Definition: fs_annot.h:3665
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:774
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:128
Note()
Constructor.
Definition: fs_annot.h:2517
Ink()
Constructor.
Definition: fs_annot.h:4074
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1157
SampleEncodingFormat GetSampleEncodingFormat() const
Get the encoding format for the sample data.
CapPos GetCaptionPositionType() const
Get the position type of caption.
Definition: fs_annot.h:3650
Annotation property: creation date.
Definition: fs_annot.h:1182
Definition: fs_annot.h:4955
bool Apply()
Apply current redact annotation: remove the text, graphics and annotations under annotation rectangle...
float word_space
The word space. It should not be negative value. It is only used in pdf::PDFPage::AddText.
Definition: fs_annot.h:434
bool IsOverlayTextRepeated()
Check whether the overlay text is repeated or not.
Redact()
Constructor.
Definition: fs_annot.h:5727
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:290
float horizontal_fraction
The horizontal fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:948
common::Path GetInkList()
Get ink list data.
~Square()
Destructor.
Definition: fs_annot.h:2985
@2024 Foxit Software Incorporated. All rights reserved.