58 typedef enum _DefAPFlags {
212 typedef enum _Style {
546 typedef enum _ScaleWayType {
548 e_ScaleWayAlways = 1,
550 e_ScaleWayBigger = 2,
552 e_ScaleWaySmaller = 3,
561 , is_proportional_scaling(false)
562 , horizontal_fraction(0)
563 , vertical_fraction(0)
564 , fit_bounds(false) {}
590 float vertical_fraction,
bool fit_bounds)
591 : scale_way_type(type)
592 , is_proportional_scaling(is_proportional_scaling)
593 , horizontal_fraction(horizontal_fraction)
594 , vertical_fraction(vertical_fraction)
595 , fit_bounds(fit_bounds) {}
603 : scale_way_type(icon_fit.scale_way_type)
604 , is_proportional_scaling(icon_fit.is_proportional_scaling)
605 , horizontal_fraction(icon_fit.horizontal_fraction)
606 , vertical_fraction(icon_fit.vertical_fraction)
607 , fit_bounds(icon_fit.fit_bounds) {}
647 bool operator != (
const IconFit& icon_fit)
const {
681 float vertical_fraction,
bool fit_bounds) {
682 this->scale_way_type = type;
683 this->is_proportional_scaling = is_proportional_scaling;
684 this->horizontal_fraction = horizontal_fraction;
685 this->vertical_fraction = vertical_fraction;
686 this->fit_bounds = fit_bounds;
831 typedef enum _Flags {
911 typedef enum _HighlightingMode {
929 typedef enum _Property {
952 typedef enum _MKEntry {
1008 typedef enum _MKIconCaptionRelation {
1030 typedef enum _AppearanceType {
1050 #ifndef __EMSCRIPTEN_RENDER__ 1060 #ifndef __EMSCRIPTEN_RENDER__ 1086 #ifndef __EMSCRIPTEN_RENDER__ 1381 : first_color(firstcolor)
1382 , second_color(secondcolor) {}
1386 : first_color(0xFFFFFFFF)
1387 , second_color(0xFFFFFFFF) {}
1395 : first_color(shading_color.first_color)
1396 , second_color(shading_color.second_color) {}
1442 this->first_color = firstcolor;
1443 this->second_color = secondcolor;
1516 #ifndef __EMSCRIPTEN_RENDER__ 1544 RGB referenced_color,
int shading_index,
ShadingColor& out_shading_color) {
1607 typedef enum _StateModel {
1609 e_StateModelMarked = 1,
1611 e_StateModelReview = 2
1619 typedef enum _State {
1629 e_StateUnmarked = 2,
1634 e_StateAccepted = 3,
1639 e_StateRejected = 4,
1644 e_StateCancelled = 5,
1649 e_StateCompleted = 6,
1662 typedef enum _EndingStyle {
1664 e_EndingStyleNone = 0,
1666 e_EndingStyleSquare = 1,
1668 e_EndingStyleCircle = 2,
1670 e_EndingStyleDiamond = 3,
1672 e_EndingStyleOpenArrow = 4,
1678 e_EndingStyleClosedArrow = 5,
1680 e_EndingStyleButt = 6,
1682 e_EndingStyleROpenArrow = 7,
1684 e_EndingStyleRClosedArrow = 8,
1686 e_EndingStyleSlash = 9
1694 typedef enum _MeasureType {
1758 void SetPopup(
const Popup& popup);
1772 void SetTitle(
const WString& title);
1786 void SetSubject(
const WString& subject);
1795 float GetOpacity()
const;
1808 void SetOpacity(
float opacity);
1830 String GetIntent()
const;
1866 void SetIntent(
const String& intent);
1873 DateTime GetCreationDateTime()
const;
1881 void SetCreationDateTime(
const DateTime& date_time);
1887 int GetReplyCount();
1896 Note GetReply(
int index)
const;
1913 bool RemoveReply(
int index);
1919 bool RemoveAllReplies();
2015 int GetStateAnnotCount(StateModel model);
2041 Note GetStateAnnot(StateModel model,
int index);
2095 Note AddStateAnnot(StateModel model, State state);
2106 bool RemoveAllStateAnnots();
3013 typedef enum _CapPos {
3545 #ifndef __EMSCRIPTEN_RENDER__ 4418 #ifndef __FSDK_NO_PSINK__ 4477 #ifndef __EMSCRIPTEN_RENDER__ 4978 #ifdef _SUPPORTWEBSDK_ 5013 #ifndef __EMSCRIPTEN_RENDER__ 5189 typedef enum _SampleEncodingFormat {
5214 #ifndef __EMSCRIPTEN_RENDER__ 5288 #endif // FS_ANNOT_H_ Annotation type: caret annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:794
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Definition: fs_annot.h:3663
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
Annotation type: sound annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:802
~FileAttachment()
Destructor.
Definition: fs_annot.h:4307
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:790
RGB GetFillColor() const
Get fill color.
Definition: fs_annot.h:1372
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:817
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.
Twos-complement values.
Definition: fs_annot.h:5193
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
~Note()
Destructor.
Definition: fs_annot.h:2145
Caption above the icon.
Definition: fs_annot.h:1016
FileAttachment()
Constructor.
Definition: fs_annot.h:4299
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1351
bool operator !=(const Annot &other) const
Not equal operator.
Annotation type: redact annotation.
Definition: fs_annot.h:823
ShadingColor()
Constructor.
Definition: fs_annot.h:1385
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.
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
Annotation type: square annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:776
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:2132
Circle()
Constructor.
Definition: fs_annot.h:2655
Type GetType() const
Get actual annotation type of current annotation.
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
~Underline()
Destructor.
Definition: fs_annot.h:2393
String GetIconName() const
Get icon name.
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:528
void SetIconName(const char *icon_name)
Set icon name.
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:958
Definition: fs_action.h:418
void SetModifiedDateTime(const DateTime &date_time)
Set last modified date time.
Definition: fs_basictypes.h:432
Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:819
RectF GetRect() const
Get rectangle, in PDF coordinate system.
Annotation flag: locked contents.
Definition: fs_annot.h:903
Definition: fs_annot.h:754
Annotation flag: hidden.
Definition: fs_annot.h:844
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
No icon; captin only.
Definition: fs_annot.h:1010
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:375
Annotation's rollover appearance.
Definition: fs_annot.h:1034
Definition: fs_annot.h:5182
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
Caption below the icon.
Definition: fs_annot.h:1014
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:702
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5191
bool ResetAppearanceStream()
Reset appearance stream.
RGB GetFillColor() const
Get fill color.
~Highlight()
Destructor.
Definition: fs_annot.h:2363
PointFArray GetVertexes()
Get vertexes.
Highlighting mode: Push, which is to display the annotation's down appearance, if any.
Definition: fs_annot.h:919
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:2352
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:811
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:2469
WString GetOverlayText() const
Get the overlay text.
Style style
Border style. Please refer to values starting from BorderInfo::e_Solid and this should be one of thes...
Definition: fs_annot.h:394
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:2355
Annotation property: fill color.
Definition: fs_annot.h:944
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:2587
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:1020
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:307
Annotation flag: toggle no view.
Definition: fs_annot.h:896
void Rotate(common::Rotation rotation)
Rotate current annotation from current state with specified rotation value (in clockwise).
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:1557
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1488
void SetAlignment(common::Alignment alignment)
Set alignment value.
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1619
void SetOverlayTextAlignment(common::Alignment alignment)
Set alignment value of overlay text.
~PolyLine()
Destructor.
Definition: fs_annot.h:4034
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:589
void SetCaptionPositionType(CapPos cap_position)
Set the position type of caption.
Definition: fs_annot.h:2442
void SetContent(const WString &content)
Set content.
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:859
Header file for common definitions and classes.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2297
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:2584
Screen()
Constructor.
Definition: fs_annot.h:3666
bool operator !=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:501
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1449
Border style: Cloudy.
Definition: fs_annot.h:248
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:821
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:772
Border style: Solid.
Definition: fs_annot.h:214
bool fit_bounds
A boolean value that indicates whether to scale button appearance to fit fully within bounds or not.
Definition: fs_annot.h:719
Definition: fs_annot.h:2382
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:362
int GetChannelCount() const
Get the count of sound channels.
PolyLine()
Constructor.
Definition: fs_annot.h:4026
float GetLeaderLineOffset() const
Get the length of leader line offset.
Definition: fs_annot.h:3535
void Set(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Set value.
Definition: fs_annot.h:516
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:915
~Circle()
Destructor.
Definition: fs_annot.h:2663
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:956
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:1380
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1441
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.
Sound()
Constructor.
Definition: fs_annot.h:5202
objects::PDFStream * GetSoundStream() const
Get the stream of sound data.
String GetMeasureRatio()
Get the scale ratio string for measuring.
IconFit()
Constructor.
Definition: fs_annot.h:559
Border style: Dashed.
Definition: fs_annot.h:221
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Annotation flag: print.
Definition: fs_annot.h:852
void SetBorderColor(RGB color)
Set border color.
Annotation flag: no view.
Definition: fs_annot.h:874
common::Alignment GetOverlayTextAlignment() const
Get alignment value of overlay text.
Matrix GetTextMatrix() const
Get matrix in default appearance data for text in current free text annotation.
Matrix GetDisplayMatrix(const Matrix &page_display_matrix)
Get the display matrix, from PDF coordinate system to targeted device coordinate system.
Offset GetCaptionOffset() const
Get caption offset values.
~PSInk()
Destructor.
Definition: fs_annot.h:4450
Definition: fs_annot.h:3017
PSInk()
Constructor.
Definition: fs_annot.h:4440
Markup()
Constructor.
Definition: fs_annot.h:1719
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1447
StateModel GetStateModel()
Get the state model.
No caption; icon only.
Definition: fs_annot.h:1012
Definition: fs_common.h:1982
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:800
RectF GetInnerRect() const
Get the inner rectangle.
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
virtual ~Screen()
Destructor.
Definition: fs_annot.h:3674
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:768
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
bool GetOpenStatus() const
Get open status.
Annotation type: unknown.
Definition: fs_annot.h:763
Stamp()
Constructor.
Definition: fs_annot.h:3538
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1394
Annotation flag: invisible.
Definition: fs_annot.h:838
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Definition: fs_annot.h:2412
Definition: fs_annot.h:2731
Definition: fs_annot.h:1600
Definition: fs_annot.h:3436
Caret()
Constructor.
Definition: fs_annot.h:4248
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:422
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
μ-law-encoded samples
Definition: fs_annot.h:5195
Line()
Constructor.
Definition: fs_annot.h:3022
PointF GetEndPoint() const
Get the end point.
String GetMeasureRatio()
Get the scale ratio string for measuring.
DefaultAppearance(const DefaultAppearance &default_appearance)
Constructor, with another default appearance object.
Definition: fs_annot.h:99
Definition: fs_annot.h:2652
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:1000
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:5001
Annotation flag: locked.
Definition: fs_annot.h:890
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:693
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
RectI GetDeviceRect(const Matrix &matrix)
Get annotation rectangle in device coordinate system.
PointF first
First point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:524
Caption overlaid directly on the icon.
Definition: fs_annot.h:1022
Annotation property: modified date.
Definition: fs_annot.h:931
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:1513
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:978
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:269
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
int GetRotation()
Get current rotation angle (in clockwise).
AppearanceType
Enumeration for the type of annotation's appearance.
Definition: fs_annot.h:1030
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:983
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:1543
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:921
void RemoveAction()
Remove action.
Link()
Constructor.
Definition: fs_annot.h:2472
Highlighting mode: No highlighting.
Definition: fs_annot.h:913
Annotation flag: no rotate.
Definition: fs_annot.h:866
BYTE STRING CLASS.
Definition: fx_string.h:317
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:1369
void SetBorderInfo(const BorderInfo &border)
Set border information.
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:929
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
DefaultAppearance()
Constructor.
Definition: fs_annot.h:89
PDFPage GetPage() const
Get the related PDF page.
QuadPoints(const QuadPoints &quad_points)
Constructor, with another quadrilateral points object.
Definition: fs_annot.h:460
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:530
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:82
Annotation's normal appearance.
Definition: fs_annot.h:1032
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:784
Border style: Underline.
Definition: fs_annot.h:227
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:3844
WString GetMeasureRatioW()
Get the scale ratio string for measuring.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
BorderInfo()
Constructor.
Definition: fs_annot.h:278
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1607
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.
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
Annotation type: movie annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:804
float GetSamplingRate() const
Get the sampling rate, in samples per second.
FileSpec GetFileSpec() const
Get the file specification object which represents an external sound file.
void SetOverlayText(const WString &overlay_text)
Set the overlay text.
Rotation
Enumeration for rotation.
Definition: fs_common.h:344
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:786
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
EndingStyle
Enumeration for line ending style.
Definition: fs_annot.h:1662
Definition: fs_annot.h:205
float GetOpacity() const
Get opacity value.
~Caret()
Destructor.
Definition: fs_annot.h:4256
void SetFillColor(RGB fill_color)
Set fill color.
MKEntry
Enumeration for annotation's MK dictionary (an appearance characteristics) entry.
Definition: fs_annot.h:952
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:2453
bool IsEmpty() const
Check whether current object is empty or not.
SampleEncodingFormat
Enumeration for encoding format of sound sample data.
Definition: fs_annot.h:5189
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:177
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:780
Annotation property: border color.
Definition: fs_annot.h:938
bool RemoveProperty(Property property)
Remove a specified annotation's property.
StrikeOut()
Constructor.
Definition: fs_annot.h:2415
Foxit namespace.
Definition: fs_compare.h:27
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:917
Underline()
Constructor.
Definition: fs_annot.h:2385
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:183
FreeText()
Constructor.
Definition: fs_annot.h:2734
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:489
Icon fit information entry. "IF" in MK dictionary.
Definition: fs_annot.h:993
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
~StrikeOut()
Destructor.
Definition: fs_annot.h:2423
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:1477
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:546
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:954
Definition: fs_annot.h:435
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:1570
DateTime GetModifiedDateTime() const
Get last modified date time.
PointF second
Second point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:526
Definition: fs_annot.h:4437
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:680
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:62
Definition: fs_annot.h:4245
RectF GetInnerRect() const
Get the inner rectangle.
int GetBits() const
Get the number of bits per sample value per channel.
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:778
Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:774
Annotation's down appearance.
Definition: fs_annot.h:1036
bool operator !=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:343
MKIconCaptionRelation
Enumeration for icon and caption relative position in annotation's MK dictionary.
Definition: fs_annot.h:1008
float vertical_fraction
The vertical fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:712
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:973
void SetLeaderLineLength(float length)
Set the length of leader line.
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:963
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:796
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:602
Definition: fs_annot.h:2286
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:323
common::Rotation GetRotation()
Get current rotation value (in clockwise).
WString GetContent() const
Get content.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
~FreeText()
Destructor.
Definition: fs_annot.h:2742
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:792
RGB GetFillColor() const
Get fill color.
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
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:163
PointFArray GetCalloutLinePoints() const
Get a point of callout line points.
Definition: fx_coordinates.h:771
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:407
float text_size
Text size for default appearance.
Definition: fs_annot.h:192
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:198
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
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:883
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:1461
Border style: Beveled.
Definition: fs_annot.h:234
Annotation type: widget annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:809
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:1500
Definition: fs_pdfpage.h:342
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
~Markup()
Destructor.
Definition: fs_annot.h:1722
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:2289
String GetIconName() const
Get icon name.
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:3013
Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:770
void SetOpenStatus(bool status)
Set open status.
Annotation type: trap network annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:815
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
Annot & operator=(const Annot &annot)
Assign operator.
A-law-encoded samples.
Definition: fs_annot.h:5197
Definition: fs_image.h:430
PointF GetStartPoint() const
Get the start point.
void SetRotation(int angle)
Set rotation angle (in clockwise).
Definition: fs_annot.h:1580
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:788
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:761
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:445
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:798
void SetAction(const actions::Action &action)
Set action.
Definition: fx_coordinates.h:596
Annot()
Constructor.
Definition: fs_annot.h:1059
Definition: fs_common.h:1418
Down icon (or alternate icon) entry. "IX" in MK dictionary.
Definition: fs_annot.h:988
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:813
float dash_phase
Dash phase.
Definition: fs_annot.h:414
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:474
Definition: fx_coordinates.h:1076
Caption to the right of the icon.
Definition: fs_annot.h:1018
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:968
bool operator==(const Annot &other) const
Equal operator.
bool operator !=(const DefaultAppearance &default_appearance) const
Not equal operator.
Definition: fs_annot.h:140
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
DefaultAppearance & operator=(const DefaultAppearance &default_appearance)
Assign operator.
Definition: fs_annot.h:112
PointFArray GetVertexes()
Get vertexes.
QuadPoints()
Constructor.
Definition: fs_annot.h:453
void SetFillColor(RGB fill_color)
Set fill color.
Squiggly()
Constructor.
Definition: fs_annot.h:2445
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:3852
Definition: fs_annot.h:4023
Definition: fs_annot.h:51
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
Definition: fs_pdfobject.h:385
Border style: Inset.
Definition: fs_annot.h:241
WIDE STRING CLASS.
Definition: fx_string.h:1452
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:3006
bool HasProperty(Property property) const
Whether current annotation has the specified annotation's property.
Definition: fs_image.h:36
actions::Action GetAction()
Get action.
float width
Border width, in points.
Definition: fs_annot.h:388
Annotation type: polyline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:782
~BorderInfo()
Destructor.
Definition: fs_annot.h:285
~Ink()
Destructor.
Definition: fs_annot.h:3447
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
BorderInfo(const BorderInfo &border_info)
Constructor, with another border information object.
Definition: fs_annot.h:292
Definition: fs_annot.h:3841
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:212
float GetLeaderLineLength() const
Get the length of leader line.
MeasureType
Enumeration for annotation's measure type.
Definition: fs_annot.h:1694
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:198
common::Alignment GetAlignment() const
Get alignment value.
String GetCompressionFormat() const
Get the name of the sound compression format used on the sample data.
~Link()
Destructor.
Definition: fs_annot.h:2482
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:534
String GetIconName() const
Get icon name.
Definition: fs_basictypes.h:399
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:831
~Line()
Destructor.
Definition: fs_annot.h:3030
void Rotate(int angle)
Rotate current annotation from current state with specified angle degree in clockwise.
State GetState()
Get the state.
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:540
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:127
Note()
Constructor.
Definition: fs_annot.h:2135
Ink()
Constructor.
Definition: fs_annot.h:3439
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:911
SampleEncodingFormat GetSampleEncodingFormat() const
Get the encoding format for the sample data.
CapPos GetCaptionPositionType() const
Get the position type of caption.
Definition: fs_annot.h:3015
Annotation property: creation date.
Definition: fs_annot.h:936
Definition: fs_annot.h:4296
bool Apply()
Apply current redact annotation: remove the text or graphics under annotation rectangle permanently.
Redact()
Constructor.
Definition: fs_annot.h:5004
float horizontal_fraction
The horizontal fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:707
common::Path GetInkList()
Get ink list data.
~Square()
Destructor.
Definition: fs_annot.h:2595