Foxit PDF SDK
fs_annot.h
Go to the documentation of this file.
1 
15 #ifndef FS_ANNOT_H_
16 #define FS_ANNOT_H_
17 
18 #include "common/fs_common.h"
19 #include "common/file/fs_file.h"
20 #include "common/fs_image.h"
22 
28 namespace foxit {
32 namespace pdf {
33 // forward declaration
34 class PDFPage;
35 class FileSpec;
36 namespace actions {
37 class Action;
38 } // namespace actions
39 namespace annots {
40 class Note;
41 class Popup;
42 } // namespace annots
43 namespace interform {
44 class Field;
45 class Control;
46 } // namespace interform
47 
51 class DefaultAppearance FS_FINAL : public Object {
52  public:
58  typedef enum _DefAPFlags {
60  e_FlagFont = 0x0001,
62  e_FlagTextColor = 0x0002,
64  e_FlagFontSize = 0x0004
65  } DefAPFlags;
66 
67 
83  : flags(flags)
84  , font(font)
87 
90  : flags(0)
91  , text_size(0)
92  , text_color(0x000000) {}
93 
99  DefaultAppearance(const DefaultAppearance& default_appearance)
100  : flags(default_appearance.flags)
101  , font(default_appearance.font)
102  , text_size(default_appearance.text_size)
103  , text_color(default_appearance.text_color) {}
104 
112  DefaultAppearance& operator = (const DefaultAppearance& default_appearance) {
113  flags = default_appearance.flags;
114  font = default_appearance.font;
115  text_size = default_appearance.text_size;
116  text_color = default_appearance.text_color;
117  return *this;
118  }
119 
127  bool operator == (const DefaultAppearance& default_appearance) const {
128  return (flags == default_appearance.flags && font == default_appearance.font &&
129  fabs(text_size-default_appearance.text_size) <= FLT_EPSILON &&
130  text_color == default_appearance.text_color);
131  }
132 
140  bool operator != (const DefaultAppearance& default_appearance) const {
141  return (flags != default_appearance.flags || font != default_appearance.font ||
142  fabs(text_size - default_appearance.text_size) > FLT_EPSILON ||
143  text_color != default_appearance.text_color);
144  }
145 
164  this->flags = flags;
165  this->font = font;
166  this->text_size = text_size;
167  this->text_color = text_color;
168  }
169 
192  float text_size;
199 };
200 
202 class RichTextStyle FS_FINAL : public Object{
203  public:
209  typedef enum _CornerMarkStyle {
216  } CornerMarkStyle;
217 
218 
237  : font(font)
241  , is_bold(is_bold)
245  , mark_style(mark_style) {}
246 
249  : text_size(0)
251  , text_color(0x000000)
252  , is_bold(false)
253  , is_italic(false)
254  , is_underline(false)
255  , is_strikethrough(false)
257 
264  : font(style.font)
265  , text_size(style.text_size)
267  , text_color(style.text_color)
268  , is_bold(style.is_bold)
269  , is_italic(style.is_italic)
270  , is_underline(style.is_underline)
272  , mark_style(style.mark_style) {}
273 
282  font = style.font;
283  text_size = style.text_size;
285  text_color = style.text_color;
286  is_bold = style.is_bold;
287  is_italic = style.is_italic;
288  is_underline = style.is_underline;
290  mark_style = style.mark_style;
291  return *this;
292  }
293 
301  bool operator == (const RichTextStyle& style) const {
302  return (font == style.font &&
303  fabs(text_size- style.text_size) <= FLT_EPSILON &&
304  text_alignment == style.text_alignment &&
305  text_color == style.text_color &&
306  is_bold == style.is_bold &&
307  is_italic == style.is_italic &&
308  is_underline == style.is_underline &&
310  mark_style == style.mark_style);
311  }
312 
320  bool operator != (const RichTextStyle& style) const {
321  return !((*this) == style);
322  }
323 
344  this->font = font;
345  this->text_size = text_size;
346  this->text_alignment = text_alignment;
347  this->text_color = text_color;
348  this->is_bold = is_bold;
349  this->is_italic = is_italic;
350  this->is_underline = is_underline;
351  this->is_strikethrough = is_strikethrough;
352  this->mark_style = mark_style;
353  }
354 
369  float text_size;
382  bool is_bold;
386  bool is_italic;
400 };
401 
405 namespace annots {
407 class BorderInfo FS_FINAL : public Object {
408  public:
414  typedef enum _Style {
416  e_Solid = 0,
423  e_Dashed = 1,
443  e_Inset = 4,
451  } Style;
452 
453 
471  BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
472  this->width = width;
473  this->style = style;
474  this->cloud_intensity = intensity;
475  this->dash_phase = dash_phase;
476  this->dashes = dashes;
477  }
478 
481  : width(1.0f)
483  , cloud_intensity(0)
484  , dash_phase(0) {}
485 
488 
494  BorderInfo(const BorderInfo& border_info) {
495  this->width = border_info.width;
496  this->style = border_info.style;
497  this->cloud_intensity = border_info.cloud_intensity;
498  this->dash_phase = border_info.dash_phase;
499  this->dashes = border_info.dashes;
500  }
501 
509  BorderInfo& operator = (const BorderInfo& border_info) {
510  this->width = border_info.width;
511  this->style = border_info.style;
512  this->cloud_intensity = border_info.cloud_intensity;
513  this->dash_phase = border_info.dash_phase;
514  this->dashes = border_info.dashes;
515  return *this;
516  }
517 
525  bool operator == (const BorderInfo& border_info) const {
526  if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
527  fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
528  fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
529  dashes.GetSize() != border_info.dashes.GetSize())
530  return false;
531  for (int i=0; i<dashes.GetSize(); i++) {
532  if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
533  return false;
534  }
535  return true;
536  }
537 
545  bool operator != (const BorderInfo& border_info) const{
546  if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
547  fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
548  fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
549  dashes.GetSize() != border_info.dashes.GetSize())
550  return true;
551  for (int i=0; i<dashes.GetSize(); i++) {
552  if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
553  return true;
554  }
555  return false;
556  }
557 
577  void Set(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
578  this->width = width;
579  this->style = style;
580  this->cloud_intensity = intensity;
581  this->dash_phase = dash_phase;
582  this->dashes = dashes;
583  }
584 
590  float width;
591 
597 
610 
616  float dash_phase;
617 
625 };
626 
637 class QuadPoints FS_FINAL : public Object {
638  public:
647  QuadPoints(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
648  this->first = first;
649  this->second = second;
650  this->third = third;
651  this->fourth = fourth;
652  }
653 
656 
662  QuadPoints(const QuadPoints& quad_points) {
663  first = quad_points.first;
664  second = quad_points.second;
665  third = quad_points.third;
666  fourth = quad_points.fourth;
667  }
668 
676  QuadPoints& operator = (const QuadPoints& quad_points) {
677  first = quad_points.first;
678  second = quad_points.second;
679  third = quad_points.third;
680  fourth = quad_points.fourth;
681  return *this;
682  }
683 
691  bool operator == (const QuadPoints& quad_points) const {
692  return (first == quad_points.first && second == quad_points.second &&
693  third == quad_points.third && fourth == quad_points.fourth);
694  }
695 
703  bool operator != (const QuadPoints& quad_points) const {
704  return (first != quad_points.first || second != quad_points.second ||
705  third != quad_points.third || fourth != quad_points.fourth);
706  }
707 
718  void Set(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
719  this->first = first;
720  this->second = second;
721  this->third = third;
722  this->fourth = fourth;
723  }
724 
733 };
734 
736 FSDK_DEFINE_ARRAY(QuadPointsArray, QuadPoints)
737 
738 
742 class IconFit FS_FINAL : public Object {
743  public:
748  typedef enum _ScaleWayType {
750  e_ScaleWayNone = 0,
752  e_ScaleWayAlways = 1,
754  e_ScaleWayBigger = 2,
756  e_ScaleWaySmaller = 3,
758  e_ScaleWayNever = 4
759  } ScaleWayType;
760 
761 
764  : scale_way_type(e_ScaleWayNone)
765  , is_proportional_scaling(false)
766  , horizontal_fraction(0)
767  , vertical_fraction(0)
768  , fit_bounds(false) {}
769 
794  IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
795  float vertical_fraction, bool fit_bounds)
796  : scale_way_type(type)
797  , is_proportional_scaling(is_proportional_scaling)
798  , horizontal_fraction(horizontal_fraction)
799  , vertical_fraction(vertical_fraction)
800  , fit_bounds(fit_bounds) {}
801 
807  IconFit(const IconFit& icon_fit)
808  : scale_way_type(icon_fit.scale_way_type)
809  , is_proportional_scaling(icon_fit.is_proportional_scaling)
810  , horizontal_fraction(icon_fit.horizontal_fraction)
811  , vertical_fraction(icon_fit.vertical_fraction)
812  , fit_bounds(icon_fit.fit_bounds) {}
813 
821  IconFit& operator = (const IconFit& icon_fit) {
822  scale_way_type = icon_fit.scale_way_type;
823  is_proportional_scaling = icon_fit.is_proportional_scaling;
824  horizontal_fraction = icon_fit.horizontal_fraction;
825  vertical_fraction = icon_fit.vertical_fraction;
826  fit_bounds = icon_fit.fit_bounds;
827  return *this;
828  }
829 
837  bool operator == (const IconFit& icon_fit) const {
838  return (scale_way_type == icon_fit.scale_way_type &&
839  is_proportional_scaling == icon_fit.is_proportional_scaling &&
840  fabs(horizontal_fraction - icon_fit.horizontal_fraction) <= FLT_EPSILON &&
841  fabs(vertical_fraction - icon_fit.vertical_fraction) <= FLT_EPSILON &&
842  fit_bounds == icon_fit.fit_bounds);
843  }
844 
852  bool operator != (const IconFit& icon_fit) const {
853  return (scale_way_type != icon_fit.scale_way_type ||
854  is_proportional_scaling != icon_fit.is_proportional_scaling ||
855  fabs(horizontal_fraction - icon_fit.horizontal_fraction) > FLT_EPSILON ||
856  fabs(vertical_fraction - icon_fit.vertical_fraction) > FLT_EPSILON ||
857  fit_bounds != icon_fit.fit_bounds);
858  }
859 
887  void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
888  float vertical_fraction, bool fit_bounds) {
889  this->scale_way_type = type;
890  this->is_proportional_scaling = is_proportional_scaling;
891  this->horizontal_fraction = horizontal_fraction;
892  this->vertical_fraction = vertical_fraction;
893  this->fit_bounds = fit_bounds;
894  }
895 
930 };
931 
964 class Annot : public Base {
965  public:
971  typedef enum _Type {
978  e_Note = 1,
980  e_Link = 2,
984  e_Line = 4,
986  e_Square = 5,
988  e_Circle = 6,
1002  e_Stamp = 13,
1004  e_Caret = 14,
1006  e_Ink = 15,
1008  e_PSInk = 16,
1012  e_Sound = 18,
1014  e_Movie = 19,
1019  e_Widget = 20,
1021  e_Screen = 21,
1029  e_3D = 25,
1031  e_Popup = 26,
1033  e_Redact = 27,
1036  } Type;
1037 
1043  typedef enum _Flags {
1056  e_FlagHidden = 0x0002,
1064  e_FlagPrint = 0x0004,
1071  e_FlagNoZoom = 0x0008,
1078  e_FlagNoRotate = 0x0010,
1086  e_FlagNoView = 0x0020,
1095  e_FlagReadOnly = 0x0040,
1102  e_FlagLocked = 0x0080,
1116  } Flags;
1117 
1123  typedef enum _HighlightingMode {
1134  } HighlightingMode;
1135 
1141  typedef enum _Property {
1161  } Property;
1162 
1168  typedef enum _MKEntry {
1217  } MKEntry;
1218 
1224  typedef enum _MKIconCaptionRelation {
1240 
1246  typedef enum _AppearanceType {
1253  } AppearanceType;
1254 
1255 
1256  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1257  explicit Annot(FS_HANDLE handle);
1265  Annot(const PDFPage& page, objects::PDFDictionary* annot_dict);
1266 #ifndef __EMSCRIPTEN_RENDER__
1267 
1272  Annot(const Annot& annot);
1273 #endif
1274 
1275  Annot() {}
1276 #ifndef __EMSCRIPTEN_RENDER__
1277 
1284  Annot& operator = (const Annot& annot);
1285 #endif
1286 
1293  bool operator ==(const Annot& other) const;
1301  bool operator != (const Annot& other) const;
1302 #ifndef __EMSCRIPTEN_RENDER__
1303 
1304  virtual ~Annot();
1305 #endif
1306 
1313  bool IsEmpty() const;
1314 
1320  PDFPage GetPage() const;
1327  bool IsMarkup() const;
1333  Type GetType() const;
1339  int GetIndex() const;
1345  WString GetContent() const;
1359  void SetContent(const WString& content);
1366  DateTime GetModifiedDateTime() const;
1374  void SetModifiedDateTime(const DateTime& date_time);
1381  uint32 GetFlags() const;
1390  void SetFlags(uint32 flags);
1396  WString GetUniqueID() const;
1404  void SetUniqueID(const WString& unique_id);
1411  RectF GetRect() const;
1412 
1425  Matrix GetDisplayMatrix(const Matrix& page_display_matrix);
1426 
1436  bool Move(const RectF& rect);
1437 
1448  bool Move(const RectF& rect, bool is_reset_appearance);
1449 
1466  BorderInfo GetBorderInfo() const;
1467 
1485  void SetBorderInfo(const BorderInfo& border);
1494  RGB GetBorderColor() const;
1506  void SetBorderColor(RGB color);
1519  bool ResetAppearanceStream();
1520 
1538  bool ResetAppearanceStream(bool is_generate_new_appearance_obj);
1539 
1555  RectI GetDeviceRect(const Matrix& matrix);
1556 
1563 
1573  bool HasProperty(Property property) const;
1574 
1592  bool RemoveProperty(Property property);
1593 
1601 
1618  objects::PDFStream* GetAppearanceStream(AppearanceType type, const char* appearance_state = "") const;
1619 };
1620 
1622 FSDK_DEFINE_ARRAY(AnnotArray, Annot)
1623 
1624 
1625 class ShadingColor FS_FINAL : public Object {
1626  public:
1633  ShadingColor(ARGB firstcolor, ARGB secondcolor)
1634  : first_color(firstcolor)
1635  , second_color(secondcolor) {}
1636 
1639  : first_color(0xFFFFFFFF)
1640  , second_color(0xFFFFFFFF) {}
1641 
1647  ShadingColor(const ShadingColor& shading_color)
1648  : first_color(shading_color.first_color)
1649  , second_color(shading_color.second_color) {}
1650 
1658  ShadingColor& operator = (const ShadingColor& shading_color) {
1659  this->first_color = shading_color.first_color;
1660  this->second_color = shading_color.second_color;
1661  return *this;
1662  }
1663 
1671  bool operator == (const ShadingColor& shading_color) const {
1672  return (first_color == shading_color.first_color && second_color == shading_color.second_color);
1673  }
1674 
1682  bool operator != (const ShadingColor& shading_color) const {
1683  return (first_color != shading_color.first_color || second_color != shading_color.second_color);
1684  }
1685 
1694  void Set(ARGB firstcolor, ARGB secondcolor) {
1695  this->first_color = firstcolor;
1696  this->second_color = secondcolor;
1697  }
1698 
1703 };
1704 
1715  public:
1721  virtual void Release() = 0;
1730  virtual String GetProviderID() {
1731  return String();
1732  }
1742  return String();
1743  }
1753  virtual bool HasIcon(Annot::Type annot_type, const char* icon_name) {
1754  return false;
1755  }
1766  virtual bool CanChangeColor(Annot::Type annot_type, const char* icon_name) {
1767  return false;
1768  }
1769 #ifndef __EMSCRIPTEN_RENDER__
1770 
1780  virtual PDFPage GetIcon(Annot::Type annot_type, const char* icon_name, ARGB color);
1781 #endif
1782 
1796  virtual bool GetShadingColor(Annot::Type annot_type, const char* icon_name,
1797  RGB referenced_color, int shading_index, ShadingColor& out_shading_color) {
1798  return false;
1799  }
1810  virtual float GetDisplayWidth(Annot::Type annot_type, const char* icon_name) {
1811  return 0.0f;
1812  }
1823  virtual float GetDisplayHeight(Annot::Type annot_type, const char* icon_name) {
1824  return 0.0f;
1825  }
1826 
1827  protected:
1828  ~IconProviderCallback() {}
1829 };
1830 
1831 class Markup;
1833 FSDK_DEFINE_ARRAY(MarkupArray, Markup)
1834 
1835 class Note;
1837 FSDK_DEFINE_ARRAY(NoteArray, Note)
1838 
1839 
1856 class Markup : public Annot {
1857  public:
1863  typedef enum _StateModel {
1865  e_StateModelMarked = 1,
1867  e_StateModelReview = 2
1868  } StateModel;
1869 
1875  typedef enum _State {
1880  e_StateNone = 0,
1885  e_StateMarked = 1,
1890  e_StateUnmarked = 2,
1895  e_StateAccepted = 3,
1900  e_StateRejected = 4,
1905  e_StateCancelled = 5,
1910  e_StateCompleted = 6,
1915  e_StateDeferred = 7,
1920  e_StateFuture = 8
1921  } State;
1922 
1928  typedef enum _EndingStyle {
1930  e_EndingStyleNone = 0,
1932  e_EndingStyleSquare = 1,
1934  e_EndingStyleCircle = 2,
1936  e_EndingStyleDiamond = 3,
1938  e_EndingStyleOpenArrow = 4,
1944  e_EndingStyleClosedArrow = 5,
1946  e_EndingStyleButt = 6,
1948  e_EndingStyleROpenArrow = 7,
1950  e_EndingStyleRClosedArrow = 8,
1952  e_EndingStyleSlash = 9
1953  } EndingStyle;
1954 
1960  typedef enum _MeasureType {
1962  e_MeasureTypeX = 0,
1964  e_MeasureTypeY = 1,
1966  e_MeasureTypeD = 2,
1968  e_MeasureTypeA = 3,
1970  e_MeasureTypeT = 4,
1972  e_MeasureTypeS = 5
1973  } MeasureType;
1974 
1975 
1981  explicit Markup(const Annot& annot);
1982  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1983  explicit Markup(FS_HANDLE handle);
1985  Markup() {}
1986 
1988  ~Markup() {}
1989 
2007  Popup GetPopup();
2024  void SetPopup(const Popup& popup);
2025 
2032  bool RemovePopup();
2033 
2041  WString GetTitle() const;
2042 
2052  void SetTitle(const WString& title);
2053 
2059  WString GetSubject() const;
2060 
2068  void SetSubject(const WString& subject);
2069 
2078  float GetOpacity() const;
2079 
2092  void SetOpacity(float opacity);
2093 
2115  String GetIntent() const;
2116 
2152  void SetIntent(const String& intent);
2153 
2160  DateTime GetCreationDateTime() const;
2161 
2169  void SetCreationDateTime(const DateTime& date_time);
2170 
2176  int GetReplyCount();
2177 
2186  Note GetReply(int index) const;
2187 
2193  Note AddReply();
2194 
2205  bool RemoveReply(int index);
2206 
2212  bool RemoveAllReplies();
2213 
2230  bool IsGrouped();
2231 
2250  Markup GetGroupHeader();
2251 
2268  MarkupArray GetGroupElements();
2269 
2285  bool Ungroup();
2286 
2302  NoteArray GetStateAnnots(StateModel model);
2303 
2340  Note AddStateAnnot(const WString& title, StateModel model, State state);
2341 
2351  bool RemoveAllStateAnnots();
2359  int32 GetRichTextCount();
2360 
2371  WString GetRichTextContent(int32 index);
2372 
2384  void SetRichTextContent(int32 index, const WString& content);
2385 
2396  RichTextStyle GetRichTextStyle(int32 index);
2397 
2411  void SetRichTextStyle(int32 index, const RichTextStyle& style);
2412 
2425  void AddRichText(const WString& content, const RichTextStyle& style);
2426 
2443  void InsertRichText(int32 index, const WString& content, const RichTextStyle& style);
2444 
2455  void RemoveRichText(int index);
2456 };
2457 
2480 class Note FS_FINAL : public Markup {
2481  public:
2483  Note() {}
2489  explicit Note(const Annot& annot);
2490  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2491  explicit Note(FS_HANDLE handle);
2493  ~Note() {}
2494 
2507  bool GetOpenStatus() const;
2522  void SetOpenStatus(bool status);
2534  String GetIconName() const;
2552  void SetIconName(const char* icon_name);
2562  Markup GetReplyTo();
2569  bool IsStateAnnot();
2570 
2583 
2595  State GetState();
2596 
2620  void SetState(State state);
2621 
2622 };
2623 
2635 class TextMarkup: public Markup {
2636  public:
2644  explicit TextMarkup(const Annot& annot);
2647 
2682  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2683 };
2684 
2701 class Highlight FS_FINAL : public TextMarkup {
2702  public:
2710  explicit Highlight(const Annot& annot);
2713 };
2714 
2731 class Underline FS_FINAL : public TextMarkup {
2732  public:
2740  explicit Underline(const Annot& annot);
2743 };
2744 
2761 class StrikeOut FS_FINAL : public TextMarkup {
2762  public:
2770  explicit StrikeOut(const Annot& annot);
2773 };
2774 
2791 class Squiggly FS_FINAL : public TextMarkup {
2792  public:
2800  explicit Squiggly(const Annot& annot);
2803 };
2804 
2818 class Link FS_FINAL : public Annot {
2819  public:
2821  Link() {}
2827  explicit Link(const Annot& annot);
2828  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2829  explicit Link(FS_HANDLE handle);
2831  ~Link() {}
2832 
2865  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2866 
2875 
2886 
2894 
2909  void SetAction(const actions::Action& action);
2910 
2916  bool RemoveAction();
2917 };
2918 
2933 class Square FS_FINAL : public Markup {
2934  public:
2936  Square() {}
2942  explicit Square(const Annot& annot);
2944  ~Square() {}
2945 
2952  RGB GetFillColor() const;
2953 
2961  void SetFillColor(RGB fill_color);
2962 
2972  RectF GetInnerRect() const;
2984  void SetInnerRect(const RectF& inner_rect);
2985 
2999  void SetMeasureRatio(const char* ratio);
3000 
3011 
3022 
3035  void SetMeasureUnit(MeasureType measure_type, const char* unit);
3036 
3048  String GetMeasureUnit(MeasureType measure_type);
3049 
3061  WString GetMeasureUnitW(MeasureType measure_type);
3062 
3075  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3076 
3088  float GetMeasureConversionFactor(MeasureType measure_type);
3089 };
3090 
3105 class Circle FS_FINAL : public Markup {
3106  public:
3108  Circle() {}
3114  explicit Circle(const Annot& annot);
3116  ~Circle() {}
3117 
3124  RGB GetFillColor() const;
3125 
3136  void SetFillColor(RGB fill_color);
3137 
3147  RectF GetInnerRect() const;
3148 
3162  void SetInnerRect(const RectF& inner_rect);
3163 
3177  void SetMeasureRatio(const char* ratio);
3178 
3189 
3200 
3213  void SetMeasureUnit(MeasureType measure_type, const char* unit);
3214 
3226  String GetMeasureUnit(MeasureType measure_type);
3227 
3239  WString GetMeasureUnitW(MeasureType measure_type);
3240 
3253  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3254 
3266  float GetMeasureConversionFactor(MeasureType measure_type);
3267 };
3268 
3288 class FreeText FS_FINAL : public Markup {
3289  public:
3297  explicit FreeText(const Annot& annot);
3298 
3301 
3312  RGB GetFillColor() const;
3313 
3327  void SetFillColor(RGB fill_color);
3328 
3344 
3363  void SetAlignment(common::Alignment alignment);
3364 
3375  RectF GetInnerRect() const;
3376 
3391  void SetInnerRect(const RectF& inner_rect);
3392 
3402 
3425  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
3426 
3438 
3453  void SetCalloutLineEndingStyle(EndingStyle ending_style);
3454 
3469 
3492  void SetCalloutLinePoints(const PointFArray& point_array);
3493 
3509  void SetTextMatrix(const Matrix& text_matrix);
3510 
3522  Matrix GetTextMatrix() const;
3523 
3531 
3546  void SetRotation(common::Rotation rotation);
3547 
3560  void Rotate(common::Rotation rotation);
3561 
3579  void AllowTextOverflow(bool is_text_overflow);
3580 };
3581 
3600 class Line FS_FINAL : public Markup {
3601  public:
3607  typedef enum _CapPos {
3612  } CapPos;
3613 
3614 
3616  Line() {}
3622  explicit Line(const Annot& annot);
3624  ~Line() {}
3625 
3647  void SetLineStartStyle(EndingStyle ending_style);
3656  EndingStyle GetLineEndStyle() const;
3669  void SetLineEndStyle(EndingStyle ending_style);
3670 
3681  RGB GetStyleFillColor() const;
3682 
3696  void SetStyleFillColor(RGB color);
3697 
3706  PointF GetStartPoint() const;
3719  void SetStartPoint(const PointF& point);
3720 
3729  PointF GetEndPoint() const;
3742  void SetEndPoint(const PointF& point);
3743 
3752  bool HasCaption() const;
3765  void EnableCaption(bool cap);
3766 
3794  void SetCaptionPositionType(CapPos cap_position);
3807  Offset GetCaptionOffset() const;
3823  void SetCaptionOffset(const Offset& offset);
3824 
3839  float GetLeaderLineLength() const;
3857  void SetLeaderLineLength(float length);
3867  float GetLeaderLineExtensionLength() const;
3880  void SetLeaderLineExtensionLength(float extension_length);
3881 
3892  float GetLeaderLineOffset() const;
3906  void SetLeaderLineOffset(float offset);
3907 
3921  void SetMeasureRatio(const String& ratio);
3922 
3933 
3944 
3957  void SetMeasureUnit(MeasureType measure_type, const String& unit);
3958 
3970  String GetMeasureUnit(MeasureType measure_type);
3971 
3983  WString GetMeasureUnitW(MeasureType measure_type);
3984 
3997  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3998 
4010  float GetMeasureConversionFactor(MeasureType measure_type);
4011 };
4012 
4030 class Ink FS_FINAL : public Markup {
4031  public:
4033  Ink() {}
4039  explicit Ink(const Annot& annot);
4041  ~Ink() {}
4069 
4102  void SetInkList(const common::Path& ink_list);
4103 
4115  void EnableUseBezier(bool use_bezier);
4116 
4117 };
4118 
4143 class Stamp FS_FINAL : public Markup {
4144  public:
4146  Stamp() {}
4152  explicit Stamp(const Annot& annot);
4153 #ifndef __EMSCRIPTEN_RENDER__
4154 
4155  ~Stamp();
4156 #endif
4157 
4168  String GetIconName() const;
4191  void SetIconName(const char* icon_name);
4202  void SetBitmap(const common::Bitmap& bitmap);
4203 
4226  void SetImage(const common::Image& image, int frame_index, int compress);
4227 
4238  void SetRotation(int angle);
4239 
4245  int GetRotation();
4246 
4256  void Rotate(int angle);
4257 };
4258 
4271 class Screen FS_FINAL : public Annot {
4272  public:
4274  Screen() {}
4280  explicit Screen(const Annot& annot);
4282  virtual ~Screen() {}
4283 
4306  void SetImage(const common::Image& image, int frame_index, int compress);
4307 
4315 
4327 
4335 
4348  void SetRotation(common::Rotation rotate);
4349 
4357 
4366  float GetOpacity() const;
4379  void SetOpacity(float opacity);
4380 
4386  WString GetTitle() const;
4394  void SetTitle(const WString& title);
4395 
4429  void SetAction(const actions::Action& action);
4438  void RemoveAction();
4439 };
4440 
4459 class Polygon FS_FINAL : public Markup {
4460  public:
4462  Polygon() {}
4468  explicit Polygon(const Annot& annot);
4479  RGB GetFillColor() const;
4480 
4492  void SetFillColor(RGB fill_color);
4493 
4503 
4515  void SetVertexes(const PointFArray& vertexes);
4516 
4530  void SetMeasureRatio(const String& ratio);
4531 
4542 
4553 
4566  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4567 
4579  String GetMeasureUnit(MeasureType measure_type);
4580 
4592  WString GetMeasureUnitW(MeasureType measure_type);
4593 
4606  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4607 
4619  float GetMeasureConversionFactor(MeasureType measure_type);
4620 };
4621 
4641 class PolyLine FS_FINAL : public Markup {
4642  public:
4650  explicit PolyLine(const Annot& annot);
4663  RGB GetStyleFillColor() const;
4675  void SetStyleFillColor(RGB fill_color);
4676 
4686 
4698  void SetVertexes(const PointFArray& vertexes);
4721  void SetLineStartStyle(EndingStyle starting_style);
4730  EndingStyle GetLineEndStyle() const;
4744  void SetLineEndStyle(EndingStyle ending_style);
4745 
4759  void SetMeasureRatio(const String& ratio);
4760 
4771 
4782 
4795  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4796 
4808  String GetMeasureUnit(MeasureType measure_type);
4809 
4821  WString GetMeasureUnitW(MeasureType measure_type);
4822 
4835  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4836 
4848  float GetMeasureConversionFactor(MeasureType measure_type);
4849 };
4850 
4863 class Caret FS_FINAL : public Markup {
4864  public:
4866  Caret() {}
4872  explicit Caret(const Annot& annot);
4874  ~Caret() {}
4875 
4885  RectF GetInnerRect() const;
4899  void SetInnerRect(const RectF& inner_rect);
4900 };
4901 
4914 class FileAttachment FS_FINAL : public Markup {
4915  public:
4923  explicit FileAttachment(const Annot& annot);
4926 
4934  bool SetFileSpec(const FileSpec& file_spec);
4935 
4943 
4954  String GetIconName() const;
4955 
4971  void SetIconName(const char* icon_name);
4972 };
4973 
4983 class Popup FS_FINAL : public Annot {
4984  public:
4986  Popup() {}
4992  explicit Popup(const Annot& annot);
4993  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
4994  explicit Popup(FS_HANDLE handle);
4996  ~Popup() {}
4997 
5010  bool GetOpenStatus() const;
5025  void SetOpenStatus(bool status);
5026 
5034  Markup GetParent();
5035 };
5036 #ifndef __FSDK_NO_PSINK__
5037 
5056 class PSInk FS_FINAL : public Annot {
5057  public:
5059  PSInk() {}
5065  explicit PSInk(const Annot& annot);
5066  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5067  explicit PSInk(FS_HANDLE handle);
5069  ~PSInk() {}
5070 
5071 };
5072 #endif
5073 
5086 class Widget FS_FINAL : public Annot {
5087  public:
5093  typedef enum _LineSpacingStyle {
5104  } LineSpacingStyle;
5105 
5106 
5108  Widget() {}
5114  explicit Widget(const Annot& annot);
5115  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5116  explicit Widget(FS_HANDLE handle);
5117 #ifndef __EMSCRIPTEN_RENDER__
5118 
5119  ~Widget();
5120 #endif
5121 
5127 
5134 
5145 
5158 
5169 
5193  void SetAction(const actions::Action& action);
5194 
5203  void RemoveAction();
5204 
5216  bool HasMKEntry(MKEntry mk_entry);
5217 
5229  void RemoveMKEntry(MKEntry mk_entry);
5230 
5244 
5257  void SetMKRotation(common::Rotation rotation);
5258 
5269  RGB GetMKBorderColor() const;
5270 
5281  void SetMKBorderColor(RGB color);
5282 
5293  RGB GetMKBackgroundColor() const;
5294 
5305  void SetMKBackgroundColor(RGB color);
5306 
5320  WString GetMKNormalCaption() const;
5321 
5335  void SetMKNormalCaption(const wchar_t* caption);
5336 
5351  WString GetMKRolloverCaption() const;
5352 
5367  void SetMKRolloverCaption(const wchar_t* caption);
5368 
5382  WString GetMKDownCaption() const;
5383 
5397  void SetMKDownCaption(const wchar_t* caption);
5398 
5412 
5426  void SetMKNormalIconBitmap(const common::Bitmap& bitmap);
5427 
5443  void SetMKNormalIconImage(const common::Image& image, int frame_index);
5444 
5459 
5474  void SetMKRolloverIconBitmap(const common::Bitmap& bitmap);
5475 
5492  void SetMKRolloverIconImage(const common::Image& image, int frame_index);
5493 
5507 
5521  void SetMKDownIconBitmap(const common::Bitmap& bitmap);
5522 
5538  void SetMKDownIconImage(const common::Image& image, int frame_index);
5539 
5554  IconFit GetMKIconFit() const;
5555 
5573  void SetMKIconFit(const IconFit& icon_fit);
5574 
5589 
5606 
5614  void SetAppearanceState(const String& appearance_state);
5615 
5621  String GetAppearanceState() const;
5622 
5629 
5641  LineSpacingStyle GetLineSpacing(float& line_spacing_value);
5642 
5658  void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value);
5659 
5660 #ifdef _SUPPORTWEBSDK_
5661  //Set push button icon form icon stream. stream is from doc::createIcon.
5662  //face: 0: normal, 1: down, 2: roller
5663  void SetButtonIcon(objects::PDFStream* icon, int face);
5664 #endif
5665 };
5666 
5683 class Redact FS_FINAL : public Markup {
5684  public:
5686  Redact() {}
5692  explicit Redact(const Annot& annot);
5693  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5694  explicit Redact(FS_HANDLE handle);
5695 #ifndef __EMSCRIPTEN_RENDER__
5696 
5697  ~Redact();
5698 #endif
5699 
5713 
5732  void SetQuadPoints(const QuadPointsArray& quad_points_array);
5733 
5740  RGB GetFillColor() const;
5748  void SetFillColor(RGB fill_color);
5749 
5756  RGB GetApplyFillColor() const;
5757 
5765  void SetApplyFillColor(RGB fill_color);
5766 
5772  WString GetOverlayText() const;
5773 
5781  void SetOverlayText(const WString& overlay_text);
5782 
5788  bool IsOverlayTextRepeated();
5789 
5798  void EnableRepeatOverlayText(bool is_to_repeat_overlay_text);
5799 
5809 
5823 
5833 
5856  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
5857 
5869  bool Apply();
5870 };
5871 
5881 class Sound FS_FINAL : public Markup{
5882  public:
5888  typedef enum _SampleEncodingFormat {
5898 
5899 
5901  Sound() {}
5902 
5908  explicit Sound(const Annot& annot);
5909 
5910  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5911  explicit Sound(FS_HANDLE handle);
5912 
5913 #ifndef __EMSCRIPTEN_RENDER__
5914 
5915  ~Sound();
5916 #endif
5917 
5930 
5936  float GetSamplingRate() const;
5937 
5943  int GetChannelCount() const;
5944 
5950  int GetBits() const;
5951 
5959 
5965  String GetCompressionFormat() const;
5966 
5980  FileSpec GetFileSpec() const;
5981 };
5982 
5983 } // namespace annots
5984 } // namespace pdf
5985 } // namespace foxit
5986 
5987 #endif // FS_ANNOT_H_
5988 
foxit::pdf::annots::Annot::e_Caret
Annotation type: caret annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1004
foxit::pdf::annots::Screen
Definition: fs_annot.h:4271
foxit::pdf::annots::Line::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
foxit::pdf::annots::Annot::e_Sound
Annotation type: sound annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1012
foxit::pdf::annots::FileAttachment::~FileAttachment
~FileAttachment()
Destructor.
Definition: fs_annot.h:4925
foxit::pdf::annots::Popup
Definition: fs_annot.h:4983
foxit::pdf::annots::Annot::e_StrikeOut
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1000
foxit::pdf::annots::Redact::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::interform::Control
Definition: fs_pdfform.h:1236
foxit::pdf::annots::ShadingColor
Definition: fs_annot.h:1625
foxit::pdf::annots::PolyLine::GetStyleFillColor
RGB GetStyleFillColor() const
Get fill color for some line ending styles.
foxit::pdf::annots::Annot::e_Watermark
Annotation type: watermark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1027
foxit::pdf::annots::FreeText::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
foxit::pdf::annots::PolyLine::GetLineEndStyle
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
foxit::pdf::annots::Widget::SetMKNormalIconBitmap
void SetMKNormalIconBitmap(const common::Bitmap &bitmap)
Set a bitmap as normal icon in the MK dictionary.
foxit::pdf::annots::Line::SetLeaderLineExtensionLength
void SetLeaderLineExtensionLength(float extension_length)
Set the length of leader line extension.
foxit::pdf::annots::Annot::GetDict
objects::PDFDictionary * GetDict() const
Get annotation's dictionary object.
foxit::pdf::annots::Sound::e_SampleEncodingFormatSigned
Twos-complement values.
Definition: fs_annot.h:5892
foxit::pdf::annots::Note::GetReplyTo
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
foxit::pdf::annots::Note::~Note
~Note()
Destructor.
Definition: fs_annot.h:2493
foxit::pdf::annots::Annot::e_MKRelationCaptionAboveIcon
Caption above the icon.
Definition: fs_annot.h:1232
foxit::pdf::annots::FileAttachment::FileAttachment
FileAttachment()
Constructor.
Definition: fs_annot.h:4917
CFX_ArrayTemplate::GetSize
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1360
foxit::pdf::annots::Annot::e_Redact
Annotation type: redact annotation.
Definition: fs_annot.h:1033
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor()
Constructor.
Definition: fs_annot.h:1638
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
foxit::pdf::annots::Widget::SetMKDownCaption
void SetMKDownCaption(const wchar_t *caption)
Set the down caption string in the MK dictionary.
foxit::pdf::annots::Annot::GetIndex
int GetIndex() const
Get the index of current annotation in the page which current annotation belongs to.
foxit::pdf::annots::Polygon::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Annot::e_Square
Annotation type: square annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:986
foxit::pdf::annots::Caret::GetInnerRect
RectF GetInnerRect() const
Get the inner rectangle.
foxit::pdf::annots::Widget::SetMKIconFit
void SetMKIconFit(const IconFit &icon_fit)
Set the icon fit information in the MK dictionary.
foxit::pdf::annots::Square::SetMeasureRatio
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
foxit::pdf::FileSpec
Definition: fs_filespec.h:38
foxit::pdf::annots::Widget::GetMKRolloverCaption
WString GetMKRolloverCaption() const
Get the rollover caption string in the MK dictionary.
foxit::pdf::annots::Note::SetIconName
void SetIconName(const char *icon_name)
Set icon name.
foxit::pdf::annots::Note
Definition: fs_annot.h:2480
foxit::pdf::annots::Circle::Circle
Circle()
Constructor.
Definition: fs_annot.h:3108
foxit::pdf::annots::Annot::GetType
Type GetType() const
Get actual annotation type of current annotation.
foxit::pdf::annots::Popup::~Popup
~Popup()
Destructor.
Definition: fs_annot.h:4996
foxit::pdf::annots::Line::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Underline::~Underline
~Underline()
Destructor.
Definition: fs_annot.h:2742
foxit::pdf::annots::FileAttachment::GetIconName
String GetIconName() const
Get icon name.
foxit::pdf::annots::Circle::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::QuadPoints::third
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:730
foxit::pdf::annots::FreeText::AllowTextOverflow
void AllowTextOverflow(bool is_text_overflow)
Decide whether to allow the text of freetext to overflow or not.
foxit::pdf::annots::Stamp::SetIconName
void SetIconName(const char *icon_name)
Set icon name.
foxit::pdf::annots::Annot::e_MKEntryBackgroundColor
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:1174
foxit::pdf::actions::Action
Definition: fs_action.h:418
foxit::pdf::annots::Annot::SetModifiedDateTime
void SetModifiedDateTime(const DateTime &date_time)
Set last modified date time.
foxit::DateTime
Definition: fs_basictypes.h:446
foxit::pdf::annots::Annot::e_3D
Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1029
foxit::pdf::annots::Annot::GetRect
RectF GetRect() const
Get rectangle, in PDF coordinate system.
foxit::pdf::annots::Annot::e_FlagLockedContents
Annotation flag: locked contents.
Definition: fs_annot.h:1115
foxit::pdf::annots::Annot
Definition: fs_annot.h:964
foxit::pdf::annots::Annot::e_FlagHidden
Annotation flag: hidden.
Definition: fs_annot.h:1056
foxit::pdf::annots::Caret::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
foxit::pdf::annots::Redact::GetDefaultAppearance
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
foxit::pdf::annots::Annot::e_MKRelationNoIcon
No icon; captin only.
Definition: fs_annot.h:1226
foxit::pdf::annots::Ink::EnableUseBezier
void EnableUseBezier(bool use_bezier)
Enable to use bezier spline to generate ink path for ink annotation's appearance.
foxit::pdf::annots::Note::SetState
void SetState(State state)
Set the state.
foxit::pdf::annots::BorderInfo::Set
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_annot.h:577
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)
Set value.
Definition: fs_annot.h:342
foxit::pdf::annots::Square::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::annots::Annot::e_AppearanceTypeRollover
Annotation's rollover appearance.
Definition: fs_annot.h:1250
foxit::pdf::annots::Widget::e_LineSpacingDouble
Line spacing style: double line spacing.
Definition: fs_annot.h:5099
foxit::pdf::annots::Sound
Definition: fs_annot.h:5881
foxit::pdf::annots::Line::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
foxit::pdf::annots::Annot::e_MKRelationCaptionBelowIcon
Caption below the icon.
Definition: fs_annot.h:1230
foxit::pdf::annots::Line::SetLeaderLineOffset
void SetLeaderLineOffset(float offset)
Set the length of leader line offset.
foxit::pdf::RichTextStyle::is_bold
bool is_bold
A boolean value which indicates whether to make text bold or not.
Definition: fs_annot.h:382
foxit::pdf::annots::IconFit::is_proportional_scaling
bool is_proportional_scaling
A boolean value which indicates whether use proportional scaling or not.
Definition: fs_annot.h:910
foxit::pdf::annots::Sound::e_SampleEncodingFormatRaw
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5890
foxit::pdf::annots::Annot::ResetAppearanceStream
bool ResetAppearanceStream()
Reset appearance stream.
foxit::pdf::annots::Square::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::RichTextStyle::mark_style
CornerMarkStyle mark_style
Corner mark style. Corner mark style which can be used to make text as superscript or subscript or no...
Definition: fs_annot.h:399
foxit::pdf::annots::Highlight::~Highlight
~Highlight()
Destructor.
Definition: fs_annot.h:2712
foxit::pdf::annots::Polygon::GetVertexes
PointFArray GetVertexes()
Get vertexes.
foxit::pdf::annots::Annot::e_HighlightingPush
Highlighting mode: Push, which is to display the annotation's down appearance, if any.
Definition: fs_annot.h:1131
foxit::pdf::annots::Note::IsStateAnnot
bool IsStateAnnot()
Check if current note annotation is used as a state annotation.
foxit::pdf::annots::Line::GetLineStartStyle
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
foxit::pdf::annots::Highlight
Definition: fs_annot.h:2701
foxit::Object
CFX_Object Object
Object type.
Definition: fs_basictypes.h:217
foxit::pdf::annots::Annot::IsMarkup
bool IsMarkup() const
Check if current annotation is a markup annotation.
foxit::pdf::annots::Annot::e_Screen
Annotation type: screen annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1021
foxit::pdf::annots::Screen::SetImage
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current screen annotation, with a specified frame index.
foxit::pdf::annots::Widget::Widget
Widget()
Constructor.
Definition: fs_annot.h:5108
foxit::pdf::annots::Square::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Redact::GetOverlayText
WString GetOverlayText() const
Get the overlay text.
foxit::pdf::annots::Popup::GetOpenStatus
bool GetOpenStatus() const
Get open status.
foxit::pdf::annots::BorderInfo::style
Style style
Border style. Please refer to values starting from BorderInfo::e_Solid and this should be one of thes...
Definition: fs_annot.h:596
foxit::pdf::RichTextStyle::is_italic
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:386
foxit::pdf::annots::IconProviderCallback::GetIcon
virtual PDFPage GetIcon(Annot::Type annot_type, const char *icon_name, ARGB color)
A callback function used to get the icon as PDF page contents for a specified type.
foxit::pdf::annots::Highlight::Highlight
Highlight()
Constructor.
Definition: fs_annot.h:2704
foxit::pdf::annots::Annot::e_PropertyFillColor
Annotation property: fill color.
Definition: fs_annot.h:1160
foxit::pdf::annots::FreeText::SetCalloutLineEndingStyle
void SetCalloutLineEndingStyle(EndingStyle ending_style)
Set line ending style of the start point in a callout line.
foxit::pdf::annots::Annot::SetUniqueID
void SetUniqueID(const WString &unique_id)
Set unique ID.
foxit::pdf::annots::Square::Square
Square()
Constructor.
Definition: fs_annot.h:2936
foxit::pdf::annots::Screen::SetMKDict
void SetMKDict(pdf::objects::PDFDictionary *dict)
Set the appearance characteristics dictionary (known as "MK" dictionary as well).
foxit::pdf::annots::Square::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::Line::SetEndPoint
void SetEndPoint(const PointF &point)
Set the end point.
foxit::pdf::annots::Annot::e_MKRelationCaptionLeft
Caption to the left of the icon.
Definition: fs_annot.h:1236
foxit::pdf::annots::BorderInfo::operator=
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:509
foxit::pdf::annots::Stamp::~Stamp
~Stamp()
Destructor.
foxit::pdf::annots::Annot::e_FlagToggleNoView
Annotation flag: toggle no view.
Definition: fs_annot.h:1108
foxit::pdf::annots::QuadPoints::operator!=
bool operator!=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:703
foxit::pdf::annots::FreeText::Rotate
void Rotate(common::Rotation rotation)
Rotate current annotation from current state with specified rotation value (in clockwise).
foxit::pdf::annots::Screen::GetAction
actions::Action GetAction()
Get action.
foxit::pdf::annots::Widget::SetMKRotation
void SetMKRotation(common::Rotation rotation)
Set the rotation value in the MK dictionary.
foxit::pdf::annots::Line::SetLineStartStyle
void SetLineStartStyle(EndingStyle ending_style)
Set line ending style of the start point.
foxit::pdf::annots::IconProviderCallback::GetDisplayWidth
virtual float GetDisplayWidth(Annot::Type annot_type, const char *icon_name)
A callback function used to get the width for display of a specified icon, in device size(pixel norma...
Definition: fs_annot.h:1810
foxit::pdf::annots::IconProviderCallback::GetProviderVersion
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1741
foxit::pdf::annots::FreeText::SetAlignment
void SetAlignment(common::Alignment alignment)
Set alignment value.
foxit::pdf::annots::Polygon::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
foxit::pdf::RichTextStyle::e_CornerMarkSuperscript
Corner mark style: superscript.
Definition: fs_annot.h:213
foxit::pdf::annots::Markup::State
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1875
foxit::pdf::annots::Popup::GetParent
Markup GetParent()
Get related parent markup annotation.
foxit::pdf::annots::Redact::SetOverlayTextAlignment
void SetOverlayTextAlignment(common::Alignment alignment)
Set alignment value of overlay text.
foxit::pdf::annots::PolyLine::~PolyLine
~PolyLine()
Destructor.
Definition: fs_annot.h:4652
foxit::pdf::annots::IconFit::IconFit
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:794
foxit::pdf::annots::Line::SetCaptionPositionType
void SetCaptionPositionType(CapPos cap_position)
Set the position type of caption.
foxit::pdf::annots::Squiggly
Definition: fs_annot.h:2791
foxit::pdf::annots::Annot::SetContent
void SetContent(const WString &content)
Set content.
foxit::pdf::annots::Annot::e_RichMedia
Annotation type: rich media annotation.
Definition: fs_annot.h:1035
foxit::pdf::annots::Screen::GetMKDict
pdf::objects::PDFDictionary * GetMKDict() const
Get the appearance characteristics dictionary (known as "MK" dictionary as well).
foxit::pdf::RichTextStyle::text_size
float text_size
Text size. It should not be negative value. 0 means text will not be shown.
Definition: fs_annot.h:369
foxit::pdf::annots::Annot::e_FlagNoZoom
Annotation flag: no zoom.
Definition: fs_annot.h:1071
fs_common.h
Header file for common definitions and classes.
foxit::pdf::annots::TextMarkup::~TextMarkup
~TextMarkup()
Destructor.
Definition: fs_annot.h:2646
foxit::pdf::annots::Stamp::SetBitmap
void SetBitmap(const common::Bitmap &bitmap)
Set bitmap to current stamp annotation.
foxit::pdf::annots::Sound::~Sound
~Sound()
Destructor.
foxit::pdf::annots::Annot::~Annot
virtual ~Annot()
Destructor.
foxit::pdf::annots::FreeText::GetCalloutLineEndingStyle
EndingStyle GetCalloutLineEndingStyle() const
Get line ending style of the start point in a callout line.
foxit::pdf::annots::Square
Definition: fs_annot.h:2933
foxit::pdf::annots::Screen::Screen
Screen()
Constructor.
Definition: fs_annot.h:4274
foxit::pdf::annots::ShadingColor::second_color
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1702
foxit::pdf::annots::BorderInfo::e_Cloudy
Border style: Cloudy.
Definition: fs_annot.h:450
CFX_ArrayTemplate< float >
foxit::pdf::annots::Annot::e_Popup
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1031
foxit::pdf::annots::Line::GetLeaderLineExtensionLength
float GetLeaderLineExtensionLength() const
Get the length of leader line extension.
foxit::pdf::annots::Redact::EnableRepeatOverlayText
void EnableRepeatOverlayText(bool is_to_repeat_overlay_text)
Set the flag to decide whether to repeat the overlay text.
foxit::pdf::annots::Annot::e_FreeText
Annotation type: free text annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:982
foxit::pdf::annots::BorderInfo::e_Solid
Border style: Solid.
Definition: fs_annot.h:416
foxit::pdf::annots::Circle::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::annots::IconFit::fit_bounds
bool fit_bounds
A boolean value that indicates whether to scale button appearance to fit fully within bounds or not.
Definition: fs_annot.h:929
foxit::pdf::annots::Underline
Definition: fs_annot.h:2731
foxit::pdf::annots::PolyLine::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
foxit::common::Alignment
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:75
foxit::pdf::annots::Sound::GetChannelCount
int GetChannelCount() const
Get the count of sound channels.
foxit::pdf::annots::PolyLine::PolyLine
PolyLine()
Constructor.
Definition: fs_annot.h:4644
foxit::pdf::annots::Line::GetLeaderLineOffset
float GetLeaderLineOffset() const
Get the length of leader line offset.
foxit::pdf::annots::Stamp
Definition: fs_annot.h:4143
foxit::pdf::annots::QuadPoints::Set
void Set(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Set value.
Definition: fs_annot.h:718
foxit::pdf::annots::Line::HasCaption
bool HasCaption() const
Check whether the content of current line annotation should be replicated as a caption in the appeara...
foxit::pdf::annots::Annot::e_HighlightingInvert
Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
Definition: fs_annot.h:1127
foxit::pdf::annots::Circle::~Circle
~Circle()
Destructor.
Definition: fs_annot.h:3116
foxit::pdf::annots::Annot::e_MKEntryBorderColor
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1172
foxit::pdf::annots::Annot::GetFlags
uint32 GetFlags() const
Get annotation flags.
fs_file.h
Header file for file operation related definitions and functions.
foxit::pdf::DefaultAppearance::e_FlagFont
Indicates property font of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:60
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1633
foxit::pdf::annots::Square::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
foxit::pdf::annots::Widget::SetMKRolloverCaption
void SetMKRolloverCaption(const wchar_t *caption)
Set the rollover caption string in the MK dictionary.
foxit::pdf::annots::Widget
Definition: fs_annot.h:5086
foxit::pdf::annots::ShadingColor::Set
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1694
foxit::ARGB
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
foxit::pdf::annots::Annot::GetUniqueID
WString GetUniqueID() const
Get unique ID.
foxit::pdf::annots::Sound::Sound
Sound()
Constructor.
Definition: fs_annot.h:5901
foxit::pdf::annots::Widget::SetAppearanceState
void SetAppearanceState(const String &appearance_state)
Set the annotation's appearance state, which selects the applicable appearance stream from an appeara...
foxit::pdf::annots::Sound::GetSoundStream
objects::PDFStream * GetSoundStream() const
Get the stream of sound data.
foxit::pdf::annots::PolyLine::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::annots::Circle::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
foxit::pdf::annots::IconFit::IconFit
IconFit()
Constructor.
Definition: fs_annot.h:763
foxit::pdf::annots::Widget::GetMKNormalIconBitmap
common::Bitmap GetMKNormalIconBitmap()
Get the normal icon bitmap in the MK dictionary.
foxit::pdf::annots::BorderInfo::e_Dashed
Border style: Dashed.
Definition: fs_annot.h:423
foxit::pdf::annots::Redact::SetQuadPoints
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
foxit::pdf::annots::FreeText::SetDefaultAppearance
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
foxit::pdf::annots::Annot::e_FlagPrint
Annotation flag: print.
Definition: fs_annot.h:1064
foxit::pdf::annots::Annot::SetBorderColor
void SetBorderColor(RGB color)
Set border color.
foxit::pdf::annots::Annot::e_FlagNoView
Annotation flag: no view.
Definition: fs_annot.h:1086
foxit::pdf::annots::Redact::GetOverlayTextAlignment
common::Alignment GetOverlayTextAlignment() const
Get alignment value of overlay text.
foxit::pdf::annots::FreeText::GetTextMatrix
Matrix GetTextMatrix() const
Get matrix in default appearance data for text in current free text annotation.
foxit::pdf::annots::Annot::GetDisplayMatrix
Matrix GetDisplayMatrix(const Matrix &page_display_matrix)
Get the display matrix, from PDF coordinate system to targeted device coordinate system.
foxit::pdf::annots::Widget::e_LineSpacingOneAndHalf
Line spacing style: one and half times line spacing.
Definition: fs_annot.h:5097
foxit::pdf::annots::Line::GetCaptionOffset
Offset GetCaptionOffset() const
Get caption offset values.
foxit::pdf::annots::PSInk::~PSInk
~PSInk()
Destructor.
Definition: fs_annot.h:5069
foxit::pdf::annots::Line::e_CapPosTop
Definition: fs_annot.h:3611
foxit::pdf::annots::PSInk::PSInk
PSInk()
Constructor.
Definition: fs_annot.h:5059
foxit::pdf::annots::Markup::Markup
Markup()
Constructor.
Definition: fs_annot.h:1985
foxit::pdf::annots::ShadingColor::first_color
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1700
foxit::pdf::annots::NoteArray
Definition: fs_annot.h:1837
foxit::pdf::annots::Note::GetStateModel
StateModel GetStateModel()
Get the state model.
foxit::pdf::annots::Annot::e_MKRelationNoCaption
No caption; icon only.
Definition: fs_annot.h:1228
foxit::pdf::annots::Widget::GetMKBorderColor
RGB GetMKBorderColor() const
Get the border color in the MK dictionary.
foxit::common::e_AlignmentLeft
Left alignment.
Definition: fs_common.h:77
foxit::pdf::RichTextStyle::e_CornerMarkSubscript
Corner mark style: subscript.
Definition: fs_annot.h:215
foxit::common::Path
Definition: fs_common.h:1941
foxit::pdf::annots::Annot::e_FileAttachment
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1010
foxit::pdf::annots::FreeText::GetInnerRect
RectF GetInnerRect() const
Get the inner rectangle.
foxit::pdf::annots::FreeText::SetRotation
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
foxit::pdf::annots::Screen::~Screen
virtual ~Screen()
Destructor.
Definition: fs_annot.h:4282
foxit::pdf::annots::Annot::e_Note
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:978
foxit::pdf::annots::Line::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
foxit::pdf::annots::Note::GetOpenStatus
bool GetOpenStatus() const
Get open status.
foxit::pdf::annots::Annot::e_UnknownType
Annotation type: unknown.
Definition: fs_annot.h:973
foxit::pdf::annots::Stamp::Stamp
Stamp()
Constructor.
Definition: fs_annot.h:4146
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1647
foxit::pdf::annots::Annot::e_FlagInvisible
Annotation flag: invisible.
Definition: fs_annot.h:1050
foxit::pdf::annots::Redact::SetDefaultAppearance
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
foxit::pdf::annots::StrikeOut
Definition: fs_annot.h:2761
foxit::pdf::annots::FreeText
Definition: fs_annot.h:3288
foxit::pdf::annots::Markup
Definition: fs_annot.h:1856
foxit::pdf::annots::Ink
Definition: fs_annot.h:4030
foxit::pdf::annots::Caret::Caret
Caret()
Constructor.
Definition: fs_annot.h:4866
foxit::pdf::annots::BorderInfo::dashes
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:624
foxit::pdf::annots::PolyLine::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
foxit::pdf::annots::Sound::e_SampleEncodingFormatMuLaw
μ-law-encoded samples.
Definition: fs_annot.h:5894
foxit::pdf::annots::Line::Line
Line()
Constructor.
Definition: fs_annot.h:3616
foxit::pdf::annots::Line::GetEndPoint
PointF GetEndPoint() const
Get the end point.
foxit::pdf::annots::Circle::SetMeasureRatio
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
foxit::pdf::annots::Polygon::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance(const DefaultAppearance &default_appearance)
Constructor, with another default appearance object.
Definition: fs_annot.h:99
foxit::pdf::annots::Circle
Definition: fs_annot.h:3105
foxit::pdf::annots::Annot::e_MKEntryIconCaptionRelation
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:1216
foxit::pdf::DefaultAppearance::DefAPFlags
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:58
foxit::pdf::annots::Ink::SetInkList
void SetInkList(const common::Path &ink_list)
Set ink list data.
foxit::pdf::annots::Widget::GetMKNormalCaption
WString GetMKNormalCaption() const
Get the normal caption string in the MK dictionary.
foxit::pdf::annots::Widget::SetLineSpacing
void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value)
Set line spacing for current widget.
foxit::pdf::annots::Redact
Definition: fs_annot.h:5683
foxit::pdf::annots::Annot::e_FlagLocked
Annotation flag: locked.
Definition: fs_annot.h:1102
foxit::pdf::annots::IconFit::scale_way_type
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:901
foxit::pdf::annots::PolyLine::SetVertexes
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
foxit::pdf::annots::Annot::GetDeviceRect
RectI GetDeviceRect(const Matrix &matrix)
Get annotation rectangle in device coordinate system.
foxit::pdf::annots::Widget::SetHighlightingMode
void SetHighlightingMode(HighlightingMode mode)
Set highlighting mode.
foxit::pdf::annots::QuadPoints::first
PointF first
First point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:726
foxit::pdf::annots::Annot::e_MKRelationCaptionOvrlayOnIcon
Caption overlaid directly on the icon.
Definition: fs_annot.h:1238
foxit::pdf::annots::Annot::e_PropertyModifiedDate
Annotation property: modified date.
Definition: fs_annot.h:1143
foxit::pdf::annots::Redact::~Redact
~Redact()
Destructor.
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)
Constructor, with parameters.
Definition: fs_annot.h:235
foxit::pdf::RichTextStyle
Definition: fs_annot.h:202
foxit::pdf::annots::IconProviderCallback::CanChangeColor
virtual bool CanChangeColor(Annot::Type annot_type, const char *icon_name)
A callback function used to check if current icon provider supports to change color for a specified t...
Definition: fs_annot.h:1766
foxit::pdf::annots::Annot::e_MKEntryNormalIcon
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1194
foxit::pdf::annots::Screen::SetTitle
void SetTitle(const WString &title)
Set title of current screen annotation.
foxit::pdf::RichTextStyle::text_color
RGB text_color
Text color. Format: 0xRRGGBB.
Definition: fs_annot.h:378
foxit::pdf::annots::Widget::e_LineSpacingAuto
Line spacing style: auto line spacing.
Definition: fs_annot.h:5103
foxit::pdf::annots::Line::SetLineEndStyle
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_annot.h:471
foxit::pdf::annots::PolyLine::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Widget::e_LineSpacingExactValue
Line spacing style: exact value line spacing.
Definition: fs_annot.h:5101
foxit::pdf::annots::Stamp::GetRotation
int GetRotation()
Get current rotation angle (in clockwise).
foxit::pdf::annots::Annot::AppearanceType
AppearanceType
Enumeration for the type of annotation's appearance.
Definition: fs_annot.h:1246
foxit::pdf::annots::Annot::e_MKEntryRolloverIcon
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1199
foxit::pdf::annots::Square::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::IconProviderCallback::GetShadingColor
virtual bool GetShadingColor(Annot::Type annot_type, const char *icon_name, RGB referenced_color, int shading_index, ShadingColor &out_shading_color)
A callback function used to get the shading colors if current icon provider supports for a specified ...
Definition: fs_annot.h:1796
foxit::pdf::annots::Annot::e_HighlightingToggle
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1133
foxit::pdf::interform::Field
Definition: fs_pdfform.h:145
foxit::pdf::annots::Screen::RemoveAction
void RemoveAction()
Remove action.
foxit::pdf::DefaultAppearance::operator!=
bool operator!=(const DefaultAppearance &default_appearance) const
Not equal operator.
Definition: fs_annot.h:140
foxit::pdf::annots::Annot::e_HighlightingNone
Highlighting mode: No highlighting.
Definition: fs_annot.h:1125
foxit::pdf::annots::Annot::e_FlagNoRotate
Annotation flag: no rotate.
Definition: fs_annot.h:1078
foxit::pdf::annots::Square::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::annots::Widget::GetControl
interform::Control GetControl()
Get associated form control.
CFX_ByteString
BYTE STRING CLASS.
Definition: fx_string.h:317
foxit::pdf::annots::PolyLine::SetLineStartStyle
void SetLineStartStyle(EndingStyle starting_style)
Set line ending style of the start point.
foxit::pdf::annots::Line::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::annots::Square::GetInnerRect
RectF GetInnerRect() const
Get the inner rectangle.
foxit::pdf::annots::AnnotArray
Definition: fs_annot.h:1622
foxit::pdf::annots::Annot::SetBorderInfo
void SetBorderInfo(const BorderInfo &border)
Set border information.
foxit::pdf::annots::Annot::Property
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:1141
foxit::pdf::annots::Polygon::SetVertexes
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance()
Constructor.
Definition: fs_annot.h:89
foxit::pdf::annots::Annot::GetPage
PDFPage GetPage() const
Get the related PDF page.
foxit::pdf::annots::Popup::SetOpenStatus
void SetOpenStatus(bool status)
Set open status.
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints(const QuadPoints &quad_points)
Constructor, with another quadrilateral points object.
Definition: fs_annot.h:662
foxit::pdf::annots::QuadPoints::fourth
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:732
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:82
foxit::pdf::annots::Annot::e_AppearanceTypeNormal
Annotation's normal appearance.
Definition: fs_annot.h:1248
foxit::pdf::annots::Annot::e_Highlight
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:994
foxit::pdf::annots::BorderInfo::e_UnderLine
Border style: Underline.
Definition: fs_annot.h:429
foxit::pdf::annots::Widget::GetMKIconFit
IconFit GetMKIconFit() const
Get the icon fit information in the MK dictionary.
foxit::pdf::annots::Widget::GetAction
actions::Action GetAction()
Get action.
foxit::pdf::annots::PolyLine::SetLineEndStyle
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
foxit::pdf::RichTextStyle::font
common::Font font
A font used in rich text style. It should be a valid font object.
Definition: fs_annot.h:365
foxit::pdf::annots::Screen::SetRotation
void SetRotation(common::Rotation rotate)
Set the rotation of the image used for the appearance of current screen annotation.
foxit::pdf::annots::Polygon::Polygon
Polygon()
Constructor.
Definition: fs_annot.h:4462
foxit::pdf::annots::PolyLine::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio string for measuring.
foxit::pdf::annots::Polygon::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo()
Constructor.
Definition: fs_annot.h:480
foxit::pdf::annots::Markup::StateModel
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1863
foxit::pdf::annots::FileAttachment::SetFileSpec
bool SetFileSpec(const FileSpec &file_spec)
Set a file specification, which should specify an embedded file.
CFX_PSVTemplate
Definition: fx_coordinates.h:30
foxit::pdf::annots::FileAttachment::GetFileSpec
FileSpec GetFileSpec()
Get the file specification.
foxit::pdf::annots::Annot::GetBorderColor
RGB GetBorderColor() const
Get border color.
foxit::pdf::annots::PolyLine::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Annot::e_Movie
Annotation type: movie annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1014
foxit::pdf::annots::Sound::GetSamplingRate
float GetSamplingRate() const
Get the sampling rate, in samples per second.
foxit::pdf::annots::Sound::GetFileSpec
FileSpec GetFileSpec() const
Get the file specification object which represents an external sound file.
foxit::pdf::annots::Redact::SetOverlayText
void SetOverlayText(const WString &overlay_text)
Set the overlay text.
foxit::common::Rotation
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
foxit::pdf::annots::Annot::e_Underline
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:996
foxit::pdf::RichTextStyle::CornerMarkStyle
CornerMarkStyle
Enumeration for corner mark style.
Definition: fs_annot.h:209
foxit::pdf::annots::Redact::GetQuadPoints
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
foxit::pdf::annots::Markup::EndingStyle
EndingStyle
Enumeration for line ending style.
Definition: fs_annot.h:1928
foxit::pdf::annots::BorderInfo
Definition: fs_annot.h:407
foxit::pdf::annots::Screen::GetOpacity
float GetOpacity() const
Get opacity value.
foxit::pdf::annots::Widget::RemoveAction
void RemoveAction()
Remove action.
foxit::pdf::annots::Square::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const char *unit)
Set the label for displaying the units for measuring.
foxit::pdf::annots::Widget::HasMKEntry
bool HasMKEntry(MKEntry mk_entry)
Check if a specified entry exists in the MK dictionary.
foxit::pdf::annots::Widget::e_LineSpacingSingle
Line spacing style: single line spacing.
Definition: fs_annot.h:5095
foxit::pdf::annots::Widget::GetField
interform::Field GetField()
Get associated form field.
foxit::pdf::annots::Caret::~Caret
~Caret()
Destructor.
Definition: fs_annot.h:4874
foxit::pdf::annots::Widget::SetAction
void SetAction(const actions::Action &action)
Set action.
foxit::pdf::annots::Circle::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::Annot::MKEntry
MKEntry
Enumeration for annotation's MK dictionary (an appearance characteristics) entry.
Definition: fs_annot.h:1168
foxit::pdf::RichTextStyle::operator!=
bool operator!=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:320
operator==
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
foxit::pdf::annots::Circle::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Line::GetStyleFillColor
RGB GetStyleFillColor() const
Get fill color for ending styles.
foxit::pdf::annots::Annot::GetBorderInfo
BorderInfo GetBorderInfo() const
Get border information.
foxit::pdf::annots::Redact::SetApplyFillColor
void SetApplyFillColor(RGB fill_color)
Set the filling color which is used for rollover appearance and will be used after redaction is appli...
foxit::pdf::annots::Annot::GetOptionalContent
objects::PDFDictionary * GetOptionalContent() const
Get the PDF dictionary of annotation's optional content.
foxit::pdf::annots::Squiggly::~Squiggly
~Squiggly()
Destructor.
Definition: fs_annot.h:2802
foxit::pdf::annots::Annot::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::pdf::annots::Sound::SampleEncodingFormat
SampleEncodingFormat
Enumeration for encoding format of sound sample data.
Definition: fs_annot.h:5888
fs_pdfobject.h
Header file for PDF object related definitions and classes.
foxit::pdf::DefaultAppearance::flags
uint32 flags
Flags to indicate which properties of default appearance are meaningful.
Definition: fs_annot.h:177
foxit::pdf::annots::FreeText::SetCalloutLinePoints
void SetCalloutLinePoints(const PointFArray &point_array)
Set points for callout line.
foxit::pdf::annots::Annot::e_Polygon
Annotation type: polygon annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:990
foxit::pdf::annots::Annot::e_PropertyBorderColor
Annotation property: border color.
Definition: fs_annot.h:1154
foxit::pdf::annots::Widget::SetMKDownIconBitmap
void SetMKDownIconBitmap(const common::Bitmap &bitmap)
Set the down icon bitmap in the MK dictionary.
foxit::pdf::annots::Annot::RemoveProperty
bool RemoveProperty(Property property)
Remove a specified annotation's property.
foxit::pdf::annots::Widget::SetMKNormalCaption
void SetMKNormalCaption(const wchar_t *caption)
Set the normal caption string in the MK dictionary.
foxit::pdf::annots::StrikeOut::StrikeOut
StrikeOut()
Constructor.
Definition: fs_annot.h:2764
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
foxit::pdf::annots::Stamp::SetImage
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current stamp annotation, with a specified frame index.
foxit::pdf::annots::Annot::e_HighlightingOutline
Highlighting mode: Outline, which is to invert the annotation's border.
Definition: fs_annot.h:1129
foxit::pdf::annots::Underline::Underline
Underline()
Constructor.
Definition: fs_annot.h:2734
foxit::pdf::annots::Screen::SetOpacity
void SetOpacity(float opacity)
Set opacity value.
foxit::pdf::annots::Screen::GetTitle
WString GetTitle() const
Get title of current screen annotation.
foxit::pdf::annots::Widget::SetMKIconCaptionRelation
void SetMKIconCaptionRelation(MKIconCaptionRelation relation)
Set the relation of icon and caption in the MK dictionary.
foxit::pdf::annots::Widget::GetMKDownIconBitmap
common::Bitmap GetMKDownIconBitmap()
Get the down icon bitmap in the MK dictionary.
foxit::pdf::annots::Widget::SetMKBackgroundColor
void SetMKBackgroundColor(RGB color)
Set the background color in the MK dictionary.
foxit::pdf::DefaultAppearance::e_FlagFontSize
Indicates property text size of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:64
foxit::pdf::DefaultAppearance::font
common::Font font
A font for default appearance. It should be a valid font object when it is useful.
Definition: fs_annot.h:183
foxit::pdf::annots::FreeText::FreeText
FreeText()
Constructor.
Definition: fs_annot.h:3291
foxit::pdf::annots::Line::SetStartPoint
void SetStartPoint(const PointF &point)
Set the start point.
foxit::pdf::annots::FreeText::GetDefaultAppearance
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
foxit::pdf::RichTextStyle::text_alignment
common::Alignment text_alignment
Alignment value. Please refer to values starting from common::e_AlignmentLeft and this should be one ...
Definition: fs_annot.h:374
foxit::pdf::annots::QuadPoints::operator==
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:691
foxit::pdf::annots::Square::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
foxit::pdf::annots::Annot::e_MKEntryIconFit
Icon fit information entry. "IF" in MK dictionary.
Definition: fs_annot.h:1209
foxit::pdf::annots::Polygon::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
foxit::pdf::annots::StrikeOut::~StrikeOut
~StrikeOut()
Destructor.
Definition: fs_annot.h:2772
foxit::pdf::annots::Polygon::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::annots::FreeText::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::annots::IconProviderCallback::GetProviderID
virtual String GetProviderID()
A callback function used to get provider ID.
Definition: fs_annot.h:1730
foxit::pdf::annots::IconFit::ScaleWayType
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:748
foxit::pdf::RichTextStyle::e_CornerMarkNone
Corner mark style: none.
Definition: fs_annot.h:211
foxit::pdf::annots::Annot::e_MKEntryRotation
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1170
foxit::pdf::annots::QuadPoints
Definition: fs_annot.h:637
foxit::pdf::annots::Widget::GetMKRolloverIconBitmap
common::Bitmap GetMKRolloverIconBitmap()
Get the rollover icon bitmap in the MK dictionary.
fs_image.h
Header file for image and bitmap related definitions and classes.
foxit::pdf::annots::IconProviderCallback::GetDisplayHeight
virtual float GetDisplayHeight(Annot::Type annot_type, const char *icon_name)
A callback function used to get the height for display of a specified icon, in device size(pixel norm...
Definition: fs_annot.h:1823
foxit::pdf::annots::Annot::GetModifiedDateTime
DateTime GetModifiedDateTime() const
Get last modified date time.
foxit::pdf::annots::QuadPoints::second
PointF second
Second point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:728
foxit::pdf::annots::PSInk
Definition: fs_annot.h:5056
foxit::pdf::annots::IconFit::Set
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:887
foxit::pdf::annots::BorderInfo::operator!=
bool operator!=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:545
foxit::pdf::DefaultAppearance::e_FlagTextColor
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:62
foxit::pdf::annots::Caret
Definition: fs_annot.h:4863
foxit::pdf::annots::Circle::GetInnerRect
RectF GetInnerRect() const
Get the inner rectangle.
foxit::pdf::annots::Sound::GetBits
int GetBits() const
Get the number of bits per sample value per channel.
foxit::pdf::annots::Widget::SetMKBorderColor
void SetMKBorderColor(RGB color)
Set the border color in the MK dictionary.
foxit::pdf::annots::Line::SetStyleFillColor
void SetStyleFillColor(RGB color)
Set fill color for ending styles.
foxit::pdf::objects::PDFDictionary
Definition: fs_pdfobject.h:809
foxit::pdf::annots::Annot::e_Circle
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:988
foxit::pdf::annots::Annot::e_Line
Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:984
foxit::pdf::annots::Square::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
operator!=
bool operator!=(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are not equal.
Definition: fs_basictypes.h:140
foxit::pdf::annots::Annot::e_AppearanceTypeDown
Annotation's down appearance.
Definition: fs_annot.h:1252
foxit::pdf::annots::Widget::GetMKIconCaptionRelation
MKIconCaptionRelation GetMKIconCaptionRelation() const
Get the relation of icon and caption in the MK dictionary.
foxit::pdf::annots::Annot::MKIconCaptionRelation
MKIconCaptionRelation
Enumeration for icon and caption relative position in annotation's MK dictionary.
Definition: fs_annot.h:1224
foxit::pdf::annots::IconFit::vertical_fraction
float vertical_fraction
The vertical fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:922
foxit::pdf::annots::Annot::e_MKEntryDownCaption
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1189
foxit::pdf::annots::Line::SetLeaderLineLength
void SetLeaderLineLength(float length)
Set the length of leader line.
foxit::pdf::annots::Widget::SetMKDownIconImage
void SetMKDownIconImage(const common::Image &image, int frame_index)
Set an image with specified frame index as down icon in the MK dictionary.
foxit::pdf::annots::Annot::e_MKEntryNormalCaption
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1179
foxit::pdf::annots::Annot::e_Ink
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1006
foxit::pdf::annots::IconFit::IconFit
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:807
foxit::pdf::annots::TextMarkup
Definition: fs_annot.h:2635
foxit::pdf::annots::BorderInfo::operator==
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:525
foxit::pdf::annots::FreeText::GetRotation
common::Rotation GetRotation()
Get current rotation value (in clockwise).
foxit::pdf::annots::Annot::GetContent
WString GetContent() const
Get content.
foxit::pdf::annots::Polygon::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
foxit::pdf::annots::FreeText::~FreeText
~FreeText()
Destructor.
Definition: fs_annot.h:3300
foxit::pdf::annots::Annot::e_Stamp
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1002
foxit::pdf::annots::Circle::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::annots::Screen::GetBitmap
common::Bitmap GetBitmap()
Get the bitmap from current screen annotation.
foxit::pdf::annots::Line::GetLineEndStyle
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
foxit::pdf::annots::Widget::LineSpacingStyle
LineSpacingStyle
Enumeration for line spacing style.
Definition: fs_annot.h:5093
foxit::pdf::annots::Annot::Move
bool Move(const RectF &rect)
Move current annotation to a new position, specified by a new rectangle in PDF coordinate system.
foxit::pdf::DefaultAppearance::Set
void Set(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Set value.
Definition: fs_annot.h:163
foxit::pdf::RichTextStyle::RichTextStyle
RichTextStyle(const RichTextStyle &style)
Constructor, with another style object.
Definition: fs_annot.h:263
foxit::pdf::annots::FreeText::GetCalloutLinePoints
PointFArray GetCalloutLinePoints() const
Get a point of callout line points.
CFX_FloatRect
Definition: fx_coordinates.h:771
foxit::pdf::annots::BorderInfo::cloud_intensity
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:609
foxit::pdf::DefaultAppearance::text_size
float text_size
Text size for default appearance.
Definition: fs_annot.h:192
foxit::pdf::DefaultAppearance::text_color
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:198
foxit::pdf::RichTextStyle::operator==
bool operator==(const RichTextStyle &style) const
Equal operator.
Definition: fs_annot.h:301
foxit::pdf::annots::Polygon::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
foxit::pdf::annots::Polygon::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::RGB
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
foxit::pdf::annots::Annot::e_FlagReadOnly
Annotation flag: read only.
Definition: fs_annot.h:1095
foxit::pdf::annots::Popup::Popup
Popup()
Constructor.
Definition: fs_annot.h:4986
foxit::pdf::annots::Line::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
foxit::pdf::annots::IconProviderCallback
Definition: fs_annot.h:1714
foxit::pdf::annots::BorderInfo::e_Beveled
Border style: Beveled.
Definition: fs_annot.h:436
foxit::pdf::annots::Circle::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::annots::Annot::e_Widget
Annotation type: widget annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1019
foxit::pdf::annots::IconProviderCallback::HasIcon
virtual bool HasIcon(Annot::Type annot_type, const char *icon_name)
A callback function used to check if current icon provider supports icon for a specified type.
Definition: fs_annot.h:1753
foxit::pdf::PDFPage
Definition: fs_pdfpage.h:411
foxit::pdf::annots::TextMarkup::GetQuadPoints
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
foxit::pdf::annots::Markup::~Markup
~Markup()
Destructor.
Definition: fs_annot.h:1988
foxit::pdf::annots::PolyLine::SetStyleFillColor
void SetStyleFillColor(RGB fill_color)
Set fill color for some line ending styles.
foxit::pdf::annots::Widget::GetAppearanceOnStateName
String GetAppearanceOnStateName() const
Get the name of the annotation's appearance "ON" state.
foxit::pdf::annots::PolyLine::GetLineStartStyle
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
foxit::pdf::annots::Widget::GetMKRotation
common::Rotation GetMKRotation() const
Get the rotation value in the MK dictionary.
foxit::pdf::annots::Circle::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
foxit::pdf::annots::IconProviderCallback::Release
virtual void Release()=0
A callback function used to release current callback object itself.
foxit::pdf::annots::Redact::GetApplyFillColor
RGB GetApplyFillColor() const
Get the filling color which is used for rollover appearance and will be used after redaction is appli...
foxit::pdf::annots::TextMarkup::TextMarkup
TextMarkup()
Constructor.
Definition: fs_annot.h:2638
foxit::int32
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:194
foxit::pdf::RichTextStyle::is_strikethrough
bool is_strikethrough
A boolean value which indicates whether to cross text out with strike through or not.
Definition: fs_annot.h:394
foxit::pdf::annots::Note::GetIconName
String GetIconName() const
Get icon name.
foxit::pdf::annots::Line::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
foxit::pdf::annots::Line::CapPos
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:3607
foxit::pdf::annots::Annot::operator!=
bool operator!=(const Annot &other) const
Not equal operator.
foxit::pdf::annots::Widget::SetMKRolloverIconBitmap
void SetMKRolloverIconBitmap(const common::Bitmap &bitmap)
Set the rollover icon bitmap in the MK dictionary.
foxit::pdf::annots::Annot::e_Link
Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:980
foxit::pdf::annots::Note::SetOpenStatus
void SetOpenStatus(bool status)
Set open status.
foxit::pdf::annots::Annot::e_TrapNet
Annotation type: trap network annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1025
foxit::pdf::annots::PolyLine::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
foxit::pdf::annots::Line::SetCaptionOffset
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
foxit::pdf::annots::Widget::GetHighlightingMode
HighlightingMode GetHighlightingMode()
Get highlighting mode.
foxit::pdf::annots::Annot::operator=
Annot & operator=(const Annot &annot)
Assign operator.
foxit::pdf::annots::Sound::e_SampleEncodingFormatALaw
A-law-encoded samples.
Definition: fs_annot.h:5896
foxit::common::Image
Definition: fs_image.h:445
foxit::pdf::annots::Line::GetStartPoint
PointF GetStartPoint() const
Get the start point.
foxit::pdf::annots::Stamp::SetRotation
void SetRotation(int angle)
Set rotation angle (in clockwise).
foxit::pdf::annots::MarkupArray
Definition: fs_annot.h:1833
foxit::pdf::annots::Annot::e_Squiggly
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:998
foxit::pdf::annots::Annot::Type
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:971
foxit::pdf::annots::FreeText::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Constructor, with parameters.
Definition: fs_annot.h:647
foxit::pdf::annots::Annot::SetFlags
void SetFlags(uint32 flags)
Set annotation flags.
foxit::pdf::annots::Widget::GetLineSpacing
LineSpacingStyle GetLineSpacing(float &line_spacing_value)
Get line spacing of current widget.
foxit::pdf::annots::Annot::GetAppearanceStream
objects::PDFStream * GetAppearanceStream(AppearanceType type, const char *appearance_state="") const
Get annotation's appearance stream with specified type and state.
foxit::pdf::annots::Annot::e_PSInk
Annotation type: pressure sensitive ink annotation.
Definition: fs_annot.h:1008
foxit::pdf::annots::Circle::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const char *unit)
Set the label for displaying the units for measuring.
foxit::pdf::annots::Screen::SetAction
void SetAction(const actions::Action &action)
Set action.
FX_RECT
Definition: fx_coordinates.h:596
foxit::pdf::annots::Annot::Annot
Annot()
Constructor.
Definition: fs_annot.h:1275
foxit::pdf::annots::Widget::RemoveMKEntry
void RemoveMKEntry(MKEntry mk_entry)
Remove a specified entry from the MK dictionary.
foxit::common::Font
Definition: fs_common.h:1344
foxit::pdf::annots::Widget::SetMKRolloverIconImage
void SetMKRolloverIconImage(const common::Image &image, int frame_index)
Set an image with specified frame index as rollover icon in the MK dictionary.
foxit::pdf::annots::Annot::e_MKEntryDownIcon
Down icon (or alternate icon) entry. "IX" in MK dictionary.
Definition: fs_annot.h:1204
foxit::pdf::annots::Annot::e_PrinterMark
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1023
foxit::pdf::annots::BorderInfo::dash_phase
float dash_phase
Dash phase.
Definition: fs_annot.h:616
foxit::pdf::annots::QuadPoints::operator=
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:676
CFX_Matrix
Definition: fx_coordinates.h:1076
foxit::pdf::annots::Annot::e_MKRelationCaptionRight
Caption to the right of the icon.
Definition: fs_annot.h:1234
foxit::pdf::annots::Widget::GetMKBackgroundColor
RGB GetMKBackgroundColor() const
Get the background color in the MK dictionary.
foxit::pdf::annots::Widget::~Widget
~Widget()
Destructor.
foxit::pdf::annots::Annot::e_MKEntryRolloverCaption
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:1184
foxit::pdf::annots::Annot::operator==
bool operator==(const Annot &other) const
Equal operator.
foxit::pdf::annots::PolyLine::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::DefaultAppearance::operator=
DefaultAppearance & operator=(const DefaultAppearance &default_appearance)
Assign operator.
Definition: fs_annot.h:112
foxit::pdf::annots::Widget::GetMKDownCaption
WString GetMKDownCaption() const
Get the down caption string in the MK dictionary.
foxit::pdf::annots::PolyLine::GetVertexes
PointFArray GetVertexes()
Get vertexes.
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints()
Constructor.
Definition: fs_annot.h:655
foxit::pdf::annots::Redact::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::Squiggly::Squiggly
Squiggly()
Constructor.
Definition: fs_annot.h:2794
foxit::pdf::annots::FreeText::SetTextMatrix
void SetTextMatrix(const Matrix &text_matrix)
Set matrix in default appearance data for text in current free text annotation.
foxit::pdf::RichTextStyle::RichTextStyle
RichTextStyle()
Constructor.
Definition: fs_annot.h:248
foxit::pdf::annots::Polygon::~Polygon
~Polygon()
Destructor.
Definition: fs_annot.h:4470
foxit::pdf::annots::PolyLine
Definition: fs_annot.h:4641
foxit::pdf::DefaultAppearance
Definition: fs_annot.h:51
foxit::pdf::annots::Polygon::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
foxit::pdf::objects::PDFStream
Definition: fs_pdfobject.h:422
foxit::pdf::annots::BorderInfo::e_Inset
Border style: Inset.
Definition: fs_annot.h:443
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1452
foxit::pdf::annots::Line::EnableCaption
void EnableCaption(bool cap)
Set the flag which is used to decide whether the content of current line annotation should be replica...
foxit::String
CFX_ByteString String
Byte string.
Definition: fs_basictypes.h:221
foxit::pdf::annots::Line
Definition: fs_annot.h:3600
foxit::pdf::annots::Annot::HasProperty
bool HasProperty(Property property) const
Whether current annotation has the specified annotation's property.
foxit::common::Bitmap
Definition: fs_image.h:36
foxit::pdf::annots::Circle::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
foxit::pdf::annots::BorderInfo::width
float width
Border width, in points.
Definition: fs_annot.h:590
foxit::pdf::annots::Annot::e_PolyLine
Annotation type: polyline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:992
foxit::pdf::RichTextStyle::is_underline
bool is_underline
A boolean value which indicates whether to underline text or not.
Definition: fs_annot.h:390
foxit::pdf::annots::BorderInfo::~BorderInfo
~BorderInfo()
Destructor.
Definition: fs_annot.h:487
foxit::pdf::annots::Ink::~Ink
~Ink()
Destructor.
Definition: fs_annot.h:4041
foxit::pdf::annots::Line::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo(const BorderInfo &border_info)
Constructor, with another border information object.
Definition: fs_annot.h:494
foxit::pdf::annots::Polygon
Definition: fs_annot.h:4459
foxit::pdf::annots::BorderInfo::Style
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:414
foxit::pdf::annots::Line::GetLeaderLineLength
float GetLeaderLineLength() const
Get the length of leader line.
foxit::pdf::annots::Markup::MeasureType
MeasureType
Enumeration for annotation's measure type.
Definition: fs_annot.h:1960
foxit::uint32
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
foxit::pdf::annots::FreeText::GetAlignment
common::Alignment GetAlignment() const
Get alignment value.
foxit::pdf::annots::Widget::SetMKNormalIconImage
void SetMKNormalIconImage(const common::Image &image, int frame_index)
Set an image with specified frame index as normal icon in the MK dictionary.
foxit::pdf::annots::Sound::GetCompressionFormat
String GetCompressionFormat() const
Get the name of the sound compression format used on the sample data.
foxit::pdf::annots::TextMarkup::SetQuadPoints
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
foxit::pdf::annots::Screen::GetRotation
common::Rotation GetRotation()
Get the rotation of the image used for the appearance of current screen annotation.
foxit::pdf::annots::QuadPointsArray
Definition: fs_annot.h:736
foxit::pdf::annots::Stamp::GetIconName
String GetIconName() const
Get icon name.
foxit::Base
Definition: fs_basictypes.h:413
foxit::pdf::annots::Annot::Flags
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1043
foxit::pdf::annots::Line::~Line
~Line()
Destructor.
Definition: fs_annot.h:3624
foxit::pdf::annots::Stamp::Rotate
void Rotate(int angle)
Rotate current annotation from current state with specified angle degree in clockwise.
foxit::pdf::annots::Note::GetState
State GetState()
Get the state.
foxit::pdf::annots::FileAttachment::SetIconName
void SetIconName(const char *icon_name)
Set icon name.
foxit::pdf::annots::IconFit
Definition: fs_annot.h:742
foxit::pdf::DefaultAppearance::operator==
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:127
foxit::pdf::annots::Note::Note
Note()
Constructor.
Definition: fs_annot.h:2483
foxit::pdf::annots::Ink::Ink
Ink()
Constructor.
Definition: fs_annot.h:4033
foxit::pdf::annots::Annot::HighlightingMode
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1123
foxit::pdf::annots::Sound::GetSampleEncodingFormat
SampleEncodingFormat GetSampleEncodingFormat() const
Get the encoding format for the sample data.
foxit::pdf::annots::Widget::GetAppearanceState
String GetAppearanceState() const
Get the annotation's appearance state, which selects the applicable appearance stream from an appeara...
foxit::pdf::annots::Line::GetCaptionPositionType
CapPos GetCaptionPositionType() const
Get the position type of caption.
foxit::pdf::annots::Line::e_CapPosInline
Definition: fs_annot.h:3609
foxit::pdf::annots::Annot::e_PropertyCreationDate
Annotation property: creation date.
Definition: fs_annot.h:1148
foxit::pdf::annots::FileAttachment
Definition: fs_annot.h:4914
foxit::pdf::annots::Redact::Apply
bool Apply()
Apply current redact annotation: remove the text or graphics under annotation rectangle permanently.
foxit::pdf::annots::Redact::IsOverlayTextRepeated
bool IsOverlayTextRepeated()
Check whether the overlay text is repeated or not.
foxit::pdf::annots::Redact::Redact
Redact()
Constructor.
Definition: fs_annot.h:5686
foxit::pdf::RichTextStyle::operator=
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:281
foxit::pdf::annots::IconFit::horizontal_fraction
float horizontal_fraction
The horizontal fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:916
foxit::pdf::annots::Ink::GetInkList
common::Path GetInkList()
Get ink list data.
foxit::pdf::annots::Square::~Square
~Square()
Destructor.
Definition: fs_annot.h:2944