58 typedef enum _DefAPFlags {
207 typedef enum _Style {
541 typedef enum _ScaleWayType {
543 e_ScaleWayAlways = 1,
545 e_ScaleWayBigger = 2,
547 e_ScaleWaySmaller = 3,
556 , is_proportional_scaling(false)
557 , horizontal_fraction(0)
558 , vertical_fraction(0)
559 , fit_bounds(false) {}
585 float vertical_fraction,
bool fit_bounds)
586 : scale_way_type(type)
587 , is_proportional_scaling(is_proportional_scaling)
588 , horizontal_fraction(horizontal_fraction)
589 , vertical_fraction(vertical_fraction)
590 , fit_bounds(fit_bounds) {}
598 : scale_way_type(icon_fit.scale_way_type)
599 , is_proportional_scaling(icon_fit.is_proportional_scaling)
600 , horizontal_fraction(icon_fit.horizontal_fraction)
601 , vertical_fraction(icon_fit.vertical_fraction)
602 , fit_bounds(icon_fit.fit_bounds) {}
676 float vertical_fraction,
bool fit_bounds) {
677 this->scale_way_type = type;
678 this->is_proportional_scaling = is_proportional_scaling;
679 this->horizontal_fraction = horizontal_fraction;
680 this->vertical_fraction = vertical_fraction;
681 this->fit_bounds = fit_bounds;
826 typedef enum _Flags {
906 typedef enum _HighlightingMode {
924 typedef enum _Property {
947 typedef enum _MKEntry {
1003 typedef enum _MKIconCaptionRelation {
1025 typedef enum _AppearanceType {
1045 #ifndef __EMSCRIPTEN_RENDER__ 1055 #ifndef __EMSCRIPTEN_RENDER__ 1081 #ifndef __EMSCRIPTEN_RENDER__ 1364 : first_color(firstcolor)
1365 , second_color(secondcolor) {}
1369 : first_color(0xFFFFFFFF)
1370 , second_color(0xFFFFFFFF) {}
1378 : first_color(shading_color.first_color)
1379 , second_color(shading_color.second_color) {}
1425 this->first_color = firstcolor;
1426 this->second_color = secondcolor;
1499 #ifndef __EMSCRIPTEN_RENDER__ 1527 RGB referenced_color,
int shading_index,
ShadingColor& out_shading_color) {
1590 typedef enum _StateModel {
1592 e_StateModelMarked = 1,
1594 e_StateModelReview = 2
1602 typedef enum _State {
1612 e_StateUnmarked = 2,
1617 e_StateAccepted = 3,
1622 e_StateRejected = 4,
1627 e_StateCancelled = 5,
1632 e_StateCompleted = 6,
1645 typedef enum _EndingStyle {
1647 e_EndingStyleNone = 0,
1649 e_EndingStyleSquare = 1,
1651 e_EndingStyleCircle = 2,
1653 e_EndingStyleDiamond = 3,
1655 e_EndingStyleOpenArrow = 4,
1661 e_EndingStyleClosedArrow = 5,
1663 e_EndingStyleButt = 6,
1665 e_EndingStyleROpenArrow = 7,
1667 e_EndingStyleRClosedArrow = 8,
1669 e_EndingStyleSlash = 9
1677 typedef enum _MeasureType {
1741 void SetPopup(
const Popup& popup);
1755 void SetTitle(
const WString& title);
1769 void SetSubject(
const WString& subject);
1778 float GetOpacity()
const;
1791 void SetOpacity(
float opacity);
1813 String GetIntent()
const;
1849 void SetIntent(
const String& intent);
1856 DateTime GetCreationDateTime()
const;
1864 void SetCreationDateTime(
const DateTime& date_time);
1870 int GetReplyCount();
1879 Note GetReply(
int index)
const;
1896 bool RemoveReply(
int index);
1902 bool RemoveAllReplies();
1998 int GetStateAnnotCount(StateModel model);
2024 Note GetStateAnnot(StateModel model,
int index);
2078 Note AddStateAnnot(StateModel model, State state);
2089 bool RemoveAllStateAnnots();
2996 typedef enum _CapPos {
3504 #ifndef __EMSCRIPTEN_RENDER__ 4320 #ifndef __FSDK_NO_PSINK__ 4379 #ifndef __EMSCRIPTEN_RENDER__ 4880 #ifdef _SUPPORTWEBSDK_ 4915 #ifndef __EMSCRIPTEN_RENDER__ 5091 typedef enum _SampleEncodingFormat {
5116 #ifndef __EMSCRIPTEN_RENDER__ 5190 #endif // FS_ANNOT_H_ FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:417
Annotation flag: read only.
Definition: fs_annot.h:878
void SetFillColor(RGB fill_color)
Set fill color.
Definition: fs_annot.h:1444
WString GetUniqueID() const
Get unique ID.
StateModel GetStateModel()
Get the state model.
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:963
~Line()
Destructor.
Definition: fs_annot.h:3013
Square()
Constructor.
Definition: fs_annot.h:2570
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:2725
IconFit()
Constructor.
Definition: fs_annot.h:554
void SetBorderColor(RGB color)
Set border color.
Definition: fs_pdfobject.h:385
PointFArray GetVertexes()
Get vertexes.
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1602
Definition: fs_annot.h:1355
Definition: fs_annot.h:2269
Definition: fs_annot.h:2365
Definition: fs_annot.h:3622
Redact()
Constructor.
Definition: fs_annot.h:4906
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:511
Definition: fs_image.h:36
MKIconCaptionRelation
Enumeration for icon and caption relative position in annotation's MK dictionary.
Definition: fs_annot.h:1003
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:783
Annotation flag: no view.
Definition: fs_annot.h:869
RectF GetInnerRect() const
Get the inner rectangle.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Definition: fs_annot.h:4207
Markup()
Constructor.
Definition: fs_annot.h:1702
PDFPage GetPage() const
Get the related PDF page.
WString GetContent() const
Get content.
Twos-complement values.
Definition: fs_annot.h:5095
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:795
Annot()
Constructor.
Definition: fs_annot.h:1054
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5093
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:983
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
float width
Border width, in points.
Definition: fs_annot.h:383
Annotation type: free text annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:767
State GetState()
Get the state.
StrikeOut()
Constructor.
Definition: fs_annot.h:2398
CFX_Object Object
Object type.
Definition: fs_basictypes.h:219
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:816
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:3961
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1430
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
void SetFlags(uint32 flags)
Set annotation flags.
Definition: fs_annot.h:1352
void SetOverlayText(const WString &overlay_text)
Set the overlay text.
Screen()
Constructor.
Definition: fs_annot.h:3625
Sound()
Constructor.
Definition: fs_annot.h:5104
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:584
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:995
float GetLeaderLineOffset() const
Get the length of leader line offset.
void SetFillColor(RGB fill_color)
Set fill color.
Definition: fs_annot.h:535
Annotation flag: print.
Definition: fs_annot.h:847
bool operator!=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:338
Definition: fs_basictypes.h:408
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...
BorderInfo(const BorderInfo &border_info)
Constructor, with another border information object.
Definition: fs_annot.h:287
Definition: fs_annot.h:200
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:207
~Highlight()
Destructor.
Definition: fs_annot.h:2346
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:1526
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1471
Definition: fs_annot.h:2567
No caption; icon only.
Definition: fs_annot.h:1007
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:214
void SetTextMatrix(const Matrix &text_matrix)
Set matrix in default appearance data for text in current free text annotation.
Definition: fx_coordinates.h:30
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:1677
Annotation type: unknown.
Definition: fs_annot.h:758
Caption above the icon.
Definition: fs_annot.h:1011
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:756
Annotation type: redact annotation.
Definition: fs_annot.h:818
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:1583
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1350
void SetIconName(const char *icon_name)
Set icon name.
Annotation's normal appearance.
Definition: fs_annot.h:1027
void SetHighlightingMode(HighlightingMode mode)
Set highlighting mode.
Definition: fs_annot.h:529
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:826
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:51
Annotation type: square annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:771
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:402
~Caret()
Destructor.
Definition: fs_annot.h:4167
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor 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:2368
Annotation property: creation date.
Definition: fs_annot.h:931
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_annot.h:370
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:3800
WIDE STRING CLASS.
Definition: fx_string.h:1459
Definition: fs_annot.h:2115
void SetAlignment(common::Alignment alignment)
Set alignment value.
Annotation type: movie annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:799
Annotation property: modified date.
Definition: fs_annot.h:926
actions::Action GetAction()
Get action.
DateTime GetModifiedDateTime() const
Get last modified date time.
~Link()
Destructor.
Definition: fs_annot.h:2465
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:973
bool IsEmpty() const
Check whether current object is empty or not.
virtual ~Screen()
Destructor.
Definition: fs_annot.h:3633
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:2452
Caption below the icon.
Definition: fs_annot.h:1009
RGB GetStyleFillColor() const
Get fill color for some line ending styles.
RectF GetInnerRect() const
Get the inner rectangle.
bool Apply()
Apply current redact annotation: remove the text or graphics under annotation rectangle permanently.
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:318
FileSpec GetFileSpec()
Get the file specification.
Annotation flag: no rotate.
Definition: fs_annot.h:861
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:806
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:484
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.
~StrikeOut()
Destructor.
Definition: fs_annot.h:2406
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:688
~PolyLine()
Destructor.
Definition: fs_annot.h:3969
DefaultAppearance()
Constructor.
Definition: fs_annot.h:88
Annotation property: fill color.
Definition: fs_annot.h:939
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:1377
Annotation property: border color.
Definition: fs_annot.h:933
float vertical_fraction
The vertical fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:707
void SetAction(const actions::Action &action)
Set action.
Highlight()
Constructor.
Definition: fs_annot.h:2338
float horizontal_fraction
The horizontal fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:702
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:62
Annotation flag: toggle no view.
Definition: fs_annot.h:891
void SetFillColor(RGB fill_color)
Set fill color.
~Underline()
Destructor.
Definition: fs_annot.h:2376
Definition: fs_annot.h:3494
Definition: fs_annot.h:2998
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:4903
FreeText()
Constructor.
Definition: fs_annot.h:2717
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:302
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:675
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1363
Border style: Solid.
Definition: fs_annot.h:209
~Note()
Destructor.
Definition: fs_annot.h:2128
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:854
bool operator!=(const DefaultAppearance &default_appearance) const
Not equal operator.
Definition: fs_annot.h:139
Annotation's rollover appearance.
Definition: fs_annot.h:1029
void SetAction(const actions::Action &action)
Set action.
bool operator!=(const Annot &other) const
Not equal operator.
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:597
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:947
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:1031
actions::Action GetAction()
Get action.
uint32 flags
Flags to indicate which properties of default appearance are meaningful.
Definition: fs_annot.h:175
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1432
μ-law-encoded samples
Definition: fs_annot.h:5097
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:2635
Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
Definition: fs_annot.h:910
Line()
Constructor.
Definition: fs_annot.h:3005
PointF GetEndPoint() const
Get the end point.
Annotation type: polygon annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:775
uint32 GetFlags() const
Get annotation flags.
Border style: Beveled.
Definition: fs_annot.h:229
int GetChannelCount() const
Get the count of sound channels.
Circle()
Constructor.
Definition: fs_annot.h:2638
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:212
Highlighting mode: Outline, which is to invert the annotation's border.
Definition: fs_annot.h:912
common::Font font
A font for default appearance. It should be a valid font object when it is useful.
Definition: fs_annot.h:181
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1424
common::Rotation GetRotation()
Get the rotation of the image used for the appearance of current screen annotation.
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.
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:697
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:2395
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:525
Definition: fs_annot.h:4156
Definition: fs_annot.h:4339
Annot & operator=(const Annot &annot)
Assign operator.
Annotation type: widget annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:804
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:763
virtual void Release()=0
A callback function used to release current callback object itself.
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1590
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
~Squiggly()
Destructor.
Definition: fs_annot.h:2436
~Polygon()
Destructor.
Definition: fs_annot.h:3811
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:791
Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:765
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:951
bool fit_bounds
A boolean value that indicates whether to scale button appearance to fit fully within bounds or not.
Definition: fs_annot.h:714
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:521
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:58
RGB GetFillColor() const
Get fill color.
Definition: fs_common.h:1876
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:1645
Definition: fs_annot.h:3395
Caret()
Constructor.
Definition: fs_annot.h:4159
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:541
Annotation flag: locked.
Definition: fs_annot.h:885
void SetRotation(common::Rotation rotate)
Set the rotation of the image used for the appearance of current screen annotation.
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
~Ink()
Destructor.
Definition: fs_annot.h:3406
Annotation type: pressure sensitive ink annotation.
Definition: fs_annot.h:793
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:469
void SetFillColor(RGB fill_color)
Set fill color.
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:3000
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:978
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
bool operator!=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:496
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:198
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:313
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:216
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:223
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Border style: Underline.
Definition: fs_annot.h:222
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:924
Annotation flag: invisible.
Definition: fs_annot.h:833
Header file for common definitions and classes.
virtual ~Annot()
Destructor.
Annotation type: trap network annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:810
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:440
Matrix GetTextMatrix() const
Get matrix in default appearance data for text in current free text annotation.
Definition: fs_annot.h:1563
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
PointF GetStartPoint() const
Get the start point.
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:590
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:777
Ink()
Constructor.
Definition: fs_annot.h:3398
Caption overlaid directly on the icon.
Definition: fs_annot.h:1017
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:293
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:523
float text_size
Text size for default appearance. It should be above 0 when it is useful.
Definition: fs_annot.h:187
Definition: fs_annot.h:2714
void SetCalloutLinePoints(const PointFArray &point_array)
Set points for callout line.
Header file for PDF object related definitions and classes.
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:916
FileSpec GetFileSpec() const
Get the file specification object which represents an external sound file.
Definition: fs_basictypes.h:375
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:808
TextMarkup()
Constructor.
Definition: fs_annot.h:2272
Highlighting mode: No highlighting.
Definition: fs_annot.h:908
Caption to the right of the icon.
Definition: fs_annot.h:1013
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:1496
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:519
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:906
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
FileAttachment()
Constructor.
Definition: fs_annot.h:4210
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:779
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:5099
~BorderInfo()
Destructor.
Definition: fs_annot.h:280
Definition: fs_annot.h:749
QuadPoints(const QuadPoints &quad_points)
Constructor, with another quadrilateral points object.
Definition: fs_annot.h:455
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:3803
Link()
Constructor.
Definition: fs_annot.h:2455
Annotation type: sound annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:797
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:785
Definition: fs_common.h:1312
void SetStartPoint(const PointF &point)
Set the start point.
Definition: fs_pdfobject.h:763
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:275
Icon fit information entry. "IF" in MK dictionary.
Definition: fs_annot.h:988
PSInk()
Constructor.
Definition: fs_annot.h:4342
Foxit namespace.
Definition: fs_compare.h:27
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:1483
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:781
bool RemoveAction()
Remove action.
~PSInk()
Destructor.
Definition: fs_annot.h:4352
Definition: fs_action.h:418
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:193
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:949
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:769
Squiggly()
Constructor.
Definition: fs_annot.h:2428
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:126
Border style: Cloudy.
Definition: fs_annot.h:243
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
AppearanceType
Enumeration for the type of annotation's appearance.
Definition: fs_annot.h:1025
Indicates property font of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:60
float dash_phase
Dash phase.
Definition: fs_annot.h:409
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:389
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:789
~Square()
Destructor.
Definition: fs_annot.h:2578
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:814
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Border style: Inset.
Definition: fs_annot.h:236
No icon; captin only.
Definition: fs_annot.h:1005
void SetBorderInfo(const BorderInfo &border)
Set border information.
~Circle()
Destructor.
Definition: fs_annot.h:2646
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:3958
bool operator!=(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are not equal.
Definition: fs_basictypes.h:140
BorderInfo()
Constructor.
Definition: fs_annot.h:273
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:812
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:1056
PointFArray GetVertexes()
Get vertexes.
SampleEncodingFormat
Enumeration for encoding format of sound sample data.
Definition: fs_annot.h:5091
void Set(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Set value.
Definition: fs_annot.h:161
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
Definition: fs_annot.h:2989
RGB GetFillColor() const
Get fill color.
void SetRotation(int angle)
Set rotation angle (in clockwise).
~FileAttachment()
Destructor.
Definition: fs_annot.h:4218
void SetLeaderLineExtensionLength(float extension_length)
Set the length of leader line extension.
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
Definition: fs_annot.h:430
RGB GetBorderColor() const
Get border color.
Definition: fs_annot.h:2425
String GetIconName() const
Get icon name.
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:1540
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:1553
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:773
WString GetTitle() const
Get title of current screen annotation.
Caption to the left of the icon.
Definition: fs_annot.h:1015
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:2996
Indicates property text size of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:64
Note()
Constructor.
Definition: fs_annot.h:2118
Stamp()
Constructor.
Definition: fs_annot.h:3497
ShadingColor()
Constructor.
Definition: fs_annot.h:1368
virtual String GetProviderID()
A callback function used to get provider ID.
Definition: fs_annot.h:1460
~Markup()
Destructor.
Definition: fs_annot.h:1705
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
Definition: fs_annot.h:2335
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:958
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:968
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2280
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:953
void RemoveAction()
Remove action.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
RectF GetRect() const
Get rectangle, in PDF coordinate system.
QuadPoints()
Constructor.
Definition: fs_annot.h:448
Annotation flag: locked contents.
Definition: fs_annot.h:898
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:787
Definition: fs_image.h:430
Annotation flag: hidden.
Definition: fs_annot.h:839
Definition: fs_annot.h:5084
Border style: Dashed.
Definition: fs_annot.h:216
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:766
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:914
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_annot.h:264