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
524 BorderInfo(const BorderInfo& border_info) {
525 this->width = border_info.width;
526 this->style = border_info.style;
527 this->cloud_intensity = border_info.cloud_intensity;
528 this->dash_phase = border_info.dash_phase;
529 this->dashes = border_info.dashes;
530 }
531
539 BorderInfo& operator = (const BorderInfo& border_info) {
540 this->width = border_info.width;
541 this->style = border_info.style;
542 this->cloud_intensity = border_info.cloud_intensity;
543 this->dash_phase = border_info.dash_phase;
544 this->dashes = border_info.dashes;
545 return *this;
546 }
547
555 bool operator == (const BorderInfo& border_info) const {
556 if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
557 fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
558 fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
559 dashes.GetSize() != border_info.dashes.GetSize())
560 return false;
561 for (int i=0; i<dashes.GetSize(); i++) {
562 if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
563 return false;
564 }
565 return true;
566 }
567
575 bool operator != (const BorderInfo& border_info) const{
576 if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
577 fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
578 fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
579 dashes.GetSize() != border_info.dashes.GetSize())
580 return true;
581 for (int i=0; i<dashes.GetSize(); i++) {
582 if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
583 return true;
584 }
585 return false;
586 }
587
600 void Set(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
601 this->width = width;
602 this->style = style;
603 this->cloud_intensity = intensity;
604 this->dash_phase = dash_phase;
605 this->dashes = dashes;
606 }
607
613 float width;
614
618 Style style;
619
630 float cloud_intensity;
631
637 float dash_phase;
638
645 FloatArray dashes;
646 };
647
658 class QuadPoints FS_FINAL : public Object {
659 public:
668 QuadPoints(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
669 this->first = first;
670 this->second = second;
671 this->third = third;
672 this->fourth = fourth;
673 }
674
676 QuadPoints() {}
677
683 QuadPoints(const QuadPoints& quad_points) {
684 first = quad_points.first;
685 second = quad_points.second;
686 third = quad_points.third;
687 fourth = quad_points.fourth;
688 }
689
697 QuadPoints& operator = (const QuadPoints& quad_points) {
698 first = quad_points.first;
699 second = quad_points.second;
700 third = quad_points.third;
701 fourth = quad_points.fourth;
702 return *this;
703 }
704
711 bool operator == (const QuadPoints& quad_points) const {
712 return (first == quad_points.first && second == quad_points.second &&
713 third == quad_points.third && fourth == quad_points.fourth);
714 }
715
723 bool operator != (const QuadPoints& quad_points) const {
724 return (first != quad_points.first || second != quad_points.second ||
725 third != quad_points.third || fourth != quad_points.fourth);
726 }
727
738 void Set(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
739 this->first = first;
740 this->second = second;
741 this->third = third;
742 this->fourth = fourth;
743 }
744
746 PointF first;
748 PointF second;
750 PointF third;
752 PointF fourth;
753 };
754
756 FSDK_DEFINE_ARRAY(QuadPointsArray, QuadPoints)
757
758
761 class IconFit FS_FINAL : public Object {
762 public:
767 typedef enum _ScaleWayType {
769 e_ScaleWayNone = 0,
771 e_ScaleWayAlways = 1,
773 e_ScaleWayBigger = 2,
775 e_ScaleWaySmaller = 3,
777 e_ScaleWayNever = 4
778 } ScaleWayType;
779
780
782 IconFit()
783 : scale_way_type(e_ScaleWayNone)
784 , is_proportional_scaling(false)
785 , horizontal_fraction(0)
786 , vertical_fraction(0)
787 , fit_bounds(false) {}
788
800 IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
801 float vertical_fraction, bool fit_bounds)
802 : scale_way_type(type)
803 , is_proportional_scaling(is_proportional_scaling)
804 , horizontal_fraction(horizontal_fraction)
805 , vertical_fraction(vertical_fraction)
806 , fit_bounds(fit_bounds) {}
807
813 IconFit(const IconFit& icon_fit)
814 : scale_way_type(icon_fit.scale_way_type)
815 , is_proportional_scaling(icon_fit.is_proportional_scaling)
816 , horizontal_fraction(icon_fit.horizontal_fraction)
817 , vertical_fraction(icon_fit.vertical_fraction)
818 , fit_bounds(icon_fit.fit_bounds) {}
819
827 IconFit& operator = (const IconFit& icon_fit) {
828 scale_way_type = icon_fit.scale_way_type;
829 is_proportional_scaling = icon_fit.is_proportional_scaling;
830 horizontal_fraction = icon_fit.horizontal_fraction;
831 vertical_fraction = icon_fit.vertical_fraction;
832 fit_bounds = icon_fit.fit_bounds;
833 return *this;
834 }
835
843 bool operator == (const IconFit& icon_fit) const {
844 return (scale_way_type == icon_fit.scale_way_type &&
845 is_proportional_scaling == icon_fit.is_proportional_scaling &&
846 fabs(horizontal_fraction - icon_fit.horizontal_fraction) <= FLT_EPSILON &&
847 fabs(vertical_fraction - icon_fit.vertical_fraction) <= FLT_EPSILON &&
848 fit_bounds == icon_fit.fit_bounds);
849 }
850
858 bool operator != (const IconFit& icon_fit) const {
859 return (scale_way_type != icon_fit.scale_way_type ||
860 is_proportional_scaling != icon_fit.is_proportional_scaling ||
861 fabs(horizontal_fraction - icon_fit.horizontal_fraction) > FLT_EPSILON ||
862 fabs(vertical_fraction - icon_fit.vertical_fraction) > FLT_EPSILON ||
863 fit_bounds != icon_fit.fit_bounds);
864 }
865
879 void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
880 float vertical_fraction, bool fit_bounds) {
881 this->scale_way_type = type;
882 this->is_proportional_scaling = is_proportional_scaling;
883 this->horizontal_fraction = horizontal_fraction;
884 this->vertical_fraction = vertical_fraction;
885 this->fit_bounds = fit_bounds;
886 }
887
892 ScaleWayType scale_way_type;
898 bool is_proportional_scaling;
902 float horizontal_fraction;
906 float vertical_fraction;
912 bool fit_bounds;
913 };
914
947 class Annot : public Base {
948 public:
954 typedef enum _Type {
956 e_UnknownType = 0,
961 e_Note = 1,
963 e_Link = 2,
965 e_FreeText = 3,
967 e_Line = 4,
969 e_Square = 5,
971 e_Circle = 6,
973 e_Polygon = 7,
975 e_PolyLine = 8,
977 e_Highlight = 9,
979 e_Underline = 10,
981 e_Squiggly = 11,
983 e_StrikeOut = 12,
985 e_Stamp = 13,
987 e_Caret = 14,
989 e_Ink = 15,
991 e_PSInk = 16,
993 e_FileAttachment = 17,
995 e_Sound = 18,
997 e_Movie = 19,
1002 e_Widget = 20,
1004 e_Screen = 21,
1006 e_PrinterMark = 22,
1008 e_TrapNet = 23,
1010 e_Watermark = 24,
1012 e_3D = 25,
1014 e_Popup = 26,
1016 e_Redact = 27,
1018 e_RichMedia = 28,
1020 e_PagingSeal = 29
1021 } Type;
1022
1028 typedef enum _Flags {
1034 e_FlagInvisible = 0x0001,
1040 e_FlagHidden = 0x0002,
1047 e_FlagPrint = 0x0004,
1054 e_FlagNoZoom = 0x0008,
1061 e_FlagNoRotate = 0x0010,
1068 e_FlagNoView = 0x0020,
1077 e_FlagReadOnly = 0x0040,
1083 e_FlagLocked = 0x0080,
1089 e_FlagToggleNoView = 0x0100,
1095 e_FlagLockedContents = 0x0200
1096 } Flags;
1097
1103 typedef enum _HighlightingMode {
1105 e_HighlightingNone = 0,
1107 e_HighlightingInvert = 1,
1109 e_HighlightingOutline = 2,
1111 e_HighlightingPush = 3,
1113 e_HighlightingToggle = 4
1114 } HighlightingMode;
1115
1121 typedef enum _Property {
1123 e_PropertyModifiedDate = 0,
1128 e_PropertyCreationDate = 1,
1134 e_PropertyBorderColor = 2,
1140 e_PropertyFillColor = 3
1141 } Property;
1142
1148 typedef enum _MKEntry {
1150 e_MKEntryRotation = 0,
1152 e_MKEntryBorderColor = 1,
1154 e_MKEntryBackgroundColor = 2,
1159 e_MKEntryNormalCaption = 3,
1164 e_MKEntryRolloverCaption = 4,
1169 e_MKEntryDownCaption = 5,
1174 e_MKEntryNormalIcon = 6,
1179 e_MKEntryRolloverIcon = 7,
1184 e_MKEntryDownIcon = 8,
1189 e_MKEntryIconFit = 9,
1195 e_MKEntryIconCaptionRelation = 10
1196 } MKEntry;
1197
1203 typedef enum _MKIconCaptionRelation {
1205 e_MKRelationNoIcon = 0,
1207 e_MKRelationNoCaption = 1,
1209 e_MKRelationCaptionBelowIcon = 2,
1211 e_MKRelationCaptionAboveIcon = 3,
1213 e_MKRelationCaptionRight = 4,
1215 e_MKRelationCaptionLeft = 5,
1217 e_MKRelationCaptionOvrlayOnIcon = 6
1218 } MKIconCaptionRelation;
1219
1225 typedef enum _AppearanceType {
1227 e_AppearanceTypeNormal = 0,
1229 e_AppearanceTypeRollover = 1,
1231 e_AppearanceTypeDown = 2
1232 } AppearanceType;
1233
1234
1235 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1236 explicit Annot(FS_HANDLE handle);
1244 Annot(const PDFPage& page, objects::PDFDictionary* annot_dict);
1245 #ifndef __EMSCRIPTEN_RENDER__
1246
1251 Annot(const Annot& annot);
1252 #endif
1253
1254 Annot() {}
1255 #ifndef __EMSCRIPTEN_RENDER__
1256
1263 Annot& operator = (const Annot& annot);
1264 #endif
1265
1272 bool operator ==(const Annot& other) const;
1280 bool operator != (const Annot& other) const;
1281 #ifndef __EMSCRIPTEN_RENDER__
1282
1283 virtual ~Annot();
1284 #endif
1285
1292 bool IsEmpty() const;
1293
1299 PDFPage GetPage() const;
1306 bool IsMarkup() const;
1312 Type GetType() const;
1318 int GetIndex() const;
1324 WString GetContent() const;
1337 void SetContent(const WString& content);
1344 DateTime GetModifiedDateTime() const;
1352 void SetModifiedDateTime(const DateTime& date_time);
1359 uint32 GetFlags() const;
1368 void SetFlags(uint32 flags);
1374 WString GetUniqueID() const;
1382 void SetUniqueID(const WString& unique_id);
1389 RectF GetRect() const;
1390
1403 Matrix GetDisplayMatrix(const Matrix& page_display_matrix);
1404
1413 bool Move(const RectF& rect);
1414
1424 bool Move(const RectF& rect, bool is_reset_appearance);
1425
1439 BorderInfo GetBorderInfo() const;
1440
1456 void SetBorderInfo(const BorderInfo& border);
1465 RGB GetBorderColor() const;
1476 void SetBorderColor(RGB color);
1488 bool ResetAppearanceStream();
1489
1505 bool ResetAppearanceStream(bool is_generate_new_appearance_obj);
1506
1522 RectI GetDeviceRect(const Matrix& matrix);
1523
1529 objects::PDFDictionary* GetDict() const;
1530
1540 bool HasProperty(Property property) const;
1541
1556 bool RemoveProperty(Property property);
1557
1564 objects::PDFDictionary* GetOptionalContent() const;
1565
1579 objects::PDFStream* GetAppearanceStream(AppearanceType type, const char* appearance_state = "") const;
1580 };
1581
1583 FSDK_DEFINE_ARRAY(AnnotArray, Annot)
1584
1585
1586 class ShadingColor FS_FINAL : public Object {
1587 public:
1594 ShadingColor(ARGB firstcolor, ARGB secondcolor)
1595 : first_color(firstcolor)
1596 , second_color(secondcolor) {}
1597
1599 ShadingColor()
1600 : first_color(0xFFFFFFFF)
1601 , second_color(0xFFFFFFFF) {}
1602
1608 ShadingColor(const ShadingColor& shading_color)
1609 : first_color(shading_color.first_color)
1610 , second_color(shading_color.second_color) {}
1611
1619 ShadingColor& operator = (const ShadingColor& shading_color) {
1620 this->first_color = shading_color.first_color;
1621 this->second_color = shading_color.second_color;
1622 return *this;
1623 }
1624
1632 bool operator == (const ShadingColor& shading_color) const {
1633 return (first_color == shading_color.first_color && second_color == shading_color.second_color);
1634 }
1635
1643 bool operator != (const ShadingColor& shading_color) const {
1644 return (first_color != shading_color.first_color || second_color != shading_color.second_color);
1645 }
1646
1655 void Set(ARGB firstcolor, ARGB secondcolor) {
1656 this->first_color = firstcolor;
1657 this->second_color = secondcolor;
1658 }
1659
1661 ARGB first_color;
1663 ARGB second_color;
1664 };
1665
1674 class IconProviderCallback {
1675 public:
1681 virtual void Release() = 0;
1690 virtual String GetProviderID() {
1691 return String();
1692 }
1701 virtual String GetProviderVersion() {
1702 return String();
1703 }
1713 virtual bool HasIcon(Annot::Type annot_type, const char* icon_name) {
1714 return false;
1715 }
1725 virtual bool CanChangeColor(Annot::Type annot_type, const char* icon_name) {
1726 return false;
1727 }
1728 #ifndef __EMSCRIPTEN_RENDER__
1729
1740 virtual PDFPage GetIcon(Annot::Type annot_type, const char* icon_name, ARGB color, foxit::pdf::objects::PDFDictionary* annot_dict);
1741 #endif
1742
1755 virtual bool GetShadingColor(Annot::Type annot_type, const char* icon_name,
1756 RGB referenced_color, int shading_index, ShadingColor& out_shading_color) {
1757 return false;
1758 }
1769 virtual float GetDisplayWidth(Annot::Type annot_type, const char* icon_name) {
1770 return 0.0f;
1771 }
1782 virtual float GetDisplayHeight(Annot::Type annot_type, const char* icon_name) {
1783 return 0.0f;
1784 }
1785
1786 protected:
1787 ~IconProviderCallback() {}
1788 };
1789
1790 class Markup;
1792 FSDK_DEFINE_ARRAY(MarkupArray, Markup)
1793
1794 class Note;
1796 FSDK_DEFINE_ARRAY(NoteArray, Note)
1797
1798
1815 class Markup : public Annot {
1816 public:
1822 typedef enum _StateModel {
1824 e_StateModelMarked = 1,
1826 e_StateModelReview = 2
1827 } StateModel;
1828
1834 typedef enum _State {
1839 e_StateNone = 0,
1844 e_StateMarked = 1,
1849 e_StateUnmarked = 2,
1854 e_StateAccepted = 3,
1859 e_StateRejected = 4,
1864 e_StateCancelled = 5,
1869 e_StateCompleted = 6,
1874 e_StateDeferred = 7,
1879 e_StateFuture = 8
1880 } State;
1881
1887 typedef enum _EndingStyle {
1889 e_EndingStyleNone = 0,
1891 e_EndingStyleSquare = 1,
1893 e_EndingStyleCircle = 2,
1895 e_EndingStyleDiamond = 3,
1897 e_EndingStyleOpenArrow = 4,
1902 e_EndingStyleClosedArrow = 5,
1904 e_EndingStyleButt = 6,
1906 e_EndingStyleROpenArrow = 7,
1908 e_EndingStyleRClosedArrow = 8,
1910 e_EndingStyleSlash = 9
1911 } EndingStyle;
1912
1918 typedef enum _MeasureType {
1920 e_MeasureTypeX = 0,
1922 e_MeasureTypeY = 1,
1924 e_MeasureTypeD = 2,
1926 e_MeasureTypeA = 3,
1928 e_MeasureTypeT = 4,
1930 e_MeasureTypeS = 5
1931 } MeasureType;
1932
1933
1939 explicit Markup(const Annot& annot);
1940 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1941 explicit Markup(FS_HANDLE handle);
1943 Markup() {}
1944
1946 ~Markup() {}
1947
1963 Popup GetPopup();
1978 void SetPopup(const Popup& popup);
1979
1986 bool RemovePopup();
1987
1995 WString GetTitle() const;
1996
2006 void SetTitle(const WString& title);
2007
2013 WString GetSubject() const;
2014
2022 void SetSubject(const WString& subject);
2023
2032 float GetOpacity() const;
2033
2045 void SetOpacity(float opacity);
2046
2068 String GetIntent() const;
2069
2104 void SetIntent(const String& intent);
2105
2112 DateTime GetCreationDateTime() const;
2113
2121 void SetCreationDateTime(const DateTime& date_time);
2122
2128 int GetReplyCount();
2129
2138 Note GetReply(int index) const;
2139
2145 Note AddReply();
2146
2157 bool RemoveReply(int index);
2158
2164 bool RemoveAllReplies();
2165
2180 bool IsGrouped();
2181
2197 Markup GetGroupHeader();
2198
2213 MarkupArray GetGroupElements();
2214
2226 bool Ungroup();
2227
2243 NoteArray GetStateAnnots(StateModel model);
2244
2281 Note AddStateAnnot(const WString& title, StateModel model, State state);
2282
2292 bool RemoveAllStateAnnots();
2300 int32 GetRichTextCount();
2301
2312 WString GetRichTextContent(int32 index);
2313
2325 void SetRichTextContent(int32 index, const WString& content);
2326
2337 RichTextStyle GetRichTextStyle(int32 index);
2338
2352 void SetRichTextStyle(int32 index, const RichTextStyle& style);
2353
2366 void AddRichText(const WString& content, const RichTextStyle& style);
2367
2384 void InsertRichText(int32 index, const WString& content, const RichTextStyle& style);
2385
2396 void RemoveRichText(int index);
2397
2409 void SetBorderOpacity(float opacity);
2410
2417 float GetBorderOpacity() const;
2418
2430 void SetFillOpacity(float opacity);
2431
2438 float GetFillOpacity() const;
2439 };
2440
2461 class Note FS_FINAL : public Markup {
2462 public:
2464 Note() {}
2470 explicit Note(const Annot& annot);
2471 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
2472 explicit Note(FS_HANDLE handle);
2474 ~Note() {}
2475
2487 bool GetOpenStatus() const;
2501 void SetOpenStatus(bool status);
2513 String GetIconName() const;
2531 void SetIconName(const char* icon_name);
2541 Markup GetReplyTo();
2548 bool IsStateAnnot();
2549
2560 StateModel GetStateModel();
2561
2572 State GetState();
2573
2596 void SetState(State state);
2597
2598 };
2599
2611 class TextMarkup: public Markup {
2612 public:
2614 TextMarkup() {}
2620 explicit TextMarkup(const Annot& annot);
2622 ~TextMarkup() {}
2623
2637 QuadPointsArray GetQuadPoints() const;
2657 void SetQuadPoints(const QuadPointsArray& quad_points_array);
2658 };
2659
2674 class Highlight FS_FINAL : public TextMarkup {
2675 public:
2677 Highlight() {}
2683 explicit Highlight(const Annot& annot);
2685 ~Highlight() {}
2686 };
2687
2702 class Underline FS_FINAL : public TextMarkup {
2703 public:
2705 Underline() {}
2711 explicit Underline(const Annot& annot);
2713 ~Underline() {}
2714 };
2715
2730 class StrikeOut FS_FINAL : public TextMarkup {
2731 public:
2733 StrikeOut() {}
2739 explicit StrikeOut(const Annot& annot);
2741 ~StrikeOut() {}
2742 };
2743
2758 class Squiggly FS_FINAL : public TextMarkup {
2759 public:
2761 Squiggly() {}
2767 explicit Squiggly(const Annot& annot);
2769 ~Squiggly() {}
2770 };
2771
2785 class Link FS_FINAL : public Annot {
2786 public:
2788 Link() {}
2794 explicit Link(const Annot& annot);
2795 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
2796 explicit Link(FS_HANDLE handle);
2798 ~Link() {}
2799
2813 QuadPointsArray GetQuadPoints() const;
2831 void SetQuadPoints(const QuadPointsArray& quad_points_array);
2832
2840 HighlightingMode GetHighlightingMode();
2841
2850 void SetHighlightingMode(HighlightingMode mode);
2851
2858 actions::Action GetAction();
2859
2874 void SetAction(const actions::Action& action);
2875
2881 bool RemoveAction();
2882
2891 bool ExecuteJavaScriptAction(const actions::JavaScriptAction& javascript_action = actions::JavaScriptAction((FS_HANDLE)NULL));
2892 };
2893
2908 class Square FS_FINAL : public Markup {
2909 public:
2911 Square() {}
2917 explicit Square(const Annot& annot);
2919 ~Square() {}
2920
2927 RGB GetFillColor() const;
2928
2936 void SetFillColor(RGB fill_color);
2937
2947 RectF GetInnerRect() const;
2959 void SetInnerRect(const RectF& inner_rect);
2960
2973 void SetMeasureRatio(const char* ratio);
2974
2984 String GetMeasureRatio();
2985
2995 WString GetMeasureRatioW();
2996
3009 void SetMeasureUnit(MeasureType measure_type, const char* unit);
3010
3022 String GetMeasureUnit(MeasureType measure_type);
3023
3035 WString GetMeasureUnitW(MeasureType measure_type);
3036
3049 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3050
3062 float GetMeasureConversionFactor(MeasureType measure_type);
3063 };
3064
3079 class Circle FS_FINAL : public Markup {
3080 public:
3082 Circle() {}
3088 explicit Circle(const Annot& annot);
3090 ~Circle() {}
3091
3098 RGB GetFillColor() const;
3099
3110 void SetFillColor(RGB fill_color);
3111
3121 RectF GetInnerRect() const;
3122
3136 void SetInnerRect(const RectF& inner_rect);
3137
3150 void SetMeasureRatio(const char* ratio);
3151
3161 String GetMeasureRatio();
3162
3172 WString GetMeasureRatioW();
3173
3186 void SetMeasureUnit(MeasureType measure_type, const char* unit);
3187
3199 String GetMeasureUnit(MeasureType measure_type);
3200
3212 WString GetMeasureUnitW(MeasureType measure_type);
3213
3226 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3227
3239 float GetMeasureConversionFactor(MeasureType measure_type);
3240 };
3241
3260 class FreeText FS_FINAL : public Markup {
3261 public:
3263 FreeText() {}
3269 explicit FreeText(const Annot& annot);
3270
3272 ~FreeText() {}
3273
3284 RGB GetFillColor() const;
3285
3299 void SetFillColor(RGB fill_color);
3300
3314 common::Alignment GetAlignment() const;
3315
3332 void SetAlignment(common::Alignment alignment);
3333
3343 RectF GetInnerRect() const;
3344
3358 void SetInnerRect(const RectF& inner_rect);
3359
3368 DefaultAppearance GetDefaultAppearance();
3369
3392 bool SetDefaultAppearance(const DefaultAppearance& default_ap);
3393
3404 EndingStyle GetCalloutLineEndingStyle() const;
3405
3421 void SetCalloutLineEndingStyle(EndingStyle ending_style);
3422
3436 PointFArray GetCalloutLinePoints() const;
3437
3458 void SetCalloutLinePoints(const PointFArray& point_array);
3459
3475 void SetTextMatrix(const Matrix& text_matrix);
3476
3488 Matrix GetTextMatrix() const;
3489
3496 common::Rotation GetRotation();
3497
3512 void SetRotation(common::Rotation rotation);
3513
3525 void Rotate(common::Rotation rotation);
3526
3544 void AllowTextOverflow(bool is_text_overflow);
3545 };
3546
3564 class Line FS_FINAL : public Markup {
3565 public:
3571 typedef enum _CapPos {
3573 e_CapPosInline = 0,
3575 e_CapPosTop = 1
3576 } CapPos;
3577
3578
3580 Line() {}
3586 explicit Line(const Annot& annot);
3588 ~Line() {}
3589
3598 EndingStyle GetLineStartStyle() const;
3612 void SetLineStartStyle(EndingStyle ending_style);
3621 EndingStyle GetLineEndStyle() const;
3635 void SetLineEndStyle(EndingStyle ending_style);
3636
3647 RGB GetStyleFillColor() const;
3648
3662 void SetStyleFillColor(RGB color);
3663
3671 PointF GetStartPoint() const;
3683 void SetStartPoint(const PointF& point);
3684
3692 PointF GetEndPoint() const;
3704 void SetEndPoint(const PointF& point);
3705
3712 bool HasCaption() const;
3724 void EnableCaption(bool cap);
3725
3736 CapPos GetCaptionPositionType() const;
3751 void SetCaptionPositionType(CapPos cap_position);
3763 Offset GetCaptionOffset() const;
3778 void SetCaptionOffset(const Offset& offset);
3779
3792 float GetLeaderLineLength() const;
3808 void SetLeaderLineLength(float length);
3817 float GetLeaderLineExtensionLength() const;
3829 void SetLeaderLineExtensionLength(float extension_length);
3830
3839 float GetLeaderLineOffset() const;
3851 void SetLeaderLineOffset(float offset);
3852
3865 void SetMeasureRatio(const String& ratio);
3866
3876 String GetMeasureRatio();
3877
3887 WString GetMeasureRatioW();
3888
3901 void SetMeasureUnit(MeasureType measure_type, const String& unit);
3902
3914 String GetMeasureUnit(MeasureType measure_type);
3915
3927 WString GetMeasureUnitW(MeasureType measure_type);
3928
3941 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3942
3954 float GetMeasureConversionFactor(MeasureType measure_type);
3955 };
3956
3973 class Ink FS_FINAL : public Markup {
3974 public:
3976 Ink() {}
3982 explicit Ink(const Annot& annot);
3984 ~Ink() {}
4010 common::Path GetInkList();
4011
4042 void SetInkList(const common::Path& ink_list);
4043
4055 void EnableUseBezier(bool use_bezier);
4056
4057 };
4058
4083 class Stamp FS_FINAL : public Markup {
4084 public:
4086 Stamp() {}
4092 explicit Stamp(const Annot& annot);
4093 #ifndef __EMSCRIPTEN_RENDER__
4094
4095 ~Stamp();
4096 #endif
4097
4108 String GetIconName() const;
4132 void SetIconName(const char* icon_name);
4143 void SetBitmap(const common::Bitmap& bitmap);
4144
4166 void SetImage(const common::Image& image, int frame_index, int compress);
4167
4178 void SetRotation(int angle);
4179
4185 int GetRotation();
4186
4196 void Rotate(int angle);
4197 };
4198
4210 class Screen FS_FINAL : public Annot {
4211 public:
4213 Screen() {}
4219 explicit Screen(const Annot& annot);
4221 virtual ~Screen() {}
4222
4244 void SetImage(const common::Image& image, int frame_index, int compress);
4245
4252 common::Bitmap GetBitmap();
4253
4264 pdf::objects::PDFDictionary* GetMKDict() const;
4265
4272 void SetMKDict(pdf::objects::PDFDictionary* dict);
4273
4285 void SetRotation(common::Rotation rotate);
4286
4293 common::Rotation GetRotation();
4294
4303 float GetOpacity() const;
4315 void SetOpacity(float opacity);
4316
4322 WString GetTitle() const;
4330 void SetTitle(const WString& title);
4331
4341 actions::Action GetAction();
4365 void SetAction(const actions::Action& action);
4374 void RemoveAction();
4375 };
4376
4394 class Polygon FS_FINAL : public Markup {
4395 public:
4397 Polygon() {}
4403 explicit Polygon(const Annot& annot);
4405 ~Polygon() {}
4414 RGB GetFillColor() const;
4415
4426 void SetFillColor(RGB fill_color);
4427
4436 PointFArray GetVertexes();
4437
4449 void SetVertexes(const PointFArray& vertexes);
4450
4463 void SetMeasureRatio(const String& ratio);
4464
4474 String GetMeasureRatio();
4475
4485 WString GetMeasureRatioW();
4486
4499 void SetMeasureUnit(MeasureType measure_type, const String& unit);
4500
4512 String GetMeasureUnit(MeasureType measure_type);
4513
4525 WString GetMeasureUnitW(MeasureType measure_type);
4526
4539 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4540
4552 float GetMeasureConversionFactor(MeasureType measure_type);
4553 };
4554
4573 class PolyLine FS_FINAL : public Markup {
4574 public:
4576 PolyLine() {}
4582 explicit PolyLine(const Annot& annot);
4584 ~PolyLine() {}
4594 RGB GetStyleFillColor() const;
4605 void SetStyleFillColor(RGB fill_color);
4606
4615 PointFArray GetVertexes();
4616
4628 void SetVertexes(const PointFArray& vertexes);
4637 EndingStyle GetLineStartStyle() const;
4650 void SetLineStartStyle(EndingStyle starting_style);
4659 EndingStyle GetLineEndStyle() const;
4672 void SetLineEndStyle(EndingStyle ending_style);
4673
4686 void SetMeasureRatio(const String& ratio);
4687
4697 String GetMeasureRatio();
4698
4708 WString GetMeasureRatioW();
4709
4722 void SetMeasureUnit(MeasureType measure_type, const String& unit);
4723
4735 String GetMeasureUnit(MeasureType measure_type);
4736
4748 WString GetMeasureUnitW(MeasureType measure_type);
4749
4762 void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4763
4775 float GetMeasureConversionFactor(MeasureType measure_type);
4776 };
4777
4790 class Caret FS_FINAL : public Markup {
4791 public:
4793 Caret() {}
4799 explicit Caret(const Annot& annot);
4801 ~Caret() {}
4802
4812 RectF GetInnerRect() const;
4826 void SetInnerRect(const RectF& inner_rect);
4827 };
4828
4841 class FileAttachment FS_FINAL : public Markup {
4842 public:
4844 FileAttachment() {}
4850 explicit FileAttachment(const Annot& annot);
4852 ~FileAttachment() {}
4853
4861 bool SetFileSpec(const FileSpec& file_spec);
4862
4869 FileSpec GetFileSpec();
4870
4881 String GetIconName() const;
4882
4898 void SetIconName(const char* icon_name);
4899 };
4900
4910 class Popup FS_FINAL : public Annot {
4911 public:
4913 Popup() {}
4919 explicit Popup(const Annot& annot);
4920 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
4921 explicit Popup(FS_HANDLE handle);
4923 ~Popup() {}
4924
4936 bool GetOpenStatus() const;
4950 void SetOpenStatus(bool status);
4951
4959 Markup GetParent();
4960 };
4961 #ifndef __FSDK_NO_PSINK__
4962
4981 class PSInk FS_FINAL : public Annot {
4982 public:
4984 PSInk() {}
4990 explicit PSInk(const Annot& annot);
4991 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
4992 explicit PSInk(FS_HANDLE handle);
4994 ~PSInk() {}
4995
4996 };
4997 #endif
4998
5011 class Widget FS_FINAL : public Annot {
5012 public:
5018 typedef enum _LineSpacingStyle {
5020 e_LineSpacingSingle = 0,
5022 e_LineSpacingOneAndHalf = 1,
5024 e_LineSpacingDouble = 2,
5026 e_LineSpacingExactValue = 3,
5028 e_LineSpacingAuto = 4
5029 } LineSpacingStyle;
5030
5031
5033 Widget() {}
5039 explicit Widget(const Annot& annot);
5040 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
5041 explicit Widget(FS_HANDLE handle);
5042 #ifndef __EMSCRIPTEN_RENDER__
5043
5044 ~Widget();
5045 #endif
5046
5051 interform::Field GetField();
5052
5058 interform::Control GetControl();
5059
5068 HighlightingMode GetHighlightingMode();
5069
5080 void SetHighlightingMode(HighlightingMode mode);
5081
5091 actions::Action GetAction();
5092
5116 void SetAction(const actions::Action& action);
5117
5126 void RemoveAction();
5127
5139 bool HasMKEntry(MKEntry mk_entry);
5140
5152 void RemoveMKEntry(MKEntry mk_entry);
5153
5165 common::Rotation GetMKRotation() const;
5166
5178 void SetMKRotation(common::Rotation rotation);
5179
5190 RGB GetMKBorderColor() const;
5191
5202 void SetMKBorderColor(RGB color);
5203
5214 RGB GetMKBackgroundColor() const;
5215
5226 void SetMKBackgroundColor(RGB color);
5227
5241 WString GetMKNormalCaption() const;
5242
5256 void SetMKNormalCaption(const wchar_t* caption);
5257
5272 WString GetMKRolloverCaption() const;
5273
5288 void SetMKRolloverCaption(const wchar_t* caption);
5289
5302 WString GetMKDownCaption() const;
5303
5316 void SetMKDownCaption(const wchar_t* caption);
5317
5329 common::Bitmap GetMKNormalIconBitmap();
5330
5343 void SetMKNormalIconBitmap(const common::Bitmap& bitmap);
5344
5359 void SetMKNormalIconImage(const common::Image& image, int frame_index);
5360
5373 common::Bitmap GetMKRolloverIconBitmap();
5374
5388 void SetMKRolloverIconBitmap(const common::Bitmap& bitmap);
5389
5405 void SetMKRolloverIconImage(const common::Image& image, int frame_index);
5406
5419 common::Bitmap GetMKDownIconBitmap();
5420
5434 void SetMKDownIconBitmap(const common::Bitmap& bitmap);
5435
5451 void SetMKDownIconImage(const common::Image& image, int frame_index);
5452
5467 IconFit GetMKIconFit() const;
5468
5486 void SetMKIconFit(const IconFit& icon_fit);
5487
5500 MKIconCaptionRelation GetMKIconCaptionRelation() const;
5501
5516 void SetMKIconCaptionRelation(MKIconCaptionRelation relation);
5517
5525 void SetAppearanceState(const String& appearance_state);
5526
5532 String GetAppearanceState() const;
5533
5539 String GetAppearanceOnStateName() const;
5540
5552 LineSpacingStyle GetLineSpacing(float& line_spacing_value);
5553
5569 void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value);
5570
5571 #ifdef _SUPPORTWEBSDK_
5572 //Set push button icon form icon stream. stream is from doc::createIcon.
5573 //face: 0: normal, 1: down, 2: roller
5574 void SetButtonIcon(objects::PDFStream* icon, int face);
5575 #endif
5576 };
5577
5593 class Redact FS_FINAL : public Markup {
5594 public:
5596 Redact() {}
5602 explicit Redact(const Annot& annot);
5603 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
5604 explicit Redact(FS_HANDLE handle);
5605 #ifndef __EMSCRIPTEN_RENDER__
5606
5607 ~Redact();
5608 #endif
5609
5622 QuadPointsArray GetQuadPoints() const;
5623
5641 void SetQuadPoints(const QuadPointsArray& quad_points_array);
5642
5649 RGB GetFillColor() const;
5657 void SetFillColor(RGB fill_color);
5658
5665 RGB GetApplyFillColor() const;
5666
5674 void SetApplyFillColor(RGB fill_color);
5675
5681 WString GetOverlayText() const;
5682
5690 void SetOverlayText(const WString& overlay_text);
5691
5697 bool IsOverlayTextRepeated();
5698
5707 void EnableRepeatOverlayText(bool is_to_repeat_overlay_text);
5708
5717 common::Alignment GetOverlayTextAlignment() const;
5718
5731 void SetOverlayTextAlignment(common::Alignment alignment);
5732
5738 void EnableAutoFontSize();
5739
5748 DefaultAppearance GetDefaultAppearance();
5749
5772 bool SetDefaultAppearance(const DefaultAppearance& default_ap);
5773
5785 bool Apply();
5786 };
5787
5797 class Sound FS_FINAL : public Markup{
5798 public:
5804 typedef enum _SampleEncodingFormat {
5806 e_SampleEncodingFormatRaw = 0,
5808 e_SampleEncodingFormatSigned = 1,
5810 e_SampleEncodingFormatMuLaw = 2,
5812 e_SampleEncodingFormatALaw = 3
5813 } SampleEncodingFormat;
5814
5815
5817 Sound() {}
5818
5824 explicit Sound(const Annot& annot);
5825
5826 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
5827 explicit Sound(FS_HANDLE handle);
5828
5829 #ifndef __EMSCRIPTEN_RENDER__
5830
5831 ~Sound();
5832 #endif
5833
5844 objects::PDFStream* GetSoundStream() const;
5845
5851 float GetSamplingRate() const;
5852
5858 int GetChannelCount() const;
5859
5865 int GetBits() const;
5866
5873 SampleEncodingFormat GetSampleEncodingFormat() const;
5874
5880 String GetCompressionFormat() const;
5881
5895 FileSpec GetFileSpec() const;
5896 };
5897
5913 class PagingSeal FS_FINAL : public Annot {
5914 public:
5916 PagingSeal(const Annot& annot);
5917
5919 ~PagingSeal();
5920
5926 PagingSealSignature GetPagingSealSignature();
5927
5928 // 强烈建议用户不要使用此方法；否则可能出现未知情况。
5929 explicit PagingSeal(FS_HANDLE handle);
5930 };
5931
5932 } // namespace annots
5933 } // namespace pdf
5934 } // namespace foxit
5935
5936 #endif // FS_ANNOT_H_
5937
foxit::pdf::annots::Annot::e_Caret
注释类型：插入符注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:987
foxit::pdf::annots::Link::GetQuadPoints
QuadPointsArray GetQuadPoints() const
获取四边形。
foxit::pdf::annots::Screen
Definition: fs_annot.h:4210
foxit::pdf::annots::Line::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
设置用于测量的单位显示标签。
foxit::pdf::annots::Annot::e_Sound
注释类型：声音注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:995
foxit::pdf::annots::FileAttachment::~FileAttachment
~FileAttachment()
析构函数。
Definition: fs_annot.h:4852
foxit::pdf::annots::Popup
Definition: fs_annot.h:4910
foxit::pdf::annots::Annot::e_StrikeOut
注释类型：删除线注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:983
foxit::pdf::annots::Redact::GetFillColor
RGB GetFillColor() const
获取填充颜色。
foxit::pdf::interform::Control
Definition: fs_pdfform.h:1217
foxit::pdf::annots::ShadingColor
Definition: fs_annot.h:1586
foxit::pdf::annots::PolyLine::GetStyleFillColor
RGB GetStyleFillColor() const
获取某些线端样式的填充颜色。
foxit::pdf::annots::Annot::e_Watermark
注释类型：水印注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1010
foxit::pdf::annots::FreeText::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
设置内部矩形。
foxit::pdf::annots::PolyLine::GetLineEndStyle
EndingStyle GetLineEndStyle() const
获取终点的线端样式。
foxit::pdf::annots::Widget::SetMKNormalIconBitmap
void SetMKNormalIconBitmap(const common::Bitmap &bitmap)
设置一个位图作为 MK 字典中的普通图标。
foxit::pdf::annots::Line::SetLeaderLineExtensionLength
void SetLeaderLineExtensionLength(float extension_length)
设置引导线延伸的长度。
foxit::pdf::annots::Annot::GetDict
objects::PDFDictionary * GetDict() const
获取注释的字典对象。
foxit::pdf::annots::Sound::e_SampleEncodingFormatSigned
二进制补码值。
Definition: fs_annot.h:5808
foxit::pdf::annots::Note::GetReplyTo
Markup GetReplyTo()
获取当前注记注释回复的标记注释。
foxit::pdf::annots::Note::~Note
~Note()
析构函数。
Definition: fs_annot.h:2474
foxit::pdf::annots::Annot::e_MKRelationCaptionAboveIcon
标题在图标上方。
Definition: fs_annot.h:1211
foxit::pdf::annots::FileAttachment::FileAttachment
FileAttachment()
构造函数。
Definition: fs_annot.h:4844
CFX_ArrayTemplate::GetSize
int GetSize() const
获取数组中元素的数量。
Definition: fx_basic.h:1341
foxit::pdf::annots::Annot::e_Redact
注释类型：编辑注释。
Definition: fs_annot.h:1016
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor()
构造函数
Definition: fs_annot.h:1599
foxit::FS_HANDLE
void * FS_HANDLE
句柄类型。
Definition: fs_basictypes.h:214
foxit::pdf::annots::Widget::SetMKDownCaption
void SetMKDownCaption(const wchar_t *caption)
设置 MK 字典中的向下标题字符串。
foxit::pdf::annots::Annot::GetIndex
int GetIndex() const
获取当前注释在其所属页面中的索引。
foxit::pdf::annots::Polygon::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
获取用于测量的单位显示标签。
foxit::pdf::annots::Annot::e_Square
注释类型：矩形注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:969
foxit::pdf::annots::Caret::GetInnerRect
RectF GetInnerRect() const
获取内矩形。
foxit::pdf::annots::Widget::SetMKIconFit
void SetMKIconFit(const IconFit &icon_fit)
设置MK字典中的图标适合信息。
foxit::pdf::annots::Link::SetAction
void SetAction(const actions::Action &action)
设置动作。
foxit::pdf::annots::Square::SetMeasureRatio
void SetMeasureRatio(const char *ratio)
设置用于测量的比例比率字符串。
foxit::pdf::FileSpec
Definition: fs_filespec.h:38
foxit::pdf::annots::Widget::GetMKRolloverCaption
WString GetMKRolloverCaption() const
获取 MK 字典中的翻转标题字符串。
foxit::pdf::annots::Note::SetIconName
void SetIconName(const char *icon_name)
设置图标名称。
foxit::pdf::annots::Note
Definition: fs_annot.h:2461
foxit::pdf::annots::Circle::Circle
Circle()
构造函数。
Definition: fs_annot.h:3082
foxit::pdf::annots::Annot::GetType
Type GetType() const
获取当前注释的实际注释类型。
foxit::pdf::annots::Popup::~Popup
~Popup()
析构函数。
Definition: fs_annot.h:4923
foxit::pdf::annots::Line::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
获取用于测量的单位显示标签。
foxit::pdf::annots::Underline::~Underline
~Underline()
析构函数。
Definition: fs_annot.h:2713
foxit::pdf::annots::FileAttachment::GetIconName
String GetIconName() const
获取图标名称。
foxit::pdf::annots::Circle::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
获取用于测量的单位显示标签。
foxit::pdf::actions::JavaScriptAction
Definition: fs_action.h:735
foxit::pdf::annots::QuadPoints::third
PointF third
四边形的第三个点，使用 PDF 坐标系。
Definition: fs_annot.h:750
foxit::pdf::annots::FreeText::AllowTextOverflow
void AllowTextOverflow(bool is_text_overflow)
决定是否允许自由文本的文本溢出。
foxit::pdf::annots::Stamp::SetIconName
void SetIconName(const char *icon_name)
设置图标名称。
foxit::pdf::annots::Annot::e_MKEntryBackgroundColor
背景颜色条目。MK字典中的"BG"。
Definition: fs_annot.h:1154
foxit::pdf::actions::Action
Definition: fs_action.h:411
foxit::pdf::annots::Annot::SetModifiedDateTime
void SetModifiedDateTime(const DateTime &date_time)
设置最后修改日期时间。
foxit::DateTime
Definition: fs_basictypes.h:482
foxit::pdf::annots::Annot::e_3D
注释类型：3D注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1012
foxit::pdf::annots::Annot::GetRect
RectF GetRect() const
获取矩形，以PDF坐标系统表示。
foxit::pdf::annots::Annot::e_FlagLockedContents
注释标志：锁定内容。
Definition: fs_annot.h:1095
foxit::pdf::annots::Annot
Definition: fs_annot.h:947
foxit::pdf::annots::Annot::e_FlagHidden
注释标志：隐藏。
Definition: fs_annot.h:1040
foxit::pdf::annots::Caret::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
设置内矩形。
foxit::pdf::annots::Redact::GetDefaultAppearance
DefaultAppearance GetDefaultAppearance()
获取默认外观数据。
foxit::pdf::annots::Annot::e_MKRelationNoIcon
无图标；仅标题。
Definition: fs_annot.h:1205
foxit::pdf::annots::Ink::EnableUseBezier
void EnableUseBezier(bool use_bezier)
启用使用贝塞尔样条来为墨迹注释的外观生成墨迹路径。
foxit::pdf::annots::Note::SetState
void SetState(State state)
设置状态。
foxit::pdf::annots::BorderInfo::Set
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
设置边框信息。
Definition: fs_annot.h:600
foxit::pdf::annots::Square::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
设置用于测量的转换因子。
foxit::pdf::annots::Annot::e_AppearanceTypeRollover
注释的悬停外观。
Definition: fs_annot.h:1229
foxit::pdf::annots::Widget::e_LineSpacingDouble
行间距样式：双倍行间距。
Definition: fs_annot.h:5024
foxit::pdf::annots::Sound
Definition: fs_annot.h:5797
foxit::pdf::annots::Line::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
获取用于测量的单位显示标签（Unicode字符串格式）。
foxit::pdf::annots::Annot::e_MKRelationCaptionBelowIcon
标题在图标下方。
Definition: fs_annot.h:1209
foxit::pdf::annots::Line::SetLeaderLineOffset
void SetLeaderLineOffset(float offset)
设置引导线偏移的长度。
foxit::pdf::RichTextStyle::is_bold
bool is_bold
指示是否将文本设为粗体的布尔值。
Definition: fs_annot.h:401
foxit::pdf::annots::IconFit::is_proportional_scaling
bool is_proportional_scaling
是否使用等比缩放。
Definition: fs_annot.h:898
foxit::pdf::annots::Sound::e_SampleEncodingFormatRaw
未指定或0到(2^B - 1)范围内的无符号值。
Definition: fs_annot.h:5806
foxit::pdf::annots::Annot::ResetAppearanceStream
bool ResetAppearanceStream()
重置外观流。
foxit::pdf::annots::Square::GetFillColor
RGB GetFillColor() const
获取填充颜色。
foxit::pdf::RichTextStyle::mark_style
CornerMarkStyle mark_style
角标样式。角标样式可用于将文本设为上标或下标或不作为任何类型的角标。 请参考从RichTextStyle::e_CornerMarkNone开始的值，这应该是这些值中的一个。
Definition: fs_annot.h:422
foxit::pdf::annots::Highlight::~Highlight
~Highlight()
Destructor.
Definition: fs_annot.h:2685
foxit::pdf::annots::Polygon::GetVertexes
PointFArray GetVertexes()
获取顶点。
foxit::pdf::annots::Annot::e_HighlightingPush
高亮模式：按下，即显示注释的按下外观（如果有）。
Definition: fs_annot.h:1111
foxit::pdf::annots::Note::IsStateAnnot
bool IsStateAnnot()
检查当前注记注释是否用作状态注释。
foxit::pdf::annots::Line::GetLineStartStyle
EndingStyle GetLineStartStyle() const
获取起点的线条结束样式。
foxit::pdf::annots::Highlight
Definition: fs_annot.h:2674
foxit::Object
CFX_Object Object
对象类型。
Definition: fs_basictypes.h:221
foxit::pdf::annots::Annot::IsMarkup
bool IsMarkup() const
检查当前注释是否为标记注释。
foxit::pdf::annots::Annot::e_Screen
注释类型：屏幕注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1004
foxit::pdf::annots::Screen::SetImage
void SetImage(const common::Image &image, int frame_index, int compress)
为当前屏幕注释设置图像，使用指定的帧索引。
foxit::pdf::annots::Widget::Widget
Widget()
构造函数。
Definition: fs_annot.h:5033
foxit::pdf::annots::Link
Definition: fs_annot.h:2785
foxit::pdf::annots::Square::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
获取用于显示测量单位的标签。
foxit::pdf::annots::Redact::GetOverlayText
WString GetOverlayText() const
获取覆盖文本。
foxit::pdf::annots::Popup::GetOpenStatus
bool GetOpenStatus() const
获取打开状态。
foxit::pdf::annots::BorderInfo::style
Style style
边框样式。请参考 BorderInfo::e_Solid 及相关值，应为这些值中的一个。
Definition: fs_annot.h:618
foxit::pdf::RichTextStyle::is_italic
bool is_italic
指示是否将文本设为斜体的布尔值。
Definition: fs_annot.h:406
foxit::pdf::annots::Highlight::Highlight
Highlight()
构造函数。
Definition: fs_annot.h:2677
foxit::pdf::annots::Annot::e_PropertyFillColor
注释属性：填充颜色
Definition: fs_annot.h:1140
foxit::pdf::annots::FreeText::SetCalloutLineEndingStyle
void SetCalloutLineEndingStyle(EndingStyle ending_style)
设置标注线起点的线条结束样式。
foxit::pdf::annots::Annot::SetUniqueID
void SetUniqueID(const WString &unique_id)
设置唯一ID。
foxit::pdf::annots::Square::Square
Square()
构造函数。
Definition: fs_annot.h:2911
foxit::pdf::annots::Screen::SetMKDict
void SetMKDict(pdf::objects::PDFDictionary *dict)
设置外观特征字典（也称为"MK"字典）。
foxit::pdf::annots::Square::SetFillColor
void SetFillColor(RGB fill_color)
设置填充颜色。
foxit::pdf::annots::Line::SetEndPoint
void SetEndPoint(const PointF &point)
设置终点。
foxit::pdf::annots::Annot::e_MKRelationCaptionLeft
标题在图标左侧。
Definition: fs_annot.h:1215
foxit::pdf::annots::BorderInfo::operator=
BorderInfo & operator=(const BorderInfo &border_info)
赋值操作符。
Definition: fs_annot.h:539
foxit::pdf::annots::Stamp::~Stamp
~Stamp()
析构函数。
foxit::pdf::annots::PagingSeal::PagingSeal
PagingSeal(const Annot &annot)
构造函数。
foxit::pdf::annots::Annot::e_FlagToggleNoView
注释标志：切换无视图。
Definition: fs_annot.h:1089
foxit::pdf::annots::QuadPoints::operator!=
bool operator!=(const QuadPoints &quad_points) const
不等于操作符。
Definition: fs_annot.h:723
foxit::pdf::annots::FreeText::Rotate
void Rotate(common::Rotation rotation)
从当前状态按指定旋转值（顺时针）旋转当前注释。
foxit::pdf::annots::Screen::GetAction
actions::Action GetAction()
获取动作。
foxit::pdf::annots::Widget::SetMKRotation
void SetMKRotation(common::Rotation rotation)
设置 MK 字典中的旋转值。
foxit::pdf::annots::Line::SetLineStartStyle
void SetLineStartStyle(EndingStyle ending_style)
设置起点的线条结束样式。
foxit::pdf::annots::IconProviderCallback::GetDisplayWidth
virtual float GetDisplayWidth(Annot::Type annot_type, const char *icon_name)
用于获取指定图标显示宽度的回调函数，以设备大小（通常为像素）为单位。
Definition: fs_annot.h:1769
foxit::pdf::annots::IconProviderCallback::GetProviderVersion
virtual String GetProviderVersion()
用于获取提供程序版本的回调函数。
Definition: fs_annot.h:1701
foxit::pdf::annots::FreeText::SetAlignment
void SetAlignment(common::Alignment alignment)
设置对齐值
foxit::pdf::annots::Polygon::GetMeasureRatioW
WString GetMeasureRatioW()
获取用于测量的比例比率Unicode字符串。
foxit::pdf::RichTextStyle::e_CornerMarkSuperscript
角标样式：上标。
Definition: fs_annot.h:212
foxit::pdf::annots::Markup::State
State
标记注释状态的枚举。
Definition: fs_annot.h:1834
foxit::pdf::annots::Popup::GetParent
Markup GetParent()
获取相关的父标记注释。
foxit::pdf::annots::Redact::SetOverlayTextAlignment
void SetOverlayTextAlignment(common::Alignment alignment)
设置覆盖文本的对齐值。
foxit::pdf::annots::PolyLine::~PolyLine
~PolyLine()
析构函数。
Definition: fs_annot.h:4584
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:800
foxit::pdf::annots::Line::SetCaptionPositionType
void SetCaptionPositionType(CapPos cap_position)
设置标题的位置类型。
foxit::pdf::annots::Squiggly
Definition: fs_annot.h:2758
foxit::pdf::annots::Annot::SetContent
void SetContent(const WString &content)
设置内容。
foxit::pdf::annots::Annot::e_RichMedia
注释类型：富媒体注释。
Definition: fs_annot.h:1018
foxit::pdf::annots::Screen::GetMKDict
pdf::objects::PDFDictionary * GetMKDict() const
获取外观特征字典（也称为"MK"字典）。
foxit::pdf::annots::Link::GetHighlightingMode
HighlightingMode GetHighlightingMode()
获取高亮模式。
foxit::pdf::RichTextStyle::text_size
float text_size
文本大小。不应为负值。0表示文本不会显示。
Definition: fs_annot.h:385
foxit::pdf::annots::Annot::e_FlagNoZoom
注释标志：无缩放。
Definition: fs_annot.h:1054
fs_common.h
通用定义和类的头文件。
foxit::pdf::annots::TextMarkup::~TextMarkup
~TextMarkup()
析构函数。
Definition: fs_annot.h:2622
foxit::pdf::annots::Stamp::SetBitmap
void SetBitmap(const common::Bitmap &bitmap)
为当前印章注释设置位图。
foxit::pdf::annots::Sound::~Sound
~Sound()
析构函数。
foxit::pdf::annots::Annot::~Annot
virtual ~Annot()
析构函数。
foxit::pdf::annots::FreeText::GetCalloutLineEndingStyle
EndingStyle GetCalloutLineEndingStyle() const
获取标注线起点的线条结束样式。
foxit::pdf::annots::Square
Definition: fs_annot.h:2908
foxit::pdf::annots::Screen::Screen
Screen()
构造函数。
Definition: fs_annot.h:4213
foxit::pdf::annots::ShadingColor::second_color
ARGB second_color
用于着色的第二种颜色。格式：0xAARRGGBB。
Definition: fs_annot.h:1663
foxit::pdf::annots::BorderInfo::e_Cloudy
边框样式：云朵。
Definition: fs_annot.h:483
CFX_ArrayTemplate< float >
foxit::pdf::annots::Annot::e_Popup
注释类型：弹出注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1014
foxit::pdf::annots::Line::GetLeaderLineExtensionLength
float GetLeaderLineExtensionLength() const
获取引导线延伸的长度。
foxit::pdf::annots::Redact::EnableRepeatOverlayText
void EnableRepeatOverlayText(bool is_to_repeat_overlay_text)
设置标志以决定是否重复覆盖文本。
foxit::pdf::annots::Annot::e_FreeText
注释类型：自由文本注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:965
foxit::pdf::annots::BorderInfo::e_Solid
边框样式：实线
Definition: fs_annot.h:449
foxit::pdf::annots::Circle::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
设置用于测量的转换因子。
foxit::pdf::annots::IconFit::fit_bounds
bool fit_bounds
是否将按钮外观完全缩放到边界内。
Definition: fs_annot.h:912
foxit::pdf::annots::Underline
Definition: fs_annot.h:2702
foxit::pdf::annots::PolyLine::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
设置用于测量的单位显示标签。
foxit::common::Alignment
Alignment
对齐方式（水平）枚举。
Definition: fs_common.h:94
foxit::pdf::annots::Sound::GetChannelCount
int GetChannelCount() const
获取声音通道数。
foxit::pdf::annots::PolyLine::PolyLine
PolyLine()
构造函数。
Definition: fs_annot.h:4576
foxit::pdf::annots::Line::GetLeaderLineOffset
float GetLeaderLineOffset() const
获取引导线偏移的长度。
foxit::pdf::annots::Stamp
Definition: fs_annot.h:4083
foxit::pdf::annots::QuadPoints::Set
void Set(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
设置值。
Definition: fs_annot.h:738
foxit::pdf::annots::Line::HasCaption
bool HasCaption() const
检查当前直线注释的内容是否应该在外观中复制为标题。
foxit::pdf::annots::Annot::e_HighlightingInvert
高亮模式：反转，即反转注释矩形的内容。
Definition: fs_annot.h:1107
foxit::pdf::annots::Circle::~Circle
~Circle()
析构函数。
Definition: fs_annot.h:3090
foxit::pdf::annots::Annot::e_MKEntryBorderColor
边框颜色条目。MK字典中的"BC"。
Definition: fs_annot.h:1152
foxit::pdf::annots::Annot::GetFlags
uint32 GetFlags() const
获取注释标志。
fs_file.h
文件操作相关定义和函数的头文件。
foxit::pdf::DefaultAppearance::e_FlagFont
指示pdf::DefaultAppearance的字体属性是有意义的。
Definition: fs_annot.h:59
foxit::pdf::annots::Link::SetQuadPoints
void SetQuadPoints(const QuadPointsArray &quad_points_array)
设置四边形。
foxit::pdf::annots::Link::RemoveAction
bool RemoveAction()
移除动作。
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor(ARGB firstcolor, ARGB secondcolor)
构造函数，带参数。
Definition: fs_annot.h:1594
foxit::pdf::annots::Square::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
设置内部矩形。
foxit::pdf::annots::Widget::SetMKRolloverCaption
void SetMKRolloverCaption(const wchar_t *caption)
设置 MK 字典中的翻转标题字符串。
foxit::pdf::annots::Widget
Definition: fs_annot.h:5011
foxit::pdf::annots::ShadingColor::Set
void Set(ARGB firstcolor, ARGB secondcolor)
设置值。
Definition: fs_annot.h:1655
foxit::ARGB
uint32 ARGB
ARGB 颜色类型，32 位，((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
foxit::pdf::annots::Annot::GetUniqueID
WString GetUniqueID() const
获取唯一ID。
foxit::pdf::annots::Sound::Sound
Sound()
构造函数。
Definition: fs_annot.h:5817
foxit::pdf::annots::Widget::SetAppearanceState
void SetAppearanceState(const String &appearance_state)
设置注释的外观状态，从外观子字典中选择适用的外观流。
foxit::pdf::annots::Sound::GetSoundStream
objects::PDFStream * GetSoundStream() const
获取声音数据的流。
foxit::pdf::annots::PolyLine::GetMeasureRatio
String GetMeasureRatio()
获取用于测量的比例比率字符串。
foxit::pdf::annots::Circle::GetMeasureRatioW
WString GetMeasureRatioW()
获取用于测量的比例比率Unicode字符串。
foxit::pdf::annots::IconFit::IconFit
IconFit()
构造函数
Definition: fs_annot.h:782
foxit::pdf::annots::Widget::GetMKNormalIconBitmap
common::Bitmap GetMKNormalIconBitmap()
获取 MK 字典中的普通图标位图。
foxit::pdf::annots::BorderInfo::e_Dashed
边框样式：虚线。
Definition: fs_annot.h:456
foxit::pdf::annots::Redact::SetQuadPoints
void SetQuadPoints(const QuadPointsArray &quad_points_array)
设置四边形。
foxit::pdf::annots::FreeText::SetDefaultAppearance
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
设置默认外观数据。
foxit::pdf::annots::Annot::e_FlagPrint
注释标志：打印。
Definition: fs_annot.h:1047
foxit::pdf::annots::Annot::SetBorderColor
void SetBorderColor(RGB color)
设置边框颜色。
foxit::pdf::annots::Annot::e_FlagNoView
注释标志：无视图。
Definition: fs_annot.h:1068
foxit::pdf::annots::Redact::GetOverlayTextAlignment
common::Alignment GetOverlayTextAlignment() const
获取覆盖文本的对齐值。
foxit::pdf::annots::FreeText::GetTextMatrix
Matrix GetTextMatrix() const
获取当前自由文本注释中文本的默认外观数据中的矩阵。
foxit::pdf::annots::Annot::GetDisplayMatrix
Matrix GetDisplayMatrix(const Matrix &page_display_matrix)
获取显示矩阵，从PDF坐标系统到 目标设备坐标系统。
foxit::pdf::annots::Redact::EnableAutoFontSize
void EnableAutoFontSize()
为覆盖文本启用自动字体大小。
foxit::pdf::annots::Widget::e_LineSpacingOneAndHalf
行间距样式：1.5倍行间距。
Definition: fs_annot.h:5022
foxit::pdf::annots::Line::GetCaptionOffset
Offset GetCaptionOffset() const
获取标题偏移值。
foxit::pdf::annots::PSInk::~PSInk
~PSInk()
析构函数。
Definition: fs_annot.h:4994
foxit::pdf::annots::Line::e_CapPosTop
Definition: fs_annot.h:3575
foxit::pdf::annots::PSInk::PSInk
PSInk()
构造函数。
Definition: fs_annot.h:4984
foxit::pdf::annots::Markup::Markup
Markup()
构造函数
Definition: fs_annot.h:1943
foxit::pdf::annots::ShadingColor::first_color
ARGB first_color
用于着色的第一种颜色。格式：0xAARRGGBB。
Definition: fs_annot.h:1661
foxit::pdf::annots::NoteArray
Definition: fs_annot.h:1796
foxit::pdf::annots::Note::GetStateModel
StateModel GetStateModel()
获取状态模型。
foxit::pdf::annots::Annot::e_MKRelationNoCaption
无标题；仅图标。
Definition: fs_annot.h:1207
foxit::pdf::annots::Widget::GetMKBorderColor
RGB GetMKBorderColor() const
获取 MK 字典中的边框颜色。
foxit::common::e_AlignmentLeft
左对齐。
Definition: fs_common.h:96
foxit::pdf::RichTextStyle::e_CornerMarkSubscript
角标样式：下标。
Definition: fs_annot.h:214
foxit::common::Path
Definition: fs_common.h:2167
foxit::pdf::annots::Annot::e_FileAttachment
注释类型：文件附件注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:993
foxit::pdf::annots::FreeText::GetInnerRect
RectF GetInnerRect() const
获取内部矩形。
foxit::pdf::annots::FreeText::SetRotation
void SetRotation(common::Rotation rotation)
设置旋转值（顺时针）。
foxit::pdf::annots::Screen::~Screen
virtual ~Screen()
析构函数。
Definition: fs_annot.h:4221
foxit::pdf::annots::Annot::e_Note
注释类型：注记注释，即"文本"注释 - <PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:961
foxit::pdf::annots::Line::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
获取用于测量的转换因子。
foxit::pdf::annots::Note::GetOpenStatus
bool GetOpenStatus() const
获取开放状态。
foxit::pdf::annots::Annot::e_UnknownType
注释类型：未知。
Definition: fs_annot.h:956
foxit::pdf::annots::Stamp::Stamp
Stamp()
构造函数。
Definition: fs_annot.h:4086
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor(const ShadingColor &shading_color)
拷贝构造函数。
Definition: fs_annot.h:1608
foxit::pdf::annots::Annot::e_FlagInvisible
注释标志：不可见。
Definition: fs_annot.h:1034
foxit::pdf::annots::Redact::SetDefaultAppearance
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
设置默认外观数据。
foxit::pdf::annots::StrikeOut
Definition: fs_annot.h:2730
foxit::pdf::annots::FreeText
Definition: fs_annot.h:3260
foxit::pdf::annots::Markup
Definition: fs_annot.h:1815
foxit::pdf::annots::Ink
Definition: fs_annot.h:3973
foxit::pdf::annots::Caret::Caret
Caret()
构造函数。
Definition: fs_annot.h:4793
foxit::pdf::annots::BorderInfo::dashes
FloatArray dashes
表示虚线模式的虚线数组。
Definition: fs_annot.h:645
foxit::pdf::annots::PolyLine::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
获取用于测量的转换因子。
foxit::pdf::annots::Sound::e_SampleEncodingFormatMuLaw
μ律编码采样。
Definition: fs_annot.h:5810
foxit::pdf::annots::Line::Line
Line()
构造函数。
Definition: fs_annot.h:3580
foxit::pdf::annots::Line::GetEndPoint
PointF GetEndPoint() const
获取终点。
foxit::pdf::annots::Circle::SetMeasureRatio
void SetMeasureRatio(const char *ratio)
设置用于测量的比例比率字符串。
foxit::pdf::annots::Polygon::GetMeasureRatio
String GetMeasureRatio()
获取用于测量的比例比率字符串。
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance(const DefaultAppearance &default_appearance)
构造函数，使用另一个默认外观对象。
Definition: fs_annot.h:97
foxit::pdf::annots::Circle
Definition: fs_annot.h:3079
foxit::pdf::annots::Annot::e_MKEntryIconCaptionRelation
图标和标题关系条目。MK字典中的"TP"。
Definition: fs_annot.h:1195
foxit::pdf::DefaultAppearance::DefAPFlags
DefAPFlags
默认外观标志枚举。
Definition: fs_annot.h:57
foxit::pdf::annots::Ink::SetInkList
void SetInkList(const common::Path &ink_list)
设置墨迹列表数据。
foxit::pdf::annots::Widget::GetMKNormalCaption
WString GetMKNormalCaption() const
获取 MK 字典中的普通标题字符串。
foxit::pdf::annots::Widget::SetLineSpacing
void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value)
设置当前小部件的行间距。
foxit::pdf::annots::Redact
Definition: fs_annot.h:5593
foxit::pdf::annots::Annot::e_FlagLocked
注释标志：锁定。
Definition: fs_annot.h:1083
foxit::pdf::annots::IconFit::scale_way_type
ScaleWayType scale_way_type
指定图标在注释矩形内缩放的情形。请参考 IconFit::e_ScaleWayNone 及相关值。 当用于设置时，该值不应为 IconFit::e_ScaleWayNone。
Definition: fs_annot.h:892
foxit::pdf::annots::PagingSeal::GetPagingSealSignature
PagingSealSignature GetPagingSealSignature()
获取关联的分页印章签名。
foxit::pdf::annots::PolyLine::SetVertexes
void SetVertexes(const PointFArray &vertexes)
设置顶点。
foxit::pdf::annots::Annot::GetDeviceRect
RectI GetDeviceRect(const Matrix &matrix)
获取设备坐标系统中的注释矩形。
foxit::pdf::annots::Widget::SetHighlightingMode
void SetHighlightingMode(HighlightingMode mode)
设置高亮模式。
foxit::pdf::annots::QuadPoints::first
PointF first
四边形的第一个点，使用 PDF 坐标系。
Definition: fs_annot.h:746
foxit::pdf::annots::Annot::e_MKRelationCaptionOvrlayOnIcon
标题直接覆盖在图标上。
Definition: fs_annot.h:1217
foxit::pdf::annots::Annot::e_PropertyModifiedDate
注释属性：修改日期。
Definition: fs_annot.h:1123
foxit::pdf::annots::Redact::~Redact
~Redact()
析构函数。
foxit::pdf::RichTextStyle
Definition: fs_annot.h:201
foxit::pdf::annots::IconProviderCallback::CanChangeColor
virtual bool CanChangeColor(Annot::Type annot_type, const char *icon_name)
用于检查当前图标提供程序是否支持为指定类型更改颜色的回调函数。
Definition: fs_annot.h:1725
foxit::pdf::annots::Annot::e_MKEntryNormalIcon
正常图标条目。MK字典中的"I"。
Definition: fs_annot.h:1174
foxit::pdf::annots::Screen::SetTitle
void SetTitle(const WString &title)
设置当前屏幕注释的标题。
foxit::pdf::RichTextStyle::text_color
RGB text_color
文本颜色。格式：0xRRGGBB。
Definition: fs_annot.h:396
foxit::pdf::annots::Widget::e_LineSpacingAuto
行间距样式：自动行间距。
Definition: fs_annot.h:5028
foxit::pdf::annots::Line::SetLineEndStyle
void SetLineEndStyle(EndingStyle ending_style)
设置终点的线条结束样式。
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
构造函数，带参数。
Definition: fs_annot.h:504
foxit::pdf::annots::PolyLine::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
获取用于显示测量单位的标签。
foxit::pdf::annots::Widget::e_LineSpacingExactValue
行间距样式：精确值行间距。
Definition: fs_annot.h:5026
foxit::pdf::annots::Stamp::GetRotation
int GetRotation()
获取当前旋转角度（顺时针方向）。
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::AppearanceType
AppearanceType
注释外观类型的枚举。
Definition: fs_annot.h:1225
foxit::pdf::annots::Annot::e_MKEntryRolloverIcon
悬停图标条目。MK字典中的"RI"。
Definition: fs_annot.h:1179
foxit::pdf::annots::Square::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
获取用于显示测量单位的标签。
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:1755
foxit::pdf::annots::Annot::e_HighlightingToggle
高亮模式：切换。这仅对小组件注释有用。
Definition: fs_annot.h:1113
foxit::pdf::interform::Field
Definition: fs_pdfform.h:145
foxit::pdf::annots::Link::ExecuteJavaScriptAction
bool ExecuteJavaScriptAction(const actions::JavaScriptAction &javascript_action=actions::JavaScriptAction((FS_HANDLE) 0))
执行与链接注释关联的 JavaScript 动作。
foxit::pdf::annots::Screen::RemoveAction
void RemoveAction()
移除动作。
foxit::pdf::annots::Link::Link
Link()
构造函数。
Definition: fs_annot.h:2788
foxit::pdf::DefaultAppearance::operator!=
bool operator!=(const DefaultAppearance &default_appearance) const
不等于运算符。
Definition: fs_annot.h:138
foxit::pdf::annots::Annot::e_HighlightingNone
高亮模式：无高亮。
Definition: fs_annot.h:1105
foxit::pdf::annots::Annot::e_FlagNoRotate
注释标志：无旋转。
Definition: fs_annot.h:1061
foxit::pdf::annots::Square::GetMeasureRatio
String GetMeasureRatio()
获取用于测量的比例比率字符串。
foxit::pdf::annots::Widget::GetControl
interform::Control GetControl()
获取关联的表单控件。
CFX_ByteString
字节字符串类
Definition: fx_string.h:317
fs_action.h
目标和动作相关定义和类的头文件。
foxit::pdf::annots::PolyLine::SetLineStartStyle
void SetLineStartStyle(EndingStyle starting_style)
设置起始点的线端样式。
foxit::pdf::annots::Line::GetMeasureRatio
String GetMeasureRatio()
获取用于测量的比例比率字符串。
foxit::pdf::annots::Square::GetInnerRect
RectF GetInnerRect() const
获取内部矩形。
foxit::pdf::annots::AnnotArray
Definition: fs_annot.h:1583
foxit::pdf::annots::Annot::SetBorderInfo
void SetBorderInfo(const BorderInfo &border)
设置边框信息。
foxit::pdf::annots::Annot::Property
Property
某些PDF注释属性的枚举。
Definition: fs_annot.h:1121
foxit::pdf::annots::Polygon::SetVertexes
void SetVertexes(const PointFArray &vertexes)
设置顶点。
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance()
构造函数。
Definition: fs_annot.h:87
foxit::pdf::annots::Annot::GetPage
PDFPage GetPage() const
获取相关的PDF页面。
foxit::pdf::annots::Popup::SetOpenStatus
void SetOpenStatus(bool status)
设置打开状态。
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints(const QuadPoints &quad_points)
拷贝构造函数。
Definition: fs_annot.h:683
foxit::pdf::annots::QuadPoints::fourth
PointF fourth
四边形的第四个点，使用 PDF 坐标系。
Definition: fs_annot.h:752
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::Annot::e_AppearanceTypeNormal
注释的正常外观。
Definition: fs_annot.h:1227
foxit::pdf::annots::Annot::e_Highlight
注释类型：高亮注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:977
foxit::pdf::annots::BorderInfo::e_UnderLine
边框样式：下划线。
Definition: fs_annot.h:462
foxit::pdf::annots::Widget::GetMKIconFit
IconFit GetMKIconFit() const
获取MK字典中的图标适合信息。
foxit::pdf::annots::Widget::GetAction
actions::Action GetAction()
获取动作。
foxit::pdf::annots::PolyLine::SetLineEndStyle
void SetLineEndStyle(EndingStyle ending_style)
设置终点的线端样式。
foxit::pdf::RichTextStyle::font
common::Font font
富文本样式中使用的字体。应该是有效的字体对象。
Definition: fs_annot.h:380
foxit::pdf::annots::Screen::SetRotation
void SetRotation(common::Rotation rotate)
设置用于当前屏幕注释外观的图像旋转。
foxit::pdf::annots::Polygon::Polygon
Polygon()
构造函数。
Definition: fs_annot.h:4397
foxit::pdf::annots::PolyLine::GetMeasureRatioW
WString GetMeasureRatioW()
获取用于测量的比例比率字符串。
foxit::pdf::annots::Polygon::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
设置用于测量的转换因子。
foxit::pdf::annots::PagingSeal
Definition: fs_annot.h:5913
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo()
默认构造函数。
Definition: fs_annot.h:513
foxit::pdf::annots::Markup::StateModel
StateModel
标记注释状态模型的枚举。
Definition: fs_annot.h:1822
foxit::pdf::annots::FileAttachment::SetFileSpec
bool SetFileSpec(const FileSpec &file_spec)
设置文件规范，应指定嵌入的文件。
CFX_PSVTemplate
Definition: fx_coordinates.h:30
foxit::pdf::annots::FileAttachment::GetFileSpec
FileSpec GetFileSpec()
获取文件规范。
foxit::pdf::annots::Annot::GetBorderColor
RGB GetBorderColor() const
获取边框颜色。
foxit::pdf::annots::PolyLine::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
获取用于显示测量单位的标签。
foxit::pdf::annots::Annot::e_Movie
注释类型：电影注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:997
foxit::pdf::annots::Sound::GetSamplingRate
float GetSamplingRate() const
获取采样率，以每秒采样数为单位。
foxit::pdf::annots::Sound::GetFileSpec
FileSpec GetFileSpec() const
获取表示外部声音文件的文件规范对象。
foxit::pdf::annots::Redact::SetOverlayText
void SetOverlayText(const WString &overlay_text)
设置覆盖文本。
foxit::pdf::RichTextStyle::char_space
float char_space
字符间距。对于表格生成器不应为负值。仅在pdf::PDFPage::AddText中使用。
Definition: fs_annot.h:427
foxit::common::Rotation
Rotation
旋转的枚举。
Definition: fs_common.h:57
foxit::pdf::annots::Annot::e_Underline
注释类型：下划线注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:979
foxit::pdf::RichTextStyle::CornerMarkStyle
CornerMarkStyle
角标样式枚举。
Definition: fs_annot.h:208
foxit::pdf::annots::Redact::GetQuadPoints
QuadPointsArray GetQuadPoints() const
获取四边形。
foxit::pdf::annots::Markup::EndingStyle
EndingStyle
线条端点样式的枚举。
Definition: fs_annot.h:1887
foxit::pdf::annots::BorderInfo
Definition: fs_annot.h:440
foxit::pdf::annots::Screen::GetOpacity
float GetOpacity() const
获取不透明度值。
foxit::pdf::annots::Widget::RemoveAction
void RemoveAction()
移除动作。
foxit::pdf::annots::Square::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const char *unit)
设置用于显示测量单位的标签。
foxit::pdf::annots::Widget::HasMKEntry
bool HasMKEntry(MKEntry mk_entry)
检查在 MK 字典中是否存在指定的条目。
foxit::pdf::annots::Widget::e_LineSpacingSingle
行间距样式：单倍行间距。
Definition: fs_annot.h:5020
foxit::pdf::annots::Widget::GetField
interform::Field GetField()
获取关联的表单字段。
foxit::pdf::annots::Caret::~Caret
~Caret()
析构函数。
Definition: fs_annot.h:4801
foxit::pdf::annots::Widget::SetAction
void SetAction(const actions::Action &action)
设置动作。
foxit::pdf::annots::Circle::SetFillColor
void SetFillColor(RGB fill_color)
设置填充颜色。
foxit::pdf::annots::Annot::MKEntry
MKEntry
注释MK字典（外观特征）条目的枚举。
Definition: fs_annot.h:1148
foxit::pdf::RichTextStyle::operator!=
bool operator!=(const RichTextStyle &style) const
不等于运算符。
Definition: fs_annot.h:331
operator==
bool operator==(const char *str1, const CFX_ByteString &str2)
检查两个字节字符串是否相等。
Definition: fs_basictypes.h:128
foxit::pdf::annots::Circle::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
获取用于测量的单位显示标签。
foxit::pdf::annots::Line::GetStyleFillColor
RGB GetStyleFillColor() const
Get fill color for ending styles.
foxit::pdf::annots::Annot::GetBorderInfo
BorderInfo GetBorderInfo() const
获取边框信息。
foxit::pdf::annots::Redact::SetApplyFillColor
void SetApplyFillColor(RGB fill_color)
设置用于翻转外观的填充颜色，将在应用编辑后使用。
foxit::pdf::annots::Annot::GetOptionalContent
objects::PDFDictionary * GetOptionalContent() const
获取注释可选内容的PDF字典。
foxit::pdf::annots::Squiggly::~Squiggly
~Squiggly()
析构函数。
Definition: fs_annot.h:2769
foxit::pdf::annots::Annot::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::pdf::annots::Sound::SampleEncodingFormat
SampleEncodingFormat
声音采样数据编码格式的枚举。
Definition: fs_annot.h:5804
fs_pdfobject.h
PDF对象相关定义和类的头文件。
foxit::pdf::DefaultAppearance::flags
uint32 flags
指示默认外观的哪些属性是有意义的标志。
Definition: fs_annot.h:173
foxit::pdf::annots::FreeText::SetCalloutLinePoints
void SetCalloutLinePoints(const PointFArray &point_array)
设置标注线的点。
foxit::pdf::annots::Annot::e_Polygon
注释类型：多边形注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:973
foxit::pdf::annots::Annot::e_PropertyBorderColor
注释属性：边框颜色。
Definition: fs_annot.h:1134
foxit::pdf::annots::Widget::SetMKDownIconBitmap
void SetMKDownIconBitmap(const common::Bitmap &bitmap)
设置MK字典中的按下图标位图。
foxit::pdf::annots::Annot::RemoveProperty
bool RemoveProperty(Property property)
删除指定的注释属性。
foxit::pdf::annots::Widget::SetMKNormalCaption
void SetMKNormalCaption(const wchar_t *caption)
设置 MK 字典中的普通标题字符串。
foxit::pdf::annots::StrikeOut::StrikeOut
StrikeOut()
构造函数。
Definition: fs_annot.h:2733
foxit
Foxit命名空间。
Definition: fs_taggedpdf.h:27
foxit::pdf::annots::Stamp::SetImage
void SetImage(const common::Image &image, int frame_index, int compress)
为当前印章注释设置图像，使用指定的帧索引。
foxit::pdf::annots::Annot::e_HighlightingOutline
高亮模式：轮廓，即反转注释的边框。
Definition: fs_annot.h:1109
foxit::pdf::annots::Underline::Underline
Underline()
构造函数。
Definition: fs_annot.h:2705
foxit::pdf::annots::Screen::SetOpacity
void SetOpacity(float opacity)
设置不透明度值。
foxit::pdf::annots::Screen::GetTitle
WString GetTitle() const
获取当前屏幕注释的标题。
foxit::pdf::annots::Widget::SetMKIconCaptionRelation
void SetMKIconCaptionRelation(MKIconCaptionRelation relation)
设置MK字典中图标和标题的关系。
foxit::pdf::annots::Widget::GetMKDownIconBitmap
common::Bitmap GetMKDownIconBitmap()
获取MK字典中的按下图标位图。
foxit::pdf::annots::Widget::SetMKBackgroundColor
void SetMKBackgroundColor(RGB color)
设置 MK 字典中的背景颜色。
foxit::pdf::DefaultAppearance::e_FlagFontSize
指示pdf::DefaultAppearance的文本大小属性是有意义的。
Definition: fs_annot.h:63
foxit::pdf::DefaultAppearance::font
common::Font font
默认外观的字体。当它有用时，应该是一个有效的字体对象。
Definition: fs_annot.h:180
foxit::pdf::annots::FreeText::FreeText
FreeText()
构造函数。
Definition: fs_annot.h:3263
foxit::pdf::annots::Line::SetStartPoint
void SetStartPoint(const PointF &point)
设置起点。
foxit::pdf::annots::FreeText::GetDefaultAppearance
DefaultAppearance GetDefaultAppearance()
获取默认外观数据。
foxit::pdf::RichTextStyle::text_alignment
common::Alignment text_alignment
对齐值。请参考从common::e_AlignmentLeft开始的值， 这应该是这些值中的一个。
Definition: fs_annot.h:391
foxit::pdf::annots::QuadPoints::operator==
bool operator==(const QuadPoints &quad_points) const
等于操作符。
Definition: fs_annot.h:711
foxit::pdf::annots::Square::GetMeasureRatioW
WString GetMeasureRatioW()
获取用于测量的比例比率 Unicode 字符串。
foxit::pdf::annots::Annot::e_MKEntryIconFit
图标适配信息条目。MK字典中的"IF"。
Definition: fs_annot.h:1189
foxit::pdf::annots::PagingSeal::~PagingSeal
~PagingSeal()
析构函数。
foxit::pdf::annots::Polygon::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
设置用于测量的单位显示标签。
foxit::pdf::annots::StrikeOut::~StrikeOut
~StrikeOut()
析构函数。
Definition: fs_annot.h:2741
foxit::pdf::annots::Polygon::GetFillColor
RGB GetFillColor() const
获取填充颜色。
foxit::pdf::annots::FreeText::GetFillColor
RGB GetFillColor() const
获取填充颜色。
foxit::pdf::annots::IconProviderCallback::GetProviderID
virtual String GetProviderID()
用于获取提供程序ID的回调函数。
Definition: fs_annot.h:1690
foxit::pdf::annots::IconFit::ScaleWayType
ScaleWayType
图标缩放方式类型的枚举。
Definition: fs_annot.h:767
foxit::pdf::RichTextStyle::e_CornerMarkNone
角标样式：无。
Definition: fs_annot.h:210
foxit::pdf::annots::Annot::e_MKEntryRotation
旋转条目。MK字典中的"R"。
Definition: fs_annot.h:1150
foxit::pdf::annots::QuadPoints
Definition: fs_annot.h:658
foxit::pdf::annots::Widget::GetMKRolloverIconBitmap
common::Bitmap GetMKRolloverIconBitmap()
获取 MK 字典中的翻转图标位图。
fs_image.h
图像和位图相关定义和类的头文件。
foxit::pdf::annots::IconProviderCallback::GetDisplayHeight
virtual float GetDisplayHeight(Annot::Type annot_type, const char *icon_name)
用于获取指定图标显示高度的回调函数，以设备大小（通常为像素）为单位。
Definition: fs_annot.h:1782
foxit::pdf::annots::Annot::GetModifiedDateTime
DateTime GetModifiedDateTime() const
获取最后修改日期时间。
foxit::pdf::annots::QuadPoints::second
PointF second
四边形的第二个点，使用 PDF 坐标系。
Definition: fs_annot.h:748
foxit::pdf::annots::PSInk
Definition: fs_annot.h:4981
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:879
foxit::pdf::annots::BorderInfo::operator!=
bool operator!=(const BorderInfo &border_info) const
不等操作符。
Definition: fs_annot.h:575
foxit::pdf::DefaultAppearance::e_FlagTextColor
指示pdf::DefaultAppearance的文本颜色属性是有意义的。
Definition: fs_annot.h:61
foxit::pdf::annots::Caret
Definition: fs_annot.h:4790
foxit::pdf::annots::Circle::GetInnerRect
RectF GetInnerRect() const
获取内部矩形。
foxit::pdf::annots::Sound::GetBits
int GetBits() const
获取每个通道每个采样值的位数。
foxit::pdf::annots::Widget::SetMKBorderColor
void SetMKBorderColor(RGB color)
设置 MK 字典中的边框颜色。
foxit::pdf::annots::Line::SetStyleFillColor
void SetStyleFillColor(RGB color)
设置结束样式的填充颜色。
foxit::pdf::objects::PDFDictionary
Definition: fs_pdfobject.h:848
foxit::pdf::annots::Annot::e_Circle
注释类型：圆形注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:971
foxit::pdf::annots::Annot::e_Line
注释类型：直线注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:967
foxit::pdf::annots::Square::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
获取用于测量的转换因子。
operator!=
bool operator!=(const char *str1, const CFX_ByteString &str2)
检查两个字节字符串是否不相等。
Definition: fs_basictypes.h:140
foxit::pdf::annots::Annot::e_AppearanceTypeDown
注释的按下外观。
Definition: fs_annot.h:1231
foxit::pdf::annots::Widget::GetMKIconCaptionRelation
MKIconCaptionRelation GetMKIconCaptionRelation() const
获取MK字典中图标和标题的关系。
foxit::pdf::annots::Annot::MKIconCaptionRelation
MKIconCaptionRelation
注释MK字典中图标和标题相对位置的枚举。
Definition: fs_annot.h:1203
foxit::pdf::annots::IconFit::vertical_fraction
float vertical_fraction
如果图标等比缩放，分配给图标左侧和底部的剩余空间的垂直比例。有效范围：0.0 到 1.0。
Definition: fs_annot.h:906
foxit::pdf::annots::Annot::e_MKEntryDownCaption
按下标题（或备用标题）条目。MK字典中的"AC"。
Definition: fs_annot.h:1169
foxit::pdf::annots::Line::SetLeaderLineLength
void SetLeaderLineLength(float length)
设置引导线的长度。
foxit::pdf::annots::Widget::SetMKDownIconImage
void SetMKDownIconImage(const common::Image &image, int frame_index)
设置指定帧索引的图像作为MK字典中的按下图标。
foxit::pdf::annots::Annot::e_MKEntryNormalCaption
正常标题条目。MK字典中的"CA"。
Definition: fs_annot.h:1159
foxit::pdf::annots::Annot::e_Ink
注释类型：墨迹注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:989
foxit::pdf::annots::IconFit::IconFit
IconFit(const IconFit &icon_fit)
拷贝构造函数。
Definition: fs_annot.h:813
foxit::pdf::annots::TextMarkup
Definition: fs_annot.h:2611
foxit::pdf::annots::BorderInfo::operator==
bool operator==(const BorderInfo &border_info) const
相等操作符。
Definition: fs_annot.h:555
foxit::pdf::annots::FreeText::GetRotation
common::Rotation GetRotation()
获取当前旋转值（顺时针）。
foxit::pdf::annots::Annot::GetContent
WString GetContent() const
获取内容。
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::Polygon::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
获取用于测量的转换因子。
foxit::pdf::annots::FreeText::~FreeText
~FreeText()
Destructor.
Definition: fs_annot.h:3272
foxit::pdf::annots::Annot::e_Stamp
注释类型：印章注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:985
foxit::pdf::annots::Circle::GetFillColor
RGB GetFillColor() const
获取填充颜色。
foxit::pdf::PagingSealSignature
Definition: fs_signature.h:2035
foxit::pdf::annots::Screen::GetBitmap
common::Bitmap GetBitmap()
从当前屏幕注释获取位图。
foxit::pdf::annots::Line::GetLineEndStyle
EndingStyle GetLineEndStyle() const
获取终点的线条结束样式。
foxit::pdf::annots::Link::SetHighlightingMode
void SetHighlightingMode(HighlightingMode mode)
设置高亮模式。
foxit::pdf::annots::Widget::LineSpacingStyle
LineSpacingStyle
行间距样式的枚举。
Definition: fs_annot.h:5018
NULL
#define NULL
空指针值。
Definition: fx_system.h:792
foxit::pdf::annots::Annot::Move
bool Move(const RectF &rect)
将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。
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::RichTextStyle::RichTextStyle
RichTextStyle(const RichTextStyle &style)
构造函数，使用另一个样式对象。
Definition: fs_annot.h:268
foxit::pdf::annots::FreeText::GetCalloutLinePoints
PointFArray GetCalloutLinePoints() const
获取标注线点。
CFX_FloatRect
Definition: fx_coordinates.h:771
foxit::pdf::annots::BorderInfo::cloud_intensity
float cloud_intensity
云状效果的强度。
Definition: fs_annot.h:630
foxit::pdf::DefaultAppearance::text_size
float text_size
默认外观的文本大小。
Definition: fs_annot.h:190
foxit::pdf::DefaultAppearance::text_color
RGB text_color
默认外观的文本颜色。格式：0xRRGGBB。
Definition: fs_annot.h:197
foxit::pdf::RichTextStyle::operator==
bool operator==(const RichTextStyle &style) const
等于运算符。
Definition: fs_annot.h:310
foxit::pdf::annots::Polygon::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
设置用于测量的比例比率字符串。
foxit::pdf::annots::Polygon::SetFillColor
void SetFillColor(RGB fill_color)
设置填充颜色。
foxit::RGB
uint32 RGB
RGB 颜色类型，24 位，((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
foxit::pdf::annots::Annot::e_FlagReadOnly
注释标志：只读。
Definition: fs_annot.h:1077
foxit::pdf::annots::Popup::Popup
Popup()
构造函数。
Definition: fs_annot.h:4913
foxit::pdf::annots::Line::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
设置用于测量的比例比率字符串。
foxit::pdf::annots::IconProviderCallback
Definition: fs_annot.h:1674
foxit::pdf::annots::BorderInfo::e_Beveled
边框样式：斜面。
Definition: fs_annot.h:469
foxit::pdf::annots::Circle::GetMeasureRatio
String GetMeasureRatio()
获取用于测量的比例比率字符串。
foxit::pdf::annots::Annot::e_Widget
注释类型：小组件注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1002
foxit::pdf::annots::IconProviderCallback::HasIcon
virtual bool HasIcon(Annot::Type annot_type, const char *icon_name)
用于检查当前图标提供程序是否支持指定类型图标的回调函数。
Definition: fs_annot.h:1713
foxit::pdf::PDFPage
Definition: fs_pdfpage.h:421
foxit::pdf::annots::TextMarkup::GetQuadPoints
QuadPointsArray GetQuadPoints() const
获取四边形。
foxit::pdf::annots::Markup::~Markup
~Markup()
析构函数。
Definition: fs_annot.h:1946
foxit::pdf::annots::PolyLine::SetStyleFillColor
void SetStyleFillColor(RGB fill_color)
设置某些线端样式的填充颜色。
foxit::pdf::annots::Widget::GetAppearanceOnStateName
String GetAppearanceOnStateName() const
获取注释外观"ON"状态的名称。
foxit::pdf::annots::PolyLine::GetLineStartStyle
EndingStyle GetLineStartStyle() const
获取起始点的线端样式。
foxit::pdf::annots::Widget::GetMKRotation
common::Rotation GetMKRotation() const
获取 MK 字典中的旋转值。
foxit::pdf::annots::Circle::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
设置内部矩形。
foxit::pdf::annots::IconProviderCallback::Release
virtual void Release()=0
用于释放当前回调对象自身的回调函数。
foxit::pdf::annots::Redact::GetApplyFillColor
RGB GetApplyFillColor() const
获取用于翻转外观的填充颜色，将在应用编辑后使用。
foxit::pdf::annots::TextMarkup::TextMarkup
TextMarkup()
构造函数。
Definition: fs_annot.h:2614
foxit::int32
FX_INT32 int32
有符号 32 位整数。
Definition: fs_basictypes.h:194
foxit::pdf::RichTextStyle::is_strikethrough
bool is_strikethrough
指示是否为文本添加删除线的布尔值。
Definition: fs_annot.h:416
foxit::pdf::annots::Note::GetIconName
String GetIconName() const
获取图标名称。
foxit::pdf::annots::Line::GetMeasureRatioW
WString GetMeasureRatioW()
获取用于测量的比例比率Unicode字符串。
foxit::pdf::annots::Line::CapPos
CapPos
标题位置类型的枚举。
Definition: fs_annot.h:3571
foxit::pdf::annots::Annot::operator!=
bool operator!=(const Annot &other) const
不等于运算符。
foxit::pdf::annots::Widget::SetMKRolloverIconBitmap
void SetMKRolloverIconBitmap(const common::Bitmap &bitmap)
设置MK字典中的翻转图标位图。
foxit::pdf::annots::Annot::e_Link
注释类型：链接注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:963
foxit::pdf::annots::Note::SetOpenStatus
void SetOpenStatus(bool status)
设置开放状态。
foxit::pdf::annots::Annot::e_TrapNet
注释类型：陷阱网络注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1008
foxit::pdf::annots::PolyLine::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
设置用于测量的比例比率字符串。
foxit::pdf::annots::Line::SetCaptionOffset
void SetCaptionOffset(const Offset &offset)
设置标题偏移值。
foxit::pdf::annots::Widget::GetHighlightingMode
HighlightingMode GetHighlightingMode()
获取高亮模式。
foxit::pdf::annots::Annot::operator=
Annot & operator=(const Annot &annot)
赋值运算符。
foxit::pdf::annots::Sound::e_SampleEncodingFormatALaw
A律编码采样。
Definition: fs_annot.h:5812
foxit::common::Image
Definition: fs_image.h:449
foxit::pdf::annots::Line::GetStartPoint
PointF GetStartPoint() const
获取起点。
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::annots::Stamp::SetRotation
void SetRotation(int angle)
设置旋转角度（顺时针方向）。
foxit::pdf::annots::MarkupArray
Definition: fs_annot.h:1792
foxit::pdf::annots::Annot::e_Squiggly
注释类型：波浪线注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:981
foxit::pdf::annots::Annot::Type
Type
PDF注释类型的枚举。
Definition: fs_annot.h:954
foxit::pdf::annots::FreeText::SetFillColor
void SetFillColor(RGB fill_color)
设置填充颜色。
foxit::pdf::annots::Annot::e_PagingSeal
注释类型：分页印章注释。福昕PDF SDK自定义注释类型（非标准注释类型）。
Definition: fs_annot.h:1020
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
构造函数，带参数。
Definition: fs_annot.h:668
foxit::pdf::annots::Annot::SetFlags
void SetFlags(uint32 flags)
设置注释标志。
foxit::pdf::annots::Widget::GetLineSpacing
LineSpacingStyle GetLineSpacing(float &line_spacing_value)
获取当前小部件的行间距。
foxit::pdf::annots::Annot::GetAppearanceStream
objects::PDFStream * GetAppearanceStream(AppearanceType type, const char *appearance_state="") const
获取具有指定类型和状态的注释外观流。
foxit::pdf::annots::Annot::e_PSInk
注释类型：压力敏感墨迹注释。
Definition: fs_annot.h:991
foxit::pdf::annots::Circle::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const char *unit)
设置用于测量的单位显示标签。
foxit::pdf::annots::Screen::SetAction
void SetAction(const actions::Action &action)
设置动作。
FX_RECT
Definition: fx_coordinates.h:596
foxit::pdf::annots::Annot::Annot
Annot()
构造函数。
Definition: fs_annot.h:1254
foxit::pdf::annots::Widget::RemoveMKEntry
void RemoveMKEntry(MKEntry mk_entry)
从 MK 字典中移除指定的条目。
foxit::common::Font
Definition: fs_common.h:1519
foxit::pdf::annots::Widget::SetMKRolloverIconImage
void SetMKRolloverIconImage(const common::Image &image, int frame_index)
设置指定帧索引的图像作为MK字典中的翻转图标。
foxit::pdf::annots::Annot::e_MKEntryDownIcon
按下图标（或备用图标）条目。MK字典中的"IX"。
Definition: fs_annot.h:1184
foxit::pdf::annots::Annot::e_PrinterMark
注释类型：印刷标记注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:1006
foxit::pdf::annots::BorderInfo::dash_phase
float dash_phase
虚线相位。
Definition: fs_annot.h:637
foxit::pdf::annots::QuadPoints::operator=
QuadPoints & operator=(const QuadPoints &quad_points)
赋值操作符。
Definition: fs_annot.h:697
CFX_Matrix
Definition: fx_coordinates.h:1076
foxit::pdf::annots::Annot::e_MKRelationCaptionRight
标题在图标右侧。
Definition: fs_annot.h:1213
foxit::pdf::annots::Widget::GetMKBackgroundColor
RGB GetMKBackgroundColor() const
获取 MK 字典中的背景颜色。
foxit::pdf::annots::Widget::~Widget
~Widget()
析构函数。
foxit::pdf::annots::Annot::e_MKEntryRolloverCaption
悬停标题条目。MK字典中的"RC"。
Definition: fs_annot.h:1164
foxit::pdf::annots::Annot::operator==
bool operator==(const Annot &other) const
等于运算符。
foxit::pdf::annots::PolyLine::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
设置用于测量的转换因子。
foxit::pdf::DefaultAppearance::operator=
DefaultAppearance & operator=(const DefaultAppearance &default_appearance)
赋值运算符。
Definition: fs_annot.h:110
foxit::pdf::annots::Widget::GetMKDownCaption
WString GetMKDownCaption() const
获取 MK 字典中的向下标题字符串。
foxit::pdf::annots::PolyLine::GetVertexes
PointFArray GetVertexes()
获取顶点。
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints()
构造函数
Definition: fs_annot.h:676
foxit::pdf::annots::Redact::SetFillColor
void SetFillColor(RGB fill_color)
设置填充颜色。
foxit::pdf::annots::Squiggly::Squiggly
Squiggly()
构造函数。
Definition: fs_annot.h:2761
foxit::pdf::annots::FreeText::SetTextMatrix
void SetTextMatrix(const Matrix &text_matrix)
为当前自由文本注释中的文本设置默认外观数据中的矩阵。
foxit::pdf::RichTextStyle::RichTextStyle
RichTextStyle()
构造函数。
Definition: fs_annot.h:251
foxit::pdf::annots::Polygon::~Polygon
~Polygon()
析构函数。
Definition: fs_annot.h:4405
foxit::pdf::annots::PolyLine
Definition: fs_annot.h:4573
foxit::pdf::DefaultAppearance
Definition: fs_annot.h:50
foxit::pdf::annots::Polygon::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
获取用于测量的单位显示标签（Unicode字符串格式）。
foxit::pdf::objects::PDFStream
Definition: fs_pdfobject.h:448
foxit::pdf::annots::BorderInfo::e_Inset
边框样式：内嵌。
Definition: fs_annot.h:476
CFX_WideString
宽字符串类
Definition: fx_string.h:1457
foxit::pdf::annots::Line::EnableCaption
void EnableCaption(bool cap)
设置用于决定当前直线注释的内容是否应该在外观中复制为标题的标志。
foxit::String
CFX_ByteString String
字节字符串。
Definition: fs_basictypes.h:225
foxit::pdf::annots::Line
Definition: fs_annot.h:3564
foxit::pdf::annots::Annot::HasProperty
bool HasProperty(Property property) const
当前注释是否具有指定的注释属性。
foxit::common::Bitmap
Definition: fs_image.h:36
foxit::pdf::annots::Link::GetAction
actions::Action GetAction()
获取动作。
foxit::pdf::annots::Circle::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
获取用于测量的转换因子。
foxit::pdf::annots::BorderInfo::width
float width
边框宽度，以点为单位。
Definition: fs_annot.h:613
foxit::pdf::annots::Annot::e_PolyLine
注释类型：折线注释。<PDF参考1.7>中的标准注释之一。
Definition: fs_annot.h:975
foxit::pdf::RichTextStyle::is_underline
bool is_underline
指示是否为文本添加下划线的布尔值。
Definition: fs_annot.h:411
foxit::pdf::annots::Ink::~Ink
~Ink()
析构函数。
Definition: fs_annot.h:3984
foxit::pdf::annots::Line::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
设置用于测量的转换因子。
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo(const BorderInfo &border_info)
拷贝构造函数。
Definition: fs_annot.h:524
foxit::pdf::annots::Polygon
Definition: fs_annot.h:4394
foxit::pdf::annots::BorderInfo::Style
Style
PDF注释边框样式的枚举。
Definition: fs_annot.h:447
foxit::pdf::annots::Line::GetLeaderLineLength
float GetLeaderLineLength() const
获取引导线的长度。
foxit::pdf::annots::Markup::MeasureType
MeasureType
注释测量类型的枚举。
Definition: fs_annot.h:1918
foxit::uint32
FX_UINT32 uint32
无符号 32 位整数。
Definition: fs_basictypes.h:196
foxit::pdf::annots::FreeText::GetAlignment
common::Alignment GetAlignment() const
获取对齐值。
foxit::pdf::annots::Widget::SetMKNormalIconImage
void SetMKNormalIconImage(const common::Image &image, int frame_index)
设置指定帧索引的图像作为 MK 字典中的普通图标。
foxit::pdf::annots::Sound::GetCompressionFormat
String GetCompressionFormat() const
获取用于采样数据的声音压缩格式的名称。
foxit::pdf::annots::Link::~Link
~Link()
析构函数。
Definition: fs_annot.h:2798
foxit::pdf::annots::TextMarkup::SetQuadPoints
void SetQuadPoints(const QuadPointsArray &quad_points_array)
设置四边形。
foxit::pdf::annots::Screen::GetRotation
common::Rotation GetRotation()
获取用于当前屏幕注释外观的图像旋转。
foxit::pdf::annots::QuadPointsArray
Definition: fs_annot.h:756
foxit::pdf::annots::Stamp::GetIconName
String GetIconName() const
获取图标名称。
foxit::Base
Definition: fs_basictypes.h:449
foxit::pdf::annots::Annot::Flags
Flags
PDF注释标志的枚举。
Definition: fs_annot.h:1028
foxit::pdf::annots::Line::~Line
~Line()
析构函数。
Definition: fs_annot.h:3588
foxit::pdf::annots::Stamp::Rotate
void Rotate(int angle)
从当前状态按指定角度度数顺时针旋转当前注释。
foxit::pdf::annots::Note::GetState
State GetState()
获取状态。
foxit::pdf::annots::FileAttachment::SetIconName
void SetIconName(const char *icon_name)
设置图标名称。
foxit::pdf::annots::IconFit
Definition: fs_annot.h:761
foxit::pdf::DefaultAppearance::operator==
bool operator==(const DefaultAppearance &default_appearance) const
等于运算符。
Definition: fs_annot.h:125
foxit::pdf::annots::Note::Note
Note()
构造函数。
Definition: fs_annot.h:2464
foxit::pdf::annots::Ink::Ink
Ink()
构造函数。
Definition: fs_annot.h:3976
foxit::pdf::annots::Annot::HighlightingMode
HighlightingMode
PDF注释高亮模式的枚举。
Definition: fs_annot.h:1103
foxit::pdf::annots::Sound::GetSampleEncodingFormat
SampleEncodingFormat GetSampleEncodingFormat() const
获取采样数据的编码格式。
foxit::pdf::annots::Widget::GetAppearanceState
String GetAppearanceState() const
获取注释的外观状态，从外观子字典中选择适用的外观流。
foxit::pdf::annots::Line::GetCaptionPositionType
CapPos GetCaptionPositionType() const
获取标题的位置类型。
foxit::pdf::annots::Line::e_CapPosInline
Definition: fs_annot.h:3573
foxit::pdf::annots::Annot::e_PropertyCreationDate
注释属性：创建日期。
Definition: fs_annot.h:1128
foxit::pdf::annots::FileAttachment
Definition: fs_annot.h:4841
foxit::pdf::annots::Redact::Apply
bool Apply()
应用当前编辑注释：永久移除注释矩形下的文本、图形和注释。
foxit::pdf::RichTextStyle::word_space
float word_space
单词间距。对于表格生成器不应为负值。仅在pdf::PDFPage::AddText中使用。
Definition: fs_annot.h:432
foxit::pdf::annots::Redact::IsOverlayTextRepeated
bool IsOverlayTextRepeated()
检查覆盖文本是否重复。
foxit::pdf::annots::Redact::Redact
Redact()
构造函数。
Definition: fs_annot.h:5596
foxit::pdf::RichTextStyle::operator=
RichTextStyle & operator=(const RichTextStyle &style)
赋值运算符。
Definition: fs_annot.h:288
foxit::pdf::annots::IconFit::horizontal_fraction
float horizontal_fraction
如果图标等比缩放，分配给图标左侧和底部的剩余空间的水平比例。有效范围：0.0 到 1.0。
Definition: fs_annot.h:902
foxit::pdf::annots::Ink::GetInkList
common::Path GetInkList()
获取墨迹列表数据。
foxit::pdf::annots::Square::~Square
~Square()
析构函数。
Definition: fs_annot.h:2919