36 class PagingSealSignature;
59 typedef enum _DefAPFlags {
210 typedef enum _CornerMarkStyle {
322 return !((*this) == style);
415 typedef enum _Style {
749 typedef enum _ScaleWayType {
753 e_ScaleWayAlways = 1,
755 e_ScaleWayBigger = 2,
757 e_ScaleWaySmaller = 3,
765 : scale_way_type(e_ScaleWayNone)
766 , is_proportional_scaling(false)
767 , horizontal_fraction(0)
768 , vertical_fraction(0)
769 , fit_bounds(false) {}
796 float vertical_fraction,
bool fit_bounds)
797 : scale_way_type(type)
798 , is_proportional_scaling(is_proportional_scaling)
799 , horizontal_fraction(horizontal_fraction)
800 , vertical_fraction(vertical_fraction)
801 , fit_bounds(fit_bounds) {}
809 : scale_way_type(icon_fit.scale_way_type)
810 , is_proportional_scaling(icon_fit.is_proportional_scaling)
811 , horizontal_fraction(icon_fit.horizontal_fraction)
812 , vertical_fraction(icon_fit.vertical_fraction)
813 , fit_bounds(icon_fit.fit_bounds) {}
853 bool operator != (
const IconFit& icon_fit)
const {
889 float vertical_fraction,
bool fit_bounds) {
890 this->scale_way_type = type;
891 this->is_proportional_scaling = is_proportional_scaling;
892 this->horizontal_fraction = horizontal_fraction;
893 this->vertical_fraction = vertical_fraction;
894 this->fit_bounds = fit_bounds;
1046 typedef enum _Flags {
1126 typedef enum _HighlightingMode {
1144 typedef enum _Property {
1171 typedef enum _MKEntry {
1227 typedef enum _MKIconCaptionRelation {
1249 typedef enum _AppearanceType {
1269 #ifndef __EMSCRIPTEN_RENDER__ 1279 #ifndef __EMSCRIPTEN_RENDER__ 1305 #ifndef __EMSCRIPTEN_RENDER__ 1451 bool Move(
const RectF& rect,
bool is_reset_appearance);
1637 : first_color(firstcolor)
1638 , second_color(secondcolor) {}
1642 : first_color(0xFFFFFFFF)
1643 , second_color(0xFFFFFFFF) {}
1651 : first_color(shading_color.first_color)
1652 , second_color(shading_color.second_color) {}
1698 this->first_color = firstcolor;
1699 this->second_color = secondcolor;
1772 #ifndef __EMSCRIPTEN_RENDER__ 1800 RGB referenced_color,
int shading_index,
ShadingColor& out_shading_color) {
1866 typedef enum _StateModel {
1868 e_StateModelMarked = 1,
1870 e_StateModelReview = 2
1878 typedef enum _State {
1893 e_StateUnmarked = 2,
1898 e_StateAccepted = 3,
1903 e_StateRejected = 4,
1908 e_StateCancelled = 5,
1913 e_StateCompleted = 6,
1918 e_StateDeferred = 7,
1931 typedef enum _EndingStyle {
1933 e_EndingStyleNone = 0,
1935 e_EndingStyleSquare = 1,
1937 e_EndingStyleCircle = 2,
1939 e_EndingStyleDiamond = 3,
1941 e_EndingStyleOpenArrow = 4,
1947 e_EndingStyleClosedArrow = 5,
1949 e_EndingStyleButt = 6,
1951 e_EndingStyleROpenArrow = 7,
1953 e_EndingStyleRClosedArrow = 8,
1955 e_EndingStyleSlash = 9
1963 typedef enum _MeasureType {
2027 void SetPopup(
const Popup& popup);
2055 void SetTitle(
const WString& title);
2071 void SetSubject(
const WString& subject);
2081 float GetOpacity()
const;
2095 void SetOpacity(
float opacity);
2118 String GetIntent()
const;
2155 void SetIntent(
const String& intent);
2163 DateTime GetCreationDateTime()
const;
2172 void SetCreationDateTime(
const DateTime& date_time);
2179 int GetReplyCount();
2189 Note GetReply(
int index)
const;
2208 bool RemoveReply(
int index);
2215 bool RemoveAllReplies();
2305 NoteArray GetStateAnnots(StateModel model);
2343 Note AddStateAnnot(
const WString& title, StateModel model, State state);
2354 bool RemoveAllStateAnnots();
2362 int32 GetRichTextCount();
2387 void SetRichTextContent(
int32 index,
const WString& content);
2458 void RemoveRichText(
int index);
3617 typedef enum _CapPos {
4163 #ifndef __EMSCRIPTEN_RENDER__ 5046 #ifndef __FSDK_NO_PSINK__ 5103 typedef enum _LineSpacingStyle {
5127 #ifndef __EMSCRIPTEN_RENDER__ 5670 #ifdef _SUPPORTWEBSDK_ 5705 #ifndef __EMSCRIPTEN_RENDER__ 5906 typedef enum _SampleEncodingFormat {
5931 #ifndef __EMSCRIPTEN_RENDER__ 6039 #endif // FS_ANNOT_H_ FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:625
Annotation flag: read only.
Definition: fs_annot.h:1098
void SetFillColor(RGB fill_color)
Set fill color.
Definition: fs_annot.h:1717
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:375
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:1187
~Line()
Destructor.
Definition: fs_annot.h:3634
Square()
Constructor.
Definition: fs_annot.h:2946
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:3310
IconFit()
Constructor.
Definition: fs_annot.h:764
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:302
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1878
Definition: fs_annot.h:1628
Definition: fs_annot.h:2638
Definition: fs_annot.h:2734
Definition: fs_annot.h:4281
Redact()
Constructor.
Definition: fs_annot.h:5696
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:719
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:1227
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:999
Annotation flag: no view.
Definition: fs_annot.h:1089
RectF GetInnerRect() const
Get the inner rectangle.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Definition: fs_annot.h:4924
Markup()
Constructor.
Definition: fs_annot.h:1988
PDFPage GetPage() const
Get the related PDF page.
WString GetContent() const
Get content.
Twos-complement values.
Definition: fs_annot.h:5910
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1011
Annot()
Constructor.
Definition: fs_annot.h:1278
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5908
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:1207
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
float width
Border width, in points.
Definition: fs_annot.h:591
Annotation type: free text annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:983
State GetState()
Get the state.
StrikeOut()
Constructor.
Definition: fs_annot.h:2767
CFX_Object Object
Object type.
Definition: fs_basictypes.h:217
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1032
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:4654
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1703
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
void SetFlags(uint32 flags)
Set annotation flags.
Definition: fs_annot.h:1625
void SetOverlayText(const WString &overlay_text)
Set the overlay text.
Screen()
Constructor.
Definition: fs_annot.h:4284
Sound()
Constructor.
Definition: fs_annot.h:5919
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:795
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:1219
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:743
Annotation flag: print.
Definition: fs_annot.h:1067
Definition: fs_basictypes.h:452
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...
common::Font font
A font used in rich text style. It should be a valid font object.
Definition: fs_annot.h:366
BorderInfo(const BorderInfo &border_info)
Constructor, with another border information object.
Definition: fs_annot.h:495
RichTextStyle()
Constructor.
Definition: fs_annot.h:249
Definition: fs_annot.h:408
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:415
~Highlight()
Destructor.
Definition: fs_annot.h:2715
virtual bool GetShadingColor(Annot::Type annot_type, const char *icon_name, RGB referenced_color, int shading_index, ShadingColor &out_shading_color)
A callback function used to get the shading colors if current icon provider supports for a specified ...
Definition: fs_annot.h:1799
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1744
Definition: fs_annot.h:2943
No caption; icon only.
Definition: fs_annot.h:1231
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:1963
Annotation type: unknown.
Definition: fs_annot.h:974
Caption above the icon.
Definition: fs_annot.h:1235
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
PagingSeal(const Annot &annot)
Constructor.
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:972
Annotation type: redact annotation.
Definition: fs_annot.h:1034
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:1859
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:1251
void SetHighlightingMode(HighlightingMode mode)
Set highlighting mode.
Definition: fs_annot.h:737
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1046
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:987
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:610
~Caret()
Destructor.
Definition: fs_annot.h:4884
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:2737
Annotation property: creation date.
Definition: fs_annot.h:1151
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_annot.h:578
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:4469
WIDE STRING CLASS.
Definition: fx_string.h:1452
Corner mark style: subscript.
Definition: fs_annot.h:216
Definition: fs_annot.h:2483
void SetAlignment(common::Alignment alignment)
Set alignment value.
Annotation type: movie annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1015
Annotation property: modified date.
Definition: fs_annot.h:1146
actions::Action GetAction()
Get action.
DateTime GetModifiedDateTime() const
Get last modified date time.
~Link()
Destructor.
Definition: fs_annot.h:2834
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1197
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:4292
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:2821
Caption below the icon.
Definition: fs_annot.h:1233
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:387
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:526
FileSpec GetFileSpec()
Get the file specification.
Annotation flag: no rotate.
Definition: fs_annot.h:1081
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:1022
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:692
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:264
~StrikeOut()
Destructor.
Definition: fs_annot.h:2775
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:902
~PolyLine()
Destructor.
Definition: fs_annot.h:4662
DefaultAppearance()
Constructor.
Definition: fs_annot.h:90
Annotation property: fill color.
Definition: fs_annot.h:1163
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:1650
Annotation property: border color.
Definition: fs_annot.h:1157
float vertical_fraction
The vertical fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:923
void SetAction(const actions::Action &action)
Set action.
WString GetMeasureRatioW()
Get the scale ratio string for measuring.
Highlight()
Constructor.
Definition: fs_annot.h:2707
float horizontal_fraction
The horizontal fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:917
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:63
Annotation flag: toggle no view.
Definition: fs_annot.h:1111
void SetFillColor(RGB fill_color)
Set fill color.
~Underline()
Destructor.
Definition: fs_annot.h:2745
Definition: fs_annot.h:4153
Definition: fs_annot.h:3619
RGB text_color
Text color. Format: 0xRRGGBB.
Definition: fs_annot.h:379
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:5693
FreeText()
Constructor.
Definition: fs_annot.h:3301
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:510
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:888
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1636
Border style: Solid.
Definition: fs_annot.h:417
~Note()
Destructor.
Definition: fs_annot.h:2496
Annotation type: rich media annotation.
Definition: fs_annot.h:1036
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:1074
Annotation's rollover appearance.
Definition: fs_annot.h:1253
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:808
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:1171
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
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:1255
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:1705
μ-law-encoded samples
Definition: fs_annot.h:5912
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:3115
Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
Definition: fs_annot.h:1130
Line()
Constructor.
Definition: fs_annot.h:3626
PointF GetEndPoint() const
Get the end point.
Annotation type: polygon annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:991
uint32 GetFlags() const
Get annotation flags.
Border style: Beveled.
Definition: fs_annot.h:437
int GetChannelCount() const
Get the count of sound channels.
Circle()
Constructor.
Definition: fs_annot.h:3118
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
Definition: fs_signature.h:2072
Highlighting mode: Outline, which is to invert the annotation's border.
Definition: fs_annot.h:1132
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:1697
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:704
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:911
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:2764
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:733
Definition: fs_annot.h:4873
Definition: fs_annot.h:5066
Annot & operator=(const Annot &annot)
Assign operator.
Annotation type: widget annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1020
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:979
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:1866
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:2805
~Polygon()
Destructor.
Definition: fs_annot.h:4480
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1007
Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:981
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1175
bool fit_bounds
A boolean value that indicates whether to scale button appearance to fit fully within bounds or not.
Definition: fs_annot.h:930
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:729
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:59
RGB GetFillColor() const
Get fill color.
Definition: fs_common.h:1958
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:1931
Definition: fs_annot.h:4040
Caret()
Constructor.
Definition: fs_annot.h:4876
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:749
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:546
Annotation flag: locked.
Definition: fs_annot.h:1105
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:1038
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
~Ink()
Destructor.
Definition: fs_annot.h:4051
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
Annotation type: pressure sensitive ink annotation.
Definition: fs_annot.h:1009
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:677
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:3621
bool operator !=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:321
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1202
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:411
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:221
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Border style: Underline.
Definition: fs_annot.h:430
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:1144
Annotation flag: invisible.
Definition: fs_annot.h:1053
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:1026
float text_size
Text size. It should not be negative value. 0 means text will not be shown.
Definition: fs_annot.h:370
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:648
Matrix GetTextMatrix() const
Get matrix in default appearance data for text in current free text annotation.
Definition: fs_annot.h:1836
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:993
Ink()
Constructor.
Definition: fs_annot.h:4043
Caption overlaid directly on the icon.
Definition: fs_annot.h:1241
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:731
float text_size
Text size for default appearance.
Definition: fs_annot.h:193
Definition: fs_annot.h:3298
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:391
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1136
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:419
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1024
TextMarkup()
Constructor.
Definition: fs_annot.h:2641
Highlighting mode: No highlighting.
Definition: fs_annot.h:1128
Caption to the right of the icon.
Definition: fs_annot.h:1237
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:1769
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:727
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1126
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
FileAttachment()
Constructor.
Definition: fs_annot.h:4927
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:995
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:5914
~BorderInfo()
Destructor.
Definition: fs_annot.h:488
Definition: fs_annot.h:965
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:663
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:4472
Link()
Constructor.
Definition: fs_annot.h:2824
Annotation type: sound annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1013
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:1001
Definition: fs_common.h:1344
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:1212
PSInk()
Constructor.
Definition: fs_annot.h:5069
Corner mark style: none.
Definition: fs_annot.h:212
Foxit namespace.
Definition: fs_taggedpdf.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:1756
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:997
bool RemoveAction()
Remove action.
Definition: fs_annot.h:1840
~PSInk()
Destructor.
Definition: fs_annot.h:5079
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:1173
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:985
Squiggly()
Constructor.
Definition: fs_annot.h:2797
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:128
Border style: Cloudy.
Definition: fs_annot.h:451
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:1249
Indicates property font of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:61
float dash_phase
Dash phase.
Definition: fs_annot.h:617
CornerMarkStyle mark_style
Corner mark style. Corner mark style which can be used to make text as superscript or subscript or no...
Definition: fs_annot.h:400
void Set(const common::Font &font, float text_size, common::Alignment text_alignment, RGB text_color, bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style)
Set value.
Definition: fs_annot.h:343
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:597
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:1005
~Square()
Destructor.
Definition: fs_annot.h:2954
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:1030
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Border style: Inset.
Definition: fs_annot.h:444
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:395
No icon; captin only.
Definition: fs_annot.h:1229
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:3126
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:4651
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
BorderInfo()
Constructor.
Definition: fs_annot.h:481
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:1028
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:5906
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:3610
RGB GetFillColor() const
Get fill color.
void SetRotation(int angle)
Set rotation angle (in clockwise).
~FileAttachment()
Destructor.
Definition: fs_annot.h:4935
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:383
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
Definition: fs_annot.h:638
RGB GetBorderColor() const
Get border color.
Definition: fs_annot.h:2794
String GetIconName() const
Get icon name.
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
RichTextStyle(const common::Font &font, float text_size, common::Alignment text_alignment, RGB text_color, bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style)
Constructor, with parameters.
Definition: fs_annot.h:236
virtual float GetDisplayWidth(Annot::Type annot_type, const char *icon_name)
A callback function used to get the width for display of a specified icon, in device size(pixel norma...
Definition: fs_annot.h:1813
virtual float GetDisplayHeight(Annot::Type annot_type, const char *icon_name)
A callback function used to get the height for display of a specified icon, in device size(pixel norm...
Definition: fs_annot.h:1826
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:989
WString GetTitle() const
Get title of current screen annotation.
Caption to the left of the icon.
Definition: fs_annot.h:1239
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:3617
Indicates property text size of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:65
Note()
Constructor.
Definition: fs_annot.h:2486
Stamp()
Constructor.
Definition: fs_annot.h:4156
ShadingColor()
Constructor.
Definition: fs_annot.h:1641
virtual String GetProviderID()
A callback function used to get provider ID.
Definition: fs_annot.h:1733
~Markup()
Destructor.
Definition: fs_annot.h:1991
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
Definition: fs_annot.h:2704
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1182
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1192
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2649
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:1177
void RemoveAction()
Remove action.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
Definition: fs_annot.h:6016
RectF GetRect() const
Get rectangle, in PDF coordinate system.
QuadPoints()
Constructor.
Definition: fs_annot.h:656
Annotation flag: locked contents.
Definition: fs_annot.h:1118
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1003
Definition: fs_image.h:448
Annotation flag: hidden.
Definition: fs_annot.h:1059
Definition: fs_annot.h:5899
Border style: Dashed.
Definition: fs_annot.h:424
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:282
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:1134
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_annot.h:472