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) {}
642 bool operator != (
const IconFit& icon_fit)
const {
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 {
1341 : first_color(firstcolor)
1342 , second_color(secondcolor) {}
1346 : first_color(0xFFFFFFFF)
1347 , second_color(0xFFFFFFFF) {}
1355 : first_color(shading_color.first_color)
1356 , second_color(shading_color.second_color) {}
1402 this->first_color = firstcolor;
1403 this->second_color = secondcolor;
1502 RGB referenced_color,
int shading_index,
ShadingColor& out_shading_color) {
1571 typedef enum _StateModel {
1573 e_StateModelMarked = 1,
1575 e_StateModelReview = 2
1583 typedef enum _State {
1593 e_StateUnmarked = 2,
1598 e_StateAccepted = 3,
1603 e_StateRejected = 4,
1608 e_StateCancelled = 5,
1613 e_StateCompleted = 6,
1626 typedef enum _EndingStyle {
1628 e_EndingStyleNone = 0,
1630 e_EndingStyleSquare = 1,
1632 e_EndingStyleCircle = 2,
1634 e_EndingStyleDiamond = 3,
1636 e_EndingStyleOpenArrow = 4,
1642 e_EndingStyleClosedArrow = 5,
1644 e_EndingStyleButt = 6,
1646 e_EndingStyleROpenArrow = 7,
1648 e_EndingStyleRClosedArrow = 8,
1650 e_EndingStyleSlash = 9
1702 void SetPopup(
const Popup& popup);
1716 void SetTitle(
const WString& title);
1730 void SetSubject(
const WString& subject);
1739 float GetOpacity()
const;
1752 void SetOpacity(
float opacity);
1774 String GetIntent()
const;
1810 void SetIntent(
const String& intent);
1817 DateTime GetCreationDateTime()
const;
1825 void SetCreationDateTime(
const DateTime& date_time);
1831 int GetReplyCount();
1840 Note GetReply(
int index)
const;
1857 bool RemoveReply(
int index);
1863 bool RemoveAllReplies();
1959 int GetStateAnnotCount(StateModel model);
1985 Note GetStateAnnot(StateModel model,
int index);
2039 Note AddStateAnnot(StateModel model, State state);
2050 bool RemoveAllStateAnnots();
2918 typedef enum _CapPos {
4627 #endif // FS_ANNOT_H_ Annotation type: caret annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:789
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Definition: fs_annot.h:3503
Annotation type: sound annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:797
~FileAttachment()
Destructor.
Definition: fs_annot.h:3939
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:785
RectI GetDeviceRect(bool is_transform_icon, const Matrix &matrix)
Get annotation rectangle in device coordinate system.
RGB GetFillColor() const
Get fill color.
Definition: fs_annot.h:1332
RGB GetStyleFillColor() const
Get fill color for some line ending styles.
Annotation type: watermark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:812
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
void SetLeaderLineExtensionLength(float extension_length)
Set the length of leader line extension.
objects::PDFDictionary * GetDict() const
Get annotation's dictionary object.
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
~Note()
Destructor.
Definition: fs_annot.h:2089
Caption above the icon.
Definition: fs_annot.h:1011
FileAttachment()
Constructor.
Definition: fs_annot.h:3931
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1350
bool operator !=(const Annot &other) const
Not equal operator.
Annotation type: redact annotation.
Definition: fs_annot.h:818
ShadingColor()
Constructor.
Definition: fs_annot.h:1345
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:216
int GetIndex() const
Get the index of current annotation in the page which current annotation belongs to.
Annotation type: square annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:771
RectF GetInnerRect() const
Get the inner rectangle.
void SetAction(const actions::Action &action)
Set action.
Definition: fs_filespec.h:38
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:2076
Circle()
Constructor.
Definition: fs_annot.h:2599
Type GetType() const
Get actual annotation type of current annotation.
~Underline()
Destructor.
Definition: fs_annot.h:2337
String GetIconName() const
Get icon name.
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:523
void SetIconName(const char *icon_name)
Set icon name.
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:953
Definition: fs_action.h:417
void SetModifiedDateTime(const DateTime &date_time)
Set last modified date time.
Definition: fs_basictypes.h:375
Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:814
RectF GetRect() const
Get rectangle, in PDF coordinate system.
Annotation flag: locked contents.
Definition: fs_annot.h:898
Definition: fs_annot.h:749
Annotation flag: hidden.
Definition: fs_annot.h:839
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
No icon; captin only.
Definition: fs_annot.h:1005
void SetState(State state)
Set the state.
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_annot.h:370
Annotation's rollover appearance.
Definition: fs_annot.h:1029
Caption below the icon.
Definition: fs_annot.h:1009
void SetLeaderLineOffset(float offset)
Set the length of leader line offset.
bool is_proportional_scaling
A boolean value which indicates whether use proportional scaling or not.
Definition: fs_annot.h:697
bool ResetAppearanceStream()
Reset appearance stream.
RGB GetFillColor() const
Get fill color.
~Highlight()
Destructor.
Definition: fs_annot.h:2307
PointFArray GetVertexes()
Get vertexes.
Highlighting mode: Push, which is to display the annotation's down appearance, if any.
Definition: fs_annot.h:914
bool IsStateAnnot()
Check if current note annotation is used as a state annotation.
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
Definition: fs_annot.h:2296
CFX_Object Object
Object type.
Definition: fs_basictypes.h:219
bool IsMarkup() const
Check if current annotation is a markup annotation.
Annotation type: screen annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:806
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current screen annotation, with a specified frame index.
Definition: fs_annot.h:2413
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
virtual PDFPage GetIcon(Annot::Type annot_type, const char *icon_name, ARGB color)
A callback function used to get the icon as PDF page contents for a specified type.
Highlight()
Constructor.
Definition: fs_annot.h:2299
Annotation property: fill color.
Definition: fs_annot.h:939
void SetCalloutLineEndingStyle(EndingStyle ending_style)
Set line ending style of the start point in a callout line.
void SetUniqueID(const WString &unique_id)
Set unique ID.
Square()
Constructor.
Definition: fs_annot.h:2531
void SetMKDict(pdf::objects::PDFDictionary *dict)
Set the appearance characteristics dictionary (known as "MK" dictionary as well).
void SetFillColor(RGB fill_color)
Set fill color.
void SetEndPoint(const PointF &point)
Set the end point.
Caption to the left of the icon.
Definition: fs_annot.h:1015
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:302
Annotation flag: toggle no view.
Definition: fs_annot.h:891
actions::Action GetAction()
Get action.
void SetLineStartStyle(EndingStyle ending_style)
Set line ending style of the start point.
virtual float GetDisplayWidth(Annot::Type annot_type, const char *icon_name)
A callback function used to get the width for display of a specified icon, in device size(pixel norma...
Definition: fs_annot.h:1518
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1448
void SetAlignment(common::Alignment alignment)
Set alignment value.
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1583
~PolyLine()
Destructor.
Definition: fs_annot.h:3770
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:584
void SetCaptionPositionType(CapPos cap_position)
Set the position type of caption.
Definition: fs_annot.h:2386
void SetContent(const WString &content)
Set content.
String GetMeasureUnit(int measure_type)
Get the label for displaying the units for measuring.
pdf::objects::PDFDictionary * GetMKDict() const
Get the appearance characteristics dictionary (known as "MK" dictionary as well).
HighlightingMode GetHighlightingMode()
Get highlighting mode.
Annotation flag: no zoom.
Definition: fs_annot.h:854
Header file for common definitions and classes.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2241
void SetBitmap(const common::Bitmap &bitmap)
Set bitmap to current stamp annotation.
virtual ~Annot()
Destructor.
EndingStyle GetCalloutLineEndingStyle() const
Get line ending style of the start point in a callout line.
Definition: fs_annot.h:2528
Screen()
Constructor.
Definition: fs_annot.h:3506
bool operator !=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:496
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1409
Border style: Cloudy.
Definition: fs_annot.h:243
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:816
float GetLeaderLineExtensionLength() const
Get the length of leader line extension.
Annotation type: free text annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:767
Border style: Solid.
Definition: fs_annot.h:209
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
Definition: fs_annot.h:2326
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:239
PolyLine()
Constructor.
Definition: fs_annot.h:3762
float GetLeaderLineOffset() const
Get the length of leader line offset.
Definition: fs_annot.h:3407
void Set(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Set value.
Definition: fs_annot.h:511
bool HasCaption() const
Check whether the content of current line annotation should be replicated as a caption in the appeara...
Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
Definition: fs_annot.h:910
void SetMeasureUnit(int measure_type, const String &unit)
Set the label for displaying the units for measuring.
~Circle()
Destructor.
Definition: fs_annot.h:2607
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:951
uint32 GetFlags() const
Get annotation flags.
Header file for file operation related definitions and functions.
Indicates property font of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:60
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
bool RemoveAction()
Remove action.
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1340
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1401
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:212
WString GetUniqueID() const
Get unique ID.
IconFit()
Constructor.
Definition: fs_annot.h:554
Border style: Dashed.
Definition: fs_annot.h:216
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Annotation flag: print.
Definition: fs_annot.h:847
void SetBorderColor(RGB color)
Set border color.
Annotation flag: no view.
Definition: fs_annot.h:869
Matrix GetTextMatrix() const
Get matrix in default appearance data for text in current free text annotation.
Offset GetCaptionOffset() const
Get caption offset values.
~PSInk()
Destructor.
Definition: fs_annot.h:4072
Definition: fs_annot.h:2922
PSInk()
Constructor.
Definition: fs_annot.h:4062
Markup()
Constructor.
Definition: fs_annot.h:1663
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1407
StateModel GetStateModel()
Get the state model.
No caption; icon only.
Definition: fs_annot.h:1007
Definition: fs_common.h:1467
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:795
RectF GetInnerRect() const
Get the inner rectangle.
virtual ~Screen()
Destructor.
Definition: fs_annot.h:3514
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:763
bool GetOpenStatus() const
Get open status.
Annotation type: unknown.
Definition: fs_annot.h:758
Stamp()
Constructor.
Definition: fs_annot.h:3410
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1354
Annotation flag: invisible.
Definition: fs_annot.h:833
Definition: fs_annot.h:2356
Definition: fs_annot.h:2675
Definition: fs_annot.h:1564
Definition: fs_annot.h:3308
Caret()
Constructor.
Definition: fs_annot.h:3880
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:417
Line()
Constructor.
Definition: fs_annot.h:2927
PointF GetEndPoint() const
Get the end point.
DefaultAppearance(const DefaultAppearance &default_appearance)
Constructor, with another default appearance object.
Definition: fs_annot.h:98
Definition: fs_annot.h:2596
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:995
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:58
void SetInkList(const common::Path &ink_list)
Set ink list data.
Definition: fs_annot.h:4575
Annotation flag: locked.
Definition: fs_annot.h:885
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:688
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
PointF first
First point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:519
Caption overlaid directly on the icon.
Definition: fs_annot.h:1017
Annotation property: modified date.
Definition: fs_annot.h:926
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:1473
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:973
void SetTitle(const WString &title)
Set title of current screen annotation.
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_annot.h:264
AppearanceType
Enumeration for the type of annotation's appearance.
Definition: fs_annot.h:1025
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:978
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:1501
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:916
void RemoveAction()
Remove action.
Link()
Constructor.
Definition: fs_annot.h:2416
Highlighting mode: No highlighting.
Definition: fs_annot.h:908
Annotation flag: no rotate.
Definition: fs_annot.h:861
BYTE STRING CLASS.
Definition: fx_string.h:317
void SetMeasureConversionFactor(int measure_type, float factor)
Set the conversion factor for measuring.
void SetLineStartStyle(EndingStyle starting_style)
Set line ending style of the start point.
String GetMeasureRatio()
Get the scale ratio string for measuring.
RectF GetInnerRect() const
Get the inner rectangle.
Definition: fs_annot.h:1329
void SetBorderInfo(const BorderInfo &border)
Set border information.
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:924
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
DefaultAppearance()
Constructor.
Definition: fs_annot.h:88
PDFPage GetPage() const
Get the related PDF page.
QuadPoints(const QuadPoints &quad_points)
Constructor, with another quadrilateral points object.
Definition: fs_annot.h:455
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:525
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:81
Annotation's normal appearance.
Definition: fs_annot.h:1027
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:779
Border style: Underline.
Definition: fs_annot.h:222
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
void SetRotation(common::Rotation rotate)
Set the rotation of the image used for the appearance of current screen annotation.
Polygon()
Constructor.
Definition: fs_annot.h:3684
BorderInfo()
Constructor.
Definition: fs_annot.h:273
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1571
bool SetFileSpec(const FileSpec &file_spec)
Set a file specification, which should specify an embedded file.
Definition: fx_coordinates.h:30
FileSpec GetFileSpec()
Get the file specification.
RGB GetBorderColor() const
Get border color.
Annotation type: movie annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:799
Rotation
Enumeration for rotation.
Definition: fs_common.h:221
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:781
EndingStyle
Enumeration for line ending style.
Definition: fs_annot.h:1626
Definition: fs_annot.h:200
float GetOpacity() const
Get opacity value.
~Caret()
Destructor.
Definition: fs_annot.h:3888
void SetFillColor(RGB fill_color)
Set fill color.
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
RGB GetStyleFillColor() const
Get fill color for ending styles.
BorderInfo GetBorderInfo() const
Get border information.
void SetApplyFillColor(RGB fill_color)
Set the filling color which is used for rollover appearance and will be used after redaction is appli...
objects::PDFDictionary * GetOptionalContent() const
Get the PDF dictionary of annotation's optional content.
~Squiggly()
Destructor.
Definition: fs_annot.h:2397
bool IsEmpty() const
Check whether current object is empty or not.
Header file for PDF object related definitions and classes.
uint32 flags
Flags to indicate which properties of default appearance are meaningful.
Definition: fs_annot.h:175
void SetCalloutLinePoints(const PointFArray &point_array)
Set points for callout line.
Annotation type: polygon annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:775
Annotation property: border color.
Definition: fs_annot.h:933
bool RemoveProperty(Property property)
Remove a specified annotation's property.
StrikeOut()
Constructor.
Definition: fs_annot.h:2359
Foxit namespace.
Definition: fs_connectedpdf.h:26
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current stamp annotation, with a specified frame index.
Highlighting mode: Outline, which is to invert the annotation's border.
Definition: fs_annot.h:912
Underline()
Constructor.
Definition: fs_annot.h:2329
void SetOpacity(float opacity)
Set opacity value.
WString GetTitle() const
Get title of current screen annotation.
Indicates property text size of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:64
common::Font font
A font for default appearance. It should be a valid font object when it is useful.
Definition: fs_annot.h:181
FreeText()
Constructor.
Definition: fs_annot.h:2678
void SetStartPoint(const PointF &point)
Set the start point.
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:484
Icon fit information entry. "IF" in MK dictionary.
Definition: fs_annot.h:988
~StrikeOut()
Destructor.
Definition: fs_annot.h:2367
RGB GetFillColor() const
Get fill color.
RGB GetFillColor() const
Get fill color.
virtual String GetProviderID()
A callback function used to get provider ID.
Definition: fs_annot.h:1437
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:541
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:949
Definition: fs_annot.h:430
Header file for image and bitmap related definitions and classes.
virtual float GetDisplayHeight(Annot::Type annot_type, const char *icon_name)
A callback function used to get the height for display of a specified icon, in device size(pixel norm...
Definition: fs_annot.h:1534
DateTime GetModifiedDateTime() const
Get last modified date time.
PointF second
Second point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:521
Definition: fs_annot.h:4059
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:675
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:62
Definition: fs_annot.h:3877
RectF GetInnerRect() const
Get the inner rectangle.
void SetStyleFillColor(RGB color)
Set fill color for ending styles.
Definition: fs_pdfobject.h:763
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:773
Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:769
Annotation's down appearance.
Definition: fs_annot.h:1031
bool operator !=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:338
MKIconCaptionRelation
Enumeration for icon and caption relative position in annotation's MK dictionary.
Definition: fs_annot.h:1003
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
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:968
void SetLeaderLineLength(float length)
Set the length of leader line.
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:958
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:791
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:597
Definition: fs_annot.h:2230
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:318
WString GetContent() const
Get content.
~FreeText()
Destructor.
Definition: fs_annot.h:2686
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:787
RGB GetFillColor() const
Get fill color.
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
float GetMeasureConversionFactor(int measure_type)
Get the conversion factor for measuring.
void SetHighlightingMode(HighlightingMode mode)
Set highlighting mode.
bool Move(const RectF &rect)
Move current annotation to a new position, specified by a new rectangle in PDF coordinate system.
void Set(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Set value.
Definition: fs_annot.h:161
PointFArray GetCalloutLinePoints() const
Get a point of callout line points.
Definition: fx_coordinates.h:763
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:402
float text_size
Text size for default appearance. It should be above 0 when it is useful.
Definition: fs_annot.h:187
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:193
void SetFillColor(RGB fill_color)
Set fill color.
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:214
Annotation flag: read only.
Definition: fs_annot.h:878
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:1421
Border style: Beveled.
Definition: fs_annot.h:229
Annotation type: widget annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:804
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:1460
Definition: fs_pdfpage.h:307
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
~Markup()
Destructor.
Definition: fs_annot.h:1666
void SetStyleFillColor(RGB fill_color)
Set fill color for some line ending styles.
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
virtual void Release()=0
A callback function used to release current callback object itself.
RGB GetApplyFillColor() const
Get the filling color which is used for rollover appearance and will be used after redaction is appli...
TextMarkup()
Constructor.
Definition: fs_annot.h:2233
String GetIconName() const
Get icon name.
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:2918
Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:765
void SetOpenStatus(bool status)
Set open status.
Annotation type: trap network annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:810
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
Annot & operator=(const Annot &annot)
Assign operator.
Definition: fs_image.h:426
PointF GetStartPoint() const
Get the start point.
Definition: fs_annot.h:1544
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:783
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:756
void SetFillColor(RGB fill_color)
Set fill color.
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Constructor, with parameters.
Definition: fs_annot.h:440
void SetFlags(uint32 flags)
Set annotation flags.
objects::PDFStream * GetAppearanceStream(AppearanceType type, const char *appearance_state="") const
Get annotation's appearance stream with specified type and state.
Annotation type: pressure sensitive ink annotation.
Definition: fs_annot.h:793
void SetAction(const actions::Action &action)
Set action.
Definition: fx_coordinates.h:594
Annot()
Constructor.
Definition: fs_annot.h:1052
Definition: fs_common.h:1188
Down icon (or alternate icon) entry. "IX" in MK dictionary.
Definition: fs_annot.h:983
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:808
float dash_phase
Dash phase.
Definition: fs_annot.h:409
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:469
Definition: fx_coordinates.h:1053
Caption to the right of the icon.
Definition: fs_annot.h:1013
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:963
bool operator==(const Annot &other) const
Equal operator.
bool operator !=(const DefaultAppearance &default_appearance) const
Not equal operator.
Definition: fs_annot.h:139
DefaultAppearance & operator=(const DefaultAppearance &default_appearance)
Assign operator.
Definition: fs_annot.h:111
PointFArray GetVertexes()
Get vertexes.
QuadPoints()
Constructor.
Definition: fs_annot.h:448
void SetFillColor(RGB fill_color)
Set fill color.
Squiggly()
Constructor.
Definition: fs_annot.h:2389
void SetTextMatrix(const Matrix &text_matrix)
Set matrix in default appearance data for text in current free text annotation.
~Polygon()
Destructor.
Definition: fs_annot.h:3692
Definition: fs_annot.h:3759
Definition: fs_annot.h:51
Definition: fs_pdfobject.h:385
Border style: Inset.
Definition: fs_annot.h:236
WIDE STRING CLASS.
Definition: fx_string.h:1470
void EnableCaption(bool cap)
Set the flag which is used to decide whether the content of current line annotation should be replica...
CFX_ByteString String
Byte string.
Definition: fs_basictypes.h:223
Definition: fs_annot.h:2911
Definition: fs_image.h:36
actions::Action GetAction()
Get action.
float width
Border width, in points.
Definition: fs_annot.h:383
Annotation type: polyline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:777
~BorderInfo()
Destructor.
Definition: fs_annot.h:280
~Ink()
Destructor.
Definition: fs_annot.h:3319
BorderInfo(const BorderInfo &border_info)
Constructor, with another border information object.
Definition: fs_annot.h:287
Definition: fs_annot.h:3681
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:207
float GetLeaderLineLength() const
Get the length of leader line.
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:198
common::Alignment GetAlignment() const
Get alignment value.
~Link()
Destructor.
Definition: fs_annot.h:2426
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
common::Rotation GetRotation()
Get the rotation of the image used for the appearance of current screen annotation.
Definition: fs_annot.h:529
String GetIconName() const
Get icon name.
Definition: fs_basictypes.h:342
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:826
~Line()
Destructor.
Definition: fs_annot.h:2935
State GetState()
Get the state.
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:535
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:126
Note()
Constructor.
Definition: fs_annot.h:2079
Ink()
Constructor.
Definition: fs_annot.h:3311
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:906
CapPos GetCaptionPositionType() const
Get the position type of caption.
Definition: fs_annot.h:2920
Annotation property: creation date.
Definition: fs_annot.h:931
Definition: fs_annot.h:3928
Redact()
Constructor.
Definition: fs_annot.h:4578
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
common::Path GetInkList()
Get ink list data.
~Square()
Destructor.
Definition: fs_annot.h:2539