Foxit PDF SDK

fs_annot.h
Go to the documentation of this file.
1
15 #ifndef FS_ANNOT_H_
16 #define FS_ANNOT_H_
17
18 #include "common/fs_common.h"
19 #include "common/file/fs_file.h"
20 #include "common/fs_image.h"
21 #include "pdf/actions/fs_action.h"
22 #include "pdf/objects/fs_pdfobject.h"
23
29 namespace foxit {
33 namespace pdf {
34 // forward declaration
35 class PDFPage;
36 class FileSpec;
37 class LayerNode;
38 class GraphicsObjects;
39 class PagingSealSignature;
40 namespace actions {
41 class Action;
42 class JavaScriptAction;
43 } // namespace actions
44 namespace annots {
45 class Note;
46 class Popup;
47 } // namespace annots
48 namespace interform {
49 class Field;
50 class Control;
51 } // namespace interform
52
56 class DefaultAppearance FS_FINAL : public Object {
57 public:
63 typedef enum _DefAPFlags {
65 e_FlagFont = 0x0001,
67 e_FlagTextColor = 0x0002,
69 e_FlagFontSize = 0x0004
70 } DefAPFlags;
71
72
87 DefaultAppearance(uint32 flags, const common::Font& font, float text_size, RGB text_color)
88 : flags(flags)
89 , font(font)
90 , text_size(text_size)
91 , text_color(text_color) {}
92
94 DefaultAppearance()
95 : flags(0)
96 , text_size(0)
97 , text_color(0x000000) {}
98
104 DefaultAppearance(const DefaultAppearance& default_appearance)
105 : flags(default_appearance.flags)
106 , font(default_appearance.font)
107 , text_size(default_appearance.text_size)
108 , text_color(default_appearance.text_color) {}
109
117 DefaultAppearance& operator = (const DefaultAppearance& default_appearance) {
118 flags = default_appearance.flags;
119 font = default_appearance.font;
120 text_size = default_appearance.text_size;
121 text_color = default_appearance.text_color;
122 return *this;
123 }
124
132 bool operator == (const DefaultAppearance& default_appearance) const {
133 return (flags == default_appearance.flags && font == default_appearance.font &&
134 fabs(text_size-default_appearance.text_size) <= FLT_EPSILON &&
135 text_color == default_appearance.text_color);
136 }
137
145 bool operator != (const DefaultAppearance& default_appearance) const {
146 return (flags != default_appearance.flags || font != default_appearance.font ||
147 fabs(text_size - default_appearance.text_size) > FLT_EPSILON ||
148 text_color != default_appearance.text_color);
149 }
150
168 void Set(uint32 flags, const common::Font& font, float text_size, RGB text_color) {
169 this->flags = flags;
170 this->font = font;
171 this->text_size = text_size;
172 this->text_color = text_color;
173 }
174
182 uint32 flags;
183
189 common::Font font;
190
199 float text_size;
200
206 RGB text_color;
207 };
208
210 class RichTextStyle FS_FINAL : public Object{
211 public:
217 typedef enum _CornerMarkStyle {
219 e_CornerMarkNone = 1,
221 e_CornerMarkSuperscript = 2,
223 e_CornerMarkSubscript = 3
224 } CornerMarkStyle;
225
226
245 RichTextStyle(const common::Font& font, float text_size, common::Alignment text_alignment, RGB text_color,
246 bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style, float char_space, float word_space)
247 : font(font)
248 , text_size(text_size)
249 , text_alignment(text_alignment)
250 , text_color(text_color)
251 , is_bold(is_bold)
252 , is_italic(is_italic)
253 , is_underline(is_underline)
254 , is_strikethrough(is_strikethrough)
255 , mark_style(mark_style)
256 , char_space(char_space)
257 , word_space(word_space) {}
258
260 RichTextStyle()
261 : text_size(0)
262 , text_alignment(common::e_AlignmentLeft)
263 , text_color(0x000000)
264 , is_bold(false)
265 , is_italic(false)
266 , is_underline(false)
267 , is_strikethrough(false)
268 , mark_style(RichTextStyle::e_CornerMarkNone)
269 , char_space(0.0f)
270 , word_space(0.0f) {}
271
277 RichTextStyle(const RichTextStyle& style)
278 : font(style.font)
279 , text_size(style.text_size)
280 , text_alignment(style.text_alignment)
281 , text_color(style.text_color)
282 , is_bold(style.is_bold)
283 , is_italic(style.is_italic)
284 , is_underline(style.is_underline)
285 , is_strikethrough(style.is_strikethrough)
286 , mark_style(style.mark_style)
287 , char_space(style.char_space)
288 , word_space(style.word_space) {}
289
297 RichTextStyle& operator = (const RichTextStyle& style) {
298 font = style.font;
299 text_size = style.text_size;
300 text_alignment = style.text_alignment;
301 text_color = style.text_color;
302 is_bold = style.is_bold;
303 is_italic = style.is_italic;
304 is_underline = style.is_underline;
305 is_strikethrough = style.is_strikethrough;
306 mark_style = style.mark_style;
307 char_space = style.char_space;
308 word_space = style.word_space;
309 return *this;
310 }
311
319 bool operator == (const RichTextStyle& style) const {
320 return (font == style.font &&
321 fabs(text_size- style.text_size) <= FLT_EPSILON &&
322 text_alignment == style.text_alignment &&
323 text_color == style.text_color &&
324 is_bold == style.is_bold &&
325 is_italic == style.is_italic &&
326 is_underline == style.is_underline &&
327 is_strikethrough == style.is_strikethrough &&
328 mark_style == style.mark_style &&
329 char_space == style.char_space &&
330 word_space == style.word_space);
331 }
332
340 bool operator != (const RichTextStyle& style) const {
341 return !((*this) == style);
342 }
343
364 void Set(const common::Font& font, float text_size, common::Alignment text_alignment, RGB text_color,
365 bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style, float char_space, float word_space) {
366 this->font = font;
367 this->text_size = text_size;
368 this->text_alignment = text_alignment;
369 this->text_color = text_color;
370 this->is_bold = is_bold;
371 this->is_italic = is_italic;
372 this->is_underline = is_underline;
373 this->is_strikethrough = is_strikethrough;
374 this->mark_style = mark_style;
375 this->char_space = char_space;
376 this->word_space = word_space;
377 }
378
389 common::Font font;
390
394 float text_size;
395
400 common::Alignment text_alignment;
401
405 RGB text_color;
406
410 bool is_bold;
411
415 bool is_italic;
416
420 bool is_underline;
421
425 bool is_strikethrough;
426
431 CornerMarkStyle mark_style;
432
436 float char_space;
437
441 float word_space;
442 };
443
447 namespace annots {
449 class BorderInfo FS_FINAL : public Object {
450 public:
456 typedef enum _Style {
458 e_Solid = 0,
465 e_Dashed = 1,
471 e_UnderLine = 2,
478 e_Beveled = 3,
485 e_Inset = 4,
492 e_Cloudy = 5
493 } Style;
494
495
513 BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
514 this->width = width;
515 this->style = style;
516 this->cloud_intensity = intensity;
517 this->dash_phase = dash_phase;
518 this->dashes = dashes;
519 }
520
522 BorderInfo()
523 : width(1.0f)
524 , style(BorderInfo::e_Solid)
525 , cloud_intensity(0)
526 , dash_phase(0) {}
527
529 ~BorderInfo() {}
530
536 BorderInfo(const BorderInfo& border_info) {
537 this->width = border_info.width;
538 this->style = border_info.style;
539 this->cloud_intensity = border_info.cloud_intensity;
540 this->dash_phase = border_info.dash_phase;
541 this->dashes = border_info.dashes;
542 }
543
551 BorderInfo& operator = (const BorderInfo& border_info) {
552 this->width = border_info.width;
553 this->style = border_info.style;
554 this->cloud_intensity = border_info.cloud_intensity;
555 this->dash_phase = border_info.dash_phase;
556 this->dashes = border_info.dashes;
557 return *this;
558 }
559
567 bool operator == (const BorderInfo& border_info) const {
568 if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
569 fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
570 fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
571 dashes.GetSize() != border_info.dashes.GetSize())
572 return false;
573 for (int i=0; i<dashes.GetSize(); i++) {
574 if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
575 return false;
576 }
577 return true;
578 }
579
587 bool operator != (const BorderInfo& border_info) const{
588 if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
589 fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
590 fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
591 dashes.GetSize() != border_info.dashes.GetSize())
592 return true;
593 for (int i=0; i<dashes.GetSize(); i++) {
594 if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
595 return true;
596 }
597 return false;
598 }
599
619 void Set(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
620 this->width = width;
621 this->style = style;
622 this->cloud_intensity = intensity;
623 this->dash_phase = dash_phase;
624 this->dashes = dashes;
625 }
626
632 float width;
633
638 Style style;
639
651 float cloud_intensity;
652
658 float dash_phase;
659
666 FloatArray dashes;
667 };
668
679 class QuadPoints FS_FINAL : public Object {
680 public:
689 QuadPoints(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
690 this->first = first;
691 this->second = second;
692 this->third = third;
693 this->fourth = fourth;
694 }
695
697 QuadPoints() {}
698
704 QuadPoints(const QuadPoints& quad_points) {
705 first = quad_points.first;
706 second = quad_points.second;
707 third = quad_points.third;
708 fourth = quad_points.fourth;
709 }
710
718 QuadPoints& operator = (const QuadPoints& quad_points) {
719 first = quad_points.first;
720 second = quad_points.second;
721 third = quad_points.third;
722 fourth = quad_points.fourth;
723 return *this;
724 }
725
733 bool operator == (const QuadPoints& quad_points) const {
734 return (first == quad_points.first && second == quad_points.second &&
735 third == quad_points.third && fourth == quad_points.fourth);
736 }
737
745 bool operator != (const QuadPoints& quad_points) const {
746 return (first != quad_points.first || second != quad_points.second ||
747 third != quad_points.third || fourth != quad_points.fourth);
748 }
749
760 void Set(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
761 this->first = first;
762 this->second = second;
763 this->third = third;
764 this->fourth = fourth;
765 }
766
768 PointF first;
770 PointF second;
772 PointF third;
774 PointF fourth;
775 };
776
778 FSDK_DEFINE_ARRAY(QuadPointsArray, QuadPoints)
779
780
784 class IconFit FS_FINAL : public Object {
785 public:
790 typedef enum _ScaleWayType {
792 e_ScaleWayNone = 0,
794 e_ScaleWayAlways = 1,
796 e_ScaleWayBigger = 2,
798 e_ScaleWaySmaller = 3,
800 e_ScaleWayNever = 4
801 } ScaleWayType;
802
803
805 IconFit()
806 : scale_way_type(e_ScaleWayNone)
807 , is_proportional_scaling(false)
808 , horizontal_fraction(0)
809 , vertical_fraction(0)
810 , fit_bounds(false) {}
811
836 IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
837 float vertical_fraction, bool fit_bounds)
838 : scale_way_type(type)
839 , is_proportional_scaling(is_proportional_scaling)
840 , horizontal_fraction(horizontal_fraction)
841 , vertical_fraction(vertical_fraction)
842 , fit_bounds(fit_bounds) {}
843
849 IconFit(const IconFit& icon_fit)
850 : scale_way_type(icon_fit.scale_way_type)
851 , is_proportional_scaling(icon_fit.is_proportional_scaling)
852 , horizontal_fraction(icon_fit.horizontal_fraction)
853 , vertical_fraction(icon_fit.vertical_fraction)
854 , fit_bounds(icon_fit.fit_bounds) {}
855
863 IconFit& operator = (const IconFit& icon_fit) {
864 scale_way_type = icon_fit.scale_way_type;
865 is_proportional_scaling = icon_fit.is_proportional_scaling;
866 horizontal_fraction = icon_fit.horizontal_fraction;
867 vertical_fraction = icon_fit.vertical_fraction;
868 fit_bounds = icon_fit.fit_bounds;
869 return *this;
870 }
871
879 bool operator == (const IconFit& icon_fit) const {
880 return (scale_way_type == icon_fit.scale_way_type &&
881 is_proportional_scaling == icon_fit.is_proportional_scaling &&
882 fabs(horizontal_fraction - icon_fit.horizontal_fraction) <= FLT_EPSILON &&
883 fabs(vertical_fraction - icon_fit.vertical_fraction) <= FLT_EPSILON &&
884 fit_bounds == icon_fit.fit_bounds);
885 }
886
894 bool operator != (const IconFit& icon_fit) const {
895 return (scale_way_type != icon_fit.scale_way_type ||
896 is_proportional_scaling != icon_fit.is_proportional_scaling ||
897 fabs(horizontal_fraction - icon_fit.horizontal_fraction) > FLT_EPSILON ||
898 fabs(vertical_fraction - icon_fit.vertical_fraction) > FLT_EPSILON ||
899 fit_bounds != icon_fit.fit_bounds);
900 }
901
929 void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
930 float vertical_fraction, bool fit_bounds) {
931 this->scale_way_type = type;
932 this->is_proportional_scaling = is_proportional_scaling;
933 this->horizontal_fraction = horizontal_fraction;
934 this->vertical_fraction = vertical_fraction;
935 this->fit_bounds = fit_bounds;
936 }
937
943 ScaleWayType scale_way_type;
952 bool is_proportional_scaling;
958 float horizontal_fraction;
964 float vertical_fraction;
971 bool fit_bounds;
972 };
973
1006 class Annot : public Base {
1007 public:
1013 typedef enum _Type {
1015 e_UnknownType = 0,
1020 e_Note = 1,
1022 e_Link = 2,
1024 e_FreeText = 3,
1026 e_Line = 4,
1028 e_Square = 5,
1030 e_Circle = 6,
1032 e_Polygon = 7,
1034 e_PolyLine = 8,
1036 e_Highlight = 9,
1038 e_Underline = 10,
1040 e_Squiggly = 11,
1042 e_StrikeOut = 12,
1044 e_Stamp = 13,
1046 e_Caret = 14,
1048 e_Ink = 15,
1050 e_PSInk = 16,
1052 e_FileAttachment = 17,
1054 e_Sound = 18,
1056 e_Movie = 19,
1061 e_Widget = 20,
1063 e_Screen = 21,
1065 e_PrinterMark = 22,
1067 e_TrapNet = 23,
1069 e_Watermark = 24,
1071 e_3D = 25,
1073 e_Popup = 26,
1075 e_Redact = 27,
1077 e_RichMedia = 28,
1079 e_PagingSeal = 29
1080 } Type;
1081
1087 typedef enum _Flags {
1094 e_FlagInvisible = 0x0001,
1100 e_FlagHidden = 0x0002,
1108 e_FlagPrint = 0x0004,
1115 e_FlagNoZoom = 0x0008,
1122 e_FlagNoRotate = 0x0010,
1130 e_FlagNoView = 0x0020,
1139 e_FlagReadOnly = 0x0040,
1146 e_FlagLocked = 0x0080,
1152 e_FlagToggleNoView = 0x0100,
1159 e_FlagLockedContents = 0x0200
1160 } Flags;
1161
1167 typedef enum _HighlightingMode {
1169 e_HighlightingNone = 0,
1171 e_HighlightingInvert = 1,
1173 e_HighlightingOutline = 2,
1175 e_HighlightingPush = 3,
1177 e_HighlightingToggle = 4
1178 } HighlightingMode;
1179
1185 typedef enum _Property {
1187 e_PropertyModifiedDate = 0,
1192 e_PropertyCreationDate = 1,
1198 e_PropertyBorderColor = 2,
1204 e_PropertyFillColor = 3
1205 } Property;
1206
1212 typedef enum _MKEntry {
1214 e_MKEntryRotation = 0,
1216 e_MKEntryBorderColor = 1,
1218 e_MKEntryBackgroundColor = 2,
1223 e_MKEntryNormalCaption = 3,
1228 e_MKEntryRolloverCaption = 4,
1233 e_MKEntryDownCaption = 5,
1238 e_MKEntryNormalIcon = 6,
1243 e_MKEntryRolloverIcon = 7,
1248 e_MKEntryDownIcon = 8,
1253 e_MKEntryIconFit = 9,
1260 e_MKEntryIconCaptionRelation = 10
1261 } MKEntry;
1262
1268 typedef enum _MKIconCaptionRelation {
1270 e_MKRelationNoIcon = 0,
1272 e_MKRelationNoCaption = 1,
1274 e_MKRelationCaptionBelowIcon = 2,
1276 e_MKRelationCaptionAboveIcon = 3,
1278 e_MKRelationCaptionRight = 4,
1280 e_MKRelationCaptionLeft = 5,
1282 e_MKRelationCaptionOvrlayOnIcon = 6
1283 } MKIconCaptionRelation;
1284
1290 typedef enum _AppearanceType {
1292 e_AppearanceTypeNormal = 0,
1294 e_AppearanceTypeRollover = 1,
1296 e_AppearanceTypeDown = 2
1297 } AppearanceType;
1298
1299
1300 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1301 explicit Annot(FS_HANDLE handle);
1309 Annot(const PDFPage& page, objects::PDFDictionary* annot_dict);
1310 #ifndef __EMSCRIPTEN_RENDER__
1311
1316 Annot(const Annot& annot);
1317 #endif
1318
1319 Annot() {}
1320 #ifndef __EMSCRIPTEN_RENDER__
1321
1328 Annot& operator = (const Annot& annot);
1329 #endif
1330
1337 bool operator ==(const Annot& other) const;
1345 bool operator != (const Annot& other) const;
1346 #ifndef __EMSCRIPTEN_RENDER__
1347
1348 virtual ~Annot();
1349 #endif
1350
1357 bool IsEmpty() const;
1358
1364 PDFPage GetPage() const;
1371 bool IsMarkup() const;
1377 Type GetType() const;
1383 int GetIndex() const;
1389 WString GetContent() const;
1403 void SetContent(const WString& content);
1410 DateTime GetModifiedDateTime() const;
1418 void SetModifiedDateTime(const DateTime& date_time);
1425 uint32 GetFlags() const;
1434 void SetFlags(uint32 flags);
1440 WString GetUniqueID() const;
1448 void SetUniqueID(const WString& unique_id);
1455 RectF GetRect() const;
1456
1469 Matrix GetDisplayMatrix(const Matrix& page_display_matrix);
1470
1480 bool Move(const RectF& rect);
1481
1492 bool Move(const RectF& rect, bool is_reset_appearance);
1493
1510 BorderInfo GetBorderInfo() const;
1511
1529 void SetBorderInfo(const BorderInfo& border);
1538 RGB GetBorderColor() const;
1550 void SetBorderColor(RGB color);
1563 bool ResetAppearanceStream();
1564
1582 bool ResetAppearanceStream(bool is_generate_new_appearance_obj);
1583
1599 RectI GetDeviceRect(const Matrix& matrix);
1600
1606 objects::PDFDictionary* GetDict() const;
1607
1617 bool HasProperty(Property property) const;
1618
1636 bool RemoveProperty(Property property);
1637
1644 objects::PDFDictionary* GetOptionalContent() const;
1645
1662 objects::PDFStream* GetAppearanceStream(AppearanceType type, const char* appearance_state = "") const;
1663 };
1664
1666 FSDK_DEFINE_ARRAY(AnnotArray, Annot)
1667
1668
1669 class ShadingColor FS_FINAL : public Object {
1670 public:
1677 ShadingColor(ARGB firstcolor, ARGB secondcolor)
1678 : first_color(firstcolor)
1679 , second_color(secondcolor) {}
1680
1682 ShadingColor()
1683 : first_color(0xFFFFFFFF)
1684 , second_color(0xFFFFFFFF) {}
1685
1691 ShadingColor(const ShadingColor& shading_color)
1692 : first_color(shading_color.first_color)
1693 , second_color(shading_color.second_color) {}
1694
1702 ShadingColor& operator = (const ShadingColor& shading_color) {
1703 this->first_color = shading_color.first_color;
1704 this->second_color = shading_color.second_color;
1705 return *this;
1706 }
1707
1715 bool operator == (const ShadingColor& shading_color) const {
1716 return (first_color == shading_color.first_color && second_color == shading_color.second_color);
1717 }
1718
1726 bool operator != (const ShadingColor& shading_color) const {
1727 return (first_color != shading_color.first_color || second_color != shading_color.second_color);
1728 }
1729
1738 void Set(ARGB firstcolor, ARGB secondcolor) {
1739 this->first_color = firstcolor;
1740 this->second_color = secondcolor;
1741 }
1742
1744 ARGB first_color;
1746 ARGB second_color;
1747 };
1748
1758 class IconProviderCallback {
1759 public:
1765 virtual void Release() = 0;
1774 virtual String GetProviderID() {
1775 return String();
1776 }
1785 virtual String GetProviderVersion() {
1786 return String();
1787 }
1797 virtual bool HasIcon(Annot::Type annot_type, const char* icon_name) {
1798 return false;
1799 }
1810 virtual bool CanChangeColor(Annot::Type annot_type, const char* icon_name) {
1811 return false;
1812 }
1813 #ifndef __EMSCRIPTEN_RENDER__
1814
1825 virtual PDFPage GetIcon(Annot::Type annot_type, const char* icon_name, ARGB color,
1826 foxit::pdf::objects::PDFDictionary* annot_dict);
1827 #endif
1828
1842 virtual bool GetShadingColor(Annot::Type annot_type, const char* icon_name,
1843 RGB referenced_color, int shading_index, ShadingColor& out_shading_color) {
1844 return false;
1845 }
1856 virtual float GetDisplayWidth(Annot::Type annot_type, const char* icon_name) {
1857 return 0.0f;
1858 }
1869 virtual float GetDisplayHeight(Annot::Type annot_type, const char* icon_name) {
1870 return 0.0f;
1871 }
1872
1873 protected:
1874 ~IconProviderCallback() {}
1875 };
1876
1877 class Markup;
1879 FSDK_DEFINE_ARRAY(MarkupArray, Markup)
1880
1881 class Note;
1883 FSDK_DEFINE_ARRAY(NoteArray, Note)
1884
1885
1902 class Markup : public Annot {
1903 public:
1909 typedef enum _StateModel {
1911 e_StateModelMarked = 1,
1913 e_StateModelReview = 2
1914 } StateModel;
1915
1921 typedef enum _State {
1926 e_StateNone = 0,
1931 e_StateMarked = 1,
1936 e_StateUnmarked = 2,
1941 e_StateAccepted = 3,
1946 e_StateRejected = 4,
1951 e_StateCancelled = 5,
1956 e_StateCompleted = 6,
1961 e_StateDeferred = 7,
1966 e_StateFuture = 8
1967 } State;
1968
1974 typedef enum _EndingStyle {
1976 e_EndingStyleNone = 0,
1978 e_EndingStyleSquare = 1,
1980 e_EndingStyleCircle = 2,
1982 e_EndingStyleDiamond = 3,
1984 e_EndingStyleOpenArrow = 4,
1990 e_EndingStyleClosedArrow = 5,
1992 e_EndingStyleButt = 6,
1994 e_EndingStyleROpenArrow = 7,
1996 e_EndingStyleRClosedArrow = 8,
1998 e_EndingStyleSlash = 9
1999 } EndingStyle;
2000
2006 typedef enum _MeasureType {
2008 e_MeasureTypeX = 0,
2010 e_MeasureTypeY = 1,
2012 e_MeasureTypeD = 2,
2014 e_MeasureTypeA = 3,
2016 e_MeasureTypeT = 4,
2018 e_MeasureTypeS = 5
2019 } MeasureType;
2020
2021
2027 explicit Markup(const Annot& annot);
2028 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2029 explicit Markup(FS_HANDLE handle);
2031 Markup() {}
2032
2034 ~Markup() {}
2035
2053 Popup GetPopup();
2070 void SetPopup(const Popup& popup);
2071
2078 bool RemovePopup();
2079
2087 WString GetTitle() const;
2088
2098 void SetTitle(const WString& title);
2099
2105 WString GetSubject() const;
2106
2114 void SetSubject(const WString& subject);
2115
2124 float GetOpacity() const;
2125
2138 void SetOpacity(float opacity);
2139
2161 String GetIntent() const;
2162
2199 void SetIntent(const String& intent);
2200
2207 DateTime GetCreationDateTime() const;
2208
2216 void SetCreationDateTime(const DateTime& date_time);
2217
2223 int GetReplyCount();
2224
2233 Note GetReply(int index) const;
2234
2240 Note AddReply();
2241
2252 bool RemoveReply(int index);
2253
2259 bool RemoveAllReplies();
2260
2277 bool IsGrouped();
2278
2297 Markup GetGroupHeader();
2298
2315 MarkupArray GetGroupElements();
2316
2332 bool Ungroup();
2333
2349 NoteArray GetStateAnnots(StateModel model);
2350
2387 Note AddStateAnnot(const WString& title, StateModel model, State state);
2388
2398 bool RemoveAllStateAnnots();
2406 int32 GetRichTextCount();
2407
2418 WString GetRichTextContent(int32 index);
2419
2431 void SetRichTextContent(int32 index, const WString& content);
2432
2443 RichTextStyle GetRichTextStyle(int32 index);
2444
2458 void SetRichTextStyle(int32 index, const RichTextStyle& style);
2459
2472 void AddRichText(const WString& content, const RichTextStyle& style);
2473
2490 void InsertRichText(int32 index, const WString& content, const RichTextStyle& style);
2491
2502 void RemoveRichText(int index);
2503
2516 void SetBorderOpacity(float opacity);
2517
2524 float GetBorderOpacity() const;
2525
2538 void SetFillOpacity(float opacity);
2539
2546 float GetFillOpacity() const;
2547 };
2548
2571 class Note FS_FINAL : public Markup {
2572 public:
2574 Note() {}
2580 explicit Note(const Annot& annot);
2581 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2582 explicit Note(FS_HANDLE handle);
2584 ~Note() {}
2585
2598 bool GetOpenStatus() const;
2613 void SetOpenStatus(bool status);
2625 String GetIconName() const;
2643 void SetIconName(const char* icon_name);
2653 Markup GetReplyTo();
2660 bool IsStateAnnot();
2661
2673 StateModel GetStateModel();
2674
2686 State GetState();
2687
2711 void SetState(State state);
2712
2713 };
2714
2726 class TextMarkup: public Markup {
2727 public:
2729 TextMarkup() {}
2735 explicit TextMarkup(const Annot& annot);
2737 ~TextMarkup() {}
2738
2753 QuadPointsArray GetQuadPoints() const;
2773 void SetQuadPoints(const QuadPointsArray& quad_points_array);
2774 };
2775
2792 class Highlight FS_FINAL : public TextMarkup {
2793 public:
2795 Highlight() {}
2801 explicit Highlight(const Annot& annot);
2803 ~Highlight() {}
2804 };
2805
2822 class Underline FS_FINAL : public TextMarkup {
2823 public:
2825 Underline() {}
2831 explicit Underline(const Annot& annot);
2833 ~Underline() {}
2834 };
2835
2852 class StrikeOut FS_FINAL : public TextMarkup {
2853 public:
2855 StrikeOut() {}
2861 explicit StrikeOut(const Annot& annot);
2863 ~StrikeOut() {}
2864 };
2865
2882 class Squiggly FS_FINAL : public TextMarkup {
2883 public:
2885 Squiggly() {}
2891 explicit Squiggly(const Annot& annot);
2893 ~Squiggly() {}
2894 };
2895
2909 class Link FS_FINAL : public Annot {
2910 public:
2912 Link() {}
2918 explicit Link(const Annot& annot);
2919 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2920 explicit Link(FS_HANDLE handle);
2922 ~Link() {}
2923
2937 QuadPointsArray GetQuadPoints() const;
2956 void SetQuadPoints(const QuadPointsArray& quad_points_array);
2957
2965 HighlightingMode GetHighlightingMode();
2966
2976 void SetHighlightingMode(HighlightingMode mode);
2977
2984 actions::Action GetAction();
2985
3000 void SetAction(const actions::Action& action);
3001
3007 bool RemoveAction();
3008
3017 bool ExecuteJavaScriptAction(const actions::JavaScriptAction& javascript_action = actions::JavaScriptAction((FS_HANDLE)NULL));
3018 };
3019
3034 class Square FS_FINAL : public Markup {
3035 public:
3037 Square() {}
3043 explicit Square(const Annot& annot);
3045 ~Square() {}
3046
3053 RGB GetFillColor() const;
3054
3062 void SetFillColor(RGB fill_color);
3063
3073 RectF GetInnerRect() const;
3085 void SetInnerRect(const RectF& inner_rect);
3086
3100 void SetMeasureRatio(const char* ratio);
3101
3111 String GetMeasureRatio();
3112
3122 WString GetMeasureRatioW();
3123
3136 void SetMeasureUnit(MeasureType measure_type, const char* unit);
3137
3149 String GetMeasureUnit(MeasureType measure_type);
3150
3162 WString GetMeasureUnitW(MeasureType measure_type);
3163
3176 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3177
3189 float GetMeasureConversionFactor(MeasureType measure_type);
3190 };
3191
3206 class Circle FS_FINAL : public Markup {
3207 public:
3209 Circle() {}
3215 explicit Circle(const Annot& annot);
3217 ~Circle() {}
3218
3225 RGB GetFillColor() const;
3226
3237 void SetFillColor(RGB fill_color);
3238
3248 RectF GetInnerRect() const;
3249
3263 void SetInnerRect(const RectF& inner_rect);
3264
3278 void SetMeasureRatio(const char* ratio);
3279
3289 String GetMeasureRatio();
3290
3300 WString GetMeasureRatioW();
3301
3314 void SetMeasureUnit(MeasureType measure_type, const char* unit);
3315
3327 String GetMeasureUnit(MeasureType measure_type);
3328
3340 WString GetMeasureUnitW(MeasureType measure_type);
3341
3354 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3355
3367 float GetMeasureConversionFactor(MeasureType measure_type);
3368 };
3369
3389 class FreeText FS_FINAL : public Markup {
3390 public:
3392 FreeText() {}
3398 explicit FreeText(const Annot& annot);
3399
3401 ~FreeText() {}
3402
3413 RGB GetFillColor() const;
3414
3428 void SetFillColor(RGB fill_color);
3429
3444 common::Alignment GetAlignment() const;
3445
3464 void SetAlignment(common::Alignment alignment);
3465
3476 RectF GetInnerRect() const;
3477
3492 void SetInnerRect(const RectF& inner_rect);
3493
3502 DefaultAppearance GetDefaultAppearance();
3503
3526 bool SetDefaultAppearance(const DefaultAppearance& default_ap);
3527
3538 EndingStyle GetCalloutLineEndingStyle() const;
3539
3554 void SetCalloutLineEndingStyle(EndingStyle ending_style);
3555
3569 PointFArray GetCalloutLinePoints() const;
3570
3593 void SetCalloutLinePoints(const PointFArray& point_array);
3594
3610 void SetTextMatrix(const Matrix& text_matrix);
3611
3623 Matrix GetTextMatrix() const;
3624
3631 common::Rotation GetRotation();
3632
3647 void SetRotation(common::Rotation rotation);
3648
3661 void Rotate(common::Rotation rotation);
3662
3680 void AllowTextOverflow(bool is_text_overflow);
3681 };
3682
3701 class Line FS_FINAL : public Markup {
3702 public:
3708 typedef enum _CapPos {
3710 e_CapPosInline = 0,
3712 e_CapPosTop = 1
3713 } CapPos;
3714
3715
3717 Line() {}
3723 explicit Line(const Annot& annot);
3725 ~Line() {}
3726
3735 EndingStyle GetLineStartStyle() const;
3748 void SetLineStartStyle(EndingStyle ending_style);
3757 EndingStyle GetLineEndStyle() const;
3770 void SetLineEndStyle(EndingStyle ending_style);
3771
3782 RGB GetStyleFillColor() const;
3783
3797 void SetStyleFillColor(RGB color);
3798
3807 PointF GetStartPoint() const;
3820 void SetStartPoint(const PointF& point);
3821
3830 PointF GetEndPoint() const;
3843 void SetEndPoint(const PointF& point);
3844
3853 bool HasCaption() const;
3866 void EnableCaption(bool cap);
3867
3879 CapPos GetCaptionPositionType() const;
3895 void SetCaptionPositionType(CapPos cap_position);
3908 Offset GetCaptionOffset() const;
3924 void SetCaptionOffset(const Offset& offset);
3925
3940 float GetLeaderLineLength() const;
3958 void SetLeaderLineLength(float length);
3968 float GetLeaderLineExtensionLength() const;
3981 void SetLeaderLineExtensionLength(float extension_length);
3982
3993 float GetLeaderLineOffset() const;
4007 void SetLeaderLineOffset(float offset);
4008
4022 void SetMeasureRatio(const String& ratio);
4023
4033 String GetMeasureRatio();
4034
4044 WString GetMeasureRatioW();
4045
4058 void SetMeasureUnit(MeasureType measure_type, const String& unit);
4059
4071 String GetMeasureUnit(MeasureType measure_type);
4072
4084 WString GetMeasureUnitW(MeasureType measure_type);
4085
4098 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4099
4111 float GetMeasureConversionFactor(MeasureType measure_type);
4112 };
4113
4131 class Ink FS_FINAL : public Markup {
4132 public:
4134 Ink() {}
4140 explicit Ink(const Annot& annot);
4142 ~Ink() {}
4169 common::Path GetInkList();
4170
4203 void SetInkList(const common::Path& ink_list);
4204
4216 void EnableUseBezier(bool use_bezier);
4217
4218 };
4219
4244 class Stamp FS_FINAL : public Markup {
4245 public:
4247 Stamp() {}
4253 explicit Stamp(const Annot& annot);
4254 #ifndef __EMSCRIPTEN_RENDER__
4255
4256 ~Stamp();
4257 #endif
4258
4269 String GetIconName() const;
4292 void SetIconName(const char* icon_name);
4303 void SetBitmap(const common::Bitmap& bitmap);
4304
4327 void SetImage(const common::Image& image, int frame_index, int compress);
4328
4339 void SetRotation(int angle);
4340
4346 int GetRotation();
4347
4357 void Rotate(int angle);
4358 };
4359
4372 class Screen FS_FINAL : public Annot {
4373 public:
4375 Screen() {}
4381 explicit Screen(const Annot& annot);
4383 virtual ~Screen() {}
4384
4407 void SetImage(const common::Image& image, int frame_index, int compress);
4408
4415 common::Bitmap GetBitmap();
4416
4427 pdf::objects::PDFDictionary* GetMKDict() const;
4428
4435 void SetMKDict(pdf::objects::PDFDictionary* dict);
4436
4449 void SetRotation(common::Rotation rotate);
4450
4457 common::Rotation GetRotation();
4458
4467 float GetOpacity() const;
4480 void SetOpacity(float opacity);
4481
4487 WString GetTitle() const;
4495 void SetTitle(const WString& title);
4496
4506 actions::Action GetAction();
4530 void SetAction(const actions::Action& action);
4539 void RemoveAction();
4540 };
4541
4560 class Polygon FS_FINAL : public Markup {
4561 public:
4563 Polygon() {}
4569 explicit Polygon(const Annot& annot);
4571 ~Polygon() {}
4580 RGB GetFillColor() const;
4581
4593 void SetFillColor(RGB fill_color);
4594
4603 PointFArray GetVertexes();
4604
4616 void SetVertexes(const PointFArray& vertexes);
4617
4631 void SetMeasureRatio(const String& ratio);
4632
4642 String GetMeasureRatio();
4643
4653 WString GetMeasureRatioW();
4654
4667 void SetMeasureUnit(MeasureType measure_type, const String& unit);
4668
4680 String GetMeasureUnit(MeasureType measure_type);
4681
4693 WString GetMeasureUnitW(MeasureType measure_type);
4694
4707 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4708
4720 float GetMeasureConversionFactor(MeasureType measure_type);
4721 };
4722
4742 class PolyLine FS_FINAL : public Markup {
4743 public:
4745 PolyLine() {}
4751 explicit PolyLine(const Annot& annot);
4753 ~PolyLine() {}
4764 RGB GetStyleFillColor() const;
4776 void SetStyleFillColor(RGB fill_color);
4777
4786 PointFArray GetVertexes();
4787
4799 void SetVertexes(const PointFArray& vertexes);
4808 EndingStyle GetLineStartStyle() const;
4822 void SetLineStartStyle(EndingStyle starting_style);
4831 EndingStyle GetLineEndStyle() const;
4845 void SetLineEndStyle(EndingStyle ending_style);
4846
4860 void SetMeasureRatio(const String& ratio);
4861
4871 String GetMeasureRatio();
4872
4882 WString GetMeasureRatioW();
4883
4896 void SetMeasureUnit(MeasureType measure_type, const String& unit);
4897
4909 String GetMeasureUnit(MeasureType measure_type);
4910
4922 WString GetMeasureUnitW(MeasureType measure_type);
4923
4936 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4937
4949 float GetMeasureConversionFactor(MeasureType measure_type);
4950 };
4951
4964 class Caret FS_FINAL : public Markup {
4965 public:
4967 Caret() {}
4973 explicit Caret(const Annot& annot);
4975 ~Caret() {}
4976
4986 RectF GetInnerRect() const;
5000 void SetInnerRect(const RectF& inner_rect);
5001 };
5002
5015 class FileAttachment FS_FINAL : public Markup {
5016 public:
5018 FileAttachment() {}
5024 explicit FileAttachment(const Annot& annot);
5026 ~FileAttachment() {}
5027
5035 bool SetFileSpec(const FileSpec& file_spec);
5036
5043 FileSpec GetFileSpec();
5044
5055 String GetIconName() const;
5056
5072 void SetIconName(const char* icon_name);
5073 };
5074
5084 class Popup FS_FINAL : public Annot {
5085 public:
5087 Popup() {}
5093 explicit Popup(const Annot& annot);
5094 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5095 explicit Popup(FS_HANDLE handle);
5097 ~Popup() {}
5098
5111 bool GetOpenStatus() const;
5126 void SetOpenStatus(bool status);
5127
5135 Markup GetParent();
5136 };
5137 #ifndef __FSDK_NO_PSINK__
5138
5157 class PSInk FS_FINAL : public Annot {
5158 public:
5160 PSInk() {}
5166 explicit PSInk(const Annot& annot);
5167 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5168 explicit PSInk(FS_HANDLE handle);
5170 ~PSInk() {}
5171
5172 };
5173 #endif
5174
5187 class Widget FS_FINAL : public Annot {
5188 public:
5194 typedef enum _LineSpacingStyle {
5196 e_LineSpacingSingle = 0,
5198 e_LineSpacingOneAndHalf = 1,
5200 e_LineSpacingDouble = 2,
5202 e_LineSpacingExactValue = 3,
5204 e_LineSpacingAuto = 4
5205 } LineSpacingStyle;
5206
5207
5209 Widget() {}
5215 explicit Widget(const Annot& annot);
5216 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5217 explicit Widget(FS_HANDLE handle);
5218 #ifndef __EMSCRIPTEN_RENDER__
5219
5220 ~Widget();
5221 #endif
5222
5227 interform::Field GetField();
5228
5234 interform::Control GetControl();
5235
5245 HighlightingMode GetHighlightingMode();
5246
5258 void SetHighlightingMode(HighlightingMode mode);
5259
5269 actions::Action GetAction();
5270
5294 void SetAction(const actions::Action& action);
5295
5304 void RemoveAction();
5305
5317 bool HasMKEntry(MKEntry mk_entry);
5318
5330 void RemoveMKEntry(MKEntry mk_entry);
5331
5344 common::Rotation GetMKRotation() const;
5345
5358 void SetMKRotation(common::Rotation rotation);
5359
5370 RGB GetMKBorderColor() const;
5371
5382 void SetMKBorderColor(RGB color);
5383
5394 RGB GetMKBackgroundColor() const;
5395
5406 void SetMKBackgroundColor(RGB color);
5407
5421 WString GetMKNormalCaption() const;
5422
5436 void SetMKNormalCaption(const wchar_t* caption);
5437
5452 WString GetMKRolloverCaption() const;
5453
5468 void SetMKRolloverCaption(const wchar_t* caption);
5469
5483 WString GetMKDownCaption() const;
5484
5498 void SetMKDownCaption(const wchar_t* caption);
5499
5512 common::Bitmap GetMKNormalIconBitmap();
5513
5527 void SetMKNormalIconBitmap(const common::Bitmap& bitmap);
5528
5544 void SetMKNormalIconImage(const common::Image& image, int frame_index);
5545
5559 common::Bitmap GetMKRolloverIconBitmap();
5560
5575 void SetMKRolloverIconBitmap(const common::Bitmap& bitmap);
5576
5593 void SetMKRolloverIconImage(const common::Image& image, int frame_index);
5594
5607 common::Bitmap GetMKDownIconBitmap();
5608
5622 void SetMKDownIconBitmap(const common::Bitmap& bitmap);
5623
5639 void SetMKDownIconImage(const common::Image& image, int frame_index);
5640
5655 IconFit GetMKIconFit() const;
5656
5674 void SetMKIconFit(const IconFit& icon_fit);
5675
5689 MKIconCaptionRelation GetMKIconCaptionRelation() const;
5690
5706 void SetMKIconCaptionRelation(MKIconCaptionRelation relation);
5707
5715 void SetAppearanceState(const String& appearance_state);
5716
5722 String GetAppearanceState() const;
5723
5729 String GetAppearanceOnStateName() const;
5730
5742 LineSpacingStyle GetLineSpacing(float& line_spacing_value);
5743
5759 void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value);
5760
5761 #ifdef _SUPPORTWEBSDK_
5762 //Set push button icon form icon stream. stream is from doc::createIcon.
5763 //face: 0: normal, 1: down, 2: roller
5764 void SetButtonIcon(objects::PDFStream* icon, int face);
5765 #endif
5766 };
5767
5784 class Redact FS_FINAL : public Markup {
5785 public:
5787 Redact() {}
5793 explicit Redact(const Annot& annot);
5794 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5795 explicit Redact(FS_HANDLE handle);
5796 #ifndef __EMSCRIPTEN_RENDER__
5797
5798 ~Redact();
5799 #endif
5800
5813 QuadPointsArray GetQuadPoints() const;
5814
5833 void SetQuadPoints(const QuadPointsArray& quad_points_array);
5834
5841 RGB GetFillColor() const;
5849 void SetFillColor(RGB fill_color);
5850
5857 RGB GetApplyFillColor() const;
5858
5866 void SetApplyFillColor(RGB fill_color);
5867
5873 WString GetOverlayText() const;
5874
5882 void SetOverlayText(const WString& overlay_text);
5883
5889 bool IsOverlayTextRepeated();
5890
5899 void EnableRepeatOverlayText(bool is_to_repeat_overlay_text);
5900
5909 common::Alignment GetOverlayTextAlignment() const;
5910
5923 void SetOverlayTextAlignment(common::Alignment alignment);
5924
5930 void EnableAutoFontSize();
5931
5940 DefaultAppearance GetDefaultAppearance();
5941
5964 bool SetDefaultAppearance(const DefaultAppearance& default_ap);
5965
5978 bool Apply();
5979
5980 };
5981
5991 class Sound FS_FINAL : public Markup{
5992 public:
5998 typedef enum _SampleEncodingFormat {
6000 e_SampleEncodingFormatRaw = 0,
6002 e_SampleEncodingFormatSigned = 1,
6004 e_SampleEncodingFormatMuLaw = 2,
6006 e_SampleEncodingFormatALaw = 3
6007 } SampleEncodingFormat;
6008
6009
6011 Sound() {}
6012
6018 explicit Sound(const Annot& annot);
6019
6020 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
6021 explicit Sound(FS_HANDLE handle);
6022
6023 #ifndef __EMSCRIPTEN_RENDER__
6024
6025 ~Sound();
6026 #endif
6027
6039 objects::PDFStream* GetSoundStream() const;
6040
6046 float GetSamplingRate() const;
6047
6053 int GetChannelCount() const;
6054
6060 int GetBits() const;
6061
6068 SampleEncodingFormat GetSampleEncodingFormat() const;
6069
6075 String GetCompressionFormat() const;
6076
6090 FileSpec GetFileSpec() const;
6091 };
6092
6108 class PagingSeal FS_FINAL : public Annot {
6109 public:
6111 PagingSeal(const Annot& annot);
6112
6114 ~PagingSeal();
6115
6121 PagingSealSignature GetPagingSealSignature();
6122
6123 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
6124 explicit PagingSeal(FS_HANDLE handle);
6125 };
6126
6127 } // namespace annots
6128 } // namespace pdf
6129 } // namespace foxit
6130
6131 #endif // FS_ANNOT_H_
6132
foxit::pdf::annots::BorderInfo::dashes
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:666
foxit::pdf::annots::Annot::e_FlagReadOnly
Annotation flag: read only.
Definition: fs_annot.h:1139
foxit::pdf::annots::Polygon::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::IconProviderCallback
Definition: fs_annot.h:1758
foxit::pdf::annots::Annot::GetUniqueID
WString GetUniqueID() const
Get unique ID.
foxit::pdf::annots::Note::GetStateModel
StateModel GetStateModel()
Get the state model.
foxit::pdf::RichTextStyle::text_alignment
common::Alignment text_alignment
Alignment value. Please refer to values starting from common::e_AlignmentLeft and this should be one ...
Definition: fs_annot.h:400
foxit::pdf::annots::Annot::e_MKEntryRolloverCaption
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:1228
foxit::pdf::annots::Line::~Line
~Line()
Destructor.
Definition: fs_annot.h:3725
foxit::pdf::annots::Square::Square
Square()
Constructor.
Definition: fs_annot.h:3037
foxit::pdf::annots::PolyLine::SetStyleFillColor
void SetStyleFillColor(RGB fill_color)
Set fill color for some line ending styles.
foxit::pdf::annots::Annot::GetDeviceRect
RectI GetDeviceRect(const Matrix &matrix)
Get annotation rectangle in device coordinate system.
foxit::pdf::annots::FreeText::~FreeText
~FreeText()
Destructor.
Definition: fs_annot.h:3401
foxit::pdf::annots::IconFit::IconFit
IconFit()
Constructor.
Definition: fs_annot.h:805
foxit::pdf::annots::Annot::SetBorderColor
void SetBorderColor(RGB color)
Set border color.
foxit::pdf::objects::PDFStream
Definition: fs_pdfobject.h:448
foxit::pdf::annots::PolyLine::GetVertexes
PointFArray GetVertexes()
Get vertexes.
foxit::pdf::annots::Widget::GetMKIconFit
IconFit GetMKIconFit() const
Get the icon fit information in the MK dictionary.
foxit::pdf::RichTextStyle::operator==
bool operator==(const RichTextStyle &style) const
Equal operator.
Definition: fs_annot.h:319
foxit::pdf::annots::Widget::GetMKNormalCaption
WString GetMKNormalCaption() const
Get the normal caption string in the MK dictionary.
foxit::pdf::annots::Widget::~Widget
~Widget()
Destructor.
foxit::pdf::annots::Markup::State
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1921
foxit::pdf::annots::ShadingColor
Definition: fs_annot.h:1669
foxit::pdf::annots::TextMarkup
Definition: fs_annot.h:2726
foxit::pdf::annots::Underline
Definition: fs_annot.h:2822
foxit::pdf::annots::Popup::~Popup
~Popup()
Destructor.
Definition: fs_annot.h:5097
foxit::pdf::annots::Widget::e_LineSpacingAuto
Line spacing style: auto line spacing.
Definition: fs_annot.h:5204
foxit::pdf::annots::Widget::GetAppearanceState
String GetAppearanceState() const
Get the annotation's appearance state, which selects the applicable appearance stream from an appeara...
foxit::pdf::annots::Screen
Definition: fs_annot.h:4372
foxit::pdf::annots::Redact::Redact
Redact()
Constructor.
Definition: fs_annot.h:5787
foxit::pdf::RichTextStyle
Definition: fs_annot.h:210
foxit::pdf::annots::Redact::GetDefaultAppearance
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
foxit::pdf::annots::FreeText::GetCalloutLinePoints
PointFArray GetCalloutLinePoints() const
Get a point of callout line points.
foxit::pdf::annots::QuadPoints::Set
void Set(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Set value.
Definition: fs_annot.h:760
foxit::pdf::annots::IconProviderCallback::GetIcon
virtual PDFPage GetIcon(Annot::Type annot_type, const char *icon_name, ARGB color, foxit::pdf::objects::PDFDictionary *annot_dict)
A callback function used to get the icon as PDF page contents for a specified type.
foxit::pdf::annots::Annot::HasProperty
bool HasProperty(Property property) const
Whether current annotation has the specified annotation's property.
foxit::common::Bitmap
Definition: fs_image.h:36
foxit::pdf::annots::Annot::MKIconCaptionRelation
MKIconCaptionRelation
Enumeration for icon and caption relative position in annotation's MK dictionary.
Definition: fs_annot.h:1268
foxit::pdf::annots::Annot::e_Squiggly
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1040
foxit::pdf::annots::Annot::e_FlagNoView
Annotation flag: no view.
Definition: fs_annot.h:1130
foxit::pdf::annots::Circle::GetInnerRect
RectF GetInnerRect() const
Get the inner rectangle.
foxit::pdf::annots::Line::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::annots::FileAttachment
Definition: fs_annot.h:5015
foxit::pdf::annots::Markup::Markup
Markup()
Constructor.
Definition: fs_annot.h:2031
foxit::pdf::annots::Annot::GetPage
PDFPage GetPage() const
Get the related PDF page.
foxit::pdf::annots::Annot::GetContent
WString GetContent() const
Get content.
foxit::pdf::annots::Sound::e_SampleEncodingFormatSigned
Twos-complement values.
Definition: fs_annot.h:6002
foxit::pdf::annots::Annot::e_FileAttachment
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1052
foxit::pdf::annots::Annot::Annot
Annot()
Constructor.
Definition: fs_annot.h:1319
foxit::pdf::annots::Redact::~Redact
~Redact()
Destructor.
foxit::pdf::annots::TextMarkup::GetQuadPoints
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
foxit::pdf::annots::Sound::e_SampleEncodingFormatRaw
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:6000
foxit::pdf::annots::Widget::SetAppearanceState
void SetAppearanceState(const String &appearance_state)
Set the annotation's appearance state, which selects the applicable appearance stream from an appeara...
foxit::pdf::annots::Redact::SetQuadPoints
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
foxit::pdf::annots::Note::IsStateAnnot
bool IsStateAnnot()
Check if current note annotation is used as a state annotation.
foxit::pdf::annots::Annot::e_MKEntryDownIcon
Down icon (or alternate icon) entry. "IX" in MK dictionary.
Definition: fs_annot.h:1248
foxit::pdf::annots::Note::GetReplyTo
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
foxit::pdf::annots::BorderInfo::width
float width
Border width, in points.
Definition: fs_annot.h:632
foxit::pdf::annots::Annot::e_FreeText
Annotation type: free text annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1024
foxit::pdf::annots::Note::GetState
State GetState()
Get the state.
foxit::pdf::annots::StrikeOut::StrikeOut
StrikeOut()
Constructor.
Definition: fs_annot.h:2855
foxit::Object
CFX_Object Object
Object type.
Definition: fs_basictypes.h:220
foxit::pdf::annots::Annot::e_Popup
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1073
foxit::pdf::annots::FreeText::GetRotation
common::Rotation GetRotation()
Get current rotation value (in clockwise).
foxit::pdf::annots::PolyLine::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
foxit::pdf::annots::PolyLine::PolyLine
PolyLine()
Constructor.
Definition: fs_annot.h:4745
foxit::pdf::annots::ShadingColor::first_color
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1744
foxit::pdf::annots::Widget::GetAction
actions::Action GetAction()
Get action.
foxit::pdf::annots::PolyLine::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
foxit::pdf::annots::Annot::SetFlags
void SetFlags(uint32 flags)
Set annotation flags.
foxit::pdf::annots::Widget::GetAppearanceOnStateName
String GetAppearanceOnStateName() const
Get the name of the annotation's appearance "ON" state.
foxit::pdf::annots::AnnotArray
Definition: fs_annot.h:1666
foxit::pdf::annots::Redact::SetOverlayText
void SetOverlayText(const WString &overlay_text)
Set the overlay text.
foxit::pdf::annots::Screen::Screen
Screen()
Constructor.
Definition: fs_annot.h:4375
foxit::pdf::annots::Sound::Sound
Sound()
Constructor.
Definition: fs_annot.h:6011
foxit::pdf::annots::IconFit::IconFit
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:836
foxit::pdf::annots::Line::HasCaption
bool HasCaption() const
Check whether the content of current line annotation should be replicated as a caption in the appeara...
foxit::pdf::annots::Link::ExecuteJavaScriptAction
bool ExecuteJavaScriptAction(const actions::JavaScriptAction &javascript_action=actions::JavaScriptAction((FS_HANDLE) 0))
Execute the JavaScript action associated with the link annotation.
foxit::pdf::annots::Annot::e_MKEntryIconCaptionRelation
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:1260
foxit::pdf::annots::Line::GetLeaderLineOffset
float GetLeaderLineOffset() const
Get the length of leader line offset.
foxit::pdf::annots::Widget::SetMKRolloverIconBitmap
void SetMKRolloverIconBitmap(const common::Bitmap &bitmap)
Set the rollover icon bitmap in the MK dictionary.
foxit::pdf::annots::Square::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::Square::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const char *unit)
Set the label for displaying the units for measuring.
foxit::pdf::RichTextStyle::e_CornerMarkSuperscript
Corner mark style: superscript.
Definition: fs_annot.h:221
foxit::pdf::annots::IconFit
Definition: fs_annot.h:784
foxit::pdf::annots::Popup::GetParent
Markup GetParent()
Get related parent markup annotation.
foxit::pdf::annots::Widget::SetMKNormalIconImage
void SetMKNormalIconImage(const common::Image &image, int frame_index)
Set an image with specified frame index as normal icon in the MK dictionary.
foxit::pdf::annots::Widget::GetHighlightingMode
HighlightingMode GetHighlightingMode()
Get highlighting mode.
foxit::pdf::annots::Annot::e_FlagPrint
Annotation flag: print.
Definition: fs_annot.h:1108
foxit::DateTime
Definition: fs_basictypes.h:484
foxit::pdf::annots::Annot::GetBorderInfo
BorderInfo GetBorderInfo() const
Get border information.
foxit::pdf::annots::Redact::GetApplyFillColor
RGB GetApplyFillColor() const
Get the filling color which is used for rollover appearance and will be used after redaction is appli...
foxit::pdf::RichTextStyle::word_space
float word_space
The word space. It should not be negative value for table generator. It is only used in pdf::PDFPage:...
Definition: fs_annot.h:441
foxit::pdf::RichTextStyle::font
common::Font font
A font used in rich text style. It should be a valid font object.
Definition: fs_annot.h:389
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo(const BorderInfo &border_info)
Constructor, with another border information object.
Definition: fs_annot.h:536
foxit::pdf::RichTextStyle::RichTextStyle
RichTextStyle()
Constructor.
Definition: fs_annot.h:260
foxit::pdf::annots::BorderInfo
Definition: fs_annot.h:449
foxit::pdf::annots::BorderInfo::Style
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:456
foxit::pdf::annots::Widget::HasMKEntry
bool HasMKEntry(MKEntry mk_entry)
Check if a specified entry exists in the MK dictionary.
foxit::pdf::annots::Highlight::~Highlight
~Highlight()
Destructor.
Definition: fs_annot.h:2803
foxit::pdf::annots::IconProviderCallback::GetShadingColor
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:1842
foxit::pdf::annots::IconProviderCallback::GetProviderVersion
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1785
foxit::pdf::annots::Square
Definition: fs_annot.h:3034
foxit::pdf::annots::Annot::e_MKRelationNoCaption
No caption; icon only.
Definition: fs_annot.h:1272
foxit::pdf::annots::Circle::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::RGB
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:211
foxit::pdf::annots::FreeText::SetTextMatrix
void SetTextMatrix(const Matrix &text_matrix)
Set matrix in default appearance data for text in current free text annotation.
CFX_PSVTemplate
Definition: fx_coordinates.h:30
foxit::pdf::annots::Redact::IsOverlayTextRepeated
bool IsOverlayTextRepeated()
Check whether the overlay text is repeated or not.
foxit::pdf::annots::Redact::EnableRepeatOverlayText
void EnableRepeatOverlayText(bool is_to_repeat_overlay_text)
Set the flag to decide whether to repeat the overlay text.
foxit::pdf::annots::Stamp::GetRotation
int GetRotation()
Get current rotation angle (in clockwise).
foxit::pdf::annots::PolyLine::SetLineStartStyle
void SetLineStartStyle(EndingStyle starting_style)
Set line ending style of the start point.
foxit::pdf::annots::Widget::SetMKRolloverIconImage
void SetMKRolloverIconImage(const common::Image &image, int frame_index)
Set an image with specified frame index as rollover icon in the MK dictionary.
foxit::pdf::annots::Markup::MeasureType
MeasureType
Enumeration for annotation's measure type.
Definition: fs_annot.h:2006
foxit::pdf::annots::Annot::e_UnknownType
Annotation type: unknown.
Definition: fs_annot.h:1015
foxit::pdf::annots::Annot::e_MKRelationCaptionAboveIcon
Caption above the icon.
Definition: fs_annot.h:1276
foxit::pdf::annots::FreeText::GetDefaultAppearance
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
foxit::pdf::annots::PagingSeal::PagingSeal
PagingSeal(const Annot &annot)
Constructor.
foxit::pdf::annots::Annot::Type
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:1013
foxit::pdf::annots::Annot::e_Redact
Annotation type: redact annotation.
Definition: fs_annot.h:1075
foxit::pdf::annots::Note::SetIconName
void SetIconName(const char *icon_name)
Set icon name.
foxit::pdf::annots::Markup
Definition: fs_annot.h:1902
CFX_ArrayTemplate::GetSize
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1360
foxit::pdf::annots::Stamp::SetIconName
void SetIconName(const char *icon_name)
Set icon name.
foxit::pdf::annots::Annot::e_AppearanceTypeNormal
Annotation's normal appearance.
Definition: fs_annot.h:1292
foxit::pdf::annots::Link::SetHighlightingMode
void SetHighlightingMode(HighlightingMode mode)
Set highlighting mode.
foxit::pdf::annots::QuadPointsArray
Definition: fs_annot.h:778
foxit::pdf::annots::Annot::Flags
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1087
fs_file.h
Header file for file operation related definitions and functions.
foxit::pdf::annots::Annot::GetAppearanceStream
objects::PDFStream * GetAppearanceStream(AppearanceType type, const char *appearance_state="") const
Get annotation's appearance stream with specified type and state.
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance(const DefaultAppearance &default_appearance)
Constructor, with another default appearance object.
Definition: fs_annot.h:104
foxit::pdf::annots::FreeText::SetCalloutLineEndingStyle
void SetCalloutLineEndingStyle(EndingStyle ending_style)
Set line ending style of the start point in a callout line.
foxit::pdf::annots::Line::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
foxit::pdf::annots::Line::EnableCaption
void EnableCaption(bool cap)
Set the flag which is used to decide whether the content of current line annotation should be replica...
foxit::pdf::annots::Sound::GetSoundStream
objects::PDFStream * GetSoundStream() const
Get the stream of sound data.
foxit::pdf::DefaultAppearance
Definition: fs_annot.h:56
foxit::pdf::annots::Annot::e_Square
Annotation type: square annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1028
foxit::pdf::annots::BorderInfo::cloud_intensity
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:651
foxit::pdf::annots::Caret::~Caret
~Caret()
Destructor.
Definition: fs_annot.h:4975
foxit::pdf::annots::Polygon::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::annots::Square::SetMeasureRatio
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
foxit::pdf::annots::Line::GetStyleFillColor
RGB GetStyleFillColor() const
Get fill color for ending styles.
foxit::pdf::annots::PolyLine::GetLineEndStyle
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
foxit::pdf::annots::Ink::SetInkList
void SetInkList(const common::Path &ink_list)
Set ink list data.
foxit::pdf::annots::FreeText::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::Widget::SetHighlightingMode
void SetHighlightingMode(HighlightingMode mode)
Set highlighting mode.
foxit::pdf::annots::FreeText::GetInnerRect
RectF GetInnerRect() const
Get the inner rectangle.
foxit::pdf::annots::Underline::Underline
Underline()
Constructor.
Definition: fs_annot.h:2825
foxit::pdf::annots::Widget::SetMKIconCaptionRelation
void SetMKIconCaptionRelation(MKIconCaptionRelation relation)
Set the relation of icon and caption in the MK dictionary.
foxit::pdf::annots::Annot::e_PropertyCreationDate
Annotation property: creation date.
Definition: fs_annot.h:1192
foxit::pdf::annots::BorderInfo::Set
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_annot.h:619
foxit::pdf::annots::Polygon::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
foxit::pdf::annots::Screen::SetMKDict
void SetMKDict(pdf::objects::PDFDictionary *dict)
Set the appearance characteristics dictionary (known as "MK" dictionary as well).
foxit::pdf::annots::Widget
Definition: fs_annot.h:5187
foxit::pdf::annots::Redact::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::annots::Polygon
Definition: fs_annot.h:4560
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1461
foxit::pdf::RichTextStyle::e_CornerMarkSubscript
Corner mark style: subscript.
Definition: fs_annot.h:223
foxit::pdf::annots::Popup::SetOpenStatus
void SetOpenStatus(bool status)
Set open status.
foxit::pdf::annots::Note
Definition: fs_annot.h:2571
foxit::pdf::annots::FreeText::SetAlignment
void SetAlignment(common::Alignment alignment)
Set alignment value.
foxit::pdf::annots::Annot::e_Movie
Annotation type: movie annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1056
foxit::pdf::annots::Annot::e_PropertyModifiedDate
Annotation property: modified date.
Definition: fs_annot.h:1187
foxit::pdf::annots::Screen::GetAction
actions::Action GetAction()
Get action.
foxit::pdf::annots::Annot::GetModifiedDateTime
DateTime GetModifiedDateTime() const
Get last modified date time.
foxit::pdf::annots::Link::~Link
~Link()
Destructor.
Definition: fs_annot.h:2922
foxit::pdf::annots::Annot::e_MKEntryNormalIcon
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1238
foxit::pdf::annots::Line::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
foxit::pdf::annots::Annot::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::pdf::annots::Screen::~Screen
virtual ~Screen()
Destructor.
Definition: fs_annot.h:4383
foxit::pdf::annots::FileAttachment::SetIconName
void SetIconName(const char *icon_name)
Set icon name.
foxit::pdf::annots::Link
Definition: fs_annot.h:2909
foxit::pdf::annots::Annot::e_MKRelationCaptionBelowIcon
Caption below the icon.
Definition: fs_annot.h:1274
foxit::pdf::RichTextStyle::is_italic
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:415
foxit::pdf::annots::PolyLine::GetStyleFillColor
RGB GetStyleFillColor() const
Get fill color for some line ending styles.
foxit::pdf::annots::Caret::GetInnerRect
RectF GetInnerRect() const
Get the inner rectangle.
foxit::pdf::annots::Redact::EnableAutoFontSize
void EnableAutoFontSize()
Enable auto font size for the overlay text.
foxit::pdf::annots::Circle::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
foxit::pdf::annots::Redact::Apply
bool Apply()
Apply current redact annotation: remove the text, graphics and annotations under annotation rectangle...
foxit::pdf::annots::BorderInfo::operator==
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:567
foxit::pdf::annots::FileAttachment::GetFileSpec
FileSpec GetFileSpec()
Get the file specification.
foxit::pdf::annots::Annot::e_FlagNoRotate
Annotation flag: no rotate.
Definition: fs_annot.h:1122
foxit::pdf::annots::Line::SetLineEndStyle
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
foxit::pdf::annots::Sound::GetSampleEncodingFormat
SampleEncodingFormat GetSampleEncodingFormat() const
Get the encoding format for the sample data.
foxit::pdf::annots::Sound::GetSamplingRate
float GetSamplingRate() const
Get the sampling rate, in samples per second.
foxit::pdf::annots::Circle::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::annots::PolyLine::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::FreeText::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::annots::Annot::e_Screen
Annotation type: screen annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1063
foxit::pdf::annots::QuadPoints::operator==
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:733
foxit::pdf::annots::Line::SetEndPoint
void SetEndPoint(const PointF &point)
Set the end point.
foxit::pdf::annots::Widget::GetMKBackgroundColor
RGB GetMKBackgroundColor() const
Get the background color in the MK dictionary.
foxit::pdf::annots::Annot::GetOptionalContent
objects::PDFDictionary * GetOptionalContent() const
Get the PDF dictionary of annotation's optional content.
foxit::pdf::annots::Annot::IsMarkup
bool IsMarkup() const
Check if current annotation is a markup annotation.
foxit::pdf::RichTextStyle::RichTextStyle
RichTextStyle(const RichTextStyle &style)
Constructor, with another style object.
Definition: fs_annot.h:277
foxit::pdf::annots::StrikeOut::~StrikeOut
~StrikeOut()
Destructor.
Definition: fs_annot.h:2863
foxit::pdf::annots::IconFit::scale_way_type
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:943
foxit::pdf::annots::PolyLine::~PolyLine
~PolyLine()
Destructor.
Definition: fs_annot.h:4753
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance()
Constructor.
Definition: fs_annot.h:94
foxit::pdf::annots::Annot::e_PropertyFillColor
Annotation property: fill color.
Definition: fs_annot.h:1204
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:87
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1691
foxit::pdf::annots::Annot::e_PropertyBorderColor
Annotation property: border color.
Definition: fs_annot.h:1198
foxit::pdf::annots::Widget::Widget
Widget()
Constructor.
Definition: fs_annot.h:5209
foxit::pdf::annots::IconFit::vertical_fraction
float vertical_fraction
The vertical fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:964
foxit::pdf::annots::Screen::SetAction
void SetAction(const actions::Action &action)
Set action.
foxit::pdf::annots::PolyLine::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio string for measuring.
foxit::pdf::interform::Control
Definition: fs_pdfform.h:1235
foxit::pdf::annots::Highlight::Highlight
Highlight()
Constructor.
Definition: fs_annot.h:2795
foxit::pdf::annots::IconFit::horizontal_fraction
float horizontal_fraction
The horizontal fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:958
foxit::pdf::DefaultAppearance::e_FlagTextColor
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:67
foxit::pdf::annots::Annot::e_FlagToggleNoView
Annotation flag: toggle no view.
Definition: fs_annot.h:1152
foxit::pdf::annots::Circle::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::Underline::~Underline
~Underline()
Destructor.
Definition: fs_annot.h:2833
foxit::pdf::annots::Stamp
Definition: fs_annot.h:4244
foxit::pdf::annots::Line::e_CapPosInline
Definition: fs_annot.h:3710
foxit::pdf::RichTextStyle::text_color
RGB text_color
Text color. Format: 0xRRGGBB.
Definition: fs_annot.h:405
fs_image.h
Header file for image and bitmap related definitions and classes.
foxit::pdf::annots::Stamp::SetBitmap
void SetBitmap(const common::Bitmap &bitmap)
Set bitmap to current stamp annotation.
foxit::pdf::annots::Line::SetLeaderLineLength
void SetLeaderLineLength(float length)
Set the length of leader line.
foxit::pdf::annots::Redact
Definition: fs_annot.h:5784
foxit::pdf::annots::FreeText::FreeText
FreeText()
Constructor.
Definition: fs_annot.h:3392
foxit::pdf::annots::BorderInfo::operator=
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:551
foxit::pdf::annots::IconFit::Set
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:929
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1677
foxit::pdf::annots::BorderInfo::e_Solid
Border style: Solid.
Definition: fs_annot.h:458
foxit::pdf::annots::Note::~Note
~Note()
Destructor.
Definition: fs_annot.h:2584
foxit::pdf::annots::Annot::e_RichMedia
Annotation type: rich media annotation.
Definition: fs_annot.h:1077
foxit::pdf::annots::Annot::GetType
Type GetType() const
Get actual annotation type of current annotation.
foxit::pdf::annots::Line::GetCaptionOffset
Offset GetCaptionOffset() const
Get caption offset values.
foxit::pdf::annots::Polygon::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
foxit::pdf::annots::Annot::e_FlagNoZoom
Annotation flag: no zoom.
Definition: fs_annot.h:1115
foxit::pdf::annots::Annot::e_AppearanceTypeRollover
Annotation's rollover appearance.
Definition: fs_annot.h:1294
foxit::pdf::annots::Link::SetAction
void SetAction(const actions::Action &action)
Set action.
foxit::pdf::annots::PagingSeal::GetPagingSealSignature
PagingSealSignature GetPagingSealSignature()
Get the associated paging seal signature.
foxit::pdf::annots::IconFit::IconFit
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:849
foxit::pdf::annots::Line::GetLeaderLineExtensionLength
float GetLeaderLineExtensionLength() const
Get the length of leader line extension.
foxit::pdf::annots::Annot::MKEntry
MKEntry
Enumeration for annotation's MK dictionary (an appearance characteristics) entry.
Definition: fs_annot.h:1212
operator==
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
foxit::pdf::RichTextStyle::char_space
float char_space
The char space. It should not be negative value for table generator. It is only used in pdf::PDFPage:...
Definition: fs_annot.h:436
foxit::pdf::annots::Widget::GetMKRotation
common::Rotation GetMKRotation() const
Get the rotation value in the MK dictionary.
foxit::pdf::annots::Line::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::annots::Circle::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
foxit::pdf::annots::Screen::GetOpacity
float GetOpacity() const
Get opacity value.
foxit::pdf::annots::Widget::SetLineSpacing
void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value)
Set line spacing for current widget.
foxit::pdf::annots::PolyLine::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::annots::Ink::GetInkList
common::Path GetInkList()
Get ink list data.
foxit::pdf::annots::Annot::e_AppearanceTypeDown
Annotation's down appearance.
Definition: fs_annot.h:1296
foxit::pdf::annots::Link::GetAction
actions::Action GetAction()
Get action.
foxit::pdf::DefaultAppearance::flags
uint32 flags
Flags to indicate which properties of default appearance are meaningful.
Definition: fs_annot.h:182
foxit::pdf::annots::ShadingColor::second_color
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1746
foxit::pdf::annots::Sound::e_SampleEncodingFormatMuLaw
μ-law-encoded samples
Definition: fs_annot.h:6004
foxit::pdf::annots::Line::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
foxit::pdf::annots::Circle
Definition: fs_annot.h:3206
foxit::pdf::annots::Annot::e_HighlightingInvert
Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
Definition: fs_annot.h:1171
foxit::pdf::annots::Line::Line
Line()
Constructor.
Definition: fs_annot.h:3717
foxit::pdf::annots::Line::GetEndPoint
PointF GetEndPoint() const
Get the end point.
foxit::pdf::annots::Annot::e_Polygon
Annotation type: polygon annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1032
foxit::pdf::annots::Widget::SetMKIconFit
void SetMKIconFit(const IconFit &icon_fit)
Set the icon fit information in the MK dictionary.
foxit::pdf::annots::Annot::GetFlags
uint32 GetFlags() const
Get annotation flags.
foxit::pdf::annots::Widget::GetMKDownIconBitmap
common::Bitmap GetMKDownIconBitmap()
Get the down icon bitmap in the MK dictionary.
foxit::pdf::annots::BorderInfo::e_Beveled
Border style: Beveled.
Definition: fs_annot.h:478
foxit::pdf::annots::Sound::GetChannelCount
int GetChannelCount() const
Get the count of sound channels.
foxit::pdf::annots::Circle::Circle
Circle()
Constructor.
Definition: fs_annot.h:3209
foxit::ARGB
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:209
foxit::pdf::annots::Widget::SetMKBorderColor
void SetMKBorderColor(RGB color)
Set the border color in the MK dictionary.
foxit::pdf::PagingSealSignature
Definition: fs_signature.h:2091
foxit::pdf::annots::Annot::e_HighlightingOutline
Highlighting mode: Outline, which is to invert the annotation's border.
Definition: fs_annot.h:1173
foxit::pdf::annots::Sound::~Sound
~Sound()
Destructor.
foxit::pdf::DefaultAppearance::font
common::Font font
A font for default appearance. It should be a valid font object when it is useful.
Definition: fs_annot.h:189
foxit::pdf::annots::ShadingColor::Set
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1738
foxit::pdf::annots::Widget::GetMKIconCaptionRelation
MKIconCaptionRelation GetMKIconCaptionRelation() const
Get the relation of icon and caption in the MK dictionary.
foxit::pdf::annots::Screen::GetRotation
common::Rotation GetRotation()
Get the rotation of the image used for the appearance of current screen annotation.
foxit::pdf::annots::QuadPoints::operator !=
bool operator !=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:745
foxit::pdf::annots::Polygon::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
foxit::pdf::annots::Annot::Move
bool Move(const RectF &rect)
Move current annotation to a new position, specified by a new rectangle in PDF coordinate system.
foxit::pdf::annots::Annot::SetContent
void SetContent(const WString &content)
Set content.
foxit::pdf::annots::FreeText::AllowTextOverflow
void AllowTextOverflow(bool is_text_overflow)
Decide whether to allow the text of freetext to overflow or not.
foxit::pdf::annots::Line::GetLineStartStyle
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
foxit::pdf::annots::IconFit::is_proportional_scaling
bool is_proportional_scaling
A boolean value which indicates whether use proportional scaling or not.
Definition: fs_annot.h:952
foxit::pdf::annots::Annot::GetDisplayMatrix
Matrix GetDisplayMatrix(const Matrix &page_display_matrix)
Get the display matrix, from PDF coordinate system to targeted device coordinate system.
foxit::pdf::annots::Note::GetOpenStatus
bool GetOpenStatus() const
Get open status.
foxit::pdf::annots::StrikeOut
Definition: fs_annot.h:2852
foxit::pdf::annots::Widget::GetMKNormalIconBitmap
common::Bitmap GetMKNormalIconBitmap()
Get the normal icon bitmap in the MK dictionary.
foxit::pdf::annots::QuadPoints::fourth
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:774
foxit::pdf::annots::Popup::Popup
Popup()
Constructor.
Definition: fs_annot.h:5087
foxit::pdf::annots::Caret
Definition: fs_annot.h:4964
foxit::pdf::annots::PSInk
Definition: fs_annot.h:5157
foxit::pdf::annots::Annot::operator=
Annot & operator=(const Annot &annot)
Assign operator.
foxit::pdf::annots::Annot::e_Widget
Annotation type: widget annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1061
foxit::pdf::annots::Annot::e_Note
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:1020
foxit::pdf::annots::IconProviderCallback::Release
virtual void Release()=0
A callback function used to release current callback object itself.
foxit::pdf::annots::Square::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::annots::Markup::StateModel
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1909
foxit::pdf::annots::TextMarkup::SetQuadPoints
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
foxit::pdf::annots::Circle::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const char *unit)
Set the label for displaying the units for measuring.
foxit::pdf::annots::Squiggly::~Squiggly
~Squiggly()
Destructor.
Definition: fs_annot.h:2893
foxit::pdf::annots::Widget::SetAction
void SetAction(const actions::Action &action)
Set action.
foxit::pdf::annots::Polygon::~Polygon
~Polygon()
Destructor.
Definition: fs_annot.h:4571
foxit::pdf::annots::Annot::e_Ink
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1048
foxit::pdf::annots::Annot::e_Link
Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1022
foxit::pdf::annots::Annot::e_MKEntryBorderColor
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1216
foxit::pdf::annots::IconFit::fit_bounds
bool fit_bounds
A boolean value that indicates whether to scale button appearance to fit fully within bounds or not.
Definition: fs_annot.h:971
foxit::pdf::annots::Link::GetHighlightingMode
HighlightingMode GetHighlightingMode()
Get highlighting mode.
foxit::pdf::annots::Screen::GetMKDict
pdf::objects::PDFDictionary * GetMKDict() const
Get the appearance characteristics dictionary (known as "MK" dictionary as well).
foxit::pdf::annots::QuadPoints::second
PointF second
Second point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:770
foxit::pdf::DefaultAppearance::DefAPFlags
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:63
foxit::pdf::annots::Square::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::common::Path
Definition: fs_common.h:2173
foxit::pdf::annots::Line::SetCaptionPositionType
void SetCaptionPositionType(CapPos cap_position)
Set the position type of caption.
foxit::pdf::annots::Screen::SetTitle
void SetTitle(const WString &title)
Set title of current screen annotation.
foxit::pdf::annots::Markup::EndingStyle
EndingStyle
Enumeration for line ending style.
Definition: fs_annot.h:1974
foxit::pdf::annots::Ink
Definition: fs_annot.h:4131
foxit::pdf::annots::Widget::GetMKBorderColor
RGB GetMKBorderColor() const
Get the border color in the MK dictionary.
foxit::pdf::annots::Caret::Caret
Caret()
Constructor.
Definition: fs_annot.h:4967
foxit::pdf::annots::IconFit::ScaleWayType
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:790
foxit::pdf::annots::Ink::EnableUseBezier
void EnableUseBezier(bool use_bezier)
Enable to use bezier spline to generate ink path for ink annotation's appearance.
foxit::pdf::annots::Circle::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::annots::BorderInfo::operator !=
bool operator !=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:587
foxit::pdf::annots::Annot::e_FlagLocked
Annotation flag: locked.
Definition: fs_annot.h:1146
foxit::pdf::annots::Screen::SetRotation
void SetRotation(common::Rotation rotate)
Set the rotation of the image used for the appearance of current screen annotation.
foxit::pdf::annots::Annot::e_PagingSeal
Annotation type: paging seal annotation. A Foxit PDF SDK custom annotation type (not a standard annot...
Definition: fs_annot.h:1079
foxit::pdf::annots::PolyLine::SetVertexes
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
foxit::pdf::annots::Ink::~Ink
~Ink()
Destructor.
Definition: fs_annot.h:4142
foxit::pdf::annots::Circle::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
foxit::pdf::annots::Widget::SetMKNormalCaption
void SetMKNormalCaption(const wchar_t *caption)
Set the normal caption string in the MK dictionary.
foxit::pdf::annots::Annot::e_PSInk
Annotation type: pressure sensitive ink annotation.
Definition: fs_annot.h:1050
foxit::pdf::annots::QuadPoints::operator=
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:718
CFX_ArrayTemplate< float >
foxit::pdf::annots::Redact::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::PolyLine::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
foxit::pdf::interform::Field
Definition: fs_pdfform.h:145
foxit::pdf::annots::Widget::SetMKNormalIconBitmap
void SetMKNormalIconBitmap(const common::Bitmap &bitmap)
Set a bitmap as normal icon in the MK dictionary.
foxit::pdf::annots::PolyLine::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Line::e_CapPosTop
Definition: fs_annot.h:3712
foxit::pdf::RichTextStyle::operator !=
bool operator !=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:340
foxit::pdf::annots::Annot::e_MKEntryRolloverIcon
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1243
foxit::pdf::annots::Link::SetQuadPoints
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
foxit::pdf::annots::Widget::RemoveAction
void RemoveAction()
Remove action.
foxit::uint32
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
foxit::pdf::annots::Stamp::SetImage
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current stamp annotation, with a specified frame index.
foxit::pdf::annots::FreeText::Rotate
void Rotate(common::Rotation rotation)
Rotate current annotation from current state with specified rotation value (in clockwise).
foxit::pdf::annots::Widget::GetField
interform::Field GetField()
Get associated form field.
foxit::pdf::PDFPage
Definition: fs_pdfpage.h:412
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
foxit::pdf::annots::Stamp::Rotate
void Rotate(int angle)
Rotate current annotation from current state with specified angle degree in clockwise.
foxit::pdf::annots::Widget::GetLineSpacing
LineSpacingStyle GetLineSpacing(float &line_spacing_value)
Get line spacing of current widget.
foxit::String
CFX_ByteString String
Byte string.
Definition: fs_basictypes.h:224
foxit::pdf::annots::Redact::SetDefaultAppearance
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
foxit::pdf::annots::BorderInfo::e_UnderLine
Border style: Underline.
Definition: fs_annot.h:471
foxit::pdf::annots::Annot::Property
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:1185
foxit::pdf::annots::Annot::e_FlagInvisible
Annotation flag: invisible.
Definition: fs_annot.h:1094
fs_common.h
Header file for common definitions and classes.
foxit::pdf::annots::Square::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
foxit::pdf::annots::Annot::~Annot
virtual ~Annot()
Destructor.
foxit::pdf::annots::Screen::GetBitmap
common::Bitmap GetBitmap()
Get the bitmap from current screen annotation.
foxit::pdf::annots::Popup::GetOpenStatus
bool GetOpenStatus() const
Get open status.
foxit::pdf::annots::Annot::e_TrapNet
Annotation type: trap network annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1067
foxit::pdf::RichTextStyle::text_size
float text_size
Text size. It should not be negative value. 0 means text will not be shown.
Definition: fs_annot.h:394
foxit::pdf::annots::Sound::GetCompressionFormat
String GetCompressionFormat() const
Get the name of the sound compression format used on the sample data.
foxit::pdf::annots::FreeText::GetAlignment
common::Alignment GetAlignment() const
Get alignment value.
foxit::pdf::annots::PagingSeal::~PagingSeal
~PagingSeal()
Destructor.
foxit::pdf::annots::Widget::e_LineSpacingSingle
Line spacing style: single line spacing.
Definition: fs_annot.h:5196
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Constructor, with parameters.
Definition: fs_annot.h:689
foxit::pdf::annots::FreeText::GetTextMatrix
Matrix GetTextMatrix() const
Get matrix in default appearance data for text in current free text annotation.
foxit::pdf::annots::MarkupArray
Definition: fs_annot.h:1879
foxit::pdf::annots::Line::GetLineEndStyle
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
foxit::pdf::annots::Line::GetStartPoint
PointF GetStartPoint() const
Get the start point.
foxit::pdf::annots::Square::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
foxit::pdf::annots::Widget::e_LineSpacingDouble
Line spacing style: double line spacing.
Definition: fs_annot.h:5200
foxit::pdf::annots::Widget::GetControl
interform::Control GetControl()
Get associated form control.
foxit::pdf::annots::Redact::GetQuadPoints
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
foxit::pdf::annots::Widget::SetMKRolloverCaption
void SetMKRolloverCaption(const wchar_t *caption)
Set the rollover caption string in the MK dictionary.
foxit::pdf::annots::Screen::SetImage
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current screen annotation, with a specified frame index.
FX_RECT
Definition: fx_coordinates.h:596
foxit::pdf::annots::Widget::GetMKRolloverIconBitmap
common::Bitmap GetMKRolloverIconBitmap()
Get the rollover icon bitmap in the MK dictionary.
foxit::pdf::annots::PolyLine::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::annots::Annot::e_PolyLine
Annotation type: polyline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1034
foxit::pdf::annots::Ink::Ink
Ink()
Constructor.
Definition: fs_annot.h:4134
foxit::pdf::RichTextStyle::Set
void Set(const common::Font &font, float text_size, common::Alignment text_alignment, RGB text_color, bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style, float char_space, float word_space)
Set value.
Definition: fs_annot.h:364
foxit::pdf::RichTextStyle::RichTextStyle
RichTextStyle(const common::Font &font, float text_size, common::Alignment text_alignment, RGB text_color, bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style, float char_space, float word_space)
Constructor, with parameters.
Definition: fs_annot.h:245
foxit::pdf::annots::Annot::e_MKRelationCaptionOvrlayOnIcon
Caption overlaid directly on the icon.
Definition: fs_annot.h:1282
foxit::pdf::annots::Annot::GetIndex
int GetIndex() const
Get the index of current annotation in the page which current annotation belongs to.
foxit::common::Alignment
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:94
foxit::pdf::annots::QuadPoints::third
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:772
foxit::pdf::DefaultAppearance::text_size
float text_size
Text size for default appearance.
Definition: fs_annot.h:199
foxit::pdf::annots::FreeText
Definition: fs_annot.h:3389
foxit::pdf::annots::FreeText::SetCalloutLinePoints
void SetCalloutLinePoints(const PointFArray &point_array)
Set points for callout line.
fs_pdfobject.h
Header file for PDF object related definitions and classes.
foxit::pdf::RichTextStyle::is_underline
bool is_underline
A boolean value which indicates whether to underline text or not.
Definition: fs_annot.h:420
foxit::pdf::annots::Link::GetQuadPoints
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
foxit::pdf::annots::Annot::e_HighlightingToggle
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1177
foxit::int32
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:193
foxit::pdf::annots::Sound::GetFileSpec
FileSpec GetFileSpec() const
Get the file specification object which represents an external sound file.
foxit::Base
Definition: fs_basictypes.h:451
foxit::pdf::annots::Annot::e_PrinterMark
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1065
foxit::pdf::annots::TextMarkup::TextMarkup
TextMarkup()
Constructor.
Definition: fs_annot.h:2729
foxit::pdf::annots::Widget::SetMKDownIconImage
void SetMKDownIconImage(const common::Image &image, int frame_index)
Set an image with specified frame index as down icon in the MK dictionary.
foxit::pdf::annots::Annot::e_HighlightingNone
Highlighting mode: No highlighting.
Definition: fs_annot.h:1169
foxit::pdf::annots::Annot::e_MKRelationCaptionRight
Caption to the right of the icon.
Definition: fs_annot.h:1278
foxit::pdf::annots::Redact::SetOverlayTextAlignment
void SetOverlayTextAlignment(common::Alignment alignment)
Set alignment value of overlay text.
foxit::pdf::annots::Square::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
foxit::pdf::annots::Stamp::GetIconName
String GetIconName() const
Get icon name.
foxit::pdf::annots::Annot::operator==
bool operator==(const Annot &other) const
Equal operator.
foxit::pdf::annots::Polygon::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::actions::JavaScriptAction
Definition: fs_action.h:743
foxit::pdf::annots::IconProviderCallback::CanChangeColor
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:1810
foxit::pdf::annots::Widget::GetMKRolloverCaption
WString GetMKRolloverCaption() const
Get the rollover caption string in the MK dictionary.
foxit::pdf::FileSpec
Definition: fs_filespec.h:38
foxit::pdf::DefaultAppearance::operator=
DefaultAppearance & operator=(const DefaultAppearance &default_appearance)
Assign operator.
Definition: fs_annot.h:117
foxit::pdf::annots::Screen::SetOpacity
void SetOpacity(float opacity)
Set opacity value.
foxit::pdf::annots::QuadPoints::first
PointF first
First point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:768
foxit::pdf::annots::Annot::HighlightingMode
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1167
foxit::pdf::annots::FreeText::SetRotation
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
foxit::pdf::annots::FileAttachment::FileAttachment
FileAttachment()
Constructor.
Definition: fs_annot.h:5018
foxit::pdf::annots::Annot::e_Highlight
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1036
foxit::pdf::annots::Note::SetOpenStatus
void SetOpenStatus(bool status)
Set open status.
foxit::pdf::annots::Polygon::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::annots::PolyLine::SetLineEndStyle
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
foxit::pdf::annots::Sound::e_SampleEncodingFormatALaw
A-law-encoded samples.
Definition: fs_annot.h:6006
foxit::pdf::annots::BorderInfo::~BorderInfo
~BorderInfo()
Destructor.
Definition: fs_annot.h:529
foxit::pdf::annots::Annot
Definition: fs_annot.h:1006
foxit::pdf::annots::Square::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints(const QuadPoints &quad_points)
Constructor, with another quadrilateral points object.
Definition: fs_annot.h:704
foxit::pdf::annots::Annot::RemoveProperty
bool RemoveProperty(Property property)
Remove a specified annotation's property.
foxit::pdf::annots::Annot::GetDict
objects::PDFDictionary * GetDict() const
Get annotation's dictionary object.
foxit::pdf::annots::Polygon::Polygon
Polygon()
Constructor.
Definition: fs_annot.h:4563
foxit::pdf::annots::Link::Link
Link()
Constructor.
Definition: fs_annot.h:2912
foxit::pdf::annots::Annot::e_Sound
Annotation type: sound annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1054
foxit::pdf::annots::Annot::operator !=
bool operator !=(const Annot &other) const
Not equal operator.
foxit::pdf::annots::Annot::e_StrikeOut
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1042
foxit::common::Font
Definition: fs_common.h:1523
foxit::pdf::annots::Circle::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Line::SetStartPoint
void SetStartPoint(const PointF &point)
Set the start point.
foxit::pdf::objects::PDFDictionary
Definition: fs_pdfobject.h:850
foxit::pdf::annots::Redact::GetOverlayText
WString GetOverlayText() const
Get the overlay text.
foxit::pdf::annots::FileAttachment::SetFileSpec
bool SetFileSpec(const FileSpec &file_spec)
Set a file specification, which should specify an embedded file.
foxit::common::Rotation
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
foxit::pdf::annots::Annot::e_MKEntryIconFit
Icon fit information entry. "IF" in MK dictionary.
Definition: fs_annot.h:1253
foxit::pdf::annots::PSInk::PSInk
PSInk()
Constructor.
Definition: fs_annot.h:5160
foxit::pdf::RichTextStyle::e_CornerMarkNone
Corner mark style: none.
Definition: fs_annot.h:219
foxit
Foxit namespace.
Definition: fs_pdf3d.h:26
foxit::common::e_AlignmentLeft
Left alignment.
Definition: fs_common.h:96
foxit::pdf::annots::IconProviderCallback::HasIcon
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:1797
foxit::pdf::annots::Annot::e_Underline
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1038
foxit::pdf::annots::Link::RemoveAction
bool RemoveAction()
Remove action.
foxit::pdf::annots::NoteArray
Definition: fs_annot.h:1883
foxit::pdf::annots::PSInk::~PSInk
~PSInk()
Destructor.
Definition: fs_annot.h:5170
foxit::pdf::actions::Action
Definition: fs_action.h:418
foxit::pdf::DefaultAppearance::text_color
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:206
foxit::pdf::annots::Circle::SetMeasureRatio
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
foxit::pdf::annots::Annot::e_MKEntryRotation
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1214
foxit::pdf::annots::Widget::SetMKDownCaption
void SetMKDownCaption(const wchar_t *caption)
Set the down caption string in the MK dictionary.
CFX_ByteString
BYTE STRING CLASS.
Definition: fx_string.h:317
foxit::pdf::annots::Widget::GetMKDownCaption
WString GetMKDownCaption() const
Get the down caption string in the MK dictionary.
foxit::pdf::annots::Line::GetLeaderLineLength
float GetLeaderLineLength() const
Get the length of leader line.
foxit::pdf::annots::Redact::GetOverlayTextAlignment
common::Alignment GetOverlayTextAlignment() const
Get alignment value of overlay text.
foxit::pdf::annots::Annot::e_Line
Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1026
foxit::pdf::annots::Squiggly::Squiggly
Squiggly()
Constructor.
Definition: fs_annot.h:2885
foxit::pdf::DefaultAppearance::operator==
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:132
foxit::pdf::annots::BorderInfo::e_Cloudy
Border style: Cloudy.
Definition: fs_annot.h:492
foxit::pdf::annots::Widget::SetMKBackgroundColor
void SetMKBackgroundColor(RGB color)
Set the background color in the MK dictionary.
foxit::pdf::annots::Widget::RemoveMKEntry
void RemoveMKEntry(MKEntry mk_entry)
Remove a specified entry from the MK dictionary.
foxit::pdf::DefaultAppearance::operator !=
bool operator !=(const DefaultAppearance &default_appearance) const
Not equal operator.
Definition: fs_annot.h:145
foxit::pdf::annots::Widget::SetMKRotation
void SetMKRotation(common::Rotation rotation)
Set the rotation value in the MK dictionary.
foxit::pdf::annots::Polygon::SetVertexes
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
foxit::pdf::annots::Annot::AppearanceType
AppearanceType
Enumeration for the type of annotation's appearance.
Definition: fs_annot.h:1290
foxit::pdf::DefaultAppearance::e_FlagFont
Indicates property font of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:65
foxit::pdf::annots::BorderInfo::dash_phase
float dash_phase
Dash phase.
Definition: fs_annot.h:658
foxit::pdf::RichTextStyle::mark_style
CornerMarkStyle mark_style
Corner mark style. Corner mark style which can be used to make text as superscript or subscript or no...
Definition: fs_annot.h:431
foxit::pdf::annots::Sound::GetBits
int GetBits() const
Get the number of bits per sample value per channel.
foxit::pdf::annots::BorderInfo::style
Style style
Border style. Please refer to values starting from BorderInfo::e_Solid and this should be one of thes...
Definition: fs_annot.h:638
foxit::pdf::annots::Line::GetCaptionPositionType
CapPos GetCaptionPositionType() const
Get the position type of caption.
foxit::pdf::annots::Annot::e_Caret
Annotation type: caret annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1046
foxit::pdf::annots::Square::~Square
~Square()
Destructor.
Definition: fs_annot.h:3045
foxit::pdf::annots::Square::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::annots::Popup
Definition: fs_annot.h:5084
foxit::pdf::annots::Annot::SetModifiedDateTime
void SetModifiedDateTime(const DateTime &date_time)
Set last modified date time.
foxit::pdf::annots::Annot::e_3D
Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1071
foxit::pdf::annots::FreeText::SetDefaultAppearance
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
foxit::pdf::annots::BorderInfo::e_Inset
Border style: Inset.
Definition: fs_annot.h:485
foxit::pdf::annots::Square::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::RichTextStyle::is_strikethrough
bool is_strikethrough
A boolean value which indicates whether to cross text out with strike through or not.
Definition: fs_annot.h:425
foxit::pdf::annots::Annot::e_MKRelationNoIcon
No icon; captin only.
Definition: fs_annot.h:1270
foxit::pdf::annots::Annot::SetBorderInfo
void SetBorderInfo(const BorderInfo &border)
Set border information.
foxit::pdf::RichTextStyle::CornerMarkStyle
CornerMarkStyle
Enumeration for corner mark style.
Definition: fs_annot.h:217
foxit::pdf::annots::Circle::~Circle
~Circle()
Destructor.
Definition: fs_annot.h:3217
foxit::pdf::annots::Redact::SetApplyFillColor
void SetApplyFillColor(RGB fill_color)
Set the filling color which is used for rollover appearance and will be used after redaction is appli...
foxit::pdf::annots::FreeText::GetCalloutLineEndingStyle
EndingStyle GetCalloutLineEndingStyle() const
Get line ending style of the start point in a callout line.
foxit::pdf::annots::PolyLine
Definition: fs_annot.h:4742
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:792
foxit::pdf::annots::Circle::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Stamp::~Stamp
~Stamp()
Destructor.
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo()
Constructor.
Definition: fs_annot.h:522
foxit::pdf::annots::Square::GetInnerRect
RectF GetInnerRect() const
Get the inner rectangle.
foxit::pdf::annots::Line::SetLineStartStyle
void SetLineStartStyle(EndingStyle ending_style)
Set line ending style of the start point.
foxit::pdf::annots::Annot::e_Watermark
Annotation type: watermark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1069
foxit::pdf::annots::FileAttachment::GetIconName
String GetIconName() const
Get icon name.
foxit::pdf::annots::PolyLine::GetLineStartStyle
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
foxit::pdf::annots::Annot::SetUniqueID
void SetUniqueID(const WString &unique_id)
Set unique ID.
foxit::pdf::annots::Line::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
CFX_Matrix
Definition: fx_coordinates.h:1076
foxit::pdf::annots::Polygon::GetVertexes
PointFArray GetVertexes()
Get vertexes.
foxit::pdf::annots::Sound::SampleEncodingFormat
SampleEncodingFormat
Enumeration for encoding format of sound sample data.
Definition: fs_annot.h:5998
foxit::pdf::DefaultAppearance::Set
void Set(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Set value.
Definition: fs_annot.h:168
foxit::pdf::annots::Polygon::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
foxit::pdf::annots::Line
Definition: fs_annot.h:3701
foxit::pdf::annots::Polygon::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::annots::Stamp::SetRotation
void SetRotation(int angle)
Set rotation angle (in clockwise).
foxit::pdf::annots::FileAttachment::~FileAttachment
~FileAttachment()
Destructor.
Definition: fs_annot.h:5026
foxit::pdf::annots::Widget::LineSpacingStyle
LineSpacingStyle
Enumeration for line spacing style.
Definition: fs_annot.h:5194
foxit::pdf::annots::Line::SetLeaderLineExtensionLength
void SetLeaderLineExtensionLength(float extension_length)
Set the length of leader line extension.
foxit::pdf::RichTextStyle::is_bold
bool is_bold
A boolean value which indicates whether to make text bold or not.
Definition: fs_annot.h:410
foxit::pdf::annots::Caret::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
foxit::pdf::annots::QuadPoints
Definition: fs_annot.h:679
foxit::pdf::annots::Annot::GetBorderColor
RGB GetBorderColor() const
Get border color.
foxit::pdf::annots::Squiggly
Definition: fs_annot.h:2882
foxit::pdf::annots::Note::GetIconName
String GetIconName() const
Get icon name.
foxit::pdf::annots::Line::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
foxit::pdf::annots::IconProviderCallback::GetDisplayWidth
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:1856
foxit::pdf::annots::IconProviderCallback::GetDisplayHeight
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:1869
foxit::pdf::annots::Widget::e_LineSpacingOneAndHalf
Line spacing style: one and half times line spacing.
Definition: fs_annot.h:5198
foxit::pdf::annots::Annot::e_Circle
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1030
fs_action.h
Header file for destination and action related definitions and classes.
foxit::pdf::annots::Screen::GetTitle
WString GetTitle() const
Get title of current screen annotation.
foxit::pdf::annots::Annot::e_MKRelationCaptionLeft
Caption to the left of the icon.
Definition: fs_annot.h:1280
foxit::pdf::annots::FreeText::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
foxit::pdf::annots::Line::CapPos
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:3708
foxit::pdf::DefaultAppearance::e_FlagFontSize
Indicates property text size of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:69
foxit::pdf::annots::Note::Note
Note()
Constructor.
Definition: fs_annot.h:2574
foxit::pdf::annots::Stamp::Stamp
Stamp()
Constructor.
Definition: fs_annot.h:4247
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor()
Constructor.
Definition: fs_annot.h:1682
foxit::pdf::annots::IconProviderCallback::GetProviderID
virtual String GetProviderID()
A callback function used to get provider ID.
Definition: fs_annot.h:1774
foxit::pdf::annots::Markup::~Markup
~Markup()
Destructor.
Definition: fs_annot.h:2034
foxit::pdf::annots::Line::SetCaptionOffset
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
foxit::pdf::annots::Highlight
Definition: fs_annot.h:2792
foxit::pdf::annots::Annot::e_MKEntryNormalCaption
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1223
foxit::pdf::annots::Annot::e_MKEntryDownCaption
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1233
foxit::pdf::annots::Line::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::TextMarkup::~TextMarkup
~TextMarkup()
Destructor.
Definition: fs_annot.h:2737
foxit::pdf::annots::Annot::e_MKEntryBackgroundColor
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:1218
foxit::pdf::annots::Screen::RemoveAction
void RemoveAction()
Remove action.
foxit::pdf::annots::Widget::SetMKDownIconBitmap
void SetMKDownIconBitmap(const common::Bitmap &bitmap)
Set the down icon bitmap in the MK dictionary.
foxit::pdf::annots::Polygon::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
foxit::pdf::annots::PagingSeal
Definition: fs_annot.h:6108
foxit::pdf::annots::Annot::GetRect
RectF GetRect() const
Get rectangle, in PDF coordinate system.
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints()
Constructor.
Definition: fs_annot.h:697
foxit::pdf::annots::Annot::e_FlagLockedContents
Annotation flag: locked contents.
Definition: fs_annot.h:1159
foxit::pdf::annots::Annot::e_Stamp
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1044
foxit::common::Image
Definition: fs_image.h:459
foxit::pdf::annots::Annot::e_FlagHidden
Annotation flag: hidden.
Definition: fs_annot.h:1100
foxit::pdf::annots::Sound
Definition: fs_annot.h:5991
foxit::pdf::annots::Widget::e_LineSpacingExactValue
Line spacing style: exact value line spacing.
Definition: fs_annot.h:5202
foxit::pdf::annots::BorderInfo::e_Dashed
Border style: Dashed.
Definition: fs_annot.h:465
foxit::pdf::RichTextStyle::operator=
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:297
foxit::pdf::annots::Note::SetState
void SetState(State state)
Set the state.
foxit::pdf::annots::Line::SetStyleFillColor
void SetStyleFillColor(RGB color)
Set fill color for ending styles.
foxit::pdf::annots::Annot::ResetAppearanceStream
bool ResetAppearanceStream()
Reset appearance stream.
CFX_FloatRect
Definition: fx_coordinates.h:771
foxit::pdf::annots::Line::SetLeaderLineOffset
void SetLeaderLineOffset(float offset)
Set the length of leader line offset.
foxit::pdf::annots::Annot::e_HighlightingPush
Highlighting mode: Push, which is to display the annotation's down appearance, if any.
Definition: fs_annot.h:1175
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_annot.h:513