Go to the documentation of this file.
37 class PagingSealSignature;
57 typedef enum _DefAPFlags {
208 typedef enum _CornerMarkStyle {
332 return !((*this) == style);
447 typedef enum _Style {
778 typedef enum _ScaleWayType {
782 e_ScaleWayAlways = 1,
784 e_ScaleWayBigger = 2,
786 e_ScaleWaySmaller = 3,
794 : scale_way_type(e_ScaleWayNone)
795 , is_proportional_scaling(false)
796 , horizontal_fraction(0)
797 , vertical_fraction(0)
798 , fit_bounds(false) {}
825 float vertical_fraction,
bool fit_bounds)
826 : scale_way_type(type)
827 , is_proportional_scaling(is_proportional_scaling)
828 , horizontal_fraction(horizontal_fraction)
829 , vertical_fraction(vertical_fraction)
830 , fit_bounds(fit_bounds) {}
838 : scale_way_type(icon_fit.scale_way_type)
839 , is_proportional_scaling(icon_fit.is_proportional_scaling)
840 , horizontal_fraction(icon_fit.horizontal_fraction)
841 , vertical_fraction(icon_fit.vertical_fraction)
842 , fit_bounds(icon_fit.fit_bounds) {}
918 float vertical_fraction,
bool fit_bounds) {
919 this->scale_way_type = type;
920 this->is_proportional_scaling = is_proportional_scaling;
921 this->horizontal_fraction = horizontal_fraction;
922 this->vertical_fraction = vertical_fraction;
923 this->fit_bounds = fit_bounds;
1001 typedef enum _Type {
1075 typedef enum _Flags {
1155 typedef enum _HighlightingMode {
1173 typedef enum _Property {
1200 typedef enum _MKEntry {
1256 typedef enum _MKIconCaptionRelation {
1278 typedef enum _AppearanceType {
1298 #ifndef __EMSCRIPTEN_RENDER__
1308 #ifndef __EMSCRIPTEN_RENDER__
1334 #ifndef __EMSCRIPTEN_RENDER__
1480 bool Move(
const RectF& rect,
bool is_reset_appearance);
1666 : first_color(firstcolor)
1667 , second_color(secondcolor) {}
1671 : first_color(0xFFFFFFFF)
1672 , second_color(0xFFFFFFFF) {}
1680 : first_color(shading_color.first_color)
1681 , second_color(shading_color.second_color) {}
1727 this->first_color = firstcolor;
1728 this->second_color = secondcolor;
1801 #ifndef __EMSCRIPTEN_RENDER__
1829 RGB referenced_color,
int shading_index,
ShadingColor& out_shading_color) {
1895 typedef enum _StateModel {
1897 e_StateModelMarked = 1,
1899 e_StateModelReview = 2
1907 typedef enum _State {
1922 e_StateUnmarked = 2,
1927 e_StateAccepted = 3,
1932 e_StateRejected = 4,
1937 e_StateCancelled = 5,
1942 e_StateCompleted = 6,
1947 e_StateDeferred = 7,
1960 typedef enum _EndingStyle {
1962 e_EndingStyleNone = 0,
1964 e_EndingStyleSquare = 1,
1966 e_EndingStyleCircle = 2,
1968 e_EndingStyleDiamond = 3,
1970 e_EndingStyleOpenArrow = 4,
1976 e_EndingStyleClosedArrow = 5,
1978 e_EndingStyleButt = 6,
1980 e_EndingStyleROpenArrow = 7,
1982 e_EndingStyleRClosedArrow = 8,
1984 e_EndingStyleSlash = 9
1992 typedef enum _MeasureType {
2056 void SetPopup(
const Popup& popup);
2084 void SetTitle(
const WString& title);
2100 void SetSubject(
const WString& subject);
2110 float GetOpacity()
const;
2124 void SetOpacity(
float opacity);
2147 String GetIntent()
const;
2184 void SetIntent(
const String& intent);
2192 DateTime GetCreationDateTime()
const;
2201 void SetCreationDateTime(
const DateTime& date_time);
2208 int GetReplyCount();
2218 Note GetReply(
int index)
const;
2237 bool RemoveReply(
int index);
2244 bool RemoveAllReplies();
2334 NoteArray GetStateAnnots(StateModel model);
2372 Note AddStateAnnot(
const WString& title, StateModel model, State state);
2383 bool RemoveAllStateAnnots();
2391 int32 GetRichTextCount();
2416 void SetRichTextContent(
int32 index,
const WString& content);
2487 void RemoveRichText(
int index);
2501 void SetBorderOpacity(
float opacity);
2509 float GetBorderOpacity()
const;
2523 void SetFillOpacity(
float opacity);
2531 float GetFillOpacity()
const;
3693 typedef enum _CapPos {
4239 #ifndef __EMSCRIPTEN_RENDER__
5122 #ifndef __FSDK_NO_PSINK__
5179 typedef enum _LineSpacingStyle {
5203 #ifndef __EMSCRIPTEN_RENDER__
5746 #ifdef _SUPPORTWEBSDK_
5781 #ifndef __EMSCRIPTEN_RENDER__
5982 typedef enum _SampleEncodingFormat {
6007 #ifndef __EMSCRIPTEN_RENDER__
6115 #endif // FS_ANNOT_H_
Annotation type: caret annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1034
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Definition: fs_annot.h:4357
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:1042
~FileAttachment()
Destructor.
Definition: fs_annot.h:5011
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1030
RGB GetFillColor() const
Get fill color.
Definition: fs_annot.h:1657
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:1057
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:5986
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
~Note()
Destructor.
Definition: fs_annot.h:2569
Caption above the icon.
Definition: fs_annot.h:1264
FileAttachment()
Constructor.
Definition: fs_annot.h:5003
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1360
Annotation type: redact annotation.
Definition: fs_annot.h:1063
ShadingColor()
Constructor.
Definition: fs_annot.h:1670
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:1016
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:2556
Circle()
Constructor.
Definition: fs_annot.h:3194
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:2818
String GetIconName() const
Get icon name.
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
Definition: fs_action.h:741
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:760
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:1206
Definition: fs_action.h:418
void SetModifiedDateTime(const DateTime &date_time)
Set last modified date time.
Definition: fs_basictypes.h:476
Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1059
RectF GetRect() const
Get rectangle, in PDF coordinate system.
Annotation flag: locked contents.
Definition: fs_annot.h:1147
Definition: fs_annot.h:994
Annotation flag: hidden.
Definition: fs_annot.h:1088
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
No icon; captin only.
Definition: fs_annot.h:1258
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:607
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Annotation's rollover appearance.
Definition: fs_annot.h:1282
Definition: fs_annot.h:5975
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:1262
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:401
bool is_proportional_scaling
A boolean value which indicates whether use proportional scaling or not.
Definition: fs_annot.h:940
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5984
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:422
~Highlight()
Destructor.
Definition: fs_annot.h:2788
PointFArray GetVertexes()
Get vertexes.
Highlighting mode: Push, which is to display the annotation's down appearance, if any.
Definition: fs_annot.h:1163
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:2777
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:1051
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:2894
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:626
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:406
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:2780
Annotation property: fill color.
Definition: fs_annot.h:1192
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:3022
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:1268
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:539
PagingSeal(const Annot &annot)
Constructor.
Annotation flag: toggle no view.
Definition: fs_annot.h:1140
bool operator!=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:733
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:1842
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1773
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:212
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1907
void SetOverlayTextAlignment(common::Alignment alignment)
Set alignment value of overlay text.
~PolyLine()
Destructor.
Definition: fs_annot.h:4738
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:824
void SetCaptionPositionType(CapPos cap_position)
Set the position type of caption.
Definition: fs_annot.h:2867
void SetContent(const WString &content)
Set content.
Annotation type: rich media annotation.
Definition: fs_annot.h:1065
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:385
Annotation flag: no zoom.
Definition: fs_annot.h:1103
Header file for common definitions and classes.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2722
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:3019
Screen()
Constructor.
Definition: fs_annot.h:4360
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1734
Border style: Cloudy.
Definition: fs_annot.h:483
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1061
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:1012
Border style: Solid.
Definition: fs_annot.h:449
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:959
Definition: fs_annot.h:2807
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:94
int GetChannelCount() const
Get the count of sound channels.
PolyLine()
Constructor.
Definition: fs_annot.h:4730
float GetLeaderLineOffset() const
Get the length of leader line offset.
Definition: fs_annot.h:4229
void Set(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Set value.
Definition: fs_annot.h:748
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:1159
~Circle()
Destructor.
Definition: fs_annot.h:3202
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1204
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:59
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:1665
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1726
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:5995
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:793
Border style: Dashed.
Definition: fs_annot.h:456
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:1096
void SetBorderColor(RGB color)
Set border color.
Annotation flag: no view.
Definition: fs_annot.h:1118
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:5155
Definition: fs_annot.h:3697
PSInk()
Constructor.
Definition: fs_annot.h:5145
Markup()
Constructor.
Definition: fs_annot.h:2017
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1732
Definition: fs_annot.h:1869
StateModel GetStateModel()
Get the state model.
No caption; icon only.
Definition: fs_annot.h:1260
Left alignment.
Definition: fs_common.h:96
Corner mark style: subscript.
Definition: fs_annot.h:214
Definition: fs_common.h:2060
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1040
RectF GetInnerRect() const
Get the inner rectangle.
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
virtual ~Screen()
Destructor.
Definition: fs_annot.h:4368
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:1008
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
bool GetOpenStatus() const
Get open status.
Annotation type: unknown.
Definition: fs_annot.h:1003
Stamp()
Constructor.
Definition: fs_annot.h:4232
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1679
Annotation flag: invisible.
Definition: fs_annot.h:1082
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Definition: fs_annot.h:2837
Definition: fs_annot.h:3374
Definition: fs_annot.h:1888
Definition: fs_annot.h:4116
Caret()
Constructor.
Definition: fs_annot.h:4952
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:654
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
μ-law-encoded samples.
Definition: fs_annot.h:5988
Line()
Constructor.
Definition: fs_annot.h:3702
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:98
Definition: fs_annot.h:3191
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:1248
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:57
void SetInkList(const common::Path &ink_list)
Set ink list data.
Definition: fs_annot.h:5769
Annotation flag: locked.
Definition: fs_annot.h:1134
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:931
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:756
Caption overlaid directly on the icon.
Definition: fs_annot.h:1270
Annotation property: modified date.
Definition: fs_annot.h:1175
Definition: fs_annot.h:201
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:1798
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1226
void SetTitle(const WString &title)
Set title of current screen annotation.
RGB text_color
Text color. Format: 0xRRGGBB.
Definition: fs_annot.h:396
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:504
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:1278
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1231
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:1828
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1165
bool ExecuteJavaScriptAction(const actions::JavaScriptAction &javascript_action=actions::JavaScriptAction((FS_HANDLE) 0))
Execute the JavaScript action associated with the link annotation.
void RemoveAction()
Remove action.
Link()
Constructor.
Definition: fs_annot.h:2897
bool operator!=(const DefaultAppearance &default_appearance) const
Not equal operator.
Definition: fs_annot.h:139
Highlighting mode: No highlighting.
Definition: fs_annot.h:1157
Annotation flag: no rotate.
Definition: fs_annot.h:1110
String GetMeasureRatio()
Get the scale ratio string for measuring.
BYTE STRING CLASS.
Definition: fx_string.h:317
Header file for destination and action related definitions and classes.
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:1654
void SetBorderInfo(const BorderInfo &border)
Set border information.
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:1173
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
DefaultAppearance()
Constructor.
Definition: fs_annot.h:88
PDFPage GetPage() const
Get the related PDF page.
QuadPoints(const QuadPoints &quad_points)
Constructor, with another quadrilateral points object.
Definition: fs_annot.h:692
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:762
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:81
Annotation's normal appearance.
Definition: fs_annot.h:1280
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1024
Border style: Underline.
Definition: fs_annot.h:462
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:380
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:4548
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:6092
BorderInfo()
Constructor.
Definition: fs_annot.h:513
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1895
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:1044
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 for table generator. It is only used in pdf::PDFPage:...
Definition: fs_annot.h:427
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:1026
CornerMarkStyle
Enumeration for corner mark style.
Definition: fs_annot.h:208
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
EndingStyle
Enumeration for line ending style.
Definition: fs_annot.h:1960
Definition: fs_annot.h:440
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:4960
void SetFillColor(RGB fill_color)
Set fill color.
MKEntry
Enumeration for annotation's MK dictionary (an appearance characteristics) entry.
Definition: fs_annot.h:1200
bool operator!=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:331
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:2878
bool IsEmpty() const
Check whether current object is empty or not.
SampleEncodingFormat
Enumeration for encoding format of sound sample data.
Definition: fs_annot.h:5982
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:176
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:1020
Annotation property: border color.
Definition: fs_annot.h:1186
bool RemoveProperty(Property property)
Remove a specified annotation's property.
StrikeOut()
Constructor.
Definition: fs_annot.h:2840
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:1161
Underline()
Constructor.
Definition: fs_annot.h:2810
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:63
common::Font font
A font for default appearance. It should be a valid font object when it is useful.
Definition: fs_annot.h:182
FreeText()
Constructor.
Definition: fs_annot.h:3377
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:391
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:721
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
Icon fit information entry. "IF" in MK dictionary.
Definition: fs_annot.h:1241
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
~StrikeOut()
Destructor.
Definition: fs_annot.h:2848
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:1762
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:778
Corner mark style: none.
Definition: fs_annot.h:210
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1202
Definition: fs_annot.h:667
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:1855
DateTime GetModifiedDateTime() const
Get last modified date time.
PointF second
Second point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:758
Definition: fs_annot.h:5142
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:917
bool operator!=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:575
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:61
Definition: fs_annot.h:4949
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:1018
Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1014
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:1284
MKIconCaptionRelation
Enumeration for icon and caption relative position in annotation's MK dictionary.
Definition: fs_annot.h:1256
float vertical_fraction
The vertical fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:952
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1221
void SetLeaderLineLength(float length)
Set the length of leader line.
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1211
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1036
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:837
Definition: fs_annot.h:2711
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:555
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:236
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
~FreeText()
Destructor.
Definition: fs_annot.h:3386
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1032
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.
#define NULL
The null-pointer value.
Definition: fx_system.h:792
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:162
RichTextStyle(const RichTextStyle &style)
Constructor, with another style object.
Definition: fs_annot.h:268
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:639
float text_size
Text size for default appearance.
Definition: fs_annot.h:191
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:197
bool operator==(const RichTextStyle &style) const
Equal operator.
Definition: fs_annot.h:310
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:1127
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:1746
Border style: Beveled.
Definition: fs_annot.h:469
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:1049
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:1785
Definition: fs_pdfpage.h:412
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
~Markup()
Destructor.
Definition: fs_annot.h:2020
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:2714
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:416
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:3693
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:1010
void SetOpenStatus(bool status)
Set open status.
Annotation type: trap network annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1055
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:5990
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:355
void SetRotation(int angle)
Set rotation angle (in clockwise).
Definition: fs_annot.h:1865
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1028
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:1001
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:1067
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Constructor, with parameters.
Definition: fs_annot.h:677
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:1038
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:1307
Definition: fs_common.h:1428
Down icon (or alternate icon) entry. "IX" in MK dictionary.
Definition: fs_annot.h:1236
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1053
float dash_phase
Dash phase.
Definition: fs_annot.h:646
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:706
Definition: fx_coordinates.h:1076
Caption to the right of the icon.
Definition: fs_annot.h:1266
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:1216
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:111
PointFArray GetVertexes()
Get vertexes.
QuadPoints()
Constructor.
Definition: fs_annot.h:685
void SetFillColor(RGB fill_color)
Set fill color.
Squiggly()
Constructor.
Definition: fs_annot.h:2870
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:251
~Polygon()
Destructor.
Definition: fs_annot.h:4556
Definition: fs_annot.h:4727
Definition: fs_annot.h:50
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:476
WIDE STRING CLASS.
Definition: fx_string.h:1461
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:3686
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:620
Annotation type: polyline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1022
bool is_underline
A boolean value which indicates whether to underline text or not.
Definition: fs_annot.h:411
~Ink()
Destructor.
Definition: fs_annot.h:4127
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:524
Definition: fs_annot.h:4545
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:447
float GetLeaderLineLength() const
Get the length of leader line.
MeasureType
Enumeration for annotation's measure type.
Definition: fs_annot.h:1992
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:2907
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:766
String GetIconName() const
Get icon name.
Definition: fs_basictypes.h:443
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1075
~Line()
Destructor.
Definition: fs_annot.h:3710
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:772
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:126
Note()
Constructor.
Definition: fs_annot.h:2559
Ink()
Constructor.
Definition: fs_annot.h:4119
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1155
SampleEncodingFormat GetSampleEncodingFormat() const
Get the encoding format for the sample data.
CapPos GetCaptionPositionType() const
Get the position type of caption.
Definition: fs_annot.h:3695
Annotation property: creation date.
Definition: fs_annot.h:1180
Definition: fs_annot.h:5000
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 for table generator. It is only used in pdf::PDFPage:...
Definition: fs_annot.h:432
bool IsOverlayTextRepeated()
Check whether the overlay text is repeated or not.
Redact()
Constructor.
Definition: fs_annot.h:5772
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:288
float horizontal_fraction
The horizontal fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:946
common::Path GetInkList()
Get ink list data.
~Square()
Destructor.
Definition: fs_annot.h:3030
@2024 Foxit Software Incorporated. All rights reserved.