37 class PagingSealSignature;
57 typedef enum _DefAPFlags {
211 typedef enum _CornerMarkStyle {
335 return !((*this) == style);
450 typedef enum _Style {
781 typedef enum _ScaleWayType {
785 e_ScaleWayAlways = 1,
787 e_ScaleWayBigger = 2,
789 e_ScaleWaySmaller = 3,
797 : scale_way_type(e_ScaleWayNone)
798 , is_proportional_scaling(false)
799 , horizontal_fraction(0)
800 , vertical_fraction(0)
801 , fit_bounds(false) {}
828 float vertical_fraction,
bool fit_bounds)
829 : scale_way_type(type)
830 , is_proportional_scaling(is_proportional_scaling)
831 , horizontal_fraction(horizontal_fraction)
832 , vertical_fraction(vertical_fraction)
833 , fit_bounds(fit_bounds) {}
841 : scale_way_type(icon_fit.scale_way_type)
842 , is_proportional_scaling(icon_fit.is_proportional_scaling)
843 , horizontal_fraction(icon_fit.horizontal_fraction)
844 , vertical_fraction(icon_fit.vertical_fraction)
845 , fit_bounds(icon_fit.fit_bounds) {}
885 bool operator != (
const IconFit& icon_fit)
const {
921 float vertical_fraction,
bool fit_bounds) {
922 this->scale_way_type = type;
923 this->is_proportional_scaling = is_proportional_scaling;
924 this->horizontal_fraction = horizontal_fraction;
925 this->vertical_fraction = vertical_fraction;
926 this->fit_bounds = fit_bounds;
1004 typedef enum _Type {
1078 typedef enum _Flags {
1158 typedef enum _HighlightingMode {
1176 typedef enum _Property {
1203 typedef enum _MKEntry {
1259 typedef enum _MKIconCaptionRelation {
1281 typedef enum _AppearanceType {
1301 #ifndef __EMSCRIPTEN_RENDER__ 1311 #ifndef __EMSCRIPTEN_RENDER__ 1337 #ifndef __EMSCRIPTEN_RENDER__ 1483 bool Move(
const RectF& rect,
bool is_reset_appearance);
1669 : first_color(firstcolor)
1670 , second_color(secondcolor) {}
1674 : first_color(0xFFFFFFFF)
1675 , second_color(0xFFFFFFFF) {}
1683 : first_color(shading_color.first_color)
1684 , second_color(shading_color.second_color) {}
1730 this->first_color = firstcolor;
1731 this->second_color = secondcolor;
1804 #ifndef __EMSCRIPTEN_RENDER__ 1832 RGB referenced_color,
int shading_index,
ShadingColor& out_shading_color) {
1898 typedef enum _StateModel {
1900 e_StateModelMarked = 1,
1902 e_StateModelReview = 2
1910 typedef enum _State {
1925 e_StateUnmarked = 2,
1930 e_StateAccepted = 3,
1935 e_StateRejected = 4,
1940 e_StateCancelled = 5,
1945 e_StateCompleted = 6,
1950 e_StateDeferred = 7,
1963 typedef enum _EndingStyle {
1965 e_EndingStyleNone = 0,
1967 e_EndingStyleSquare = 1,
1969 e_EndingStyleCircle = 2,
1971 e_EndingStyleDiamond = 3,
1973 e_EndingStyleOpenArrow = 4,
1979 e_EndingStyleClosedArrow = 5,
1981 e_EndingStyleButt = 6,
1983 e_EndingStyleROpenArrow = 7,
1985 e_EndingStyleRClosedArrow = 8,
1987 e_EndingStyleSlash = 9
1995 typedef enum _MeasureType {
2059 void SetPopup(
const Popup& popup);
2087 void SetTitle(
const WString& title);
2103 void SetSubject(
const WString& subject);
2113 float GetOpacity()
const;
2127 void SetOpacity(
float opacity);
2150 String GetIntent()
const;
2188 void SetIntent(
const String& intent);
2196 DateTime GetCreationDateTime()
const;
2205 void SetCreationDateTime(
const DateTime& date_time);
2212 int GetReplyCount();
2222 Note GetReply(
int index)
const;
2241 bool RemoveReply(
int index);
2248 bool RemoveAllReplies();
2338 NoteArray GetStateAnnots(StateModel model);
2376 Note AddStateAnnot(
const WString& title, StateModel model, State state);
2387 bool RemoveAllStateAnnots();
2395 int32 GetRichTextCount();
2420 void SetRichTextContent(
int32 index,
const WString& content);
2491 void RemoveRichText(
int index);
2505 void SetBorderOpacity(
float opacity);
2513 float GetBorderOpacity()
const;
2527 void SetFillOpacity(
float opacity);
2535 float GetFillOpacity()
const;
3697 typedef enum _CapPos {
4243 #ifndef __EMSCRIPTEN_RENDER__ 5126 #ifndef __FSDK_NO_PSINK__ 5183 typedef enum _LineSpacingStyle {
5207 #ifndef __EMSCRIPTEN_RENDER__ 5750 #ifdef _SUPPORTWEBSDK_ 5785 #ifndef __EMSCRIPTEN_RENDER__ 5986 typedef enum _SampleEncodingFormat {
6011 #ifndef __EMSCRIPTEN_RENDER__ 6119 #endif // FS_ANNOT_H_ FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:657
Annotation flag: read only.
Definition: fs_annot.h:1130
void SetFillColor(RGB fill_color)
Set fill color.
Definition: fs_annot.h:1749
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:394
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:1219
~Line()
Destructor.
Definition: fs_annot.h:3714
Square()
Constructor.
Definition: fs_annot.h:3026
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:3390
IconFit()
Constructor.
Definition: fs_annot.h:796
void SetBorderColor(RGB color)
Set border color.
Definition: fs_pdfobject.h:448
PointFArray GetVertexes()
Get vertexes.
bool operator==(const RichTextStyle &style) const
Equal operator.
Definition: fs_annot.h:313
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1910
Definition: fs_annot.h:1660
Definition: fs_annot.h:2715
Definition: fs_annot.h:2811
Definition: fs_annot.h:4361
Redact()
Constructor.
Definition: fs_annot.h:5776
Definition: fs_annot.h:204
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:751
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:1259
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1031
Annotation flag: no view.
Definition: fs_annot.h:1121
RectF GetInnerRect() const
Get the inner rectangle.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Definition: fs_annot.h:5004
Markup()
Constructor.
Definition: fs_annot.h:2020
PDFPage GetPage() const
Get the related PDF page.
WString GetContent() const
Get content.
Twos-complement values.
Definition: fs_annot.h:5990
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1043
Annot()
Constructor.
Definition: fs_annot.h:1310
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5988
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:1239
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
float width
Border width, in points.
Definition: fs_annot.h:623
Annotation type: free text annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1015
State GetState()
Get the state.
StrikeOut()
Constructor.
Definition: fs_annot.h:2844
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:1064
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:4734
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1735
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
void SetFlags(uint32 flags)
Set annotation flags.
Definition: fs_annot.h:1657
void SetOverlayText(const WString &overlay_text)
Set the overlay text.
Screen()
Constructor.
Definition: fs_annot.h:4364
Sound()
Constructor.
Definition: fs_annot.h:5999
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:827
bool HasCaption() const
Check whether the content of current line annotation should be replicated as a caption in the appeara...
bool ExecuteJavaScriptAction(const actions::JavaScriptAction &javascript_action=actions::JavaScriptAction((FS_HANDLE) 0))
Execute the JavaScript action associated with the link annotation.
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:1251
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:215
Definition: fs_annot.h:775
Annotation flag: print.
Definition: fs_annot.h:1099
Definition: fs_basictypes.h:482
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 for table generator. It is only used in pdf::PDFPage:...
Definition: fs_annot.h:435
common::Font font
A font used in rich text style. It should be a valid font object.
Definition: fs_annot.h:383
BorderInfo(const BorderInfo &border_info)
Constructor, with another border information object.
Definition: fs_annot.h:527
RichTextStyle()
Constructor.
Definition: fs_annot.h:254
Definition: fs_annot.h:443
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:450
~Highlight()
Destructor.
Definition: fs_annot.h:2792
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:1831
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1776
Definition: fs_annot.h:3023
No caption; icon only.
Definition: fs_annot.h:1263
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:1995
Annotation type: unknown.
Definition: fs_annot.h:1006
Caption above the icon.
Definition: fs_annot.h:1267
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
PagingSeal(const Annot &annot)
Constructor.
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:1004
Annotation type: redact annotation.
Definition: fs_annot.h:1066
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:1891
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:1283
void SetHighlightingMode(HighlightingMode mode)
Set highlighting mode.
Definition: fs_annot.h:769
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1078
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:98
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:50
Annotation type: square annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1019
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:642
~Caret()
Destructor.
Definition: fs_annot.h:4964
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:2814
Annotation property: creation date.
Definition: fs_annot.h:1183
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_annot.h:610
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:4549
WIDE STRING CLASS.
Definition: fx_string.h:1461
Corner mark style: subscript.
Definition: fs_annot.h:217
Definition: fs_annot.h:2560
void SetAlignment(common::Alignment alignment)
Set alignment value.
Annotation type: movie annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1047
Annotation property: modified date.
Definition: fs_annot.h:1178
actions::Action GetAction()
Get action.
DateTime GetModifiedDateTime() const
Get last modified date time.
~Link()
Destructor.
Definition: fs_annot.h:2911
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1229
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:4372
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:2898
Caption below the icon.
Definition: fs_annot.h:1265
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:409
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:558
FileSpec GetFileSpec()
Get the file specification.
Annotation flag: no rotate.
Definition: fs_annot.h:1113
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:1054
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:724
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:271
~StrikeOut()
Destructor.
Definition: fs_annot.h:2852
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:934
~PolyLine()
Destructor.
Definition: fs_annot.h:4742
DefaultAppearance()
Constructor.
Definition: fs_annot.h:88
Annotation property: fill color.
Definition: fs_annot.h:1195
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:81
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1682
Annotation property: border color.
Definition: fs_annot.h:1189
float vertical_fraction
The vertical fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:955
void SetAction(const actions::Action &action)
Set action.
WString GetMeasureRatioW()
Get the scale ratio string for measuring.
Highlight()
Constructor.
Definition: fs_annot.h:2784
float horizontal_fraction
The horizontal fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:949
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:61
Annotation flag: toggle no view.
Definition: fs_annot.h:1143
void SetFillColor(RGB fill_color)
Set fill color.
~Underline()
Destructor.
Definition: fs_annot.h:2822
Definition: fs_annot.h:4233
Definition: fs_annot.h:3699
RGB text_color
Text color. Format: 0xRRGGBB.
Definition: fs_annot.h:399
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:5773
FreeText()
Constructor.
Definition: fs_annot.h:3381
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:542
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:920
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1668
Border style: Solid.
Definition: fs_annot.h:452
~Note()
Destructor.
Definition: fs_annot.h:2573
Annotation type: rich media annotation.
Definition: fs_annot.h:1068
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:1106
Annotation's rollover appearance.
Definition: fs_annot.h:1285
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:840
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:1203
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 for table generator. It is only used in pdf::PDFPage:...
Definition: fs_annot.h:430
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:1287
actions::Action GetAction()
Get action.
uint32 flags
Flags to indicate which properties of default appearance are meaningful.
Definition: fs_annot.h:176
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1737
μ-law-encoded samples
Definition: fs_annot.h:5992
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:3195
Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
Definition: fs_annot.h:1162
Line()
Constructor.
Definition: fs_annot.h:3706
PointF GetEndPoint() const
Get the end point.
Annotation type: polygon annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1023
uint32 GetFlags() const
Get annotation flags.
Border style: Beveled.
Definition: fs_annot.h:472
int GetChannelCount() const
Get the count of sound channels.
Circle()
Constructor.
Definition: fs_annot.h:3198
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:1164
common::Font font
A font for default appearance. It should be a valid font object when it is useful.
Definition: fs_annot.h:183
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1729
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:736
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:943
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:2841
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:765
Definition: fs_annot.h:4953
Definition: fs_annot.h:5146
Annot & operator=(const Annot &annot)
Assign operator.
Annotation type: widget annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1052
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:1011
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:1898
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:2882
~Polygon()
Destructor.
Definition: fs_annot.h:4560
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1039
Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1013
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1207
bool fit_bounds
A boolean value that indicates whether to scale button appearance to fit fully within bounds or not.
Definition: fs_annot.h:962
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:761
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:57
RGB GetFillColor() const
Get fill color.
Definition: fs_common.h:2143
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:1963
Definition: fs_annot.h:4120
Caret()
Constructor.
Definition: fs_annot.h:4956
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:781
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:578
Annotation flag: locked.
Definition: fs_annot.h:1137
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:1070
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
~Ink()
Destructor.
Definition: fs_annot.h:4131
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
Annotation type: pressure sensitive ink annotation.
Definition: fs_annot.h:1041
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:709
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:3701
bool operator !=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:334
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1234
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:465
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:1176
Annotation flag: invisible.
Definition: fs_annot.h:1085
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:1058
float text_size
Text size. It should not be negative value. 0 means text will not be shown.
Definition: fs_annot.h:388
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:680
Matrix GetTextMatrix() const
Get matrix in default appearance data for text in current free text annotation.
Definition: fs_annot.h:1868
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:1025
Ink()
Constructor.
Definition: fs_annot.h:4123
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:358
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:239
Caption overlaid directly on the icon.
Definition: fs_annot.h:1273
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:94
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:763
float text_size
Text size for default appearance.
Definition: fs_annot.h:193
Definition: fs_annot.h:3378
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:414
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1168
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:449
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1056
TextMarkup()
Constructor.
Definition: fs_annot.h:2718
Highlighting mode: No highlighting.
Definition: fs_annot.h:1160
Caption to the right of the icon.
Definition: fs_annot.h:1269
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.
Definition: fs_action.h:743
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:1801
Definition: fs_filespec.h:38
DefaultAppearance & operator=(const DefaultAppearance &default_appearance)
Assign operator.
Definition: fs_annot.h:111
void SetOpacity(float opacity)
Set opacity value.
PointF first
First point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:759
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1158
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
FileAttachment()
Constructor.
Definition: fs_annot.h:5007
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1027
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:5994
Definition: fs_annot.h:997
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:695
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:4552
Link()
Constructor.
Definition: fs_annot.h:2901
Annotation type: sound annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1045
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:1033
Definition: fs_common.h:1503
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:850
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:1244
PSInk()
Constructor.
Definition: fs_annot.h:5149
Corner mark style: none.
Definition: fs_annot.h:213
Foxit namespace.
Definition: fs_pdf3d.h:27
Left alignment.
Definition: fs_common.h:96
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:1788
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1029
bool RemoveAction()
Remove action.
Definition: fs_annot.h:1872
~PSInk()
Destructor.
Definition: fs_annot.h:5159
Definition: fs_action.h:418
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:200
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1205
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:1017
Squiggly()
Constructor.
Definition: fs_annot.h:2874
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:126
Border style: Cloudy.
Definition: fs_annot.h:486
bool operator !=(const DefaultAppearance &default_appearance) const
Not equal operator.
Definition: fs_annot.h:139
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
AppearanceType
Enumeration for the type of annotation's appearance.
Definition: fs_annot.h:1281
Indicates property font of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:59
float dash_phase
Dash phase.
Definition: fs_annot.h:649
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:425
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:629
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:1037
~Square()
Destructor.
Definition: fs_annot.h:3034
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:1062
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Border style: Inset.
Definition: fs_annot.h:479
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:419
No icon; captin only.
Definition: fs_annot.h:1261
void SetBorderInfo(const BorderInfo &border)
Set border information.
CornerMarkStyle
Enumeration for corner mark style.
Definition: fs_annot.h:211
~Circle()
Destructor.
Definition: fs_annot.h:3206
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:4731
#define NULL
The null-pointer value.
Definition: fx_system.h:792
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
BorderInfo()
Constructor.
Definition: fs_annot.h:516
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:1060
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:5986
void Set(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Set value.
Definition: fs_annot.h:162
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
Definition: fs_annot.h:3690
RGB GetFillColor() const
Get fill color.
void SetRotation(int angle)
Set rotation angle (in clockwise).
~FileAttachment()
Destructor.
Definition: fs_annot.h:5015
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:404
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
Definition: fs_annot.h:670
RGB GetBorderColor() const
Get border color.
Definition: fs_annot.h:2871
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:1845
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:1858
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1021
Header file for destination and action related definitions and classes.
WString GetTitle() const
Get title of current screen annotation.
Caption to the left of the icon.
Definition: fs_annot.h:1271
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:3697
Indicates property text size of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:63
Note()
Constructor.
Definition: fs_annot.h:2563
Stamp()
Constructor.
Definition: fs_annot.h:4236
ShadingColor()
Constructor.
Definition: fs_annot.h:1673
virtual String GetProviderID()
A callback function used to get provider ID.
Definition: fs_annot.h:1765
~Markup()
Destructor.
Definition: fs_annot.h:2023
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
Definition: fs_annot.h:2781
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1214
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1224
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2726
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:1209
void RemoveAction()
Remove action.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
Definition: fs_annot.h:6096
RectF GetRect() const
Get rectangle, in PDF coordinate system.
QuadPoints()
Constructor.
Definition: fs_annot.h:688
Annotation flag: locked contents.
Definition: fs_annot.h:1150
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1035
Definition: fs_image.h:460
Annotation flag: hidden.
Definition: fs_annot.h:1091
Definition: fs_annot.h:5979
Border style: Dashed.
Definition: fs_annot.h:459
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:291
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:1166
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_annot.h:507