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);
1453  BorderInfo GetBorderInfo() const;
1454 
1472  void SetBorderInfo(const BorderInfo& border);
1481  RGB GetBorderColor() const;
1493  void SetBorderColor(RGB color);
1506  bool ResetAppearanceStream();
1522  RectI GetDeviceRect(const Matrix& matrix);
1523 
1530 
1540  bool HasProperty(Property property) const;
1541 
1559  bool RemoveProperty(Property property);
1560 
1568 
1585  objects::PDFStream* GetAppearanceStream(AppearanceType type, const char* appearance_state = "") const;
1586 };
1587 
1589 FSDK_DEFINE_ARRAY(AnnotArray, Annot)
1590 
1591 
1592 class ShadingColor FS_FINAL : public Object {
1593  public:
1600  ShadingColor(ARGB firstcolor, ARGB secondcolor)
1601  : first_color(firstcolor)
1602  , second_color(secondcolor) {}
1603 
1606  : first_color(0xFFFFFFFF)
1607  , second_color(0xFFFFFFFF) {}
1608 
1614  ShadingColor(const ShadingColor& shading_color)
1615  : first_color(shading_color.first_color)
1616  , second_color(shading_color.second_color) {}
1617 
1625  ShadingColor& operator = (const ShadingColor& shading_color) {
1626  this->first_color = shading_color.first_color;
1627  this->second_color = shading_color.second_color;
1628  return *this;
1629  }
1630 
1638  bool operator == (const ShadingColor& shading_color) const {
1639  return (first_color == shading_color.first_color && second_color == shading_color.second_color);
1640  }
1641 
1649  bool operator != (const ShadingColor& shading_color) const {
1650  return (first_color != shading_color.first_color || second_color != shading_color.second_color);
1651  }
1652 
1661  void Set(ARGB firstcolor, ARGB secondcolor) {
1662  this->first_color = firstcolor;
1663  this->second_color = secondcolor;
1664  }
1665 
1670 };
1671 
1682  public:
1688  virtual void Release() = 0;
1697  virtual String GetProviderID() {
1698  return String();
1699  }
1709  return String();
1710  }
1720  virtual bool HasIcon(Annot::Type annot_type, const char* icon_name) {
1721  return false;
1722  }
1733  virtual bool CanChangeColor(Annot::Type annot_type, const char* icon_name) {
1734  return false;
1735  }
1736 #ifndef __EMSCRIPTEN_RENDER__
1737 
1747  virtual PDFPage GetIcon(Annot::Type annot_type, const char* icon_name, ARGB color);
1748 #endif
1749 
1763  virtual bool GetShadingColor(Annot::Type annot_type, const char* icon_name,
1764  RGB referenced_color, int shading_index, ShadingColor& out_shading_color) {
1765  return false;
1766  }
1777  virtual float GetDisplayWidth(Annot::Type annot_type, const char* icon_name) {
1778  return 0.0f;
1779  }
1790  virtual float GetDisplayHeight(Annot::Type annot_type, const char* icon_name) {
1791  return 0.0f;
1792  }
1793 
1794  protected:
1795  ~IconProviderCallback() {}
1796 };
1797 
1798 class Markup;
1800 FSDK_DEFINE_ARRAY(MarkupArray, Markup)
1801 
1802 class Note;
1804 FSDK_DEFINE_ARRAY(NoteArray, Note)
1805 
1806 
1823 class Markup : public Annot {
1824  public:
1830  typedef enum _StateModel {
1832  e_StateModelMarked = 1,
1834  e_StateModelReview = 2
1835  } StateModel;
1836 
1842  typedef enum _State {
1847  e_StateNone = 0,
1852  e_StateMarked = 1,
1857  e_StateUnmarked = 2,
1862  e_StateAccepted = 3,
1867  e_StateRejected = 4,
1872  e_StateCancelled = 5,
1877  e_StateCompleted = 6,
1882  e_StateDeferred = 7,
1887  e_StateFuture = 8
1888  } State;
1889 
1895  typedef enum _EndingStyle {
1897  e_EndingStyleNone = 0,
1899  e_EndingStyleSquare = 1,
1901  e_EndingStyleCircle = 2,
1903  e_EndingStyleDiamond = 3,
1905  e_EndingStyleOpenArrow = 4,
1911  e_EndingStyleClosedArrow = 5,
1913  e_EndingStyleButt = 6,
1915  e_EndingStyleROpenArrow = 7,
1917  e_EndingStyleRClosedArrow = 8,
1919  e_EndingStyleSlash = 9
1920  } EndingStyle;
1921 
1927  typedef enum _MeasureType {
1929  e_MeasureTypeX = 0,
1931  e_MeasureTypeY = 1,
1933  e_MeasureTypeD = 2,
1935  e_MeasureTypeA = 3,
1937  e_MeasureTypeT = 4,
1939  e_MeasureTypeS = 5
1940  } MeasureType;
1941 
1942 
1948  explicit Markup(const Annot& annot);
1949  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1950  explicit Markup(FS_HANDLE handle);
1952  Markup() {}
1953 
1955  ~Markup() {}
1956 
1974  Popup GetPopup();
1991  void SetPopup(const Popup& popup);
1998  bool RemovePopup();
2006  WString GetTitle() const;
2016  void SetTitle(const WString& title);
2022  WString GetSubject() const;
2030  void SetSubject(const WString& subject);
2039  float GetOpacity() const;
2052  void SetOpacity(float opacity);
2074  String GetIntent() const;
2110  void SetIntent(const String& intent);
2117  DateTime GetCreationDateTime() const;
2125  void SetCreationDateTime(const DateTime& date_time);
2131  int GetReplyCount();
2140  Note GetReply(int index) const;
2146  Note AddReply();
2157  bool RemoveReply(int index);
2163  bool RemoveAllReplies();
2164 
2181  bool IsGrouped();
2182 
2201  Markup GetGroupHeader();
2202 
2219  MarkupArray GetGroupElements();
2220 
2236  bool Ungroup();
2237 
2253  NoteArray GetStateAnnots(StateModel model);
2254 
2291  Note AddStateAnnot(const WString& title, StateModel model, State state);
2292 
2302  bool RemoveAllStateAnnots();
2310  int32 GetRichTextCount();
2321  WString GetRichTextContent(int32 index);
2333  void SetRichTextContent(int32 index, const WString& content);
2334 
2345  RichTextStyle GetRichTextStyle(int32 index);
2359  void SetRichTextStyle(int32 index, const RichTextStyle& style);
2372  void AddRichText(const WString& content, const RichTextStyle& style);
2389  void InsertRichText(int32 index, const WString& content, const RichTextStyle& style);
2400  void RemoveRichText(int index);
2401 };
2402 
2425 class Note FS_FINAL : public Markup {
2426  public:
2428  Note() {}
2434  explicit Note(const Annot& annot);
2435  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2436  explicit Note(FS_HANDLE handle);
2438  ~Note() {}
2439 
2452  bool GetOpenStatus() const;
2467  void SetOpenStatus(bool status);
2479  String GetIconName() const;
2497  void SetIconName(const char* icon_name);
2507  Markup GetReplyTo();
2514  bool IsStateAnnot();
2515 
2528 
2540  State GetState();
2541 
2565  void SetState(State state);
2566 
2567 };
2568 
2580 class TextMarkup: public Markup {
2581  public:
2589  explicit TextMarkup(const Annot& annot);
2592 
2627  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2628 };
2629 
2646 class Highlight FS_FINAL : public TextMarkup {
2647  public:
2655  explicit Highlight(const Annot& annot);
2658 };
2659 
2676 class Underline FS_FINAL : public TextMarkup {
2677  public:
2685  explicit Underline(const Annot& annot);
2688 };
2689 
2706 class StrikeOut FS_FINAL : public TextMarkup {
2707  public:
2715  explicit StrikeOut(const Annot& annot);
2718 };
2719 
2736 class Squiggly FS_FINAL : public TextMarkup {
2737  public:
2745  explicit Squiggly(const Annot& annot);
2748 };
2749 
2763 class Link FS_FINAL : public Annot {
2764  public:
2766  Link() {}
2772  explicit Link(const Annot& annot);
2773  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2774  explicit Link(FS_HANDLE handle);
2776  ~Link() {}
2777 
2810  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2811 
2820 
2831 
2839 
2854  void SetAction(const actions::Action& action);
2855 
2861  bool RemoveAction();
2862 };
2863 
2878 class Square FS_FINAL : public Markup {
2879  public:
2881  Square() {}
2887  explicit Square(const Annot& annot);
2889  ~Square() {}
2890 
2897  RGB GetFillColor() const;
2898 
2906  void SetFillColor(RGB fill_color);
2907 
2917  RectF GetInnerRect() const;
2929  void SetInnerRect(const RectF& inner_rect);
2930 
2944  void SetMeasureRatio(const char* ratio);
2945 
2956 
2967 
2980  void SetMeasureUnit(MeasureType measure_type, const char* unit);
2981 
2993  String GetMeasureUnit(MeasureType measure_type);
2994 
3006  WString GetMeasureUnitW(MeasureType measure_type);
3007 
3020  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3021 
3033  float GetMeasureConversionFactor(MeasureType measure_type);
3034 };
3035 
3050 class Circle FS_FINAL : public Markup {
3051  public:
3053  Circle() {}
3059  explicit Circle(const Annot& annot);
3061  ~Circle() {}
3062 
3069  RGB GetFillColor() const;
3070 
3081  void SetFillColor(RGB fill_color);
3082 
3092  RectF GetInnerRect() const;
3093 
3107  void SetInnerRect(const RectF& inner_rect);
3108 
3122  void SetMeasureRatio(const char* ratio);
3123 
3134 
3145 
3158  void SetMeasureUnit(MeasureType measure_type, const char* unit);
3159 
3171  String GetMeasureUnit(MeasureType measure_type);
3172 
3184  WString GetMeasureUnitW(MeasureType measure_type);
3185 
3198  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3199 
3211  float GetMeasureConversionFactor(MeasureType measure_type);
3212 };
3213 
3233 class FreeText FS_FINAL : public Markup {
3234  public:
3242  explicit FreeText(const Annot& annot);
3245 
3256  RGB GetFillColor() const;
3270  void SetFillColor(RGB fill_color);
3271 
3284 
3301  void SetAlignment(common::Alignment alignment);
3302 
3313  RectF GetInnerRect() const;
3314 
3329  void SetInnerRect(const RectF& inner_rect);
3330 
3340 
3363  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
3364 
3376 
3391  void SetCalloutLineEndingStyle(EndingStyle ending_style);
3392 
3407 
3430  void SetCalloutLinePoints(const PointFArray& point_array);
3431 
3447  void SetTextMatrix(const Matrix& text_matrix);
3448 
3460  Matrix GetTextMatrix() const;
3461 
3469 
3484  void SetRotation(common::Rotation rotation);
3485 
3498  void Rotate(common::Rotation rotation);
3499 
3517  void AllowTextOverflow(bool is_text_overflow);
3518 };
3519 
3538 class Line FS_FINAL : public Markup {
3539  public:
3545  typedef enum _CapPos {
3550  } CapPos;
3551 
3552 
3554  Line() {}
3560  explicit Line(const Annot& annot);
3562  ~Line() {}
3563 
3585  void SetLineStartStyle(EndingStyle ending_style);
3594  EndingStyle GetLineEndStyle() const;
3607  void SetLineEndStyle(EndingStyle ending_style);
3608 
3619  RGB GetStyleFillColor() const;
3620 
3634  void SetStyleFillColor(RGB color);
3635 
3644  PointF GetStartPoint() const;
3657  void SetStartPoint(const PointF& point);
3658 
3667  PointF GetEndPoint() const;
3680  void SetEndPoint(const PointF& point);
3681 
3690  bool HasCaption() const;
3703  void EnableCaption(bool cap);
3704 
3732  void SetCaptionPositionType(CapPos cap_position);
3745  Offset GetCaptionOffset() const;
3761  void SetCaptionOffset(const Offset& offset);
3762 
3777  float GetLeaderLineLength() const;
3795  void SetLeaderLineLength(float length);
3805  float GetLeaderLineExtensionLength() const;
3818  void SetLeaderLineExtensionLength(float extension_length);
3819 
3830  float GetLeaderLineOffset() const;
3844  void SetLeaderLineOffset(float offset);
3845 
3859  void SetMeasureRatio(const String& ratio);
3860 
3871 
3882 
3895  void SetMeasureUnit(MeasureType measure_type, const String& unit);
3896 
3908  String GetMeasureUnit(MeasureType measure_type);
3909 
3921  WString GetMeasureUnitW(MeasureType measure_type);
3922 
3935  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3936 
3948  float GetMeasureConversionFactor(MeasureType measure_type);
3949 };
3950 
3968 class Ink FS_FINAL : public Markup {
3969  public:
3971  Ink() {}
3977  explicit Ink(const Annot& annot);
3979  ~Ink() {}
4007 
4040  void SetInkList(const common::Path& ink_list);
4041 
4053  void EnableUseBezier(bool use_bezier);
4054 
4055 };
4056 
4081 class Stamp FS_FINAL : public Markup {
4082  public:
4084  Stamp() {}
4090  explicit Stamp(const Annot& annot);
4091 #ifndef __EMSCRIPTEN_RENDER__
4092 
4093  ~Stamp();
4094 #endif
4095 
4106  String GetIconName() const;
4129  void SetIconName(const char* icon_name);
4140  void SetBitmap(const common::Bitmap& bitmap);
4141 
4164  void SetImage(const common::Image& image, int frame_index, int compress);
4165 
4176  void SetRotation(int angle);
4177 
4183  int GetRotation();
4184 
4194  void Rotate(int angle);
4195 };
4196 
4209 class Screen FS_FINAL : public Annot {
4210  public:
4212  Screen() {}
4218  explicit Screen(const Annot& annot);
4220  virtual ~Screen() {}
4221 
4244  void SetImage(const common::Image& image, int frame_index, int compress);
4245 
4253 
4264 
4272 
4285  void SetRotation(common::Rotation rotate);
4286 
4294 
4303  float GetOpacity() const;
4316  void SetOpacity(float opacity);
4317 
4323  WString GetTitle() const;
4331  void SetTitle(const WString& title);
4332 
4366  void SetAction(const actions::Action& action);
4375  void RemoveAction();
4376 };
4377 
4396 class Polygon FS_FINAL : public Markup {
4397  public:
4399  Polygon() {}
4405  explicit Polygon(const Annot& annot);
4416  RGB GetFillColor() const;
4417 
4429  void SetFillColor(RGB fill_color);
4430 
4440 
4452  void SetVertexes(const PointFArray& vertexes);
4453 
4467  void SetMeasureRatio(const String& ratio);
4468 
4479 
4490 
4503  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4504 
4516  String GetMeasureUnit(MeasureType measure_type);
4517 
4529  WString GetMeasureUnitW(MeasureType measure_type);
4530 
4543  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4544 
4556  float GetMeasureConversionFactor(MeasureType measure_type);
4557 };
4558 
4578 class PolyLine FS_FINAL : public Markup {
4579  public:
4587  explicit PolyLine(const Annot& annot);
4600  RGB GetStyleFillColor() const;
4612  void SetStyleFillColor(RGB fill_color);
4613 
4623 
4635  void SetVertexes(const PointFArray& vertexes);
4658  void SetLineStartStyle(EndingStyle starting_style);
4667  EndingStyle GetLineEndStyle() const;
4681  void SetLineEndStyle(EndingStyle ending_style);
4682 
4696  void SetMeasureRatio(const String& ratio);
4697 
4708 
4719 
4732  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4733 
4745  String GetMeasureUnit(MeasureType measure_type);
4746 
4758  WString GetMeasureUnitW(MeasureType measure_type);
4759 
4772  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4773 
4785  float GetMeasureConversionFactor(MeasureType measure_type);
4786 };
4787 
4800 class Caret FS_FINAL : public Markup {
4801  public:
4803  Caret() {}
4809  explicit Caret(const Annot& annot);
4811  ~Caret() {}
4812 
4822  RectF GetInnerRect() const;
4836  void SetInnerRect(const RectF& inner_rect);
4837 };
4838 
4851 class FileAttachment FS_FINAL : public Markup {
4852  public:
4860  explicit FileAttachment(const Annot& annot);
4863 
4871  bool SetFileSpec(const FileSpec& file_spec);
4872 
4880 
4891  String GetIconName() const;
4892 
4908  void SetIconName(const char* icon_name);
4909 };
4910 
4920 class Popup FS_FINAL : public Annot {
4921  public:
4923  Popup() {}
4929  explicit Popup(const Annot& annot);
4930  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
4931  explicit Popup(FS_HANDLE handle);
4933  ~Popup() {}
4934 
4947  bool GetOpenStatus() const;
4962  void SetOpenStatus(bool status);
4963 
4971  Markup GetParent();
4972 };
4973 #ifndef __FSDK_NO_PSINK__
4974 
4993 class PSInk FS_FINAL : public Annot {
4994  public:
4996  PSInk() {}
5002  explicit PSInk(const Annot& annot);
5003  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5004  explicit PSInk(FS_HANDLE handle);
5006  ~PSInk() {}
5007 
5008 };
5009 #endif
5010 
5023 class Widget FS_FINAL : public Annot {
5024  public:
5030  typedef enum _LineSpacingStyle {
5041  } LineSpacingStyle;
5042 
5043 
5045  Widget() {}
5051  explicit Widget(const Annot& annot);
5052  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5053  explicit Widget(FS_HANDLE handle);
5054 #ifndef __EMSCRIPTEN_RENDER__
5055 
5056  ~Widget();
5057 #endif
5058 
5064 
5071 
5082 
5095 
5106 
5130  void SetAction(const actions::Action& action);
5131 
5140  void RemoveAction();
5141 
5153  bool HasMKEntry(MKEntry mk_entry);
5154 
5166  void RemoveMKEntry(MKEntry mk_entry);
5167 
5181 
5194  void SetMKRotation(common::Rotation rotation);
5195 
5206  RGB GetMKBorderColor() const;
5207 
5218  void SetMKBorderColor(RGB color);
5219 
5230  RGB GetMKBackgroundColor() const;
5231 
5242  void SetMKBackgroundColor(RGB color);
5243 
5257  WString GetMKNormalCaption() const;
5258 
5272  void SetMKNormalCaption(const wchar_t* caption);
5273 
5288  WString GetMKRolloverCaption() const;
5289 
5304  void SetMKRolloverCaption(const wchar_t* caption);
5305 
5319  WString GetMKDownCaption() const;
5320 
5334  void SetMKDownCaption(const wchar_t* caption);
5335 
5349 
5363  void SetMKNormalIconBitmap(const common::Bitmap& bitmap);
5364 
5380  void SetMKNormalIconImage(const common::Image& image, int frame_index);
5381 
5396 
5411  void SetMKRolloverIconBitmap(const common::Bitmap& bitmap);
5412 
5429  void SetMKRolloverIconImage(const common::Image& image, int frame_index);
5430 
5444 
5458  void SetMKDownIconBitmap(const common::Bitmap& bitmap);
5459 
5475  void SetMKDownIconImage(const common::Image& image, int frame_index);
5476 
5491  IconFit GetMKIconFit() const;
5492 
5510  void SetMKIconFit(const IconFit& icon_fit);
5511 
5526 
5543 
5551  void SetAppearanceState(const String& appearance_state);
5552 
5558  String GetAppearanceState() const;
5559 
5566 
5578  LineSpacingStyle GetLineSpacing(float& line_spacing_value);
5579 
5595  void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value);
5596 
5597 #ifdef _SUPPORTWEBSDK_
5598  //Set push button icon form icon stream. stream is from doc::createIcon.
5599  //face: 0: normal, 1: down, 2: roller
5600  void SetButtonIcon(objects::PDFStream* icon, int face);
5601 #endif
5602 };
5603 
5620 class Redact FS_FINAL : public Markup {
5621  public:
5623  Redact() {}
5629  explicit Redact(const Annot& annot);
5630  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5631  explicit Redact(FS_HANDLE handle);
5632 #ifndef __EMSCRIPTEN_RENDER__
5633 
5634  ~Redact();
5635 #endif
5636 
5650 
5669  void SetQuadPoints(const QuadPointsArray& quad_points_array);
5670 
5677  RGB GetFillColor() const;
5685  void SetFillColor(RGB fill_color);
5686 
5693  RGB GetApplyFillColor() const;
5694 
5702  void SetApplyFillColor(RGB fill_color);
5703 
5709  WString GetOverlayText() const;
5710 
5718  void SetOverlayText(const WString& overlay_text);
5719 
5729 
5743 
5753 
5776  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
5777 
5789  bool Apply();
5790 };
5791 
5801 class Sound FS_FINAL : public Markup{
5802  public:
5808  typedef enum _SampleEncodingFormat {
5818 
5819 
5821  Sound() {}
5822 
5828  explicit Sound(const Annot& annot);
5829 
5830  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5831  explicit Sound(FS_HANDLE handle);
5832 
5833 #ifndef __EMSCRIPTEN_RENDER__
5834 
5835  ~Sound();
5836 #endif
5837 
5850 
5856  float GetSamplingRate() const;
5857 
5863  int GetChannelCount() const;
5864 
5870  int GetBits() const;
5871 
5879 
5885  String GetCompressionFormat() const;
5886 
5900  FileSpec GetFileSpec() const;
5901 };
5902 
5903 } // namespace annots
5904 } // namespace pdf
5905 } // namespace foxit
5906 
5907 #endif // FS_ANNOT_H_
5908 
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:624
Annotation flag: read only.
Definition: fs_annot.h:1095
void SetFillColor(RGB fill_color)
Set fill color.
Definition: fs_annot.h:1681
WString GetUniqueID() const
Get unique ID.
StateModel GetStateModel()
Get the state model.
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
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:1184
~Line()
Destructor.
Definition: fs_annot.h:3562
Square()
Constructor.
Definition: fs_annot.h:2881
void SetStyleFillColor(RGB fill_color)
Set fill color for some line ending styles.
RectI GetDeviceRect(const Matrix &matrix)
Get annotation rectangle in device coordinate system.
~FreeText()
Destructor.
Definition: fs_annot.h:3244
IconFit()
Constructor.
Definition: fs_annot.h:763
void SetBorderColor(RGB color)
Set border color.
Definition: fs_pdfobject.h:416
PointFArray GetVertexes()
Get vertexes.
IconFit GetMKIconFit() const
Get the icon fit information in the MK dictionary.
bool operator==(const RichTextStyle &style) const
Equal operator.
Definition: fs_annot.h:301
WString GetMKNormalCaption() const
Get the normal caption string in the MK dictionary.
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1842
Definition: fs_annot.h:1592
Definition: fs_annot.h:2580
Definition: fs_annot.h:2676
~Popup()
Destructor.
Definition: fs_annot.h:4933
Line spacing style: auto line spacing.
Definition: fs_annot.h:5040
String GetAppearanceState() const
Get the annotation's appearance state, which selects the applicable appearance stream from an appeara...
Definition: fs_annot.h:4209
Redact()
Constructor.
Definition: fs_annot.h:5623
Definition: fs_annot.h:202
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
PointFArray GetCalloutLinePoints() const
Get a point of callout line points.
void Set(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Set value.
Definition: fs_annot.h:718
bool HasProperty(Property property) const
Whether current annotation has the specified annotation's property.
Definition: fs_image.h:36
MKIconCaptionRelation
Enumeration for icon and caption relative position in annotation's MK dictionary.
Definition: fs_annot.h:1224
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:998
Annotation flag: no view.
Definition: fs_annot.h:1086
RectF GetInnerRect() const
Get the inner rectangle.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Definition: fs_annot.h:4851
Markup()
Constructor.
Definition: fs_annot.h:1952
PDFPage GetPage() const
Get the related PDF page.
WString GetContent() const
Get content.
Twos-complement values.
Definition: fs_annot.h:5812
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1010
Annot()
Constructor.
Definition: fs_annot.h:1275
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5810
void SetAppearanceState(const String &appearance_state)
Set the annotation's appearance state, which selects the applicable appearance stream from an appeara...
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
bool IsStateAnnot()
Check if current note annotation is used as a state annotation.
Down icon (or alternate icon) entry. "IX" in MK dictionary.
Definition: fs_annot.h:1204
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
float width
Border width, in points.
Definition: fs_annot.h:590
Annotation type: free text annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:982
State GetState()
Get the state.
StrikeOut()
Constructor.
Definition: fs_annot.h:2709
CFX_Object Object
Object type.
Definition: fs_basictypes.h:217
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1031
common::Rotation GetRotation()
Get current rotation value (in clockwise).
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
PolyLine()
Constructor.
Definition: fs_annot.h:4581
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1667
actions::Action GetAction()
Get action.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
void SetFlags(uint32 flags)
Set annotation flags.
String GetAppearanceOnStateName() const
Get the name of the annotation's appearance "ON" state.
Definition: fs_annot.h:1589
void SetOverlayText(const WString &overlay_text)
Set the overlay text.
Screen()
Constructor.
Definition: fs_annot.h:4212
Sound()
Constructor.
Definition: fs_annot.h:5821
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:794
bool HasCaption() const
Check whether the content of current line annotation should be replicated as a caption in the appeara...
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:1216
float GetLeaderLineOffset() const
Get the length of leader line offset.
void SetMKRolloverIconBitmap(const common::Bitmap &bitmap)
Set the rollover icon bitmap in the MK dictionary.
void SetFillColor(RGB fill_color)
Set fill color.
void SetMeasureUnit(MeasureType measure_type, const char *unit)
Set the label for displaying the units for measuring.
Corner mark style: superscript.
Definition: fs_annot.h:213
Definition: fs_annot.h:742
Markup GetParent()
Get related parent markup annotation.
void SetMKNormalIconImage(const common::Image &image, int frame_index)
Set an image with specified frame index as normal icon in the MK dictionary.
HighlightingMode GetHighlightingMode()
Get highlighting mode.
Annotation flag: print.
Definition: fs_annot.h:1064
Definition: fs_basictypes.h:440
BorderInfo GetBorderInfo() const
Get border information.
RGB GetApplyFillColor() const
Get the filling color which is used for rollover appearance and will be used after redaction is appli...
common::Font font
A font used in rich text style. It should be a valid font object.
Definition: fs_annot.h:365
BorderInfo(const BorderInfo &border_info)
Constructor, with another border information object.
Definition: fs_annot.h:494
RichTextStyle()
Constructor.
Definition: fs_annot.h:248
Definition: fs_annot.h:407
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:414
bool HasMKEntry(MKEntry mk_entry)
Check if a specified entry exists in the MK dictionary.
~Highlight()
Destructor.
Definition: fs_annot.h:2657
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:1763
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1708
Definition: fs_annot.h:2878
No caption; icon only.
Definition: fs_annot.h:1228
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
void SetTextMatrix(const Matrix &text_matrix)
Set matrix in default appearance data for text in current free text annotation.
Definition: fx_coordinates.h:30
int GetRotation()
Get current rotation angle (in clockwise).
void SetLineStartStyle(EndingStyle starting_style)
Set line ending style of the start point.
void SetMKRolloverIconImage(const common::Image &image, int frame_index)
Set an image with specified frame index as rollover icon in the MK dictionary.
MeasureType
Enumeration for annotation's measure type.
Definition: fs_annot.h:1927
Annotation type: unknown.
Definition: fs_annot.h:973
Caption above the icon.
Definition: fs_annot.h:1232
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:971
Annotation type: redact annotation.
Definition: fs_annot.h:1033
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:1823
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1360
void SetIconName(const char *icon_name)
Set icon name.
Annotation's normal appearance.
Definition: fs_annot.h:1248
Definition: fs_annot.h:736
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1043
Header file for file operation related definitions and functions.
objects::PDFStream * GetAppearanceStream(AppearanceType type, const char *appearance_state="") const
Get annotation's appearance stream with specified type and state.
DefaultAppearance(const DefaultAppearance &default_appearance)
Constructor, with another default appearance object.
Definition: fs_annot.h:99
void SetCalloutLineEndingStyle(EndingStyle ending_style)
Set line ending style of the start point in a callout line.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
void EnableCaption(bool cap)
Set the flag which is used to decide whether the content of current line annotation should be replica...
objects::PDFStream * GetSoundStream() const
Get the stream of sound data.
Definition: fs_annot.h:51
Annotation type: square annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:986
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:609
~Caret()
Destructor.
Definition: fs_annot.h:4811
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
RGB GetStyleFillColor() const
Get fill color for ending styles.
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
void SetInkList(const common::Path &ink_list)
Set ink list data.
void SetFillColor(RGB fill_color)
Set fill color.
void SetHighlightingMode(HighlightingMode mode)
Set highlighting mode.
RectF GetInnerRect() const
Get the inner rectangle.
Underline()
Constructor.
Definition: fs_annot.h:2679
void SetMKIconCaptionRelation(MKIconCaptionRelation relation)
Set the relation of icon and caption in the MK dictionary.
Annotation property: creation date.
Definition: fs_annot.h:1148
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_annot.h:577
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
void SetMKDict(pdf::objects::PDFDictionary *dict)
Set the appearance characteristics dictionary (known as "MK" dictionary as well).
Definition: fs_annot.h:5023
RGB GetFillColor() const
Get fill color.
Definition: fs_annot.h:4396
WIDE STRING CLASS.
Definition: fx_string.h:1452
Corner mark style: subscript.
Definition: fs_annot.h:215
void SetOpenStatus(bool status)
Set open status.
Definition: fs_annot.h:2425
void SetAlignment(common::Alignment alignment)
Set alignment value.
Annotation type: movie annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1014
Annotation property: modified date.
Definition: fs_annot.h:1143
actions::Action GetAction()
Get action.
DateTime GetModifiedDateTime() const
Get last modified date time.
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1194
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
bool IsEmpty() const
Check whether current object is empty or not.
virtual ~Screen()
Destructor.
Definition: fs_annot.h:4220
void SetIconName(const char *icon_name)
Set icon name.
Caption below the icon.
Definition: fs_annot.h:1230
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:386
RGB GetStyleFillColor() const
Get fill color for some line ending styles.
RectF GetInnerRect() const
Get the inner rectangle.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
bool Apply()
Apply current redact annotation: remove the text or graphics under annotation rectangle permanently.
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:525
FileSpec GetFileSpec()
Get the file specification.
Annotation flag: no rotate.
Definition: fs_annot.h:1078
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
SampleEncodingFormat GetSampleEncodingFormat() const
Get the encoding format for the sample data.
float GetSamplingRate() const
Get the sampling rate, in samples per second.
RGB GetFillColor() const
Get fill color.
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
RGB GetFillColor() const
Get fill color.
Annotation type: screen annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1021
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:691
void SetEndPoint(const PointF &point)
Set the end point.
RGB GetMKBackgroundColor() const
Get the background color in the MK dictionary.
objects::PDFDictionary * GetOptionalContent() const
Get the PDF dictionary of annotation's optional content.
bool IsMarkup() const
Check if current annotation is a markup annotation.
RichTextStyle(const RichTextStyle &style)
Constructor, with another style object.
Definition: fs_annot.h:263
~StrikeOut()
Destructor.
Definition: fs_annot.h:2717
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:901
~PolyLine()
Destructor.
Definition: fs_annot.h:4589
DefaultAppearance()
Constructor.
Definition: fs_annot.h:89
Annotation property: fill color.
Definition: fs_annot.h:1160
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:82
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1614
Annotation property: border color.
Definition: fs_annot.h:1154
Widget()
Constructor.
Definition: fs_annot.h:5045
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
void SetAction(const actions::Action &action)
Set action.
WString GetMeasureRatioW()
Get the scale ratio string for measuring.
Definition: fs_pdfform.h:1239
Highlight()
Constructor.
Definition: fs_annot.h:2649
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
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:62
Annotation flag: toggle no view.
Definition: fs_annot.h:1108
void SetFillColor(RGB fill_color)
Set fill color.
~Underline()
Destructor.
Definition: fs_annot.h:2687
Definition: fs_annot.h:4081
Definition: fs_annot.h:3547
RGB text_color
Text color. Format: 0xRRGGBB.
Definition: fs_annot.h:378
Header file for image and bitmap related definitions and classes.
void SetBitmap(const common::Bitmap &bitmap)
Set bitmap to current stamp annotation.
void SetLeaderLineLength(float length)
Set the length of leader line.
Definition: fs_annot.h:5620
FreeText()
Constructor.
Definition: fs_annot.h:3236
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:509
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:887
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1600
Border style: Solid.
Definition: fs_annot.h:416
~Note()
Destructor.
Definition: fs_annot.h:2438
Annotation type: rich media annotation.
Definition: fs_annot.h:1035
Type GetType() const
Get actual annotation type of current annotation.
Offset GetCaptionOffset() const
Get caption offset values.
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Annotation flag: no zoom.
Definition: fs_annot.h:1071
Annotation's rollover appearance.
Definition: fs_annot.h:1250
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:807
float GetLeaderLineExtensionLength() const
Get the length of leader line extension.
MKEntry
Enumeration for annotation's MK dictionary (an appearance characteristics) entry.
Definition: fs_annot.h:1168
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
common::Rotation GetMKRotation() const
Get the rotation value in the MK dictionary.
String GetMeasureRatio()
Get the scale ratio string for measuring.
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
float GetOpacity() const
Get opacity value.
void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value)
Set line spacing for current widget.
String GetMeasureRatio()
Get the scale ratio string for measuring.
common::Path GetInkList()
Get ink list data.
Annotation's down appearance.
Definition: fs_annot.h:1252
uint32 flags
Flags to indicate which properties of default appearance are meaningful.
Definition: fs_annot.h:177
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1669
μ-law-encoded samples
Definition: fs_annot.h:5814
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:3050
Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
Definition: fs_annot.h:1127
Line()
Constructor.
Definition: fs_annot.h:3554
PointF GetEndPoint() const
Get the end point.
Annotation type: polygon annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:990
void SetMKIconFit(const IconFit &icon_fit)
Set the icon fit information in the MK dictionary.
uint32 GetFlags() const
Get annotation flags.
common::Bitmap GetMKDownIconBitmap()
Get the down icon bitmap in the MK dictionary.
Border style: Beveled.
Definition: fs_annot.h:436
int GetChannelCount() const
Get the count of sound channels.
Circle()
Constructor.
Definition: fs_annot.h:3053
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
void SetMKBorderColor(RGB color)
Set the border color in the MK dictionary.
Highlighting mode: Outline, which is to invert the annotation's border.
Definition: fs_annot.h:1129
common::Font font
A font for default appearance. It should be a valid font object when it is useful.
Definition: fs_annot.h:183
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1661
MKIconCaptionRelation GetMKIconCaptionRelation() const
Get the relation of icon and caption in the MK dictionary.
common::Rotation GetRotation()
Get the rotation of the image used for the appearance of current screen annotation.
bool operator !=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:703
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
bool Move(const RectF &rect)
Move current annotation to a new position, specified by a new rectangle in PDF coordinate system.
void SetContent(const WString &content)
Set content.
void AllowTextOverflow(bool is_text_overflow)
Decide whether to allow the text of freetext to overflow or not.
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
bool is_proportional_scaling
A boolean value which indicates whether use proportional scaling or not.
Definition: fs_annot.h:910
Matrix GetDisplayMatrix(const Matrix &page_display_matrix)
Get the display matrix, from PDF coordinate system to targeted device coordinate system.
bool GetOpenStatus() const
Get open status.
Definition: fs_annot.h:2706
common::Bitmap GetMKNormalIconBitmap()
Get the normal icon bitmap in the MK dictionary.
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:732
Popup()
Constructor.
Definition: fs_annot.h:4923
Definition: fs_annot.h:4800
Definition: fs_annot.h:4993
Annot & operator=(const Annot &annot)
Assign operator.
Annotation type: widget annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1019
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:978
virtual void Release()=0
A callback function used to release current callback object itself.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1830
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
void SetMeasureUnit(MeasureType measure_type, const char *unit)
Set the label for displaying the units for measuring.
~Squiggly()
Destructor.
Definition: fs_annot.h:2747
void SetAction(const actions::Action &action)
Set action.
~Polygon()
Destructor.
Definition: fs_annot.h:4407
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1006
Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:980
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1172
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
pdf::objects::PDFDictionary * GetMKDict() const
Get the appearance characteristics dictionary (known as "MK" dictionary as well).
PointF second
Second point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:728
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:58
RGB GetFillColor() const
Get fill color.
Definition: fs_common.h:1908
void SetCaptionPositionType(CapPos cap_position)
Set the position type of caption.
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.
void SetTitle(const WString &title)
Set title of current screen annotation.
EndingStyle
Enumeration for line ending style.
Definition: fs_annot.h:1895
Definition: fs_annot.h:3968
RGB GetMKBorderColor() const
Get the border color in the MK dictionary.
Caret()
Constructor.
Definition: fs_annot.h:4803
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:748
void EnableUseBezier(bool use_bezier)
Enable to use bezier spline to generate ink path for ink annotation's appearance.
String GetMeasureRatio()
Get the scale ratio string for measuring.
bool operator !=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:545
Annotation flag: locked.
Definition: fs_annot.h:1102
void SetRotation(common::Rotation rotate)
Set the rotation of the image used for the appearance of current screen annotation.
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
~Ink()
Destructor.
Definition: fs_annot.h:3979
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
void SetMKNormalCaption(const wchar_t *caption)
Set the normal caption string in the MK dictionary.
Annotation type: pressure sensitive ink annotation.
Definition: fs_annot.h:1008
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:676
void SetFillColor(RGB fill_color)
Set fill color.
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_pdfform.h:145
void SetMKNormalIconBitmap(const common::Bitmap &bitmap)
Set a bitmap as normal icon in the MK dictionary.
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
Definition: fs_annot.h:3549
bool operator !=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:320
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1199
void RemoveAction()
Remove action.
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current stamp annotation, with a specified frame index.
void Rotate(common::Rotation rotation)
Rotate current annotation from current state with specified rotation value (in clockwise).
interform::Field GetField()
Get associated form field.
Definition: fs_pdfpage.h:411
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
void Rotate(int angle)
Rotate current annotation from current state with specified angle degree in clockwise.
LineSpacingStyle GetLineSpacing(float &line_spacing_value)
Get line spacing of current widget.
CFX_ByteString String
Byte string.
Definition: fs_basictypes.h:221
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Border style: Underline.
Definition: fs_annot.h:429
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:1141
Annotation flag: invisible.
Definition: fs_annot.h:1050
Header file for common definitions and classes.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
virtual ~Annot()
Destructor.
common::Bitmap GetBitmap()
Get the bitmap from current screen annotation.
bool GetOpenStatus() const
Get open status.
Annotation type: trap network annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1025
float text_size
Text size. It should not be negative value. 0 means text will not be shown.
Definition: fs_annot.h:369
String GetCompressionFormat() const
Get the name of the sound compression format used on the sample data.
common::Alignment GetAlignment() const
Get alignment value.
Line spacing style: single line spacing.
Definition: fs_annot.h:5032
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Constructor, with parameters.
Definition: fs_annot.h:647
Matrix GetTextMatrix() const
Get matrix in default appearance data for text in current free text annotation.
Definition: fs_annot.h:1800
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
PointF GetStartPoint() const
Get the start point.
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
Line spacing style: double line spacing.
Definition: fs_annot.h:5036
interform::Control GetControl()
Get associated form control.
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
void SetMKRolloverCaption(const wchar_t *caption)
Set the rollover caption string in the MK dictionary.
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current screen annotation, with a specified frame index.
Definition: fx_coordinates.h:596
common::Bitmap GetMKRolloverIconBitmap()
Get the rollover icon bitmap in the MK dictionary.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Annotation type: polyline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:992
Ink()
Constructor.
Definition: fs_annot.h:3971
Caption overlaid directly on the icon.
Definition: fs_annot.h:1238
int GetIndex() const
Get the index of current annotation in the page which current annotation belongs to.
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:75
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:730
float text_size
Text size for default appearance.
Definition: fs_annot.h:192
Definition: fs_annot.h:3233
void SetCalloutLinePoints(const PointFArray &point_array)
Set points for callout line.
Header file for PDF object related definitions and classes.
bool is_underline
A boolean value which indicates whether to underline text or not.
Definition: fs_annot.h:390
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1133
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:194
FileSpec GetFileSpec() const
Get the file specification object which represents an external sound file.
Definition: fs_basictypes.h:407
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1023
TextMarkup()
Constructor.
Definition: fs_annot.h:2583
void SetMKDownIconImage(const common::Image &image, int frame_index)
Set an image with specified frame index as down icon in the MK dictionary.
Highlighting mode: No highlighting.
Definition: fs_annot.h:1125
Caption to the right of the icon.
Definition: fs_annot.h:1234
void SetOverlayTextAlignment(common::Alignment alignment)
Set alignment value of overlay text.
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
String GetIconName() const
Get icon name.
bool operator==(const Annot &other) const
Equal operator.
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
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:1733
WString GetMKRolloverCaption() const
Get the rollover caption string in the MK dictionary.
Definition: fs_filespec.h:38
DefaultAppearance & operator=(const DefaultAppearance &default_appearance)
Assign operator.
Definition: fs_annot.h:112
void SetOpacity(float opacity)
Set opacity value.
PointF first
First point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:726
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1123
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
FileAttachment()
Constructor.
Definition: fs_annot.h:4854
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:994
void SetOpenStatus(bool status)
Set open status.
String GetMeasureRatio()
Get the scale ratio string for measuring.
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
A-law-encoded samples.
Definition: fs_annot.h:5816
~BorderInfo()
Destructor.
Definition: fs_annot.h:487
Definition: fs_annot.h:964
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
QuadPoints(const QuadPoints &quad_points)
Constructor, with another quadrilateral points object.
Definition: fs_annot.h:662
bool RemoveProperty(Property property)
Remove a specified annotation's property.
objects::PDFDictionary * GetDict() const
Get annotation's dictionary object.
Polygon()
Constructor.
Definition: fs_annot.h:4399
Annotation type: sound annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1012
bool operator !=(const Annot &other) const
Not equal operator.
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1000
Definition: fs_common.h:1334
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
void SetStartPoint(const PointF &point)
Set the start point.
Definition: fs_pdfobject.h:800
WString GetOverlayText() const
Get the overlay text.
bool SetFileSpec(const FileSpec &file_spec)
Set a file specification, which should specify an embedded file.
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
Icon fit information entry. "IF" in MK dictionary.
Definition: fs_annot.h:1209
PSInk()
Constructor.
Definition: fs_annot.h:4996
Corner mark style: none.
Definition: fs_annot.h:211
Foxit namespace.
Definition: fs_taggedpdf.h:27
Left alignment.
Definition: fs_common.h:77
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:1720
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:996
Definition: fs_annot.h:1804
~PSInk()
Destructor.
Definition: fs_annot.h:5006
Definition: fs_action.h:418
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:198
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1170
void SetMKDownCaption(const wchar_t *caption)
Set the down caption string in the MK dictionary.
BYTE STRING CLASS.
Definition: fx_string.h:317
WString GetMKDownCaption() const
Get the down caption string in the MK dictionary.
float GetLeaderLineLength() const
Get the length of leader line.
common::Alignment GetOverlayTextAlignment() const
Get alignment value of overlay text.
Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:984
Squiggly()
Constructor.
Definition: fs_annot.h:2739
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:127
Border style: Cloudy.
Definition: fs_annot.h:450
void SetMKBackgroundColor(RGB color)
Set the background color in the MK dictionary.
void RemoveMKEntry(MKEntry mk_entry)
Remove a specified entry from the MK dictionary.
bool operator !=(const DefaultAppearance &default_appearance) const
Not equal operator.
Definition: fs_annot.h:140
void SetMKRotation(common::Rotation rotation)
Set the rotation value in the MK dictionary.
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
AppearanceType
Enumeration for the type of annotation's appearance.
Definition: fs_annot.h:1246
Indicates property font of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:60
float dash_phase
Dash phase.
Definition: fs_annot.h:616
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
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
int GetBits() const
Get the number of bits per sample value per channel.
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
CapPos GetCaptionPositionType() const
Get the position type of caption.
Annotation type: caret annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1004
~Square()
Destructor.
Definition: fs_annot.h:2889
String GetMeasureRatio()
Get the scale ratio string for measuring.
Definition: fs_annot.h:4920
void SetModifiedDateTime(const DateTime &date_time)
Set last modified date time.
Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1029
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Border style: Inset.
Definition: fs_annot.h:443
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
bool is_strikethrough
A boolean value which indicates whether to cross text out with strike through or not.
Definition: fs_annot.h:394
No icon; captin only.
Definition: fs_annot.h:1226
void SetBorderInfo(const BorderInfo &border)
Set border information.
CornerMarkStyle
Enumeration for corner mark style.
Definition: fs_annot.h:209
~Circle()
Destructor.
Definition: fs_annot.h:3061
void SetApplyFillColor(RGB fill_color)
Set the filling color which is used for rollover appearance and will be used after redaction is appli...
EndingStyle GetCalloutLineEndingStyle() const
Get line ending style of the start point in a callout line.
Definition: fs_annot.h:4578
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
BorderInfo()
Constructor.
Definition: fs_annot.h:480
RectF GetInnerRect() const
Get the inner rectangle.
void SetLineStartStyle(EndingStyle ending_style)
Set line ending style of the start point.
Annotation type: watermark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1027
String GetIconName() const
Get icon name.
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
void SetUniqueID(const WString &unique_id)
Set unique ID.
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
Definition: fx_coordinates.h:1076
PointFArray GetVertexes()
Get vertexes.
SampleEncodingFormat
Enumeration for encoding format of sound sample data.
Definition: fs_annot.h:5808
void Set(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Set value.
Definition: fs_annot.h:163
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
Definition: fs_annot.h:3538
RGB GetFillColor() const
Get fill color.
void SetRotation(int angle)
Set rotation angle (in clockwise).
~FileAttachment()
Destructor.
Definition: fs_annot.h:4862
LineSpacingStyle
Enumeration for line spacing style.
Definition: fs_annot.h:5030
void SetLeaderLineExtensionLength(float extension_length)
Set the length of leader line extension.
bool is_bold
A boolean value which indicates whether to make text bold or not.
Definition: fs_annot.h:382
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
Definition: fs_annot.h:637
RGB GetBorderColor() const
Get border color.
Definition: fs_annot.h:2736
String GetIconName() const
Get icon name.
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
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
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:1777
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:1790
Line spacing style: one and half times line spacing.
Definition: fs_annot.h:5034
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:988
WString GetTitle() const
Get title of current screen annotation.
Caption to the left of the icon.
Definition: fs_annot.h:1236
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:3545
Indicates property text size of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:64
Note()
Constructor.
Definition: fs_annot.h:2428
Stamp()
Constructor.
Definition: fs_annot.h:4084
ShadingColor()
Constructor.
Definition: fs_annot.h:1605
virtual String GetProviderID()
A callback function used to get provider ID.
Definition: fs_annot.h:1697
~Markup()
Destructor.
Definition: fs_annot.h:1955
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
Definition: fs_annot.h:2646
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1179
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1189
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2591
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:1174
void RemoveAction()
Remove action.
void SetMKDownIconBitmap(const common::Bitmap &bitmap)
Set the down icon bitmap in the MK dictionary.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
RectF GetRect() const
Get rectangle, in PDF coordinate system.
QuadPoints()
Constructor.
Definition: fs_annot.h:655
Annotation flag: locked contents.
Definition: fs_annot.h:1115
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1002
Definition: fs_image.h:445
Annotation flag: hidden.
Definition: fs_annot.h:1056
Definition: fs_annot.h:5801
Line spacing style: exact value line spacing.
Definition: fs_annot.h:5038
Border style: Dashed.
Definition: fs_annot.h:423
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:281
void SetState(State state)
Set the state.
void SetStyleFillColor(RGB color)
Set fill color for ending styles.
bool ResetAppearanceStream()
Reset appearance stream.
Definition: fx_coordinates.h:771
void SetLeaderLineOffset(float offset)
Set the length of leader line offset.
Highlighting mode: Push, which is to display the annotation's down appearance, if any.
Definition: fs_annot.h:1131
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_annot.h:471