Foxit PDF SDK

fs_annot.h
浏览该文件的文档.
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 PagingSealSignature;
38 namespace annots {
39 class Note;
40 class Popup;
41 } // namespace annots
42 namespace interform {
43 class Field;
44 class Control;
45 } // namespace interform
46
50 class DefaultAppearance FS_FINAL : public Object {
51 public:
57 typedef enum _DefAPFlags {
59 e_FlagFont = 0x0001,
61 e_FlagTextColor = 0x0002,
63 e_FlagFontSize = 0x0004
64 } DefAPFlags;
65
66
80 DefaultAppearance(uint32 flags, const common::Font& font, float text_size, RGB text_color)
81 : flags(flags)
82 , font(font)
83 , text_size(text_size)
84 , text_color(text_color) {}
85
87 DefaultAppearance()
88 : flags(0)
89 , text_size(0)
90 , text_color(0x000000) {}
91
97 DefaultAppearance(const DefaultAppearance& default_appearance)
98 : flags(default_appearance.flags)
99 , font(default_appearance.font)
100 , text_size(default_appearance.text_size)
101 , text_color(default_appearance.text_color) {}
102
110 DefaultAppearance& operator = (const DefaultAppearance& default_appearance) {
111 flags = default_appearance.flags;
112 font = default_appearance.font;
113 text_size = default_appearance.text_size;
114 text_color = default_appearance.text_color;
115 return *this;
116 }
117
125 bool operator == (const DefaultAppearance& default_appearance) const {
126 return (flags == default_appearance.flags && font == default_appearance.font &&
127 fabs(text_size-default_appearance.text_size) <= FLT_EPSILON &&
128 text_color == default_appearance.text_color);
129 }
130
138 bool operator != (const DefaultAppearance& default_appearance) const {
139 return (flags != default_appearance.flags || font != default_appearance.font ||
140 fabs(text_size - default_appearance.text_size) > FLT_EPSILON ||
141 text_color != default_appearance.text_color);
142 }
143
159 void Set(uint32 flags, const common::Font& font, float text_size, RGB text_color) {
160 this->flags = flags;
161 this->font = font;
162 this->text_size = text_size;
163 this->text_color = text_color;
164 }
165
173 uint32 flags;
174
180 common::Font font;
181
190 float text_size;
191
197 RGB text_color;
198 };
199
201 class RichTextStyle FS_FINAL : public Object{
202 public:
208 typedef enum _CornerMarkStyle {
210 e_CornerMarkNone = 1,
212 e_CornerMarkSuperscript = 2,
214 e_CornerMarkSubscript = 3
215 } CornerMarkStyle;
216
217
236 RichTextStyle(const common::Font& font, float text_size, common::Alignment text_alignment, RGB text_color,
237 bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style, float char_space, float word_space)
238 : font(font)
239 , text_size(text_size)
240 , text_alignment(text_alignment)
241 , text_color(text_color)
242 , is_bold(is_bold)
243 , is_italic(is_italic)
244 , is_underline(is_underline)
245 , is_strikethrough(is_strikethrough)
246 , mark_style(mark_style)
247 , char_space(char_space)
248 , word_space(word_space) {}
249
251 RichTextStyle()
252 : text_size(0)
253 , text_alignment(common::e_AlignmentLeft)
254 , text_color(0x000000)
255 , is_bold(false)
256 , is_italic(false)
257 , is_underline(false)
258 , is_strikethrough(false)
259 , mark_style(RichTextStyle::e_CornerMarkNone)
260 , char_space(0.0f)
261 , word_space(0.0f) {}
262
268 RichTextStyle(const RichTextStyle& style)
269 : font(style.font)
270 , text_size(style.text_size)
271 , text_alignment(style.text_alignment)
272 , text_color(style.text_color)
273 , is_bold(style.is_bold)
274 , is_italic(style.is_italic)
275 , is_underline(style.is_underline)
276 , is_strikethrough(style.is_strikethrough)
277 , mark_style(style.mark_style)
278 , char_space(style.char_space)
279 , word_space(style.word_space) {}
280
288 RichTextStyle& operator = (const RichTextStyle& style) {
289 font = style.font;
290 text_size = style.text_size;
291 text_alignment = style.text_alignment;
292 text_color = style.text_color;
293 is_bold = style.is_bold;
294 is_italic = style.is_italic;
295 is_underline = style.is_underline;
296 is_strikethrough = style.is_strikethrough;
297 mark_style = style.mark_style;
298 char_space = style.char_space;
299 word_space = style.word_space;
300 return *this;
301 }
302
310 bool operator == (const RichTextStyle& style) const {
311 return (font == style.font &&
312 fabs(text_size- style.text_size) <= FLT_EPSILON &&
313 text_alignment == style.text_alignment &&
314 text_color == style.text_color &&
315 is_bold == style.is_bold &&
316 is_italic == style.is_italic &&
317 is_underline == style.is_underline &&
318 is_strikethrough == style.is_strikethrough &&
319 mark_style == style.mark_style &&
320 char_space == style.char_space &&
321 word_space == style.word_space);
322 }
323
331 bool operator != (const RichTextStyle& style) const {
332 return !((*this) == style);
333 }
334
355 void Set(const common::Font& font, float text_size, common::Alignment text_alignment, RGB text_color,
356 bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style, float char_space, float word_space) {
357 this->font = font;
358 this->text_size = text_size;
359 this->text_alignment = text_alignment;
360 this->text_color = text_color;
361 this->is_bold = is_bold;
362 this->is_italic = is_italic;
363 this->is_underline = is_underline;
364 this->is_strikethrough = is_strikethrough;
365 this->mark_style = mark_style;
366 this->char_space = char_space;
367 this->word_space = word_space;
368 }
369
380 common::Font font;
381
385 float text_size;
386
391 common::Alignment text_alignment;
392
396 RGB text_color;
397
401 bool is_bold;
402
406 bool is_italic;
407
411 bool is_underline;
412
416 bool is_strikethrough;
417
422 CornerMarkStyle mark_style;
423
427 float char_space;
428
432 float word_space;
433 };
434
438 namespace annots {
440 class BorderInfo FS_FINAL : public Object {
441 public:
447 typedef enum _Style {
449 e_Solid = 0,
456 e_Dashed = 1,
462 e_UnderLine = 2,
469 e_Beveled = 3,
476 e_Inset = 4,
483 e_Cloudy = 5
484 } Style;
485
486
504 BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
505 this->width = width;
506 this->style = style;
507 this->cloud_intensity = intensity;
508 this->dash_phase = dash_phase;
509 this->dashes = dashes;
510 }
511
513 BorderInfo()
514 : width(1.0f)
515 , style(BorderInfo::e_Solid)
516 , cloud_intensity(0)
517 , dash_phase(0) {}
518
520 ~BorderInfo() {}
521
527 BorderInfo(const BorderInfo& border_info) {
528 this->width = border_info.width;
529 this->style = border_info.style;
530 this->cloud_intensity = border_info.cloud_intensity;
531 this->dash_phase = border_info.dash_phase;
532 this->dashes = border_info.dashes;
533 }
534
542 BorderInfo& operator = (const BorderInfo& border_info) {
543 this->width = border_info.width;
544 this->style = border_info.style;
545 this->cloud_intensity = border_info.cloud_intensity;
546 this->dash_phase = border_info.dash_phase;
547 this->dashes = border_info.dashes;
548 return *this;
549 }
550
558 bool operator == (const BorderInfo& border_info) const {
559 if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
560 fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
561 fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
562 dashes.GetSize() != border_info.dashes.GetSize())
563 return false;
564 for (int i=0; i<dashes.GetSize(); i++) {
565 if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
566 return false;
567 }
568 return true;
569 }
570
578 bool operator != (const BorderInfo& border_info) const{
579 if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
580 fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
581 fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
582 dashes.GetSize() != border_info.dashes.GetSize())
583 return true;
584 for (int i=0; i<dashes.GetSize(); i++) {
585 if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
586 return true;
587 }
588 return false;
589 }
590
603 void Set(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
604 this->width = width;
605 this->style = style;
606 this->cloud_intensity = intensity;
607 this->dash_phase = dash_phase;
608 this->dashes = dashes;
609 }
610
616 float width;
617
621 Style style;
622
633 float cloud_intensity;
634
640 float dash_phase;
641
648 FloatArray dashes;
649 };
650
661 class QuadPoints FS_FINAL : public Object {
662 public:
671 QuadPoints(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
672 this->first = first;
673 this->second = second;
674 this->third = third;
675 this->fourth = fourth;
676 }
677
679 QuadPoints() {}
680
686 QuadPoints(const QuadPoints& quad_points) {
687 first = quad_points.first;
688 second = quad_points.second;
689 third = quad_points.third;
690 fourth = quad_points.fourth;
691 }
692
700 QuadPoints& operator = (const QuadPoints& quad_points) {
701 first = quad_points.first;
702 second = quad_points.second;
703 third = quad_points.third;
704 fourth = quad_points.fourth;
705 return *this;
706 }
707
714 bool operator == (const QuadPoints& quad_points) const {
715 return (first == quad_points.first && second == quad_points.second &&
716 third == quad_points.third && fourth == quad_points.fourth);
717 }
718
726 bool operator != (const QuadPoints& quad_points) const {
727 return (first != quad_points.first || second != quad_points.second ||
728 third != quad_points.third || fourth != quad_points.fourth);
729 }
730
741 void Set(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
742 this->first = first;
743 this->second = second;
744 this->third = third;
745 this->fourth = fourth;
746 }
747
749 PointF first;
751 PointF second;
753 PointF third;
755 PointF fourth;
756 };
757
759 FSDK_DEFINE_ARRAY(QuadPointsArray, QuadPoints)
760
761
764 class IconFit FS_FINAL : public Object {
765 public:
770 typedef enum _ScaleWayType {
772 e_ScaleWayNone = 0,
774 e_ScaleWayAlways = 1,
776 e_ScaleWayBigger = 2,
778 e_ScaleWaySmaller = 3,
780 e_ScaleWayNever = 4
781 } ScaleWayType;
782
783
785 IconFit()
786 : scale_way_type(e_ScaleWayNone)
787 , is_proportional_scaling(false)
788 , horizontal_fraction(0)
789 , vertical_fraction(0)
790 , fit_bounds(false) {}
791
803 IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
804 float vertical_fraction, bool fit_bounds)
805 : scale_way_type(type)
806 , is_proportional_scaling(is_proportional_scaling)
807 , horizontal_fraction(horizontal_fraction)
808 , vertical_fraction(vertical_fraction)
809 , fit_bounds(fit_bounds) {}
810
816 IconFit(const IconFit& icon_fit)
817 : scale_way_type(icon_fit.scale_way_type)
818 , is_proportional_scaling(icon_fit.is_proportional_scaling)
819 , horizontal_fraction(icon_fit.horizontal_fraction)
820 , vertical_fraction(icon_fit.vertical_fraction)
821 , fit_bounds(icon_fit.fit_bounds) {}
822
830 IconFit& operator = (const IconFit& icon_fit) {
831 scale_way_type = icon_fit.scale_way_type;
832 is_proportional_scaling = icon_fit.is_proportional_scaling;
833 horizontal_fraction = icon_fit.horizontal_fraction;
834 vertical_fraction = icon_fit.vertical_fraction;
835 fit_bounds = icon_fit.fit_bounds;
836 return *this;
837 }
838
846 bool operator == (const IconFit& icon_fit) const {
847 return (scale_way_type == icon_fit.scale_way_type &&
848 is_proportional_scaling == icon_fit.is_proportional_scaling &&
849 fabs(horizontal_fraction - icon_fit.horizontal_fraction) <= FLT_EPSILON &&
850 fabs(vertical_fraction - icon_fit.vertical_fraction) <= FLT_EPSILON &&
851 fit_bounds == icon_fit.fit_bounds);
852 }
853
861 bool operator != (const IconFit& icon_fit) const {
862 return (scale_way_type != icon_fit.scale_way_type ||
863 is_proportional_scaling != icon_fit.is_proportional_scaling ||
864 fabs(horizontal_fraction - icon_fit.horizontal_fraction) > FLT_EPSILON ||
865 fabs(vertical_fraction - icon_fit.vertical_fraction) > FLT_EPSILON ||
866 fit_bounds != icon_fit.fit_bounds);
867 }
868
882 void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
883 float vertical_fraction, bool fit_bounds) {
884 this->scale_way_type = type;
885 this->is_proportional_scaling = is_proportional_scaling;
886 this->horizontal_fraction = horizontal_fraction;
887 this->vertical_fraction = vertical_fraction;
888 this->fit_bounds = fit_bounds;
889 }
890
895 ScaleWayType scale_way_type;
901 bool is_proportional_scaling;
905 float horizontal_fraction;
909 float vertical_fraction;
915 bool fit_bounds;
916 };
917
950 class Annot : public Base {
951 public:
957 typedef enum _Type {
959 e_UnknownType = 0,
964 e_Note = 1,
966 e_Link = 2,
968 e_FreeText = 3,
970 e_Line = 4,
972 e_Square = 5,
974 e_Circle = 6,
976 e_Polygon = 7,
978 e_PolyLine = 8,
980 e_Highlight = 9,
982 e_Underline = 10,
984 e_Squiggly = 11,
986 e_StrikeOut = 12,
988 e_Stamp = 13,
990 e_Caret = 14,
992 e_Ink = 15,
994 e_PSInk = 16,
996 e_FileAttachment = 17,
998 e_Sound = 18,
1000 e_Movie = 19,
1005 e_Widget = 20,
1007 e_Screen = 21,
1009 e_PrinterMark = 22,
1011 e_TrapNet = 23,
1013 e_Watermark = 24,
1015 e_3D = 25,
1017 e_Popup = 26,
1019 e_Redact = 27,
1021 e_RichMedia = 28,
1023 e_PagingSeal = 29
1024 } Type;
1025
1031 typedef enum _Flags {
1037 e_FlagInvisible = 0x0001,
1043 e_FlagHidden = 0x0002,
1050 e_FlagPrint = 0x0004,
1057 e_FlagNoZoom = 0x0008,
1064 e_FlagNoRotate = 0x0010,
1071 e_FlagNoView = 0x0020,
1080 e_FlagReadOnly = 0x0040,
1086 e_FlagLocked = 0x0080,
1092 e_FlagToggleNoView = 0x0100,
1098 e_FlagLockedContents = 0x0200
1099 } Flags;
1100
1106 typedef enum _HighlightingMode {
1108 e_HighlightingNone = 0,
1110 e_HighlightingInvert = 1,
1112 e_HighlightingOutline = 2,
1114 e_HighlightingPush = 3,
1116 e_HighlightingToggle = 4
1117 } HighlightingMode;
1118
1124 typedef enum _Property {
1126 e_PropertyModifiedDate = 0,
1131 e_PropertyCreationDate = 1,
1137 e_PropertyBorderColor = 2,
1143 e_PropertyFillColor = 3
1144 } Property;
1145
1151 typedef enum _MKEntry {
1153 e_MKEntryRotation = 0,
1155 e_MKEntryBorderColor = 1,
1157 e_MKEntryBackgroundColor = 2,
1162 e_MKEntryNormalCaption = 3,
1167 e_MKEntryRolloverCaption = 4,
1172 e_MKEntryDownCaption = 5,
1177 e_MKEntryNormalIcon = 6,
1182 e_MKEntryRolloverIcon = 7,
1187 e_MKEntryDownIcon = 8,
1192 e_MKEntryIconFit = 9,
1198 e_MKEntryIconCaptionRelation = 10
1199 } MKEntry;
1200
1206 typedef enum _MKIconCaptionRelation {
1208 e_MKRelationNoIcon = 0,
1210 e_MKRelationNoCaption = 1,
1212 e_MKRelationCaptionBelowIcon = 2,
1214 e_MKRelationCaptionAboveIcon = 3,
1216 e_MKRelationCaptionRight = 4,
1218 e_MKRelationCaptionLeft = 5,
1220 e_MKRelationCaptionOvrlayOnIcon = 6
1221 } MKIconCaptionRelation;
1222
1228 typedef enum _AppearanceType {
1230 e_AppearanceTypeNormal = 0,
1232 e_AppearanceTypeRollover = 1,
1234 e_AppearanceTypeDown = 2
1235 } AppearanceType;
1236
1237
1238 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1239 explicit Annot(FS_HANDLE handle);
1247 Annot(const PDFPage& page, objects::PDFDictionary* annot_dict);
1248 #ifndef __EMSCRIPTEN_RENDER__
1249
1254 Annot(const Annot& annot);
1255 #endif
1256
1257 Annot() {}
1258 #ifndef __EMSCRIPTEN_RENDER__
1259
1266 Annot& operator = (const Annot& annot);
1267 #endif
1268
1275 bool operator ==(const Annot& other) const;
1283 bool operator != (const Annot& other) const;
1284 #ifndef __EMSCRIPTEN_RENDER__
1285
1286 virtual ~Annot();
1287 #endif
1288
1295 bool IsEmpty() const;
1296
1302 PDFPage GetPage() const;
1309 bool IsMarkup() const;
1315 Type GetType() const;
1321 int GetIndex() const;
1327 WString GetContent() const;
1340 void SetContent(const WString& content);
1347 DateTime GetModifiedDateTime() const;
1355 void SetModifiedDateTime(const DateTime& date_time);
1362 uint32 GetFlags() const;
1371 void SetFlags(uint32 flags);
1377 WString GetUniqueID() const;
1385 void SetUniqueID(const WString& unique_id);
1392 RectF GetRect() const;
1393
1406 Matrix GetDisplayMatrix(const Matrix& page_display_matrix);
1407
1416 bool Move(const RectF& rect);
1417
1427 bool Move(const RectF& rect, bool is_reset_appearance);
1428
1442 BorderInfo GetBorderInfo() const;
1443
1459 void SetBorderInfo(const BorderInfo& border);
1468 RGB GetBorderColor() const;
1479 void SetBorderColor(RGB color);
1491 bool ResetAppearanceStream();
1492
1508 bool ResetAppearanceStream(bool is_generate_new_appearance_obj);
1509
1525 RectI GetDeviceRect(const Matrix& matrix);
1526
1532 objects::PDFDictionary* GetDict() const;
1533
1543 bool HasProperty(Property property) const;
1544
1559 bool RemoveProperty(Property property);
1560
1567 objects::PDFDictionary* GetOptionalContent() const;
1568
1582 objects::PDFStream* GetAppearanceStream(AppearanceType type, const char* appearance_state = "") const;
1583 };
1584
1586 FSDK_DEFINE_ARRAY(AnnotArray, Annot)
1587
1588
1589 class ShadingColor FS_FINAL : public Object {
1590 public:
1597 ShadingColor(ARGB firstcolor, ARGB secondcolor)
1598 : first_color(firstcolor)
1599 , second_color(secondcolor) {}
1600
1602 ShadingColor()
1603 : first_color(0xFFFFFFFF)
1604 , second_color(0xFFFFFFFF) {}
1605
1611 ShadingColor(const ShadingColor& shading_color)
1612 : first_color(shading_color.first_color)
1613 , second_color(shading_color.second_color) {}
1614
1622 ShadingColor& operator = (const ShadingColor& shading_color) {
1623 this->first_color = shading_color.first_color;
1624 this->second_color = shading_color.second_color;
1625 return *this;
1626 }
1627
1635 bool operator == (const ShadingColor& shading_color) const {
1636 return (first_color == shading_color.first_color && second_color == shading_color.second_color);
1637 }
1638
1646 bool operator != (const ShadingColor& shading_color) const {
1647 return (first_color != shading_color.first_color || second_color != shading_color.second_color);
1648 }
1649
1658 void Set(ARGB firstcolor, ARGB secondcolor) {
1659 this->first_color = firstcolor;
1660 this->second_color = secondcolor;
1661 }
1662
1664 ARGB first_color;
1666 ARGB second_color;
1667 };
1668
1677 class IconProviderCallback {
1678 public:
1684 virtual void Release() = 0;
1693 virtual String GetProviderID() {
1694 return String();
1695 }
1704 virtual String GetProviderVersion() {
1705 return String();
1706 }
1716 virtual bool HasIcon(Annot::Type annot_type, const char* icon_name) {
1717 return false;
1718 }
1728 virtual bool CanChangeColor(Annot::Type annot_type, const char* icon_name) {
1729 return false;
1730 }
1731 #ifndef __EMSCRIPTEN_RENDER__
1732
1743 virtual PDFPage GetIcon(Annot::Type annot_type, const char* icon_name, ARGB color, foxit::pdf::objects::PDFDictionary* annot_dict);
1744 #endif
1745
1758 virtual bool GetShadingColor(Annot::Type annot_type, const char* icon_name,
1759 RGB referenced_color, int shading_index, ShadingColor& out_shading_color) {
1760 return false;
1761 }
1772 virtual float GetDisplayWidth(Annot::Type annot_type, const char* icon_name) {
1773 return 0.0f;
1774 }
1785 virtual float GetDisplayHeight(Annot::Type annot_type, const char* icon_name) {
1786 return 0.0f;
1787 }
1788
1789 protected:
1790 ~IconProviderCallback() {}
1791 };
1792
1793 class Markup;
1795 FSDK_DEFINE_ARRAY(MarkupArray, Markup)
1796
1797 class Note;
1799 FSDK_DEFINE_ARRAY(NoteArray, Note)
1800
1801
1818 class Markup : public Annot {
1819 public:
1825 typedef enum _StateModel {
1827 e_StateModelMarked = 1,
1829 e_StateModelReview = 2
1830 } StateModel;
1831
1837 typedef enum _State {
1842 e_StateNone = 0,
1847 e_StateMarked = 1,
1852 e_StateUnmarked = 2,
1857 e_StateAccepted = 3,
1862 e_StateRejected = 4,
1867 e_StateCancelled = 5,
1872 e_StateCompleted = 6,
1877 e_StateDeferred = 7,
1882 e_StateFuture = 8
1883 } State;
1884
1890 typedef enum _EndingStyle {
1892 e_EndingStyleNone = 0,
1894 e_EndingStyleSquare = 1,
1896 e_EndingStyleCircle = 2,
1898 e_EndingStyleDiamond = 3,
1900 e_EndingStyleOpenArrow = 4,
1905 e_EndingStyleClosedArrow = 5,
1907 e_EndingStyleButt = 6,
1909 e_EndingStyleROpenArrow = 7,
1911 e_EndingStyleRClosedArrow = 8,
1913 e_EndingStyleSlash = 9
1914 } EndingStyle;
1915
1921 typedef enum _MeasureType {
1923 e_MeasureTypeX = 0,
1925 e_MeasureTypeY = 1,
1927 e_MeasureTypeD = 2,
1929 e_MeasureTypeA = 3,
1931 e_MeasureTypeT = 4,
1933 e_MeasureTypeS = 5
1934 } MeasureType;
1935
1936
1942 explicit Markup(const Annot& annot);
1943 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1944 explicit Markup(FS_HANDLE handle);
1946 Markup() {}
1947
1949 ~Markup() {}
1950
1966 Popup GetPopup();
1981 void SetPopup(const Popup& popup);
1982
1989 bool RemovePopup();
1990
1998 WString GetTitle() const;
1999
2009 void SetTitle(const WString& title);
2010
2016 WString GetSubject() const;
2017
2025 void SetSubject(const WString& subject);
2026
2035 float GetOpacity() const;
2036
2048 void SetOpacity(float opacity);
2049
2071 String GetIntent() const;
2072
2107 void SetIntent(const String& intent);
2108
2115 DateTime GetCreationDateTime() const;
2116
2124 void SetCreationDateTime(const DateTime& date_time);
2125
2131 int GetReplyCount();
2132
2141 Note GetReply(int index) const;
2142
2148 Note AddReply();
2149
2160 bool RemoveReply(int index);
2161
2167 bool RemoveAllReplies();
2168
2183 bool IsGrouped();
2184
2200 Markup GetGroupHeader();
2201
2216 MarkupArray GetGroupElements();
2217
2229 bool Ungroup();
2230
2246 NoteArray GetStateAnnots(StateModel model);
2247
2284 Note AddStateAnnot(const WString& title, StateModel model, State state);
2285
2295 bool RemoveAllStateAnnots();
2303 int32 GetRichTextCount();
2304
2315 WString GetRichTextContent(int32 index);
2316
2328 void SetRichTextContent(int32 index, const WString& content);
2329
2340 RichTextStyle GetRichTextStyle(int32 index);
2341
2355 void SetRichTextStyle(int32 index, const RichTextStyle& style);
2356
2369 void AddRichText(const WString& content, const RichTextStyle& style);
2370
2387 void InsertRichText(int32 index, const WString& content, const RichTextStyle& style);
2388
2399 void RemoveRichText(int index);
2400
2412 void SetBorderOpacity(float opacity);
2413
2420 float GetBorderOpacity() const;
2421
2433 void SetFillOpacity(float opacity);
2434
2441 float GetFillOpacity() const;
2442 };
2443
2464 class Note FS_FINAL : public Markup {
2465 public:
2467 Note() {}
2473 explicit Note(const Annot& annot);
2474 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
2475 explicit Note(FS_HANDLE handle);
2477 ~Note() {}
2478
2490 bool GetOpenStatus() const;
2504 void SetOpenStatus(bool status);
2516 String GetIconName() const;
2534 void SetIconName(const char* icon_name);
2544 Markup GetReplyTo();
2551 bool IsStateAnnot();
2552
2563 StateModel GetStateModel();
2564
2575 State GetState();
2576
2599 void SetState(State state);
2600
2601 };
2602
2614 class TextMarkup: public Markup {
2615 public:
2617 TextMarkup() {}
2623 explicit TextMarkup(const Annot& annot);
2625 ~TextMarkup() {}
2626
2640 QuadPointsArray GetQuadPoints() const;
2660 void SetQuadPoints(const QuadPointsArray& quad_points_array);
2661 };
2662
2677 class Highlight FS_FINAL : public TextMarkup {
2678 public:
2680 Highlight() {}
2686 explicit Highlight(const Annot& annot);
2688 ~Highlight() {}
2689 };
2690
2705 class Underline FS_FINAL : public TextMarkup {
2706 public:
2708 Underline() {}
2714 explicit Underline(const Annot& annot);
2716 ~Underline() {}
2717 };
2718
2733 class StrikeOut FS_FINAL : public TextMarkup {
2734 public:
2736 StrikeOut() {}
2742 explicit StrikeOut(const Annot& annot);
2744 ~StrikeOut() {}
2745 };
2746
2761 class Squiggly FS_FINAL : public TextMarkup {
2762 public:
2764 Squiggly() {}
2770 explicit Squiggly(const Annot& annot);
2772 ~Squiggly() {}
2773 };
2774
2788 class Link FS_FINAL : public Annot {
2789 public:
2791 Link() {}
2797 explicit Link(const Annot& annot);
2798 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
2799 explicit Link(FS_HANDLE handle);
2801 ~Link() {}
2802
2816 QuadPointsArray GetQuadPoints() const;
2834 void SetQuadPoints(const QuadPointsArray& quad_points_array);
2835
2843 HighlightingMode GetHighlightingMode();
2844
2853 void SetHighlightingMode(HighlightingMode mode);
2854
2861 actions::Action GetAction();
2862
2877 void SetAction(const actions::Action& action);
2878
2884 bool RemoveAction();
2885
2894 bool ExecuteJavaScriptAction(const actions::JavaScriptAction& javascript_action = actions::JavaScriptAction((FS_HANDLE)NULL));
2895 };
2896
2911 class Square FS_FINAL : public Markup {
2912 public:
2914 Square() {}
2920 explicit Square(const Annot& annot);
2922 ~Square() {}
2923
2930 RGB GetFillColor() const;
2931
2939 void SetFillColor(RGB fill_color);
2940
2950 RectF GetInnerRect() const;
2962 void SetInnerRect(const RectF& inner_rect);
2963
2976 void SetMeasureRatio(const char* ratio);
2977
2987 String GetMeasureRatio();
2988
2998 WString GetMeasureRatioW();
2999
3012 void SetMeasureUnit(MeasureType measure_type, const char* unit);
3013
3025 String GetMeasureUnit(MeasureType measure_type);
3026
3038 WString GetMeasureUnitW(MeasureType measure_type);
3039
3052 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3053
3065 float GetMeasureConversionFactor(MeasureType measure_type);
3066 };
3067
3082 class Circle FS_FINAL : public Markup {
3083 public:
3085 Circle() {}
3091 explicit Circle(const Annot& annot);
3093 ~Circle() {}
3094
3101 RGB GetFillColor() const;
3102
3113 void SetFillColor(RGB fill_color);
3114
3124 RectF GetInnerRect() const;
3125
3139 void SetInnerRect(const RectF& inner_rect);
3140
3153 void SetMeasureRatio(const char* ratio);
3154
3164 String GetMeasureRatio();
3165
3175 WString GetMeasureRatioW();
3176
3189 void SetMeasureUnit(MeasureType measure_type, const char* unit);
3190
3202 String GetMeasureUnit(MeasureType measure_type);
3203
3215 WString GetMeasureUnitW(MeasureType measure_type);
3216
3229 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3230
3242 float GetMeasureConversionFactor(MeasureType measure_type);
3243 };
3244
3263 class FreeText FS_FINAL : public Markup {
3264 public:
3266 FreeText() {}
3272 explicit FreeText(const Annot& annot);
3273
3275 ~FreeText() {}
3276
3287 RGB GetFillColor() const;
3288
3302 void SetFillColor(RGB fill_color);
3303
3317 common::Alignment GetAlignment() const;
3318
3335 void SetAlignment(common::Alignment alignment);
3336
3346 RectF GetInnerRect() const;
3347
3361 void SetInnerRect(const RectF& inner_rect);
3362
3371 DefaultAppearance GetDefaultAppearance();
3372
3395 bool SetDefaultAppearance(const DefaultAppearance& default_ap);
3396
3407 EndingStyle GetCalloutLineEndingStyle() const;
3408
3424 void SetCalloutLineEndingStyle(EndingStyle ending_style);
3425
3439 PointFArray GetCalloutLinePoints() const;
3440
3461 void SetCalloutLinePoints(const PointFArray& point_array);
3462
3478 void SetTextMatrix(const Matrix& text_matrix);
3479
3491 Matrix GetTextMatrix() const;
3492
3499 common::Rotation GetRotation();
3500
3515 void SetRotation(common::Rotation rotation);
3516
3528 void Rotate(common::Rotation rotation);
3529
3547 void AllowTextOverflow(bool is_text_overflow);
3548 };
3549
3567 class Line FS_FINAL : public Markup {
3568 public:
3574 typedef enum _CapPos {
3576 e_CapPosInline = 0,
3578 e_CapPosTop = 1
3579 } CapPos;
3580
3581
3583 Line() {}
3589 explicit Line(const Annot& annot);
3591 ~Line() {}
3592
3601 EndingStyle GetLineStartStyle() const;
3615 void SetLineStartStyle(EndingStyle ending_style);
3624 EndingStyle GetLineEndStyle() const;
3638 void SetLineEndStyle(EndingStyle ending_style);
3639
3650 RGB GetStyleFillColor() const;
3651
3665 void SetStyleFillColor(RGB color);
3666
3674 PointF GetStartPoint() const;
3686 void SetStartPoint(const PointF& point);
3687
3695 PointF GetEndPoint() const;
3707 void SetEndPoint(const PointF& point);
3708
3715 bool HasCaption() const;
3727 void EnableCaption(bool cap);
3728
3739 CapPos GetCaptionPositionType() const;
3754 void SetCaptionPositionType(CapPos cap_position);
3766 Offset GetCaptionOffset() const;
3781 void SetCaptionOffset(const Offset& offset);
3782
3795 float GetLeaderLineLength() const;
3811 void SetLeaderLineLength(float length);
3820 float GetLeaderLineExtensionLength() const;
3832 void SetLeaderLineExtensionLength(float extension_length);
3833
3842 float GetLeaderLineOffset() const;
3854 void SetLeaderLineOffset(float offset);
3855
3868 void SetMeasureRatio(const String& ratio);
3869
3879 String GetMeasureRatio();
3880
3890 WString GetMeasureRatioW();
3891
3904 void SetMeasureUnit(MeasureType measure_type, const String& unit);
3905
3917 String GetMeasureUnit(MeasureType measure_type);
3918
3930 WString GetMeasureUnitW(MeasureType measure_type);
3931
3944 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3945
3957 float GetMeasureConversionFactor(MeasureType measure_type);
3958 };
3959
3976 class Ink FS_FINAL : public Markup {
3977 public:
3979 Ink() {}
3985 explicit Ink(const Annot& annot);
3987 ~Ink() {}
4013 common::Path GetInkList();
4014
4045 void SetInkList(const common::Path& ink_list);
4046
4058 void EnableUseBezier(bool use_bezier);
4059
4060 };
4061
4086 class Stamp FS_FINAL : public Markup {
4087 public:
4089 Stamp() {}
4095 explicit Stamp(const Annot& annot);
4096 #ifndef __EMSCRIPTEN_RENDER__
4097
4098 ~Stamp();
4099 #endif
4100
4111 String GetIconName() const;
4135 void SetIconName(const char* icon_name);
4146 void SetBitmap(const common::Bitmap& bitmap);
4147
4169 void SetImage(const common::Image& image, int frame_index, int compress);
4170
4181 void SetRotation(int angle);
4182
4188 int GetRotation();
4189
4199 void Rotate(int angle);
4200 };
4201
4213 class Screen FS_FINAL : public Annot {
4214 public:
4216 Screen() {}
4222 explicit Screen(const Annot& annot);
4224 virtual ~Screen() {}
4225
4247 void SetImage(const common::Image& image, int frame_index, int compress);
4248
4255 common::Bitmap GetBitmap();
4256
4267 pdf::objects::PDFDictionary* GetMKDict() const;
4268
4275 void SetMKDict(pdf::objects::PDFDictionary* dict);
4276
4288 void SetRotation(common::Rotation rotate);
4289
4296 common::Rotation GetRotation();
4297
4306 float GetOpacity() const;
4318 void SetOpacity(float opacity);
4319
4325 WString GetTitle() const;
4333 void SetTitle(const WString& title);
4334
4344 actions::Action GetAction();
4368 void SetAction(const actions::Action& action);
4377 void RemoveAction();
4378 };
4379
4397 class Polygon FS_FINAL : public Markup {
4398 public:
4400 Polygon() {}
4406 explicit Polygon(const Annot& annot);
4408 ~Polygon() {}
4417 RGB GetFillColor() const;
4418
4429 void SetFillColor(RGB fill_color);
4430
4439 PointFArray GetVertexes();
4440
4452 void SetVertexes(const PointFArray& vertexes);
4453
4466 void SetMeasureRatio(const String& ratio);
4467
4477 String GetMeasureRatio();
4478
4488 WString GetMeasureRatioW();
4489
4502 void SetMeasureUnit(MeasureType measure_type, const String& unit);
4503
4515 String GetMeasureUnit(MeasureType measure_type);
4516
4528 WString GetMeasureUnitW(MeasureType measure_type);
4529
4542 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4543
4555 float GetMeasureConversionFactor(MeasureType measure_type);
4556 };
4557
4576 class PolyLine FS_FINAL : public Markup {
4577 public:
4579 PolyLine() {}
4585 explicit PolyLine(const Annot& annot);
4587 ~PolyLine() {}
4597 RGB GetStyleFillColor() const;
4608 void SetStyleFillColor(RGB fill_color);
4609
4618 PointFArray GetVertexes();
4619
4631 void SetVertexes(const PointFArray& vertexes);
4640 EndingStyle GetLineStartStyle() const;
4653 void SetLineStartStyle(EndingStyle starting_style);
4662 EndingStyle GetLineEndStyle() const;
4675 void SetLineEndStyle(EndingStyle ending_style);
4676
4689 void SetMeasureRatio(const String& ratio);
4690
4700 String GetMeasureRatio();
4701
4711 WString GetMeasureRatioW();
4712
4725 void SetMeasureUnit(MeasureType measure_type, const String& unit);
4726
4738 String GetMeasureUnit(MeasureType measure_type);
4739
4751 WString GetMeasureUnitW(MeasureType measure_type);
4752
4765 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4766
4778 float GetMeasureConversionFactor(MeasureType measure_type);
4779 };
4780
4793 class Caret FS_FINAL : public Markup {
4794 public:
4796 Caret() {}
4802 explicit Caret(const Annot& annot);
4804 ~Caret() {}
4805
4815 RectF GetInnerRect() const;
4829 void SetInnerRect(const RectF& inner_rect);
4830 };
4831
4844 class FileAttachment FS_FINAL : public Markup {
4845 public:
4847 FileAttachment() {}
4853 explicit FileAttachment(const Annot& annot);
4855 ~FileAttachment() {}
4856
4864 bool SetFileSpec(const FileSpec& file_spec);
4865
4872 FileSpec GetFileSpec();
4873
4884 String GetIconName() const;
4885
4901 void SetIconName(const char* icon_name);
4902 };
4903
4913 class Popup FS_FINAL : public Annot {
4914 public:
4916 Popup() {}
4922 explicit Popup(const Annot& annot);
4923 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
4924 explicit Popup(FS_HANDLE handle);
4926 ~Popup() {}
4927
4939 bool GetOpenStatus() const;
4953 void SetOpenStatus(bool status);
4954
4962 Markup GetParent();
4963 };
4964 #ifndef __FSDK_NO_PSINK__
4965
4984 class PSInk FS_FINAL : public Annot {
4985 public:
4987 PSInk() {}
4993 explicit PSInk(const Annot& annot);
4994 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
4995 explicit PSInk(FS_HANDLE handle);
4997 ~PSInk() {}
4998
4999 };
5000 #endif
5001
5014 class Widget FS_FINAL : public Annot {
5015 public:
5021 typedef enum _LineSpacingStyle {
5023 e_LineSpacingSingle = 0,
5025 e_LineSpacingOneAndHalf = 1,
5027 e_LineSpacingDouble = 2,
5029 e_LineSpacingExactValue = 3,
5031 e_LineSpacingAuto = 4
5032 } LineSpacingStyle;
5033
5034
5036 Widget() {}
5042 explicit Widget(const Annot& annot);
5043 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
5044 explicit Widget(FS_HANDLE handle);
5045 #ifndef __EMSCRIPTEN_RENDER__
5046
5047 ~Widget();
5048 #endif
5049
5054 interform::Field GetField();
5055
5061 interform::Control GetControl();
5062
5071 HighlightingMode GetHighlightingMode();
5072
5083 void SetHighlightingMode(HighlightingMode mode);
5084
5094 actions::Action GetAction();
5095
5119 void SetAction(const actions::Action& action);
5120
5129 void RemoveAction();
5130
5142 bool HasMKEntry(MKEntry mk_entry);
5143
5155 void RemoveMKEntry(MKEntry mk_entry);
5156
5168 common::Rotation GetMKRotation() const;
5169
5181 void SetMKRotation(common::Rotation rotation);
5182
5193 RGB GetMKBorderColor() const;
5194
5205 void SetMKBorderColor(RGB color);
5206
5217 RGB GetMKBackgroundColor() const;
5218
5229 void SetMKBackgroundColor(RGB color);
5230
5244 WString GetMKNormalCaption() const;
5245
5259 void SetMKNormalCaption(const wchar_t* caption);
5260
5275 WString GetMKRolloverCaption() const;
5276
5291 void SetMKRolloverCaption(const wchar_t* caption);
5292
5305 WString GetMKDownCaption() const;
5306
5319 void SetMKDownCaption(const wchar_t* caption);
5320
5332 common::Bitmap GetMKNormalIconBitmap();
5333
5346 void SetMKNormalIconBitmap(const common::Bitmap& bitmap);
5347
5362 void SetMKNormalIconImage(const common::Image& image, int frame_index);
5363
5376 common::Bitmap GetMKRolloverIconBitmap();
5377
5391 void SetMKRolloverIconBitmap(const common::Bitmap& bitmap);
5392
5408 void SetMKRolloverIconImage(const common::Image& image, int frame_index);
5409
5422 common::Bitmap GetMKDownIconBitmap();
5423
5437 void SetMKDownIconBitmap(const common::Bitmap& bitmap);
5438
5454 void SetMKDownIconImage(const common::Image& image, int frame_index);
5455
5470 IconFit GetMKIconFit() const;
5471
5489 void SetMKIconFit(const IconFit& icon_fit);
5490
5503 MKIconCaptionRelation GetMKIconCaptionRelation() const;
5504
5519 void SetMKIconCaptionRelation(MKIconCaptionRelation relation);
5520
5528 void SetAppearanceState(const String& appearance_state);
5529
5535 String GetAppearanceState() const;
5536
5542 String GetAppearanceOnStateName() const;
5543
5555 LineSpacingStyle GetLineSpacing(float& line_spacing_value);
5556
5572 void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value);
5573
5574 #ifdef _SUPPORTWEBSDK_
5575 //Set push button icon form icon stream. stream is from doc::createIcon.
5576 //face: 0: normal, 1: down, 2: roller
5577 void SetButtonIcon(objects::PDFStream* icon, int face);
5578 #endif
5579 };
5580
5596 class Redact FS_FINAL : public Markup {
5597 public:
5599 Redact() {}
5605 explicit Redact(const Annot& annot);
5606 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
5607 explicit Redact(FS_HANDLE handle);
5608 #ifndef __EMSCRIPTEN_RENDER__
5609
5610 ~Redact();
5611 #endif
5612
5625 QuadPointsArray GetQuadPoints() const;
5626
5644 void SetQuadPoints(const QuadPointsArray& quad_points_array);
5645
5652 RGB GetFillColor() const;
5660 void SetFillColor(RGB fill_color);
5661
5668 RGB GetApplyFillColor() const;
5669
5677 void SetApplyFillColor(RGB fill_color);
5678
5684 WString GetOverlayText() const;
5685
5693 void SetOverlayText(const WString& overlay_text);
5694
5700 bool IsOverlayTextRepeated();
5701
5710 void EnableRepeatOverlayText(bool is_to_repeat_overlay_text);
5711
5720 common::Alignment GetOverlayTextAlignment() const;
5721
5734 void SetOverlayTextAlignment(common::Alignment alignment);
5735
5741 void EnableAutoFontSize();
5742
5751 DefaultAppearance GetDefaultAppearance();
5752
5775 bool SetDefaultAppearance(const DefaultAppearance& default_ap);
5776
5788 bool Apply();
5789 };
5790
5800 class Sound FS_FINAL : public Markup{
5801 public:
5807 typedef enum _SampleEncodingFormat {
5809 e_SampleEncodingFormatRaw = 0,
5811 e_SampleEncodingFormatSigned = 1,
5813 e_SampleEncodingFormatMuLaw = 2,
5815 e_SampleEncodingFormatALaw = 3
5816 } SampleEncodingFormat;
5817
5818
5820 Sound() {}
5821
5827 explicit Sound(const Annot& annot);
5828
5829 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
5830 explicit Sound(FS_HANDLE handle);
5831
5832 #ifndef __EMSCRIPTEN_RENDER__
5833
5834 ~Sound();
5835 #endif
5836
5847 objects::PDFStream* GetSoundStream() const;
5848
5854 float GetSamplingRate() const;
5855
5861 int GetChannelCount() const;
5862
5868 int GetBits() const;
5869
5876 SampleEncodingFormat GetSampleEncodingFormat() const;
5877
5883 String GetCompressionFormat() const;
5884
5898 FileSpec GetFileSpec() const;
5899 };
5900
5916 class PagingSeal FS_FINAL : public Annot {
5917 public:
5919 PagingSeal(const Annot& annot);
5920
5922 ~PagingSeal();
5923
5929 PagingSealSignature GetPagingSealSignature();
5930
5931 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
5932 explicit PagingSeal(FS_HANDLE handle);
5933 };
5934
5935 } // namespace annots
5936 } // namespace pdf
5937 } // namespace foxit
5938
5939 #endif // FS_ANNOT_H_
5940
foxit::pdf::annots::BorderInfo::dashes
FloatArray dashes
表示虚线模式的虚线数组。
Definition: fs_annot.h:648
foxit::pdf::annots::Annot::e_FlagReadOnly
注释标志：只读。
Definition: fs_annot.h:1080
foxit::pdf::annots::Polygon::SetFillColor
void SetFillColor(RGB fill_color)
设置填充颜色。
foxit::pdf::annots::IconProviderCallback
Definition: fs_annot.h:1677
foxit::pdf::annots::Annot::GetUniqueID
WString GetUniqueID() const
获取唯一ID。
foxit::pdf::annots::Note::GetStateModel
StateModel GetStateModel()
获取状态模型。
foxit::pdf::RichTextStyle::text_alignment
common::Alignment text_alignment
对齐值。请参考从common::e_AlignmentLeft开始的值， 这应该是这些值中的一个。
Definition: fs_annot.h:391
foxit::pdf::annots::Annot::e_MKEntryRolloverCaption
悬停标题条目。MK字典中的"RC"。
Definition: fs_annot.h:1167
foxit::pdf::annots::Line::~Line
~Line()
析构函数。
Definition: fs_annot.h:3591
foxit::pdf::annots::Square::Square
Square()
构造函数。
Definition: fs_annot.h:2914
foxit::pdf::annots::PolyLine::SetStyleFillColor
void SetStyleFillColor(RGB fill_color)
设置某些线端样式的填充颜色。
foxit::pdf::annots::Annot::GetDeviceRect
RectI GetDeviceRect(const Matrix &matrix)
获取设备坐标系统中的注释矩形。
foxit::pdf::annots::FreeText::~FreeText
~FreeText()
Destructor.
Definition: fs_annot.h:3275
foxit::pdf::annots::IconFit::IconFit
IconFit()
构造函数
Definition: fs_annot.h:785
foxit::pdf::annots::Annot::SetBorderColor
void SetBorderColor(RGB color)
设置边框颜色。
foxit::pdf::objects::PDFStream
Definition: fs_pdfobject.h:448
foxit::pdf::annots::PolyLine::GetVertexes
PointFArray GetVertexes()
获取顶点。
foxit::pdf::annots::Widget::GetMKIconFit
IconFit GetMKIconFit() const
获取MK字典中的图标适合信息。
foxit::pdf::RichTextStyle::operator==
bool operator==(const RichTextStyle &style) const
等于运算符。
Definition: fs_annot.h:310
foxit::pdf::annots::Widget::GetMKNormalCaption
WString GetMKNormalCaption() const
获取 MK 字典中的普通标题字符串。
foxit::pdf::annots::Widget::~Widget
~Widget()
析构函数。
foxit::pdf::annots::Markup::State
State
标记注释状态的枚举。
Definition: fs_annot.h:1837
foxit::pdf::annots::ShadingColor
Definition: fs_annot.h:1589
foxit::pdf::annots::TextMarkup
Definition: fs_annot.h:2614
foxit::pdf::annots::Underline
Definition: fs_annot.h:2705
foxit::pdf::annots::Popup::~Popup
~Popup()
析构函数。
Definition: fs_annot.h:4926
foxit::pdf::annots::Widget::e_LineSpacingAuto
行间距样式：自动行间距。
Definition: fs_annot.h:5031
foxit::pdf::annots::Widget::GetAppearanceState
String GetAppearanceState() const
获取注释的外观状态，从外观子字典中选择适用的外观流。
foxit::pdf::annots::Screen
Definition: fs_annot.h:4213
foxit::pdf::annots::Redact::Redact
Redact()
构造函数。
Definition: fs_annot.h:5599
foxit::pdf::RichTextStyle
Definition: fs_annot.h:201
foxit::pdf::annots::Redact::GetDefaultAppearance
DefaultAppearance GetDefaultAppearance()
获取默认外观数据。
foxit::pdf::annots::FreeText::GetCalloutLinePoints
PointFArray GetCalloutLinePoints() const
获取标注线点。
foxit::pdf::annots::QuadPoints::Set
void Set(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
设置值。
Definition: fs_annot.h:741
foxit::pdf::annots::IconProviderCallback::GetIcon
virtual PDFPage GetIcon(Annot::Type annot_type, const char *icon_name, ARGB color, foxit::pdf::objects::PDFDictionary *annot_dict)
用于获取指定类型图标作为PDF页面内容的回调函数。
foxit::pdf::annots::Annot::HasProperty
bool HasProperty(Property property) const
当前注释是否具有指定的注释属性。
foxit::common::Bitmap
Definition: fs_image.h:36
foxit::pdf::annots::Annot::MKIconCaptionRelation
MKIconCaptionRelation
注释MK字典中图标和标题相对位置的枚举。
Definition: fs_annot.h:1206
foxit::pdf::annots::Annot::e_Squiggly
注释类型：波浪线注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:984
foxit::pdf::annots::Annot::e_FlagNoView
注释标志：无视图。
Definition: fs_annot.h:1071
foxit::pdf::annots::Circle::GetInnerRect
RectF GetInnerRect() const
获取内部矩形。
foxit::pdf::annots::Line::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
设置用于测量的转换因子。
foxit::pdf::annots::FileAttachment
Definition: fs_annot.h:4844
foxit::pdf::annots::Markup::Markup
Markup()
构造函数
Definition: fs_annot.h:1946
foxit::pdf::annots::Annot::GetPage
PDFPage GetPage() const
获取相关的PDF页面。
foxit::pdf::annots::Annot::GetContent
WString GetContent() const
获取内容。
foxit::pdf::annots::Sound::e_SampleEncodingFormatSigned
二进制补码值。
Definition: fs_annot.h:5811
foxit::pdf::annots::Annot::e_FileAttachment
注释类型：文件附件注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:996
foxit::pdf::annots::Annot::Annot
Annot()
构造函数。
Definition: fs_annot.h:1257
foxit::pdf::annots::Redact::~Redact
~Redact()
析构函数。
foxit::pdf::annots::TextMarkup::GetQuadPoints
QuadPointsArray GetQuadPoints() const
获取四边形。
foxit::pdf::annots::Sound::e_SampleEncodingFormatRaw
未指定或0到(2^B - 1)范围内的无符号值。
Definition: fs_annot.h:5809
foxit::pdf::annots::Widget::SetAppearanceState
void SetAppearanceState(const String &appearance_state)
设置注释的外观状态，从外观子字典中选择适用的外观流。
foxit::pdf::annots::Redact::SetQuadPoints
void SetQuadPoints(const QuadPointsArray &quad_points_array)
设置四边形。
foxit::pdf::annots::Note::IsStateAnnot
bool IsStateAnnot()
检查当前注记注释是否用作状态注释。
foxit::pdf::annots::Annot::e_MKEntryDownIcon
按下图标（或备用图标）条目。MK字典中的"IX"。
Definition: fs_annot.h:1187
foxit::pdf::annots::Note::GetReplyTo
Markup GetReplyTo()
获取当前注记注释回复的标记注释。
foxit::pdf::annots::BorderInfo::width
float width
边框宽度，以点为单位。
Definition: fs_annot.h:616
foxit::pdf::annots::Annot::e_FreeText
注释类型：自由文本注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:968
foxit::pdf::annots::Note::GetState
State GetState()
获取状态。
foxit::pdf::annots::StrikeOut::StrikeOut
StrikeOut()
构造函数。
Definition: fs_annot.h:2736
foxit::Object
CFX_Object Object
对象类型。
Definition: fs_basictypes.h:220
foxit::pdf::annots::Annot::e_Popup
注释类型：弹出注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1017
foxit::pdf::annots::FreeText::GetRotation
common::Rotation GetRotation()
获取当前旋转值（顺时针）。
foxit::pdf::annots::PolyLine::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
设置用于测量的单位显示标签。
foxit::pdf::annots::PolyLine::PolyLine
PolyLine()
构造函数。
Definition: fs_annot.h:4579
foxit::pdf::annots::ShadingColor::first_color
ARGB first_color
用于着色的第一种颜色。格式：0xAARRGGBB。
Definition: fs_annot.h:1664
foxit::pdf::annots::Widget::GetAction
actions::Action GetAction()
获取动作。
foxit::pdf::annots::PolyLine::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
获取用于测量的转换因子。
foxit::pdf::annots::Annot::SetFlags
void SetFlags(uint32 flags)
设置注释标志。
foxit::pdf::annots::Widget::GetAppearanceOnStateName
String GetAppearanceOnStateName() const
获取注释外观"ON"状态的名称。
foxit::pdf::annots::AnnotArray
Definition: fs_annot.h:1586
foxit::pdf::annots::Redact::SetOverlayText
void SetOverlayText(const WString &overlay_text)
设置覆盖文本。
foxit::pdf::annots::Screen::Screen
Screen()
构造函数。
Definition: fs_annot.h:4216
foxit::pdf::annots::Sound::Sound
Sound()
构造函数。
Definition: fs_annot.h:5820
foxit::pdf::annots::IconFit::IconFit
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
构造函数，带参数。
Definition: fs_annot.h:803
foxit::pdf::annots::Line::HasCaption
bool HasCaption() const
检查当前直线注释的内容是否应该在外观中复制为标题。
foxit::pdf::annots::Link::ExecuteJavaScriptAction
bool ExecuteJavaScriptAction(const actions::JavaScriptAction &javascript_action=actions::JavaScriptAction((FS_HANDLE) 0))
执行与链接注释关联的 JavaScript 动作。
foxit::pdf::annots::Annot::e_MKEntryIconCaptionRelation
图标和标题关系条目。MK字典中的"TP"。
Definition: fs_annot.h:1198
foxit::pdf::annots::Line::GetLeaderLineOffset
float GetLeaderLineOffset() const
获取引导线偏移的长度。
foxit::pdf::annots::Widget::SetMKRolloverIconBitmap
void SetMKRolloverIconBitmap(const common::Bitmap &bitmap)
设置MK字典中的翻转图标位图。
foxit::pdf::annots::Square::SetFillColor
void SetFillColor(RGB fill_color)
设置填充颜色。
foxit::pdf::annots::Square::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const char *unit)
设置用于显示测量单位的标签。
foxit::pdf::RichTextStyle::e_CornerMarkSuperscript
角标样式：上标。
Definition: fs_annot.h:212
foxit::pdf::annots::IconFit
Definition: fs_annot.h:764
foxit::pdf::annots::Popup::GetParent
Markup GetParent()
获取相关的父标记注释。
foxit::pdf::annots::Widget::SetMKNormalIconImage
void SetMKNormalIconImage(const common::Image &image, int frame_index)
设置指定帧索引的图像作为 MK 字典中的普通图标。
foxit::pdf::annots::Widget::GetHighlightingMode
HighlightingMode GetHighlightingMode()
获取高亮模式。
foxit::pdf::annots::Annot::e_FlagPrint
注释标志：打印。
Definition: fs_annot.h:1050
foxit::DateTime
Definition: fs_basictypes.h:498
foxit::pdf::annots::Annot::GetBorderInfo
BorderInfo GetBorderInfo() const
获取边框信息。
foxit::pdf::annots::Redact::GetApplyFillColor
RGB GetApplyFillColor() const
获取用于翻转外观的填充颜色，将在应用编辑后使用。
foxit::pdf::RichTextStyle::word_space
float word_space
单词间距。对于表格生成器不应为负值。仅在pdf::PDFPage::AddText中使用。
Definition: fs_annot.h:432
foxit::pdf::RichTextStyle::font
common::Font font
富文本样式中使用的字体。应该是有效的字体对象。
Definition: fs_annot.h:380
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo(const BorderInfo &border_info)
拷贝构造函数。
Definition: fs_annot.h:527
foxit::pdf::RichTextStyle::RichTextStyle
RichTextStyle()
构造函数。
Definition: fs_annot.h:251
foxit::pdf::annots::BorderInfo
Definition: fs_annot.h:440
foxit::pdf::annots::BorderInfo::Style
Style
PDF注释边框样式的枚举。
Definition: fs_annot.h:447
foxit::pdf::annots::Widget::HasMKEntry
bool HasMKEntry(MKEntry mk_entry)
检查在 MK 字典中是否存在指定的条目。
foxit::pdf::annots::Highlight::~Highlight
~Highlight()
Destructor.
Definition: fs_annot.h:2688
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)
用于获取着色颜色的回调函数（如果当前图标提供程序支持指定类型）。 目前，仅支持具有两个颜色值的Type-2着色设置。
Definition: fs_annot.h:1758
foxit::pdf::annots::IconProviderCallback::GetProviderVersion
virtual String GetProviderVersion()
用于获取提供程序版本的回调函数。
Definition: fs_annot.h:1704
foxit::pdf::annots::Square
Definition: fs_annot.h:2911
foxit::pdf::annots::Annot::e_MKRelationNoCaption
无标题；仅图标。
Definition: fs_annot.h:1210
foxit::pdf::annots::Circle::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
设置用于测量的转换因子。
foxit::RGB
uint32 RGB
RGB 颜色类型，24 位，((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:211
foxit::pdf::annots::FreeText::SetTextMatrix
void SetTextMatrix(const Matrix &text_matrix)
为当前自由文本注释中的文本设置默认外观数据中的矩阵。
CFX_PSVTemplate
Definition: fx_coordinates.h:30
foxit::pdf::annots::Redact::IsOverlayTextRepeated
bool IsOverlayTextRepeated()
检查覆盖文本是否重复。
foxit::pdf::annots::Redact::EnableRepeatOverlayText
void EnableRepeatOverlayText(bool is_to_repeat_overlay_text)
设置标志以决定是否重复覆盖文本。
foxit::pdf::annots::Stamp::GetRotation
int GetRotation()
获取当前旋转角度（顺时针方向）。
foxit::pdf::annots::PolyLine::SetLineStartStyle
void SetLineStartStyle(EndingStyle starting_style)
设置起始点的线端样式。
foxit::pdf::annots::Widget::SetMKRolloverIconImage
void SetMKRolloverIconImage(const common::Image &image, int frame_index)
设置指定帧索引的图像作为MK字典中的翻转图标。
foxit::pdf::annots::Markup::MeasureType
MeasureType
注释测量类型的枚举。
Definition: fs_annot.h:1921
foxit::pdf::annots::Annot::e_UnknownType
注释类型：未知。
Definition: fs_annot.h:959
foxit::pdf::annots::Annot::e_MKRelationCaptionAboveIcon
标题在图标上方。
Definition: fs_annot.h:1214
foxit::pdf::annots::FreeText::GetDefaultAppearance
DefaultAppearance GetDefaultAppearance()
获取默认外观数据。
foxit::pdf::annots::PagingSeal::PagingSeal
PagingSeal(const Annot &annot)
构造函数。
foxit::pdf::annots::Annot::Type
Type
PDF注释类型的枚举。
Definition: fs_annot.h:957
foxit::pdf::annots::Annot::e_Redact
注释类型：编辑注释。
Definition: fs_annot.h:1019
foxit::pdf::annots::Note::SetIconName
void SetIconName(const char *icon_name)
设置图标名称。
foxit::pdf::annots::Markup
Definition: fs_annot.h:1818
CFX_ArrayTemplate::GetSize
int GetSize() const
获取数组中元素的数量。
Definition: fx_basic.h:1341
foxit::pdf::annots::Stamp::SetIconName
void SetIconName(const char *icon_name)
设置图标名称。
foxit::pdf::annots::Annot::e_AppearanceTypeNormal
注释的正常外观。
Definition: fs_annot.h:1230
foxit::pdf::annots::Link::SetHighlightingMode
void SetHighlightingMode(HighlightingMode mode)
设置高亮模式。
foxit::pdf::annots::QuadPointsArray
Definition: fs_annot.h:759
foxit::pdf::annots::Annot::Flags
Flags
PDF注释标志的枚举。
Definition: fs_annot.h:1031
fs_file.h
文件操作相关定义和函数的头文件。
foxit::pdf::annots::Annot::GetAppearanceStream
objects::PDFStream * GetAppearanceStream(AppearanceType type, const char *appearance_state="") const
获取具有指定类型和状态的注释外观流。
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance(const DefaultAppearance &default_appearance)
构造函数，使用另一个默认外观对象。
Definition: fs_annot.h:97
foxit::pdf::annots::FreeText::SetCalloutLineEndingStyle
void SetCalloutLineEndingStyle(EndingStyle ending_style)
设置标注线起点的线条结束样式。
foxit::pdf::annots::Line::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
获取用于测量的转换因子。
foxit::pdf::annots::Line::EnableCaption
void EnableCaption(bool cap)
设置用于决定当前直线注释的内容是否应该在外观中复制为标题的标志。
foxit::pdf::annots::Sound::GetSoundStream
objects::PDFStream * GetSoundStream() const
获取声音数据的流。
foxit::pdf::DefaultAppearance
Definition: fs_annot.h:50
foxit::pdf::annots::Annot::e_Square
注释类型：矩形注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:972
foxit::pdf::annots::BorderInfo::cloud_intensity
float cloud_intensity
云状效果的强度。
Definition: fs_annot.h:633
foxit::pdf::annots::Caret::~Caret
~Caret()
析构函数。
Definition: fs_annot.h:4804
foxit::pdf::annots::Polygon::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
设置用于测量的转换因子。
foxit::pdf::annots::Square::SetMeasureRatio
void SetMeasureRatio(const char *ratio)
设置用于测量的比例比率字符串。
foxit::pdf::annots::Line::GetStyleFillColor
RGB GetStyleFillColor() const
Get fill color for ending styles.
foxit::pdf::annots::PolyLine::GetLineEndStyle
EndingStyle GetLineEndStyle() const
获取终点的线端样式。
foxit::pdf::annots::Ink::SetInkList
void SetInkList(const common::Path &ink_list)
设置墨迹列表数据。
foxit::pdf::annots::FreeText::SetFillColor
void SetFillColor(RGB fill_color)
设置填充颜色。
foxit::pdf::annots::Widget::SetHighlightingMode
void SetHighlightingMode(HighlightingMode mode)
设置高亮模式。
foxit::pdf::annots::FreeText::GetInnerRect
RectF GetInnerRect() const
获取内部矩形。
foxit::pdf::annots::Underline::Underline
Underline()
构造函数。
Definition: fs_annot.h:2708
foxit::pdf::annots::Widget::SetMKIconCaptionRelation
void SetMKIconCaptionRelation(MKIconCaptionRelation relation)
设置MK字典中图标和标题的关系。
foxit::pdf::annots::Annot::e_PropertyCreationDate
注释属性：创建日期。
Definition: fs_annot.h:1131
foxit::pdf::annots::BorderInfo::Set
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
设置边框信息。
Definition: fs_annot.h:603
foxit::pdf::annots::Polygon::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
获取用于测量的单位显示标签（Unicode字符串格式）。
foxit::pdf::annots::Screen::SetMKDict
void SetMKDict(pdf::objects::PDFDictionary *dict)
设置外观特征字典（也称为"MK"字典）。
foxit::pdf::annots::Widget
Definition: fs_annot.h:5014
foxit::pdf::annots::Redact::GetFillColor
RGB GetFillColor() const
获取填充颜色。
foxit::pdf::annots::Polygon
Definition: fs_annot.h:4397
CFX_WideString
宽字符串类
Definition: fx_string.h:1457
foxit::pdf::RichTextStyle::e_CornerMarkSubscript
角标样式：下标。
Definition: fs_annot.h:214
foxit::pdf::annots::Popup::SetOpenStatus
void SetOpenStatus(bool status)
设置打开状态。
foxit::pdf::annots::Note
Definition: fs_annot.h:2464
foxit::pdf::annots::FreeText::SetAlignment
void SetAlignment(common::Alignment alignment)
设置对齐值
foxit::pdf::annots::Annot::e_Movie
注释类型：电影注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1000
foxit::pdf::annots::Annot::e_PropertyModifiedDate
注释属性：修改日期。
Definition: fs_annot.h:1126
foxit::pdf::annots::Screen::GetAction
actions::Action GetAction()
获取动作。
foxit::pdf::annots::Annot::GetModifiedDateTime
DateTime GetModifiedDateTime() const
获取最后修改日期时间。
foxit::pdf::annots::Link::~Link
~Link()
析构函数。
Definition: fs_annot.h:2801
foxit::pdf::annots::Annot::e_MKEntryNormalIcon
正常图标条目。MK字典中的"I"。
Definition: fs_annot.h:1177
foxit::pdf::annots::Line::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
获取用于测量的单位显示标签（Unicode字符串格式）。
foxit::pdf::annots::Annot::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::pdf::annots::Screen::~Screen
virtual ~Screen()
析构函数。
Definition: fs_annot.h:4224
foxit::pdf::annots::FileAttachment::SetIconName
void SetIconName(const char *icon_name)
设置图标名称。
foxit::pdf::annots::Link
Definition: fs_annot.h:2788
foxit::pdf::annots::Annot::e_MKRelationCaptionBelowIcon
标题在图标下方。
Definition: fs_annot.h:1212
foxit::pdf::RichTextStyle::is_italic
bool is_italic
指示是否将文本设为斜体的布尔值。
Definition: fs_annot.h:406
foxit::pdf::annots::PolyLine::GetStyleFillColor
RGB GetStyleFillColor() const
获取某些线端样式的填充颜色。
foxit::pdf::annots::Caret::GetInnerRect
RectF GetInnerRect() const
获取内矩形。
foxit::pdf::annots::Redact::EnableAutoFontSize
void EnableAutoFontSize()
为覆盖文本启用自动字体大小。
foxit::pdf::annots::Circle::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
获取用于测量的转换因子。
foxit::pdf::annots::Redact::Apply
bool Apply()
应用当前编辑注释：永久移除注释矩形下的文本、图形和注释。
foxit::pdf::annots::BorderInfo::operator==
bool operator==(const BorderInfo &border_info) const
相等操作符。
Definition: fs_annot.h:558
foxit::pdf::annots::FileAttachment::GetFileSpec
FileSpec GetFileSpec()
获取文件规范。
foxit::pdf::annots::Annot::e_FlagNoRotate
注释标志：无旋转。
Definition: fs_annot.h:1064
foxit::pdf::annots::Line::SetLineEndStyle
void SetLineEndStyle(EndingStyle ending_style)
设置终点的线条结束样式。
foxit::pdf::annots::Sound::GetSampleEncodingFormat
SampleEncodingFormat GetSampleEncodingFormat() const
获取采样数据的编码格式。
foxit::pdf::annots::Sound::GetSamplingRate
float GetSamplingRate() const
获取采样率，以每秒采样数为单位。
foxit::pdf::annots::Circle::GetFillColor
RGB GetFillColor() const
获取填充颜色。
foxit::pdf::annots::PolyLine::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
获取用于显示测量单位的标签。
foxit::pdf::annots::FreeText::GetFillColor
RGB GetFillColor() const
获取填充颜色。
foxit::pdf::annots::Annot::e_Screen
注释类型：屏幕注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1007
foxit::pdf::annots::QuadPoints::operator==
bool operator==(const QuadPoints &quad_points) const
等于操作符。
Definition: fs_annot.h:714
foxit::pdf::annots::Line::SetEndPoint
void SetEndPoint(const PointF &point)
设置终点。
foxit::pdf::annots::Widget::GetMKBackgroundColor
RGB GetMKBackgroundColor() const
获取 MK 字典中的背景颜色。
foxit::pdf::annots::Annot::GetOptionalContent
objects::PDFDictionary * GetOptionalContent() const
获取注释可选内容的PDF字典。
foxit::pdf::annots::Annot::IsMarkup
bool IsMarkup() const
检查当前注释是否为标记注释。
foxit::pdf::RichTextStyle::RichTextStyle
RichTextStyle(const RichTextStyle &style)
构造函数，使用另一个样式对象。
Definition: fs_annot.h:268
foxit::pdf::annots::StrikeOut::~StrikeOut
~StrikeOut()
析构函数。
Definition: fs_annot.h:2744
foxit::pdf::annots::IconFit::scale_way_type
ScaleWayType scale_way_type
指定图标在注释矩形内缩放的情形。请参考 IconFit::e_ScaleWayNone 及相关值。 当用于设置时，该值不应为 IconFit::e_ScaleWayNone。
Definition: fs_annot.h:895
foxit::pdf::annots::PolyLine::~PolyLine
~PolyLine()
析构函数。
Definition: fs_annot.h:4587
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance()
构造函数。
Definition: fs_annot.h:87
foxit::pdf::annots::Annot::e_PropertyFillColor
注释属性：填充颜色
Definition: fs_annot.h:1143
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
构造函数，带参数。
Definition: fs_annot.h:80
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor(const ShadingColor &shading_color)
拷贝构造函数。
Definition: fs_annot.h:1611
foxit::pdf::annots::Annot::e_PropertyBorderColor
注释属性：边框颜色。
Definition: fs_annot.h:1137
foxit::pdf::annots::Widget::Widget
Widget()
构造函数。
Definition: fs_annot.h:5036
foxit::pdf::annots::IconFit::vertical_fraction
float vertical_fraction
如果图标等比缩放，分配给图标左侧和底部的剩余空间的垂直比例。有效范围：0.0 到 1.0。
Definition: fs_annot.h:909
foxit::pdf::annots::Screen::SetAction
void SetAction(const actions::Action &action)
设置动作。
foxit::pdf::annots::PolyLine::GetMeasureRatioW
WString GetMeasureRatioW()
获取用于测量的比例比率字符串。
foxit::pdf::interform::Control
Definition: fs_pdfform.h:1217
foxit::pdf::annots::Highlight::Highlight
Highlight()
构造函数。
Definition: fs_annot.h:2680
foxit::pdf::annots::IconFit::horizontal_fraction
float horizontal_fraction
如果图标等比缩放，分配给图标左侧和底部的剩余空间的水平比例。有效范围：0.0 到 1.0。
Definition: fs_annot.h:905
foxit::pdf::DefaultAppearance::e_FlagTextColor
指示pdf::DefaultAppearance的文本颜色属性是有意义的。
Definition: fs_annot.h:61
foxit::pdf::annots::Annot::e_FlagToggleNoView
注释标志：切换无视图。
Definition: fs_annot.h:1092
foxit::pdf::annots::Circle::SetFillColor
void SetFillColor(RGB fill_color)
设置填充颜色。
foxit::pdf::annots::Underline::~Underline
~Underline()
析构函数。
Definition: fs_annot.h:2716
foxit::pdf::annots::Stamp
Definition: fs_annot.h:4086
foxit::pdf::annots::Line::e_CapPosInline
Definition: fs_annot.h:3576
foxit::pdf::RichTextStyle::text_color
RGB text_color
文本颜色。格式：0xRRGGBB。
Definition: fs_annot.h:396
fs_image.h
图像和位图相关定义和类的头文件。
foxit::pdf::annots::Stamp::SetBitmap
void SetBitmap(const common::Bitmap &bitmap)
为当前印章注释设置位图。
foxit::pdf::annots::Line::SetLeaderLineLength
void SetLeaderLineLength(float length)
设置引导线的长度。
foxit::pdf::annots::Redact
Definition: fs_annot.h:5596
foxit::pdf::annots::FreeText::FreeText
FreeText()
构造函数。
Definition: fs_annot.h:3266
foxit::pdf::annots::BorderInfo::operator=
BorderInfo & operator=(const BorderInfo &border_info)
赋值操作符。
Definition: fs_annot.h:542
foxit::pdf::annots::IconFit::Set
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
设置值。
Definition: fs_annot.h:882
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor(ARGB firstcolor, ARGB secondcolor)
构造函数，带参数。
Definition: fs_annot.h:1597
foxit::pdf::annots::BorderInfo::e_Solid
边框样式：实线
Definition: fs_annot.h:449
foxit::pdf::annots::Note::~Note
~Note()
析构函数。
Definition: fs_annot.h:2477
foxit::pdf::annots::Annot::e_RichMedia
注释类型：富媒体注释。
Definition: fs_annot.h:1021
foxit::pdf::annots::Annot::GetType
Type GetType() const
获取当前注释的实际注释类型。
foxit::pdf::annots::Line::GetCaptionOffset
Offset GetCaptionOffset() const
获取标题偏移值。
foxit::pdf::annots::Polygon::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
设置用于测量的比例比率字符串。
foxit::pdf::annots::Annot::e_FlagNoZoom
注释标志：无缩放。
Definition: fs_annot.h:1057
foxit::pdf::annots::Annot::e_AppearanceTypeRollover
注释的悬停外观。
Definition: fs_annot.h:1232
foxit::pdf::annots::Link::SetAction
void SetAction(const actions::Action &action)
设置动作。
foxit::pdf::annots::PagingSeal::GetPagingSealSignature
PagingSealSignature GetPagingSealSignature()
获取关联的分页印章签名。
foxit::pdf::annots::IconFit::IconFit
IconFit(const IconFit &icon_fit)
拷贝构造函数。
Definition: fs_annot.h:816
foxit::pdf::annots::Line::GetLeaderLineExtensionLength
float GetLeaderLineExtensionLength() const
获取引导线延伸的长度。
foxit::pdf::annots::Annot::MKEntry
MKEntry
注释MK字典（外观特征）条目的枚举。
Definition: fs_annot.h:1151
operator==
bool operator==(const char *str1, const CFX_ByteString &str2)
检查两个字节字符串是否相等。
Definition: fs_basictypes.h:128
foxit::pdf::RichTextStyle::char_space
float char_space
字符间距。对于表格生成器不应为负值。仅在pdf::PDFPage::AddText中使用。
Definition: fs_annot.h:427
foxit::pdf::annots::Widget::GetMKRotation
common::Rotation GetMKRotation() const
获取 MK 字典中的旋转值。
foxit::pdf::annots::Line::GetMeasureRatio
String GetMeasureRatio()
获取用于测量的比例比率字符串。
foxit::pdf::annots::Circle::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
设置内部矩形。
foxit::pdf::annots::Screen::GetOpacity
float GetOpacity() const
获取不透明度值。
foxit::pdf::annots::Widget::SetLineSpacing
void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value)
设置当前小部件的行间距。
foxit::pdf::annots::PolyLine::GetMeasureRatio
String GetMeasureRatio()
获取用于测量的比例比率字符串。
foxit::pdf::annots::Ink::GetInkList
common::Path GetInkList()
获取墨迹列表数据。
foxit::pdf::annots::Annot::e_AppearanceTypeDown
注释的按下外观。
Definition: fs_annot.h:1234
foxit::pdf::annots::Link::GetAction
actions::Action GetAction()
获取动作。
foxit::pdf::DefaultAppearance::flags
uint32 flags
指示默认外观的哪些属性是有意义的标志。
Definition: fs_annot.h:173
foxit::pdf::annots::ShadingColor::second_color
ARGB second_color
用于着色的第二种颜色。格式：0xAARRGGBB。
Definition: fs_annot.h:1666
foxit::pdf::annots::Sound::e_SampleEncodingFormatMuLaw
μ律编码采样。
Definition: fs_annot.h:5813
foxit::pdf::annots::Line::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
设置用于测量的比例比率字符串。
foxit::pdf::annots::Circle
Definition: fs_annot.h:3082
foxit::pdf::annots::Annot::e_HighlightingInvert
高亮模式：反转，即反转注释矩形的内容。
Definition: fs_annot.h:1110
foxit::pdf::annots::Line::Line
Line()
构造函数。
Definition: fs_annot.h:3583
foxit::pdf::annots::Line::GetEndPoint
PointF GetEndPoint() const
获取终点。
foxit::pdf::annots::Annot::e_Polygon
注释类型：多边形注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:976
foxit::pdf::annots::Widget::SetMKIconFit
void SetMKIconFit(const IconFit &icon_fit)
设置MK字典中的图标适合信息。
foxit::pdf::annots::Annot::GetFlags
uint32 GetFlags() const
获取注释标志。
foxit::pdf::annots::Widget::GetMKDownIconBitmap
common::Bitmap GetMKDownIconBitmap()
获取MK字典中的按下图标位图。
foxit::pdf::annots::BorderInfo::e_Beveled
边框样式：斜面。
Definition: fs_annot.h:469
foxit::pdf::annots::Sound::GetChannelCount
int GetChannelCount() const
获取声音通道数。
foxit::pdf::annots::Circle::Circle
Circle()
构造函数。
Definition: fs_annot.h:3085
foxit::ARGB
uint32 ARGB
ARGB 颜色类型，32 位，((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:209
foxit::pdf::annots::Widget::SetMKBorderColor
void SetMKBorderColor(RGB color)
设置 MK 字典中的边框颜色。
foxit::pdf::PagingSealSignature
Definition: fs_signature.h:2035
foxit::pdf::annots::Annot::e_HighlightingOutline
高亮模式：轮廓，即反转注释的边框。
Definition: fs_annot.h:1112
foxit::pdf::annots::Sound::~Sound
~Sound()
析构函数。
foxit::pdf::DefaultAppearance::font
common::Font font
默认外观的字体。当它有用时，应该是一个有效的字体对象。
Definition: fs_annot.h:180
foxit::pdf::annots::ShadingColor::Set
void Set(ARGB firstcolor, ARGB secondcolor)
设置值。
Definition: fs_annot.h:1658
foxit::pdf::annots::Widget::GetMKIconCaptionRelation
MKIconCaptionRelation GetMKIconCaptionRelation() const
获取MK字典中图标和标题的关系。
foxit::pdf::annots::Screen::GetRotation
common::Rotation GetRotation()
获取用于当前屏幕注释外观的图像旋转。
foxit::pdf::annots::QuadPoints::operator !=
bool operator !=(const QuadPoints &quad_points) const
不等于操作符。
Definition: fs_annot.h:726
foxit::pdf::annots::Polygon::GetMeasureRatioW
WString GetMeasureRatioW()
获取用于测量的比例比率Unicode字符串。
foxit::pdf::annots::Annot::Move
bool Move(const RectF &rect)
将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。
foxit::pdf::annots::Annot::SetContent
void SetContent(const WString &content)
设置内容。
foxit::pdf::annots::FreeText::AllowTextOverflow
void AllowTextOverflow(bool is_text_overflow)
决定是否允许自由文本的文本溢出。
foxit::pdf::annots::Line::GetLineStartStyle
EndingStyle GetLineStartStyle() const
获取起点的线条结束样式。
foxit::pdf::annots::IconFit::is_proportional_scaling
bool is_proportional_scaling
是否使用等比缩放。
Definition: fs_annot.h:901
foxit::pdf::annots::Annot::GetDisplayMatrix
Matrix GetDisplayMatrix(const Matrix &page_display_matrix)
获取显示矩阵，从PDF坐标系统到 目标设备坐标系统。
foxit::pdf::annots::Note::GetOpenStatus
bool GetOpenStatus() const
获取开放状态。
foxit::pdf::annots::StrikeOut
Definition: fs_annot.h:2733
foxit::pdf::annots::Widget::GetMKNormalIconBitmap
common::Bitmap GetMKNormalIconBitmap()
获取 MK 字典中的普通图标位图。
foxit::pdf::annots::QuadPoints::fourth
PointF fourth
四边形的第四个点，使用 PDF 坐标系。
Definition: fs_annot.h:755
foxit::pdf::annots::Popup::Popup
Popup()
构造函数。
Definition: fs_annot.h:4916
foxit::pdf::annots::Caret
Definition: fs_annot.h:4793
foxit::pdf::annots::PSInk
Definition: fs_annot.h:4984
foxit::pdf::annots::Annot::operator=
Annot & operator=(const Annot &annot)
赋值运算符。
foxit::pdf::annots::Annot::e_Widget
注释类型：小组件注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1005
foxit::pdf::annots::Annot::e_Note
注释类型：注记注释，即"文本"注释 - <PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:964
foxit::pdf::annots::IconProviderCallback::Release
virtual void Release()=0
用于释放当前回调对象自身的回调函数。
foxit::pdf::annots::Square::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
设置用于测量的转换因子。
foxit::pdf::annots::Markup::StateModel
StateModel
标记注释状态模型的枚举。
Definition: fs_annot.h:1825
foxit::pdf::annots::TextMarkup::SetQuadPoints
void SetQuadPoints(const QuadPointsArray &quad_points_array)
设置四边形。
foxit::pdf::annots::Circle::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const char *unit)
设置用于测量的单位显示标签。
foxit::pdf::annots::Squiggly::~Squiggly
~Squiggly()
析构函数。
Definition: fs_annot.h:2772
foxit::pdf::annots::Widget::SetAction
void SetAction(const actions::Action &action)
设置动作。
foxit::pdf::annots::Polygon::~Polygon
~Polygon()
析构函数。
Definition: fs_annot.h:4408
foxit::pdf::annots::Annot::e_Ink
注释类型：墨迹注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:992
foxit::pdf::annots::Annot::e_Link
注释类型：链接注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:966
foxit::pdf::annots::Annot::e_MKEntryBorderColor
边框颜色条目。MK字典中的"BC"。
Definition: fs_annot.h:1155
foxit::pdf::annots::IconFit::fit_bounds
bool fit_bounds
是否将按钮外观完全缩放到边界内。
Definition: fs_annot.h:915
foxit::pdf::annots::Link::GetHighlightingMode
HighlightingMode GetHighlightingMode()
获取高亮模式。
foxit::pdf::annots::Screen::GetMKDict
pdf::objects::PDFDictionary * GetMKDict() const
获取外观特征字典（也称为"MK"字典）。
foxit::pdf::annots::QuadPoints::second
PointF second
四边形的第二个点，使用 PDF 坐标系。
Definition: fs_annot.h:751
foxit::pdf::DefaultAppearance::DefAPFlags
DefAPFlags
默认外观标志枚举。
Definition: fs_annot.h:57
foxit::pdf::annots::Square::GetFillColor
RGB GetFillColor() const
获取填充颜色。
foxit::common::Path
Definition: fs_common.h:2167
foxit::pdf::annots::Line::SetCaptionPositionType
void SetCaptionPositionType(CapPos cap_position)
设置标题的位置类型。
foxit::pdf::annots::Screen::SetTitle
void SetTitle(const WString &title)
设置当前屏幕注释的标题。
foxit::pdf::annots::Markup::EndingStyle
EndingStyle
线条端点样式的枚举。
Definition: fs_annot.h:1890
foxit::pdf::annots::Ink
Definition: fs_annot.h:3976
foxit::pdf::annots::Widget::GetMKBorderColor
RGB GetMKBorderColor() const
获取 MK 字典中的边框颜色。
foxit::pdf::annots::Caret::Caret
Caret()
构造函数。
Definition: fs_annot.h:4796
foxit::pdf::annots::IconFit::ScaleWayType
ScaleWayType
图标缩放方式类型的枚举。
Definition: fs_annot.h:770
foxit::pdf::annots::Ink::EnableUseBezier
void EnableUseBezier(bool use_bezier)
启用使用贝塞尔样条来为墨迹注释的外观生成墨迹路径。
foxit::pdf::annots::Circle::GetMeasureRatio
String GetMeasureRatio()
获取用于测量的比例比率字符串。
foxit::pdf::annots::BorderInfo::operator !=
bool operator !=(const BorderInfo &border_info) const
不等操作符。
Definition: fs_annot.h:578
foxit::pdf::annots::Annot::e_FlagLocked
注释标志：锁定。
Definition: fs_annot.h:1086
foxit::pdf::annots::Screen::SetRotation
void SetRotation(common::Rotation rotate)
设置用于当前屏幕注释外观的图像旋转。
foxit::pdf::annots::Annot::e_PagingSeal
注释类型：分页印章注释。福昕PDF SDK自定义注释类型（非标准注释类型）。
Definition: fs_annot.h:1023
foxit::pdf::annots::PolyLine::SetVertexes
void SetVertexes(const PointFArray &vertexes)
设置顶点。
foxit::pdf::annots::Ink::~Ink
~Ink()
析构函数。
Definition: fs_annot.h:3987
foxit::pdf::annots::Circle::GetMeasureRatioW
WString GetMeasureRatioW()
获取用于测量的比例比率Unicode字符串。
foxit::pdf::annots::Widget::SetMKNormalCaption
void SetMKNormalCaption(const wchar_t *caption)
设置 MK 字典中的普通标题字符串。
foxit::pdf::annots::Annot::e_PSInk
注释类型：压力敏感墨迹注释。
Definition: fs_annot.h:994
foxit::pdf::annots::QuadPoints::operator=
QuadPoints & operator=(const QuadPoints &quad_points)
赋值操作符。
Definition: fs_annot.h:700
CFX_ArrayTemplate< float >
foxit::pdf::annots::Redact::SetFillColor
void SetFillColor(RGB fill_color)
设置填充颜色。
foxit::pdf::annots::PolyLine::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
设置用于测量的比例比率字符串。
foxit::pdf::interform::Field
Definition: fs_pdfform.h:145
foxit::pdf::annots::Widget::SetMKNormalIconBitmap
void SetMKNormalIconBitmap(const common::Bitmap &bitmap)
设置一个位图作为 MK 字典中的普通图标。
foxit::pdf::annots::PolyLine::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
获取用于显示测量单位的标签。
foxit::pdf::annots::Line::e_CapPosTop
Definition: fs_annot.h:3578
foxit::pdf::RichTextStyle::operator !=
bool operator !=(const RichTextStyle &style) const
不等于运算符。
Definition: fs_annot.h:331
foxit::pdf::annots::Annot::e_MKEntryRolloverIcon
悬停图标条目。MK字典中的"RI"。
Definition: fs_annot.h:1182
foxit::pdf::annots::Link::SetQuadPoints
void SetQuadPoints(const QuadPointsArray &quad_points_array)
设置四边形。
foxit::pdf::annots::Widget::RemoveAction
void RemoveAction()
移除动作。
foxit::uint32
FX_UINT32 uint32
无符号 32 位整数。
Definition: fs_basictypes.h:195
foxit::pdf::annots::Stamp::SetImage
void SetImage(const common::Image &image, int frame_index, int compress)
为当前印章注释设置图像，使用指定的帧索引。
foxit::pdf::annots::FreeText::Rotate
void Rotate(common::Rotation rotation)
从当前状态按指定旋转值（顺时针）旋转当前注释。
foxit::pdf::annots::Widget::GetField
interform::Field GetField()
获取关联的表单字段。
foxit::pdf::PDFPage
Definition: fs_pdfpage.h:417
foxit::FS_HANDLE
void * FS_HANDLE
句柄类型。
Definition: fs_basictypes.h:213
foxit::pdf::annots::Stamp::Rotate
void Rotate(int angle)
从当前状态按指定角度度数顺时针旋转当前注释。
foxit::pdf::annots::Widget::GetLineSpacing
LineSpacingStyle GetLineSpacing(float &line_spacing_value)
获取当前小部件的行间距。
foxit::String
CFX_ByteString String
字节字符串。
Definition: fs_basictypes.h:224
foxit::pdf::annots::Redact::SetDefaultAppearance
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
设置默认外观数据。
foxit::pdf::annots::BorderInfo::e_UnderLine
边框样式：下划线。
Definition: fs_annot.h:462
foxit::pdf::annots::Annot::Property
Property
某些PDF注释属性的枚举。
Definition: fs_annot.h:1124
foxit::pdf::annots::Annot::e_FlagInvisible
注释标志：不可见。
Definition: fs_annot.h:1037
fs_common.h
通用定义和类的头文件。
foxit::pdf::annots::Square::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
获取用于测量的转换因子。
foxit::pdf::annots::Annot::~Annot
virtual ~Annot()
析构函数。
foxit::pdf::annots::Screen::GetBitmap
common::Bitmap GetBitmap()
从当前屏幕注释获取位图。
foxit::pdf::annots::Popup::GetOpenStatus
bool GetOpenStatus() const
获取打开状态。
foxit::pdf::annots::Annot::e_TrapNet
注释类型：陷阱网络注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1011
foxit::pdf::RichTextStyle::text_size
float text_size
文本大小。不应为负值。0表示文本不会显示。
Definition: fs_annot.h:385
foxit::pdf::annots::Sound::GetCompressionFormat
String GetCompressionFormat() const
获取用于采样数据的声音压缩格式的名称。
foxit::pdf::annots::FreeText::GetAlignment
common::Alignment GetAlignment() const
获取对齐值。
foxit::pdf::annots::PagingSeal::~PagingSeal
~PagingSeal()
析构函数。
foxit::pdf::annots::Widget::e_LineSpacingSingle
行间距样式：单倍行间距。
Definition: fs_annot.h:5023
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
构造函数，带参数。
Definition: fs_annot.h:671
foxit::pdf::annots::FreeText::GetTextMatrix
Matrix GetTextMatrix() const
获取当前自由文本注释中文本的默认外观数据中的矩阵。
foxit::pdf::annots::MarkupArray
Definition: fs_annot.h:1795
foxit::pdf::annots::Line::GetLineEndStyle
EndingStyle GetLineEndStyle() const
获取终点的线条结束样式。
foxit::pdf::annots::Line::GetStartPoint
PointF GetStartPoint() const
获取起点。
foxit::pdf::annots::Square::GetMeasureRatioW
WString GetMeasureRatioW()
获取用于测量的比例比率 Unicode 字符串。
foxit::pdf::annots::Widget::e_LineSpacingDouble
行间距样式：双倍行间距。
Definition: fs_annot.h:5027
foxit::pdf::annots::Widget::GetControl
interform::Control GetControl()
获取关联的表单控件。
foxit::pdf::annots::Redact::GetQuadPoints
QuadPointsArray GetQuadPoints() const
获取四边形。
foxit::pdf::annots::Widget::SetMKRolloverCaption
void SetMKRolloverCaption(const wchar_t *caption)
设置 MK 字典中的翻转标题字符串。
foxit::pdf::annots::Screen::SetImage
void SetImage(const common::Image &image, int frame_index, int compress)
为当前屏幕注释设置图像，使用指定的帧索引。
FX_RECT
Definition: fx_coordinates.h:596
foxit::pdf::annots::Widget::GetMKRolloverIconBitmap
common::Bitmap GetMKRolloverIconBitmap()
获取 MK 字典中的翻转图标位图。
foxit::pdf::annots::PolyLine::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
设置用于测量的转换因子。
foxit::pdf::annots::Annot::e_PolyLine
注释类型：折线注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:978
foxit::pdf::annots::Ink::Ink
Ink()
构造函数。
Definition: fs_annot.h:3979
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)
设置值。
Definition: fs_annot.h:355
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)
构造函数，带参数。
Definition: fs_annot.h:236
foxit::pdf::annots::Annot::e_MKRelationCaptionOvrlayOnIcon
标题直接覆盖在图标上。
Definition: fs_annot.h:1220
foxit::pdf::annots::Annot::GetIndex
int GetIndex() const
获取当前注释在其所属页面中的索引。
foxit::common::Alignment
Alignment
对齐方式（水平）枚举。
Definition: fs_common.h:94
foxit::pdf::annots::QuadPoints::third
PointF third
四边形的第三个点，使用 PDF 坐标系。
Definition: fs_annot.h:753
foxit::pdf::DefaultAppearance::text_size
float text_size
默认外观的文本大小。
Definition: fs_annot.h:190
foxit::pdf::annots::FreeText
Definition: fs_annot.h:3263
foxit::pdf::annots::FreeText::SetCalloutLinePoints
void SetCalloutLinePoints(const PointFArray &point_array)
设置标注线的点。
fs_pdfobject.h
PDF对象相关定义和类的头文件。
foxit::pdf::RichTextStyle::is_underline
bool is_underline
指示是否为文本添加下划线的布尔值。
Definition: fs_annot.h:411
foxit::pdf::annots::Link::GetQuadPoints
QuadPointsArray GetQuadPoints() const
获取四边形。
foxit::pdf::annots::Annot::e_HighlightingToggle
高亮模式：切换。这仅对小组件注释有用。
Definition: fs_annot.h:1116
foxit::int32
FX_INT32 int32
有符号 32 位整数。
Definition: fs_basictypes.h:193
foxit::pdf::annots::Sound::GetFileSpec
FileSpec GetFileSpec() const
获取表示外部声音文件的文件规范对象。
foxit::Base
Definition: fs_basictypes.h:465
foxit::pdf::annots::Annot::e_PrinterMark
注释类型：印刷标记注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1009
foxit::pdf::annots::TextMarkup::TextMarkup
TextMarkup()
构造函数。
Definition: fs_annot.h:2617
foxit::pdf::annots::Widget::SetMKDownIconImage
void SetMKDownIconImage(const common::Image &image, int frame_index)
设置指定帧索引的图像作为MK字典中的按下图标。
foxit::pdf::annots::Annot::e_HighlightingNone
高亮模式：无高亮。
Definition: fs_annot.h:1108
foxit::pdf::annots::Annot::e_MKRelationCaptionRight
标题在图标右侧。
Definition: fs_annot.h:1216
foxit::pdf::annots::Redact::SetOverlayTextAlignment
void SetOverlayTextAlignment(common::Alignment alignment)
设置覆盖文本的对齐值。
foxit::pdf::annots::Square::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
设置内部矩形。
foxit::pdf::annots::Stamp::GetIconName
String GetIconName() const
获取图标名称。
foxit::pdf::annots::Annot::operator==
bool operator==(const Annot &other) const
等于运算符。
foxit::pdf::annots::Polygon::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
获取用于测量的单位显示标签。
foxit::pdf::actions::JavaScriptAction
Definition: fs_action.h:735
foxit::pdf::annots::IconProviderCallback::CanChangeColor
virtual bool CanChangeColor(Annot::Type annot_type, const char *icon_name)
用于检查当前图标提供程序是否支持为指定类型更改颜色的回调函数。
Definition: fs_annot.h:1728
foxit::pdf::annots::Widget::GetMKRolloverCaption
WString GetMKRolloverCaption() const
获取 MK 字典中的翻转标题字符串。
foxit::pdf::FileSpec
Definition: fs_filespec.h:38
foxit::pdf::DefaultAppearance::operator=
DefaultAppearance & operator=(const DefaultAppearance &default_appearance)
赋值运算符。
Definition: fs_annot.h:110
foxit::pdf::annots::Screen::SetOpacity
void SetOpacity(float opacity)
设置不透明度值。
foxit::pdf::annots::QuadPoints::first
PointF first
四边形的第一个点，使用 PDF 坐标系。
Definition: fs_annot.h:749
foxit::pdf::annots::Annot::HighlightingMode
HighlightingMode
PDF注释高亮模式的枚举。
Definition: fs_annot.h:1106
foxit::pdf::annots::FreeText::SetRotation
void SetRotation(common::Rotation rotation)
设置旋转值（顺时针）。
foxit::pdf::annots::FileAttachment::FileAttachment
FileAttachment()
构造函数。
Definition: fs_annot.h:4847
foxit::pdf::annots::Annot::e_Highlight
注释类型：高亮注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:980
foxit::pdf::annots::Note::SetOpenStatus
void SetOpenStatus(bool status)
设置开放状态。
foxit::pdf::annots::Polygon::GetMeasureRatio
String GetMeasureRatio()
获取用于测量的比例比率字符串。
foxit::pdf::annots::PolyLine::SetLineEndStyle
void SetLineEndStyle(EndingStyle ending_style)
设置终点的线端样式。
foxit::pdf::annots::Sound::e_SampleEncodingFormatALaw
A律编码采样。
Definition: fs_annot.h:5815
foxit::pdf::annots::BorderInfo::~BorderInfo
~BorderInfo()
析构函数。
Definition: fs_annot.h:520
foxit::pdf::annots::Annot
Definition: fs_annot.h:950
foxit::pdf::annots::Square::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
获取用于显示测量单位的标签。
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints(const QuadPoints &quad_points)
拷贝构造函数。
Definition: fs_annot.h:686
foxit::pdf::annots::Annot::RemoveProperty
bool RemoveProperty(Property property)
删除指定的注释属性。
foxit::pdf::annots::Annot::GetDict
objects::PDFDictionary * GetDict() const
获取注释的字典对象。
foxit::pdf::annots::Polygon::Polygon
Polygon()
构造函数。
Definition: fs_annot.h:4400
foxit::pdf::annots::Link::Link
Link()
构造函数。
Definition: fs_annot.h:2791
foxit::pdf::annots::Annot::e_Sound
注释类型：声音注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:998
foxit::pdf::annots::Annot::operator !=
bool operator !=(const Annot &other) const
不等于运算符。
foxit::pdf::annots::Annot::e_StrikeOut
注释类型：删除线注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:986
foxit::common::Font
Definition: fs_common.h:1519
foxit::pdf::annots::Circle::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
获取用于测量的单位显示标签。
foxit::pdf::annots::Line::SetStartPoint
void SetStartPoint(const PointF &point)
设置起点。
foxit::pdf::objects::PDFDictionary
Definition: fs_pdfobject.h:848
foxit::pdf::annots::Redact::GetOverlayText
WString GetOverlayText() const
获取覆盖文本。
foxit::pdf::annots::FileAttachment::SetFileSpec
bool SetFileSpec(const FileSpec &file_spec)
设置文件规范，应指定嵌入的文件。
foxit::common::Rotation
Rotation
旋转的枚举。
Definition: fs_common.h:57
foxit::pdf::annots::Annot::e_MKEntryIconFit
图标适配信息条目。MK字典中的"IF"。
Definition: fs_annot.h:1192
foxit::pdf::annots::PSInk::PSInk
PSInk()
构造函数。
Definition: fs_annot.h:4987
foxit::pdf::RichTextStyle::e_CornerMarkNone
角标样式：无。
Definition: fs_annot.h:210
foxit
Foxit命名空间。
Definition: fs_taggedpdf.h:27
foxit::common::e_AlignmentLeft
左对齐。
Definition: fs_common.h:96
foxit::pdf::annots::IconProviderCallback::HasIcon
virtual bool HasIcon(Annot::Type annot_type, const char *icon_name)
用于检查当前图标提供程序是否支持指定类型图标的回调函数。
Definition: fs_annot.h:1716
foxit::pdf::annots::Annot::e_Underline
注释类型：下划线注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:982
foxit::pdf::annots::Link::RemoveAction
bool RemoveAction()
移除动作。
foxit::pdf::annots::NoteArray
Definition: fs_annot.h:1799
foxit::pdf::annots::PSInk::~PSInk
~PSInk()
析构函数。
Definition: fs_annot.h:4997
foxit::pdf::actions::Action
Definition: fs_action.h:411
foxit::pdf::DefaultAppearance::text_color
RGB text_color
默认外观的文本颜色。格式：0xRRGGBB。
Definition: fs_annot.h:197
foxit::pdf::annots::Circle::SetMeasureRatio
void SetMeasureRatio(const char *ratio)
设置用于测量的比例比率字符串。
foxit::pdf::annots::Annot::e_MKEntryRotation
旋转条目。MK字典中的"R"。
Definition: fs_annot.h:1153
foxit::pdf::annots::Widget::SetMKDownCaption
void SetMKDownCaption(const wchar_t *caption)
设置 MK 字典中的向下标题字符串。
CFX_ByteString
字节字符串类
Definition: fx_string.h:317
foxit::pdf::annots::Widget::GetMKDownCaption
WString GetMKDownCaption() const
获取 MK 字典中的向下标题字符串。
foxit::pdf::annots::Line::GetLeaderLineLength
float GetLeaderLineLength() const
获取引导线的长度。
foxit::pdf::annots::Redact::GetOverlayTextAlignment
common::Alignment GetOverlayTextAlignment() const
获取覆盖文本的对齐值。
foxit::pdf::annots::Annot::e_Line
注释类型：直线注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:970
foxit::pdf::annots::Squiggly::Squiggly
Squiggly()
构造函数。
Definition: fs_annot.h:2764
foxit::pdf::DefaultAppearance::operator==
bool operator==(const DefaultAppearance &default_appearance) const
等于运算符。
Definition: fs_annot.h:125
foxit::pdf::annots::BorderInfo::e_Cloudy
边框样式：云朵。
Definition: fs_annot.h:483
foxit::pdf::annots::Widget::SetMKBackgroundColor
void SetMKBackgroundColor(RGB color)
设置 MK 字典中的背景颜色。
foxit::pdf::annots::Widget::RemoveMKEntry
void RemoveMKEntry(MKEntry mk_entry)
从 MK 字典中移除指定的条目。
foxit::pdf::DefaultAppearance::operator !=
bool operator !=(const DefaultAppearance &default_appearance) const
不等于运算符。
Definition: fs_annot.h:138
foxit::pdf::annots::Widget::SetMKRotation
void SetMKRotation(common::Rotation rotation)
设置 MK 字典中的旋转值。
foxit::pdf::annots::Polygon::SetVertexes
void SetVertexes(const PointFArray &vertexes)
设置顶点。
foxit::pdf::annots::Annot::AppearanceType
AppearanceType
注释外观类型的枚举。
Definition: fs_annot.h:1228
foxit::pdf::DefaultAppearance::e_FlagFont
指示pdf::DefaultAppearance的字体属性是有意义的。
Definition: fs_annot.h:59
foxit::pdf::annots::BorderInfo::dash_phase
float dash_phase
虚线相位。
Definition: fs_annot.h:640
foxit::pdf::RichTextStyle::mark_style
CornerMarkStyle mark_style
角标样式。角标样式可用于将文本设为上标或下标或不作为任何类型的角标。 请参考从RichTextStyle::e_CornerMarkNone开始的值，这应该是这些值中的一个。
Definition: fs_annot.h:422
foxit::pdf::annots::Sound::GetBits
int GetBits() const
获取每个通道每个采样值的位数。
foxit::pdf::annots::BorderInfo::style
Style style
边框样式。请参考 BorderInfo::e_Solid 及相关值，应为这些值中的一个。
Definition: fs_annot.h:621
foxit::pdf::annots::Line::GetCaptionPositionType
CapPos GetCaptionPositionType() const
获取标题的位置类型。
foxit::pdf::annots::Annot::e_Caret
注释类型：插入符注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:990
foxit::pdf::annots::Square::~Square
~Square()
析构函数。
Definition: fs_annot.h:2922
foxit::pdf::annots::Square::GetMeasureRatio
String GetMeasureRatio()
获取用于测量的比例比率字符串。
foxit::pdf::annots::Popup
Definition: fs_annot.h:4913
foxit::pdf::annots::Annot::SetModifiedDateTime
void SetModifiedDateTime(const DateTime &date_time)
设置最后修改日期时间。
foxit::pdf::annots::Annot::e_3D
注释类型：3D注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1015
foxit::pdf::annots::FreeText::SetDefaultAppearance
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
设置默认外观数据。
foxit::pdf::annots::BorderInfo::e_Inset
边框样式：内嵌。
Definition: fs_annot.h:476
foxit::pdf::annots::Square::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
获取用于显示测量单位的标签。
foxit::pdf::RichTextStyle::is_strikethrough
bool is_strikethrough
指示是否为文本添加删除线的布尔值。
Definition: fs_annot.h:416
foxit::pdf::annots::Annot::e_MKRelationNoIcon
无图标；仅标题。
Definition: fs_annot.h:1208
foxit::pdf::annots::Annot::SetBorderInfo
void SetBorderInfo(const BorderInfo &border)
设置边框信息。
foxit::pdf::RichTextStyle::CornerMarkStyle
CornerMarkStyle
角标样式枚举。
Definition: fs_annot.h:208
foxit::pdf::annots::Circle::~Circle
~Circle()
析构函数。
Definition: fs_annot.h:3093
foxit::pdf::annots::Redact::SetApplyFillColor
void SetApplyFillColor(RGB fill_color)
设置用于翻转外观的填充颜色，将在应用编辑后使用。
foxit::pdf::annots::FreeText::GetCalloutLineEndingStyle
EndingStyle GetCalloutLineEndingStyle() const
获取标注线起点的线条结束样式。
foxit::pdf::annots::PolyLine
Definition: fs_annot.h:4576
NULL
#define NULL
空指针值。
Definition: fx_system.h:792
foxit::pdf::annots::Circle::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
获取用于测量的单位显示标签。
foxit::pdf::annots::Stamp::~Stamp
~Stamp()
析构函数。
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo()
默认构造函数。
Definition: fs_annot.h:513
foxit::pdf::annots::Square::GetInnerRect
RectF GetInnerRect() const
获取内部矩形。
foxit::pdf::annots::Line::SetLineStartStyle
void SetLineStartStyle(EndingStyle ending_style)
设置起点的线条结束样式。
foxit::pdf::annots::Annot::e_Watermark
注释类型：水印注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1013
foxit::pdf::annots::FileAttachment::GetIconName
String GetIconName() const
获取图标名称。
foxit::pdf::annots::PolyLine::GetLineStartStyle
EndingStyle GetLineStartStyle() const
获取起始点的线端样式。
foxit::pdf::annots::Annot::SetUniqueID
void SetUniqueID(const WString &unique_id)
设置唯一ID。
foxit::pdf::annots::Line::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
设置用于测量的单位显示标签。
CFX_Matrix
Definition: fx_coordinates.h:1076
foxit::pdf::annots::Polygon::GetVertexes
PointFArray GetVertexes()
获取顶点。
foxit::pdf::annots::Sound::SampleEncodingFormat
SampleEncodingFormat
声音采样数据编码格式的枚举。
Definition: fs_annot.h:5807
foxit::pdf::DefaultAppearance::Set
void Set(uint32 flags, const common::Font &font, float text_size, RGB text_color)
设置值。
Definition: fs_annot.h:159
foxit::pdf::annots::Polygon::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
设置用于测量的单位显示标签。
foxit::pdf::annots::Line
Definition: fs_annot.h:3567
foxit::pdf::annots::Polygon::GetFillColor
RGB GetFillColor() const
获取填充颜色。
foxit::pdf::annots::Stamp::SetRotation
void SetRotation(int angle)
设置旋转角度（顺时针方向）。
foxit::pdf::annots::FileAttachment::~FileAttachment
~FileAttachment()
析构函数。
Definition: fs_annot.h:4855
foxit::pdf::annots::Widget::LineSpacingStyle
LineSpacingStyle
行间距样式的枚举。
Definition: fs_annot.h:5021
foxit::pdf::annots::Line::SetLeaderLineExtensionLength
void SetLeaderLineExtensionLength(float extension_length)
设置引导线延伸的长度。
foxit::pdf::RichTextStyle::is_bold
bool is_bold
指示是否将文本设为粗体的布尔值。
Definition: fs_annot.h:401
foxit::pdf::annots::Caret::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
设置内矩形。
foxit::pdf::annots::QuadPoints
Definition: fs_annot.h:661
foxit::pdf::annots::Annot::GetBorderColor
RGB GetBorderColor() const
获取边框颜色。
foxit::pdf::annots::Squiggly
Definition: fs_annot.h:2761
foxit::pdf::annots::Note::GetIconName
String GetIconName() const
获取图标名称。
foxit::pdf::annots::Line::GetMeasureRatioW
WString GetMeasureRatioW()
获取用于测量的比例比率Unicode字符串。
foxit::pdf::annots::IconProviderCallback::GetDisplayWidth
virtual float GetDisplayWidth(Annot::Type annot_type, const char *icon_name)
用于获取指定图标显示宽度的回调函数，以设备大小（通常为像素）为单位。
Definition: fs_annot.h:1772
foxit::pdf::annots::IconProviderCallback::GetDisplayHeight
virtual float GetDisplayHeight(Annot::Type annot_type, const char *icon_name)
用于获取指定图标显示高度的回调函数，以设备大小（通常为像素）为单位。
Definition: fs_annot.h:1785
foxit::pdf::annots::Widget::e_LineSpacingOneAndHalf
行间距样式：1.5倍行间距。
Definition: fs_annot.h:5025
foxit::pdf::annots::Annot::e_Circle
注释类型：圆形注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:974
fs_action.h
目标和动作相关定义和类的头文件。
foxit::pdf::annots::Screen::GetTitle
WString GetTitle() const
获取当前屏幕注释的标题。
foxit::pdf::annots::Annot::e_MKRelationCaptionLeft
标题在图标左侧。
Definition: fs_annot.h:1218
foxit::pdf::annots::FreeText::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
设置内部矩形。
foxit::pdf::annots::Line::CapPos
CapPos
标题位置类型的枚举。
Definition: fs_annot.h:3574
foxit::pdf::DefaultAppearance::e_FlagFontSize
指示pdf::DefaultAppearance的文本大小属性是有意义的。
Definition: fs_annot.h:63
foxit::pdf::annots::Note::Note
Note()
构造函数。
Definition: fs_annot.h:2467
foxit::pdf::annots::Stamp::Stamp
Stamp()
构造函数。
Definition: fs_annot.h:4089
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor()
构造函数
Definition: fs_annot.h:1602
foxit::pdf::annots::IconProviderCallback::GetProviderID
virtual String GetProviderID()
用于获取提供程序ID的回调函数。
Definition: fs_annot.h:1693
foxit::pdf::annots::Markup::~Markup
~Markup()
析构函数。
Definition: fs_annot.h:1949
foxit::pdf::annots::Line::SetCaptionOffset
void SetCaptionOffset(const Offset &offset)
设置标题偏移值。
foxit::pdf::annots::Highlight
Definition: fs_annot.h:2677
foxit::pdf::annots::Annot::e_MKEntryNormalCaption
正常标题条目。MK字典中的"CA"。
Definition: fs_annot.h:1162
foxit::pdf::annots::Annot::e_MKEntryDownCaption
按下标题（或备用标题）条目。MK字典中的"AC"。
Definition: fs_annot.h:1172
foxit::pdf::annots::Line::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
获取用于测量的单位显示标签。
foxit::pdf::annots::TextMarkup::~TextMarkup
~TextMarkup()
析构函数。
Definition: fs_annot.h:2625
foxit::pdf::annots::Annot::e_MKEntryBackgroundColor
背景颜色条目。MK字典中的"BG"。
Definition: fs_annot.h:1157
foxit::pdf::annots::Screen::RemoveAction
void RemoveAction()
移除动作。
foxit::pdf::annots::Widget::SetMKDownIconBitmap
void SetMKDownIconBitmap(const common::Bitmap &bitmap)
设置MK字典中的按下图标位图。
foxit::pdf::annots::Polygon::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
获取用于测量的转换因子。
foxit::pdf::annots::PagingSeal
Definition: fs_annot.h:5916
foxit::pdf::annots::Annot::GetRect
RectF GetRect() const
获取矩形，以PDF坐标系统表示。
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints()
构造函数
Definition: fs_annot.h:679
foxit::pdf::annots::Annot::e_FlagLockedContents
注释标志：锁定内容。
Definition: fs_annot.h:1098
foxit::pdf::annots::Annot::e_Stamp
注释类型：印章注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:988
foxit::common::Image
Definition: fs_image.h:450
foxit::pdf::annots::Annot::e_FlagHidden
注释标志：隐藏。
Definition: fs_annot.h:1043
foxit::pdf::annots::Sound
Definition: fs_annot.h:5800
foxit::pdf::annots::Widget::e_LineSpacingExactValue
行间距样式：精确值行间距。
Definition: fs_annot.h:5029
foxit::pdf::annots::BorderInfo::e_Dashed
边框样式：虚线。
Definition: fs_annot.h:456
foxit::pdf::RichTextStyle::operator=
RichTextStyle & operator=(const RichTextStyle &style)
赋值运算符。
Definition: fs_annot.h:288
foxit::pdf::annots::Note::SetState
void SetState(State state)
设置状态。
foxit::pdf::annots::Line::SetStyleFillColor
void SetStyleFillColor(RGB color)
设置结束样式的填充颜色。
foxit::pdf::annots::Annot::ResetAppearanceStream
bool ResetAppearanceStream()
重置外观流。
CFX_FloatRect
Definition: fx_coordinates.h:771
foxit::pdf::annots::Line::SetLeaderLineOffset
void SetLeaderLineOffset(float offset)
设置引导线偏移的长度。
foxit::pdf::annots::Annot::e_HighlightingPush
高亮模式：按下，即显示注释的按下外观（如果有）。
Definition: fs_annot.h:1114
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
构造函数，带参数。
Definition: fs_annot.h:504