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) {}
884 bool operator != (
const IconFit& icon_fit)
const {
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_ FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:656
Annotation flag: read only.
Definition: fs_annot.h:1129
void SetFillColor(RGB fill_color)
Set fill color.
Definition: fs_annot.h:1748
WString GetUniqueID() const
Get unique ID.
StateModel GetStateModel()
Get the state model.
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
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:1218
~Line()
Destructor.
Definition: fs_annot.h:3665
Square()
Constructor.
Definition: fs_annot.h:2977
void SetStyleFillColor(RGB fill_color)
Set fill color for some line ending styles.
RectI GetDeviceRect(const Matrix &matrix)
Get annotation rectangle in device coordinate system.
~FreeText()
Destructor.
Definition: fs_annot.h:3341
IconFit()
Constructor.
Definition: fs_annot.h:795
void SetBorderColor(RGB color)
Set border color.
Definition: fs_pdfobject.h:422
PointFArray GetVertexes()
Get vertexes.
bool operator==(const RichTextStyle &style) const
Equal operator.
Definition: fs_annot.h:312
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1909
Definition: fs_annot.h:1659
Definition: fs_annot.h:2669
Definition: fs_annot.h:2765
Definition: fs_annot.h:4312
Redact()
Constructor.
Definition: fs_annot.h:5727
Definition: fs_annot.h:203
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
PointFArray GetCalloutLinePoints() const
Get a point of callout line points.
void Set(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Set value.
Definition: fs_annot.h:750
bool HasProperty(Property property) const
Whether current annotation has the specified annotation's property.
Definition: fs_image.h:36
MKIconCaptionRelation
Enumeration for icon and caption relative position in annotation's MK dictionary.
Definition: fs_annot.h:1258
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1030
Annotation flag: no view.
Definition: fs_annot.h:1120
RectF GetInnerRect() const
Get the inner rectangle.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Definition: fs_annot.h:4955
Markup()
Constructor.
Definition: fs_annot.h:2019
PDFPage GetPage() const
Get the related PDF page.
WString GetContent() const
Get content.
Twos-complement values.
Definition: fs_annot.h:5941
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1042
Annot()
Constructor.
Definition: fs_annot.h:1309
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5939
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
bool IsStateAnnot()
Check if current note annotation is used as a state annotation.
Down icon (or alternate icon) entry. "IX" in MK dictionary.
Definition: fs_annot.h:1238
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
float width
Border width, in points.
Definition: fs_annot.h:622
Annotation type: free text annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1014
State GetState()
Get the state.
StrikeOut()
Constructor.
Definition: fs_annot.h:2798
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1063
common::Rotation GetRotation()
Get current rotation value (in clockwise).
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
PolyLine()
Constructor.
Definition: fs_annot.h:4685
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1734
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
void SetFlags(uint32 flags)
Set annotation flags.
Definition: fs_annot.h:1656
void SetOverlayText(const WString &overlay_text)
Set the overlay text.
Screen()
Constructor.
Definition: fs_annot.h:4315
Sound()
Constructor.
Definition: fs_annot.h:5950
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:826
bool HasCaption() const
Check whether the content of current line annotation should be replicated as a caption in the appeara...
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:1250
float GetLeaderLineOffset() const
Get the length of leader line offset.
void SetFillColor(RGB fill_color)
Set fill color.
void SetMeasureUnit(MeasureType measure_type, const char *unit)
Set the label for displaying the units for measuring.
Corner mark style: superscript.
Definition: fs_annot.h:214
Definition: fs_annot.h:774
Annotation flag: print.
Definition: fs_annot.h:1098
Definition: fs_basictypes.h:460
BorderInfo GetBorderInfo() const
Get border information.
RGB GetApplyFillColor() const
Get the filling color which is used for rollover appearance and will be used after redaction is appli...
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
common::Font font
A font used in rich text style. It should be a valid font object.
Definition: fs_annot.h:382
BorderInfo(const BorderInfo &border_info)
Constructor, with another border information object.
Definition: fs_annot.h:526
RichTextStyle()
Constructor.
Definition: fs_annot.h:253
Definition: fs_annot.h:442
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:449
~Highlight()
Destructor.
Definition: fs_annot.h:2746
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
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1775
Definition: fs_annot.h:2974
No caption; icon only.
Definition: fs_annot.h:1262
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
void SetTextMatrix(const Matrix &text_matrix)
Set matrix in default appearance data for text in current free text annotation.
Definition: fx_coordinates.h:30
bool IsOverlayTextRepeated()
Check whether the overlay text is repeated or not.
void EnableRepeatOverlayText(bool is_to_repeat_overlay_text)
Set the flag to decide whether to repeat the overlay text.
int GetRotation()
Get current rotation angle (in clockwise).
void SetLineStartStyle(EndingStyle starting_style)
Set line ending style of the start point.
MeasureType
Enumeration for annotation's measure type.
Definition: fs_annot.h:1994
Annotation type: unknown.
Definition: fs_annot.h:1005
Caption above the icon.
Definition: fs_annot.h:1266
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
PagingSeal(const Annot &annot)
Constructor.
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:1003
Annotation type: redact annotation.
Definition: fs_annot.h:1065
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:1890
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1360
void SetIconName(const char *icon_name)
Set icon name.
Annotation's normal appearance.
Definition: fs_annot.h:1282
void SetHighlightingMode(HighlightingMode mode)
Set highlighting mode.
Definition: fs_annot.h:768
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1077
Header file for file operation related definitions and functions.
objects::PDFStream * GetAppearanceStream(AppearanceType type, const char *appearance_state="") const
Get annotation's appearance stream with specified type and state.
DefaultAppearance(const DefaultAppearance &default_appearance)
Constructor, with another default appearance object.
Definition: fs_annot.h:100
void SetCalloutLineEndingStyle(EndingStyle ending_style)
Set line ending style of the start point in a callout line.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
void EnableCaption(bool cap)
Set the flag which is used to decide whether the content of current line annotation should be replica...
objects::PDFStream * GetSoundStream() const
Get the stream of sound data.
Definition: fs_annot.h:52
Annotation type: square annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1018
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:641
~Caret()
Destructor.
Definition: fs_annot.h:4915
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
RGB GetStyleFillColor() const
Get fill color for ending styles.
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
void SetInkList(const common::Path &ink_list)
Set ink list data.
void SetFillColor(RGB fill_color)
Set fill color.
RectF GetInnerRect() const
Get the inner rectangle.
Underline()
Constructor.
Definition: fs_annot.h:2768
Annotation property: creation date.
Definition: fs_annot.h:1182
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_annot.h:609
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
void SetMKDict(pdf::objects::PDFDictionary *dict)
Set the appearance characteristics dictionary (known as "MK" dictionary as well).
RGB GetFillColor() const
Get fill color.
Definition: fs_annot.h:4500
WIDE STRING CLASS.
Definition: fx_string.h:1452
Corner mark style: subscript.
Definition: fs_annot.h:216
Definition: fs_annot.h:2514
void SetAlignment(common::Alignment alignment)
Set alignment value.
Annotation type: movie annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1046
Annotation property: modified date.
Definition: fs_annot.h:1177
actions::Action GetAction()
Get action.
DateTime GetModifiedDateTime() const
Get last modified date time.
~Link()
Destructor.
Definition: fs_annot.h:2865
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1228
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
bool IsEmpty() const
Check whether current object is empty or not.
virtual ~Screen()
Destructor.
Definition: fs_annot.h:4323
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:2852
Caption below the icon.
Definition: fs_annot.h:1264
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:408
RGB GetStyleFillColor() const
Get fill color for some line ending styles.
RectF GetInnerRect() const
Get the inner rectangle.
void EnableAutoFontSize()
Enable auto font size for the overlay text.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
bool Apply()
Apply current redact annotation: remove the text, graphics and annotations under annotation rectangle...
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:557
FileSpec GetFileSpec()
Get the file specification.
Annotation flag: no rotate.
Definition: fs_annot.h:1112
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
SampleEncodingFormat GetSampleEncodingFormat() const
Get the encoding format for the sample data.
float GetSamplingRate() const
Get the sampling rate, in samples per second.
RGB GetFillColor() const
Get fill color.
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
RGB GetFillColor() const
Get fill color.
Annotation type: screen annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1053
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:723
void SetEndPoint(const PointF &point)
Set the end point.
objects::PDFDictionary * GetOptionalContent() const
Get the PDF dictionary of annotation's optional content.
bool IsMarkup() const
Check if current annotation is a markup annotation.
RichTextStyle(const RichTextStyle &style)
Constructor, with another style object.
Definition: fs_annot.h:270
~StrikeOut()
Destructor.
Definition: fs_annot.h:2806
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:933
~PolyLine()
Destructor.
Definition: fs_annot.h:4693
DefaultAppearance()
Constructor.
Definition: fs_annot.h:90
Annotation property: fill color.
Definition: fs_annot.h:1194
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:83
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1681
Annotation property: border color.
Definition: fs_annot.h:1188
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
void SetAction(const actions::Action &action)
Set action.
WString GetMeasureRatioW()
Get the scale ratio string for measuring.
Highlight()
Constructor.
Definition: fs_annot.h:2738
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
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:63
Annotation flag: toggle no view.
Definition: fs_annot.h:1142
void SetFillColor(RGB fill_color)
Set fill color.
~Underline()
Destructor.
Definition: fs_annot.h:2776
Definition: fs_annot.h:4184
Definition: fs_annot.h:3650
RGB text_color
Text color. Format: 0xRRGGBB.
Definition: fs_annot.h:398
Header file for image and bitmap related definitions and classes.
void SetBitmap(const common::Bitmap &bitmap)
Set bitmap to current stamp annotation.
void SetLeaderLineLength(float length)
Set the length of leader line.
Definition: fs_annot.h:5724
FreeText()
Constructor.
Definition: fs_annot.h:3332
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:541
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:919
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1667
Border style: Solid.
Definition: fs_annot.h:451
~Note()
Destructor.
Definition: fs_annot.h:2527
Annotation type: rich media annotation.
Definition: fs_annot.h:1067
Type GetType() const
Get actual annotation type of current annotation.
Offset GetCaptionOffset() const
Get caption offset values.
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Annotation flag: no zoom.
Definition: fs_annot.h:1105
Annotation's rollover appearance.
Definition: fs_annot.h:1284
void SetAction(const actions::Action &action)
Set action.
PagingSealSignature GetPagingSealSignature()
Get the associated paging seal signature.
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:839
float GetLeaderLineExtensionLength() const
Get the length of leader line extension.
MKEntry
Enumeration for annotation's MK dictionary (an appearance characteristics) entry.
Definition: fs_annot.h:1202
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
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
String GetMeasureRatio()
Get the scale ratio string for measuring.
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
float GetOpacity() const
Get opacity value.
String GetMeasureRatio()
Get the scale ratio string for measuring.
common::Path GetInkList()
Get ink list data.
Annotation's down appearance.
Definition: fs_annot.h:1286
actions::Action GetAction()
Get action.
uint32 flags
Flags to indicate which properties of default appearance are meaningful.
Definition: fs_annot.h:178
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1736
μ-law-encoded samples
Definition: fs_annot.h:5943
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:3146
Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
Definition: fs_annot.h:1161
Line()
Constructor.
Definition: fs_annot.h:3657
PointF GetEndPoint() const
Get the end point.
Annotation type: polygon annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1022
uint32 GetFlags() const
Get annotation flags.
Border style: Beveled.
Definition: fs_annot.h:471
int GetChannelCount() const
Get the count of sound channels.
Circle()
Constructor.
Definition: fs_annot.h:3149
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
Definition: fs_signature.h:2091
Highlighting mode: Outline, which is to invert the annotation's border.
Definition: fs_annot.h:1163
common::Font font
A font for default appearance. It should be a valid font object when it is useful.
Definition: fs_annot.h:184
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1728
common::Rotation GetRotation()
Get the rotation of the image used for the appearance of current screen annotation.
bool operator !=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:735
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
bool Move(const RectF &rect)
Move current annotation to a new position, specified by a new rectangle in PDF coordinate system.
void SetContent(const WString &content)
Set content.
void AllowTextOverflow(bool is_text_overflow)
Decide whether to allow the text of freetext to overflow or not.
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
bool is_proportional_scaling
A boolean value which indicates whether use proportional scaling or not.
Definition: fs_annot.h:942
Matrix GetDisplayMatrix(const Matrix &page_display_matrix)
Get the display matrix, from PDF coordinate system to targeted device coordinate system.
bool GetOpenStatus() const
Get open status.
Definition: fs_annot.h:2795
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:764
Definition: fs_annot.h:4904
Definition: fs_annot.h:5097
Annot & operator=(const Annot &annot)
Assign operator.
Annotation type: widget annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1051
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:1010
bool ExecuteJavaScriptAction()
Execute the JavaScript action associated with the link annotation.
virtual void Release()=0
A callback function used to release current callback object itself.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1897
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
void SetMeasureUnit(MeasureType measure_type, const char *unit)
Set the label for displaying the units for measuring.
~Squiggly()
Destructor.
Definition: fs_annot.h:2836
~Polygon()
Destructor.
Definition: fs_annot.h:4511
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1038
Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1012
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1206
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
HighlightingMode GetHighlightingMode()
Get highlighting mode.
pdf::objects::PDFDictionary * GetMKDict() const
Get the appearance characteristics dictionary (known as "MK" dictionary as well).
PointF second
Second point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:760
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:59
RGB GetFillColor() const
Get fill color.
Definition: fs_common.h:2005
void SetCaptionPositionType(CapPos cap_position)
Set the position type of caption.
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.
void SetTitle(const WString &title)
Set title of current screen annotation.
EndingStyle
Enumeration for line ending style.
Definition: fs_annot.h:1962
Definition: fs_annot.h:4071
Caret()
Constructor.
Definition: fs_annot.h:4907
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:780
void EnableUseBezier(bool use_bezier)
Enable to use bezier spline to generate ink path for ink annotation's appearance.
String GetMeasureRatio()
Get the scale ratio string for measuring.
bool operator !=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:577
Annotation flag: locked.
Definition: fs_annot.h:1136
void SetRotation(common::Rotation rotate)
Set the rotation of the image used for the appearance of current screen annotation.
Annotation type: paging seal annotation. A Foxit PDF SDK custom annotation type (not a standard annot...
Definition: fs_annot.h:1069
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
~Ink()
Destructor.
Definition: fs_annot.h:4082
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
Annotation type: pressure sensitive ink annotation.
Definition: fs_annot.h:1040
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:708
void SetFillColor(RGB fill_color)
Set fill color.
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
Definition: fs_annot.h:3652
bool operator !=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:333
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1233
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current stamp annotation, with a specified frame index.
void Rotate(common::Rotation rotation)
Rotate current annotation from current state with specified rotation value (in clockwise).
Definition: fs_pdfpage.h:412
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
void Rotate(int angle)
Rotate current annotation from current state with specified angle degree in clockwise.
CFX_ByteString String
Byte string.
Definition: fs_basictypes.h:225
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Border style: Underline.
Definition: fs_annot.h:464
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:1175
Annotation flag: invisible.
Definition: fs_annot.h:1084
Header file for common definitions and classes.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
virtual ~Annot()
Destructor.
common::Bitmap GetBitmap()
Get the bitmap from current screen annotation.
Annotation type: trap network annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1057
float text_size
Text size. It should not be negative value. 0 means text will not be shown.
Definition: fs_annot.h:387
String GetCompressionFormat() const
Get the name of the sound compression format used on the sample data.
common::Alignment GetAlignment() const
Get alignment value.
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Constructor, with parameters.
Definition: fs_annot.h:679
Matrix GetTextMatrix() const
Get matrix in default appearance data for text in current free text annotation.
Definition: fs_annot.h:1867
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
PointF GetStartPoint() const
Get the start point.
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current screen annotation, with a specified frame index.
Definition: fx_coordinates.h:596
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Annotation type: polyline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1024
Ink()
Constructor.
Definition: fs_annot.h:4074
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
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
Caption overlaid directly on the icon.
Definition: fs_annot.h:1272
int GetIndex() const
Get the index of current annotation in the page which current annotation belongs to.
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:75
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:762
float text_size
Text size for default appearance.
Definition: fs_annot.h:193
Definition: fs_annot.h:3329
void SetCalloutLinePoints(const PointFArray &point_array)
Set points for callout line.
Header file for PDF object related definitions and classes.
bool is_underline
A boolean value which indicates whether to underline text or not.
Definition: fs_annot.h:413
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1167
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:194
FileSpec GetFileSpec() const
Get the file specification object which represents an external sound file.
Definition: fs_basictypes.h:427
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1055
TextMarkup()
Constructor.
Definition: fs_annot.h:2672
Highlighting mode: No highlighting.
Definition: fs_annot.h:1159
Caption to the right of the icon.
Definition: fs_annot.h:1268
void SetOverlayTextAlignment(common::Alignment alignment)
Set alignment value of overlay text.
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
String GetIconName() const
Get icon name.
bool operator==(const Annot &other) const
Equal operator.
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
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
Definition: fs_filespec.h:38
DefaultAppearance & operator=(const DefaultAppearance &default_appearance)
Assign operator.
Definition: fs_annot.h:113
void SetOpacity(float opacity)
Set opacity value.
PointF first
First point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:758
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1157
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
FileAttachment()
Constructor.
Definition: fs_annot.h:4958
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1026
void SetOpenStatus(bool status)
Set open status.
String GetMeasureRatio()
Get the scale ratio string for measuring.
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
A-law-encoded samples.
Definition: fs_annot.h:5945
Definition: fs_annot.h:996
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
QuadPoints(const QuadPoints &quad_points)
Constructor, with another quadrilateral points object.
Definition: fs_annot.h:694
bool RemoveProperty(Property property)
Remove a specified annotation's property.
objects::PDFDictionary * GetDict() const
Get annotation's dictionary object.
Polygon()
Constructor.
Definition: fs_annot.h:4503
Link()
Constructor.
Definition: fs_annot.h:2855
Annotation type: sound annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1044
bool operator !=(const Annot &other) const
Not equal operator.
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1032
Definition: fs_common.h:1391
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
void SetStartPoint(const PointF &point)
Set the start point.
Definition: fs_pdfobject.h:809
WString GetOverlayText() const
Get the overlay text.
bool SetFileSpec(const FileSpec &file_spec)
Set a file specification, which should specify an embedded file.
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
Icon fit information entry. "IF" in MK dictionary.
Definition: fs_annot.h:1243
PSInk()
Constructor.
Definition: fs_annot.h:5100
Corner mark style: none.
Definition: fs_annot.h:212
Foxit namespace.
Definition: fs_pdf3d.h:27
Left alignment.
Definition: fs_common.h:77
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
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1028
bool RemoveAction()
Remove action.
Definition: fs_annot.h:1871
~PSInk()
Destructor.
Definition: fs_annot.h:5110
Definition: fs_action.h:418
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:199
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1204
BYTE STRING CLASS.
Definition: fx_string.h:317
float GetLeaderLineLength() const
Get the length of leader line.
common::Alignment GetOverlayTextAlignment() const
Get alignment value of overlay text.
Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1016
Squiggly()
Constructor.
Definition: fs_annot.h:2828
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:128
Border style: Cloudy.
Definition: fs_annot.h:485
bool operator !=(const DefaultAppearance &default_appearance) const
Not equal operator.
Definition: fs_annot.h:141
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
AppearanceType
Enumeration for the type of annotation's appearance.
Definition: fs_annot.h:1280
Indicates property font of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:61
float dash_phase
Dash phase.
Definition: fs_annot.h:648
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
int GetBits() const
Get the number of bits per sample value per channel.
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
CapPos GetCaptionPositionType() const
Get the position type of caption.
Annotation type: caret annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1036
~Square()
Destructor.
Definition: fs_annot.h:2985
String GetMeasureRatio()
Get the scale ratio string for measuring.
void SetModifiedDateTime(const DateTime &date_time)
Set last modified date time.
Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1061
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Border style: Inset.
Definition: fs_annot.h:478
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
bool is_strikethrough
A boolean value which indicates whether to cross text out with strike through or not.
Definition: fs_annot.h:418
No icon; captin only.
Definition: fs_annot.h:1260
void SetBorderInfo(const BorderInfo &border)
Set border information.
CornerMarkStyle
Enumeration for corner mark style.
Definition: fs_annot.h:210
~Circle()
Destructor.
Definition: fs_annot.h:3157
void SetApplyFillColor(RGB fill_color)
Set the filling color which is used for rollover appearance and will be used after redaction is appli...
EndingStyle GetCalloutLineEndingStyle() const
Get line ending style of the start point in a callout line.
Definition: fs_annot.h:4682
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
BorderInfo()
Constructor.
Definition: fs_annot.h:515
RectF GetInnerRect() const
Get the inner rectangle.
void SetLineStartStyle(EndingStyle ending_style)
Set line ending style of the start point.
Annotation type: watermark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1059
String GetIconName() const
Get icon name.
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
void SetUniqueID(const WString &unique_id)
Set unique ID.
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
Definition: fx_coordinates.h:1076
PointFArray GetVertexes()
Get vertexes.
SampleEncodingFormat
Enumeration for encoding format of sound sample data.
Definition: fs_annot.h:5937
void Set(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Set value.
Definition: fs_annot.h:164
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
Definition: fs_annot.h:3641
RGB GetFillColor() const
Get fill color.
void SetRotation(int angle)
Set rotation angle (in clockwise).
~FileAttachment()
Destructor.
Definition: fs_annot.h:4966
void SetLeaderLineExtensionLength(float extension_length)
Set the length of leader line extension.
bool is_bold
A boolean value which indicates whether to make text bold or not.
Definition: fs_annot.h:403
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
Definition: fs_annot.h:669
RGB GetBorderColor() const
Get border color.
Definition: fs_annot.h:2825
String GetIconName() const
Get icon name.
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
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 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
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1020
WString GetTitle() const
Get title of current screen annotation.
Caption to the left of the icon.
Definition: fs_annot.h:1270
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:3648
Indicates property text size of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:65
Note()
Constructor.
Definition: fs_annot.h:2517
Stamp()
Constructor.
Definition: fs_annot.h:4187
ShadingColor()
Constructor.
Definition: fs_annot.h:1672
virtual String GetProviderID()
A callback function used to get provider ID.
Definition: fs_annot.h:1764
~Markup()
Destructor.
Definition: fs_annot.h:2022
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
Definition: fs_annot.h:2735
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1213
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1223
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2680
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:1208
void RemoveAction()
Remove action.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
Definition: fs_annot.h:6047
RectF GetRect() const
Get rectangle, in PDF coordinate system.
QuadPoints()
Constructor.
Definition: fs_annot.h:687
Annotation flag: locked contents.
Definition: fs_annot.h:1149
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1034
Definition: fs_image.h:448
Annotation flag: hidden.
Definition: fs_annot.h:1090
Definition: fs_annot.h:5930
Border style: Dashed.
Definition: fs_annot.h:458
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:290
void SetState(State state)
Set the state.
void SetStyleFillColor(RGB color)
Set fill color for ending styles.
bool ResetAppearanceStream()
Reset appearance stream.
Definition: fx_coordinates.h:771
void SetLeaderLineOffset(float offset)
Set the length of leader line offset.
Highlighting mode: Push, which is to display the annotation's down appearance, if any.
Definition: fs_annot.h:1165
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_annot.h:506