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 class PagingSealSignature;
37 namespace actions {
38 class Action;
39 } // namespace actions
40 namespace annots {
41 class Note;
42 class Popup;
43 } // namespace annots
44 namespace interform {
45 class Field;
46 class Control;
47 } // namespace interform
48 
52 class DefaultAppearance FS_FINAL : public Object {
53  public:
59  typedef enum _DefAPFlags {
61  e_FlagFont = 0x0001,
63  e_FlagTextColor = 0x0002,
65  e_FlagFontSize = 0x0004
66  } DefAPFlags;
67 
68 
84  : flags(flags)
85  , font(font)
88 
91  : flags(0)
92  , text_size(0)
93  , text_color(0x000000) {}
94 
100  DefaultAppearance(const DefaultAppearance& default_appearance)
101  : flags(default_appearance.flags)
102  , font(default_appearance.font)
103  , text_size(default_appearance.text_size)
104  , text_color(default_appearance.text_color) {}
105 
113  DefaultAppearance& operator = (const DefaultAppearance& default_appearance) {
114  flags = default_appearance.flags;
115  font = default_appearance.font;
116  text_size = default_appearance.text_size;
117  text_color = default_appearance.text_color;
118  return *this;
119  }
120 
128  bool operator == (const DefaultAppearance& default_appearance) const {
129  return (flags == default_appearance.flags && font == default_appearance.font &&
130  fabs(text_size-default_appearance.text_size) <= FLT_EPSILON &&
131  text_color == default_appearance.text_color);
132  }
133 
141  bool operator != (const DefaultAppearance& default_appearance) const {
142  return (flags != default_appearance.flags || font != default_appearance.font ||
143  fabs(text_size - default_appearance.text_size) > FLT_EPSILON ||
144  text_color != default_appearance.text_color);
145  }
146 
165  this->flags = flags;
166  this->font = font;
167  this->text_size = text_size;
168  this->text_color = text_color;
169  }
170 
193  float text_size;
200 };
201 
203 class RichTextStyle FS_FINAL : public Object{
204  public:
210  typedef enum _CornerMarkStyle {
217  } CornerMarkStyle;
218 
219 
238  : font(font)
242  , is_bold(is_bold)
246  , mark_style(mark_style) {}
247 
250  : text_size(0)
252  , text_color(0x000000)
253  , is_bold(false)
254  , is_italic(false)
255  , is_underline(false)
256  , is_strikethrough(false)
258 
265  : font(style.font)
266  , text_size(style.text_size)
268  , text_color(style.text_color)
269  , is_bold(style.is_bold)
270  , is_italic(style.is_italic)
271  , is_underline(style.is_underline)
273  , mark_style(style.mark_style) {}
274 
283  font = style.font;
284  text_size = style.text_size;
286  text_color = style.text_color;
287  is_bold = style.is_bold;
288  is_italic = style.is_italic;
289  is_underline = style.is_underline;
291  mark_style = style.mark_style;
292  return *this;
293  }
294 
302  bool operator == (const RichTextStyle& style) const {
303  return (font == style.font &&
304  fabs(text_size- style.text_size) <= FLT_EPSILON &&
305  text_alignment == style.text_alignment &&
306  text_color == style.text_color &&
307  is_bold == style.is_bold &&
308  is_italic == style.is_italic &&
309  is_underline == style.is_underline &&
311  mark_style == style.mark_style);
312  }
313 
321  bool operator != (const RichTextStyle& style) const {
322  return !((*this) == style);
323  }
324 
345  this->font = font;
346  this->text_size = text_size;
347  this->text_alignment = text_alignment;
348  this->text_color = text_color;
349  this->is_bold = is_bold;
350  this->is_italic = is_italic;
351  this->is_underline = is_underline;
352  this->is_strikethrough = is_strikethrough;
353  this->mark_style = mark_style;
354  }
355 
370  float text_size;
383  bool is_bold;
387  bool is_italic;
401 };
402 
406 namespace annots {
408 class BorderInfo FS_FINAL : public Object {
409  public:
415  typedef enum _Style {
417  e_Solid = 0,
424  e_Dashed = 1,
444  e_Inset = 4,
452  } Style;
453 
454 
472  BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
473  this->width = width;
474  this->style = style;
475  this->cloud_intensity = intensity;
476  this->dash_phase = dash_phase;
477  this->dashes = dashes;
478  }
479 
482  : width(1.0f)
484  , cloud_intensity(0)
485  , dash_phase(0) {}
486 
489 
495  BorderInfo(const BorderInfo& border_info) {
496  this->width = border_info.width;
497  this->style = border_info.style;
498  this->cloud_intensity = border_info.cloud_intensity;
499  this->dash_phase = border_info.dash_phase;
500  this->dashes = border_info.dashes;
501  }
502 
510  BorderInfo& operator = (const BorderInfo& border_info) {
511  this->width = border_info.width;
512  this->style = border_info.style;
513  this->cloud_intensity = border_info.cloud_intensity;
514  this->dash_phase = border_info.dash_phase;
515  this->dashes = border_info.dashes;
516  return *this;
517  }
518 
526  bool operator == (const BorderInfo& border_info) const {
527  if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
528  fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
529  fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
530  dashes.GetSize() != border_info.dashes.GetSize())
531  return false;
532  for (int i=0; i<dashes.GetSize(); i++) {
533  if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
534  return false;
535  }
536  return true;
537  }
538 
546  bool operator != (const BorderInfo& border_info) const{
547  if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
548  fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
549  fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
550  dashes.GetSize() != border_info.dashes.GetSize())
551  return true;
552  for (int i=0; i<dashes.GetSize(); i++) {
553  if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
554  return true;
555  }
556  return false;
557  }
558 
578  void Set(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
579  this->width = width;
580  this->style = style;
581  this->cloud_intensity = intensity;
582  this->dash_phase = dash_phase;
583  this->dashes = dashes;
584  }
585 
591  float width;
592 
598 
611 
617  float dash_phase;
618 
626 };
627 
638 class QuadPoints FS_FINAL : public Object {
639  public:
648  QuadPoints(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
649  this->first = first;
650  this->second = second;
651  this->third = third;
652  this->fourth = fourth;
653  }
654 
657 
663  QuadPoints(const QuadPoints& quad_points) {
664  first = quad_points.first;
665  second = quad_points.second;
666  third = quad_points.third;
667  fourth = quad_points.fourth;
668  }
669 
677  QuadPoints& operator = (const QuadPoints& quad_points) {
678  first = quad_points.first;
679  second = quad_points.second;
680  third = quad_points.third;
681  fourth = quad_points.fourth;
682  return *this;
683  }
684 
692  bool operator == (const QuadPoints& quad_points) const {
693  return (first == quad_points.first && second == quad_points.second &&
694  third == quad_points.third && fourth == quad_points.fourth);
695  }
696 
704  bool operator != (const QuadPoints& quad_points) const {
705  return (first != quad_points.first || second != quad_points.second ||
706  third != quad_points.third || fourth != quad_points.fourth);
707  }
708 
719  void Set(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
720  this->first = first;
721  this->second = second;
722  this->third = third;
723  this->fourth = fourth;
724  }
725 
734 };
735 
737 FSDK_DEFINE_ARRAY(QuadPointsArray, QuadPoints)
738 
739 
743 class IconFit FS_FINAL : public Object {
744  public:
749  typedef enum _ScaleWayType {
751  e_ScaleWayNone = 0,
753  e_ScaleWayAlways = 1,
755  e_ScaleWayBigger = 2,
757  e_ScaleWaySmaller = 3,
759  e_ScaleWayNever = 4
760  } ScaleWayType;
761 
762 
765  : scale_way_type(e_ScaleWayNone)
766  , is_proportional_scaling(false)
767  , horizontal_fraction(0)
768  , vertical_fraction(0)
769  , fit_bounds(false) {}
770 
795  IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
796  float vertical_fraction, bool fit_bounds)
797  : scale_way_type(type)
798  , is_proportional_scaling(is_proportional_scaling)
799  , horizontal_fraction(horizontal_fraction)
800  , vertical_fraction(vertical_fraction)
801  , fit_bounds(fit_bounds) {}
802 
808  IconFit(const IconFit& icon_fit)
809  : scale_way_type(icon_fit.scale_way_type)
810  , is_proportional_scaling(icon_fit.is_proportional_scaling)
811  , horizontal_fraction(icon_fit.horizontal_fraction)
812  , vertical_fraction(icon_fit.vertical_fraction)
813  , fit_bounds(icon_fit.fit_bounds) {}
814 
822  IconFit& operator = (const IconFit& icon_fit) {
823  scale_way_type = icon_fit.scale_way_type;
824  is_proportional_scaling = icon_fit.is_proportional_scaling;
825  horizontal_fraction = icon_fit.horizontal_fraction;
826  vertical_fraction = icon_fit.vertical_fraction;
827  fit_bounds = icon_fit.fit_bounds;
828  return *this;
829  }
830 
838  bool operator == (const IconFit& icon_fit) const {
839  return (scale_way_type == icon_fit.scale_way_type &&
840  is_proportional_scaling == icon_fit.is_proportional_scaling &&
841  fabs(horizontal_fraction - icon_fit.horizontal_fraction) <= FLT_EPSILON &&
842  fabs(vertical_fraction - icon_fit.vertical_fraction) <= FLT_EPSILON &&
843  fit_bounds == icon_fit.fit_bounds);
844  }
845 
853  bool operator != (const IconFit& icon_fit) const {
854  return (scale_way_type != icon_fit.scale_way_type ||
855  is_proportional_scaling != icon_fit.is_proportional_scaling ||
856  fabs(horizontal_fraction - icon_fit.horizontal_fraction) > FLT_EPSILON ||
857  fabs(vertical_fraction - icon_fit.vertical_fraction) > FLT_EPSILON ||
858  fit_bounds != icon_fit.fit_bounds);
859  }
860 
888  void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
889  float vertical_fraction, bool fit_bounds) {
890  this->scale_way_type = type;
891  this->is_proportional_scaling = is_proportional_scaling;
892  this->horizontal_fraction = horizontal_fraction;
893  this->vertical_fraction = vertical_fraction;
894  this->fit_bounds = fit_bounds;
895  }
896 
931 };
932 
965 class Annot : public Base {
966  public:
972  typedef enum _Type {
979  e_Note = 1,
981  e_Link = 2,
985  e_Line = 4,
987  e_Square = 5,
989  e_Circle = 6,
1003  e_Stamp = 13,
1005  e_Caret = 14,
1007  e_Ink = 15,
1009  e_PSInk = 16,
1013  e_Sound = 18,
1015  e_Movie = 19,
1020  e_Widget = 20,
1022  e_Screen = 21,
1030  e_3D = 25,
1032  e_Popup = 26,
1034  e_Redact = 27,
1039  } Type;
1040 
1046  typedef enum _Flags {
1059  e_FlagHidden = 0x0002,
1067  e_FlagPrint = 0x0004,
1074  e_FlagNoZoom = 0x0008,
1081  e_FlagNoRotate = 0x0010,
1089  e_FlagNoView = 0x0020,
1098  e_FlagReadOnly = 0x0040,
1105  e_FlagLocked = 0x0080,
1119  } Flags;
1120 
1126  typedef enum _HighlightingMode {
1137  } HighlightingMode;
1138 
1144  typedef enum _Property {
1164  } Property;
1165 
1171  typedef enum _MKEntry {
1220  } MKEntry;
1221 
1227  typedef enum _MKIconCaptionRelation {
1243 
1249  typedef enum _AppearanceType {
1256  } AppearanceType;
1257 
1258 
1259  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1260  explicit Annot(FS_HANDLE handle);
1268  Annot(const PDFPage& page, objects::PDFDictionary* annot_dict);
1269 #ifndef __EMSCRIPTEN_RENDER__
1270 
1275  Annot(const Annot& annot);
1276 #endif
1277 
1278  Annot() {}
1279 #ifndef __EMSCRIPTEN_RENDER__
1280 
1287  Annot& operator = (const Annot& annot);
1288 #endif
1289 
1296  bool operator ==(const Annot& other) const;
1304  bool operator != (const Annot& other) const;
1305 #ifndef __EMSCRIPTEN_RENDER__
1306 
1307  virtual ~Annot();
1308 #endif
1309 
1316  bool IsEmpty() const;
1317 
1323  PDFPage GetPage() const;
1330  bool IsMarkup() const;
1336  Type GetType() const;
1342  int GetIndex() const;
1348  WString GetContent() const;
1362  void SetContent(const WString& content);
1369  DateTime GetModifiedDateTime() const;
1377  void SetModifiedDateTime(const DateTime& date_time);
1384  uint32 GetFlags() const;
1393  void SetFlags(uint32 flags);
1399  WString GetUniqueID() const;
1407  void SetUniqueID(const WString& unique_id);
1414  RectF GetRect() const;
1415 
1428  Matrix GetDisplayMatrix(const Matrix& page_display_matrix);
1429 
1439  bool Move(const RectF& rect);
1440 
1451  bool Move(const RectF& rect, bool is_reset_appearance);
1452 
1469  BorderInfo GetBorderInfo() const;
1470 
1488  void SetBorderInfo(const BorderInfo& border);
1497  RGB GetBorderColor() const;
1509  void SetBorderColor(RGB color);
1522  bool ResetAppearanceStream();
1523 
1541  bool ResetAppearanceStream(bool is_generate_new_appearance_obj);
1542 
1558  RectI GetDeviceRect(const Matrix& matrix);
1559 
1566 
1576  bool HasProperty(Property property) const;
1577 
1595  bool RemoveProperty(Property property);
1596 
1604 
1621  objects::PDFStream* GetAppearanceStream(AppearanceType type, const char* appearance_state = "") const;
1622 };
1623 
1625 FSDK_DEFINE_ARRAY(AnnotArray, Annot)
1626 
1627 
1628 class ShadingColor FS_FINAL : public Object {
1629  public:
1636  ShadingColor(ARGB firstcolor, ARGB secondcolor)
1637  : first_color(firstcolor)
1638  , second_color(secondcolor) {}
1639 
1642  : first_color(0xFFFFFFFF)
1643  , second_color(0xFFFFFFFF) {}
1644 
1650  ShadingColor(const ShadingColor& shading_color)
1651  : first_color(shading_color.first_color)
1652  , second_color(shading_color.second_color) {}
1653 
1661  ShadingColor& operator = (const ShadingColor& shading_color) {
1662  this->first_color = shading_color.first_color;
1663  this->second_color = shading_color.second_color;
1664  return *this;
1665  }
1666 
1674  bool operator == (const ShadingColor& shading_color) const {
1675  return (first_color == shading_color.first_color && second_color == shading_color.second_color);
1676  }
1677 
1685  bool operator != (const ShadingColor& shading_color) const {
1686  return (first_color != shading_color.first_color || second_color != shading_color.second_color);
1687  }
1688 
1697  void Set(ARGB firstcolor, ARGB secondcolor) {
1698  this->first_color = firstcolor;
1699  this->second_color = secondcolor;
1700  }
1701 
1706 };
1707 
1718  public:
1724  virtual void Release() = 0;
1733  virtual String GetProviderID() {
1734  return String();
1735  }
1745  return String();
1746  }
1756  virtual bool HasIcon(Annot::Type annot_type, const char* icon_name) {
1757  return false;
1758  }
1769  virtual bool CanChangeColor(Annot::Type annot_type, const char* icon_name) {
1770  return false;
1771  }
1772 #ifndef __EMSCRIPTEN_RENDER__
1773 
1783  virtual PDFPage GetIcon(Annot::Type annot_type, const char* icon_name, ARGB color);
1784 #endif
1785 
1799  virtual bool GetShadingColor(Annot::Type annot_type, const char* icon_name,
1800  RGB referenced_color, int shading_index, ShadingColor& out_shading_color) {
1801  return false;
1802  }
1813  virtual float GetDisplayWidth(Annot::Type annot_type, const char* icon_name) {
1814  return 0.0f;
1815  }
1826  virtual float GetDisplayHeight(Annot::Type annot_type, const char* icon_name) {
1827  return 0.0f;
1828  }
1829 
1830  protected:
1831  ~IconProviderCallback() {}
1832 };
1833 
1834 class Markup;
1836 FSDK_DEFINE_ARRAY(MarkupArray, Markup)
1837 
1838 class Note;
1840 FSDK_DEFINE_ARRAY(NoteArray, Note)
1841 
1842 
1859 class Markup : public Annot {
1860  public:
1866  typedef enum _StateModel {
1868  e_StateModelMarked = 1,
1870  e_StateModelReview = 2
1871  } StateModel;
1872 
1878  typedef enum _State {
1883  e_StateNone = 0,
1888  e_StateMarked = 1,
1893  e_StateUnmarked = 2,
1898  e_StateAccepted = 3,
1903  e_StateRejected = 4,
1908  e_StateCancelled = 5,
1913  e_StateCompleted = 6,
1918  e_StateDeferred = 7,
1923  e_StateFuture = 8
1924  } State;
1925 
1931  typedef enum _EndingStyle {
1933  e_EndingStyleNone = 0,
1935  e_EndingStyleSquare = 1,
1937  e_EndingStyleCircle = 2,
1939  e_EndingStyleDiamond = 3,
1941  e_EndingStyleOpenArrow = 4,
1947  e_EndingStyleClosedArrow = 5,
1949  e_EndingStyleButt = 6,
1951  e_EndingStyleROpenArrow = 7,
1953  e_EndingStyleRClosedArrow = 8,
1955  e_EndingStyleSlash = 9
1956  } EndingStyle;
1957 
1963  typedef enum _MeasureType {
1965  e_MeasureTypeX = 0,
1967  e_MeasureTypeY = 1,
1969  e_MeasureTypeD = 2,
1971  e_MeasureTypeA = 3,
1973  e_MeasureTypeT = 4,
1975  e_MeasureTypeS = 5
1976  } MeasureType;
1977 
1978 
1984  explicit Markup(const Annot& annot);
1985  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1986  explicit Markup(FS_HANDLE handle);
1988  Markup() {}
1989 
1991  ~Markup() {}
1992 
2010  Popup GetPopup();
2027  void SetPopup(const Popup& popup);
2028 
2035  bool RemovePopup();
2036 
2044  WString GetTitle() const;
2045 
2055  void SetTitle(const WString& title);
2056 
2062  WString GetSubject() const;
2063 
2071  void SetSubject(const WString& subject);
2072 
2081  float GetOpacity() const;
2082 
2095  void SetOpacity(float opacity);
2096 
2118  String GetIntent() const;
2119 
2155  void SetIntent(const String& intent);
2156 
2163  DateTime GetCreationDateTime() const;
2164 
2172  void SetCreationDateTime(const DateTime& date_time);
2173 
2179  int GetReplyCount();
2180 
2189  Note GetReply(int index) const;
2190 
2196  Note AddReply();
2197 
2208  bool RemoveReply(int index);
2209 
2215  bool RemoveAllReplies();
2216 
2233  bool IsGrouped();
2234 
2253  Markup GetGroupHeader();
2254 
2271  MarkupArray GetGroupElements();
2272 
2288  bool Ungroup();
2289 
2305  NoteArray GetStateAnnots(StateModel model);
2306 
2343  Note AddStateAnnot(const WString& title, StateModel model, State state);
2344 
2354  bool RemoveAllStateAnnots();
2362  int32 GetRichTextCount();
2363 
2374  WString GetRichTextContent(int32 index);
2375 
2387  void SetRichTextContent(int32 index, const WString& content);
2388 
2399  RichTextStyle GetRichTextStyle(int32 index);
2400 
2414  void SetRichTextStyle(int32 index, const RichTextStyle& style);
2415 
2428  void AddRichText(const WString& content, const RichTextStyle& style);
2429 
2446  void InsertRichText(int32 index, const WString& content, const RichTextStyle& style);
2447 
2458  void RemoveRichText(int index);
2459 };
2460 
2483 class Note FS_FINAL : public Markup {
2484  public:
2486  Note() {}
2492  explicit Note(const Annot& annot);
2493  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2494  explicit Note(FS_HANDLE handle);
2496  ~Note() {}
2497 
2510  bool GetOpenStatus() const;
2525  void SetOpenStatus(bool status);
2537  String GetIconName() const;
2555  void SetIconName(const char* icon_name);
2565  Markup GetReplyTo();
2572  bool IsStateAnnot();
2573 
2586 
2598  State GetState();
2599 
2623  void SetState(State state);
2624 
2625 };
2626 
2638 class TextMarkup: public Markup {
2639  public:
2647  explicit TextMarkup(const Annot& annot);
2650 
2685  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2686 };
2687 
2704 class Highlight FS_FINAL : public TextMarkup {
2705  public:
2713  explicit Highlight(const Annot& annot);
2716 };
2717 
2734 class Underline FS_FINAL : public TextMarkup {
2735  public:
2743  explicit Underline(const Annot& annot);
2746 };
2747 
2764 class StrikeOut FS_FINAL : public TextMarkup {
2765  public:
2773  explicit StrikeOut(const Annot& annot);
2776 };
2777 
2794 class Squiggly FS_FINAL : public TextMarkup {
2795  public:
2803  explicit Squiggly(const Annot& annot);
2806 };
2807 
2821 class Link FS_FINAL : public Annot {
2822  public:
2824  Link() {}
2830  explicit Link(const Annot& annot);
2831  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2832  explicit Link(FS_HANDLE handle);
2834  ~Link() {}
2835 
2868  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2869 
2878 
2889 
2897 
2912  void SetAction(const actions::Action& action);
2913 
2919  bool RemoveAction();
2920 
2926  bool ExecuteJavaScriptAction();
2927 };
2928 
2943 class Square FS_FINAL : public Markup {
2944  public:
2946  Square() {}
2952  explicit Square(const Annot& annot);
2954  ~Square() {}
2955 
2962  RGB GetFillColor() const;
2963 
2971  void SetFillColor(RGB fill_color);
2972 
2982  RectF GetInnerRect() const;
2994  void SetInnerRect(const RectF& inner_rect);
2995 
3009  void SetMeasureRatio(const char* ratio);
3010 
3021 
3032 
3045  void SetMeasureUnit(MeasureType measure_type, const char* unit);
3046 
3058  String GetMeasureUnit(MeasureType measure_type);
3059 
3071  WString GetMeasureUnitW(MeasureType measure_type);
3072 
3085  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3086 
3098  float GetMeasureConversionFactor(MeasureType measure_type);
3099 };
3100 
3115 class Circle FS_FINAL : public Markup {
3116  public:
3118  Circle() {}
3124  explicit Circle(const Annot& annot);
3126  ~Circle() {}
3127 
3134  RGB GetFillColor() const;
3135 
3146  void SetFillColor(RGB fill_color);
3147 
3157  RectF GetInnerRect() const;
3158 
3172  void SetInnerRect(const RectF& inner_rect);
3173 
3187  void SetMeasureRatio(const char* ratio);
3188 
3199 
3210 
3223  void SetMeasureUnit(MeasureType measure_type, const char* unit);
3224 
3236  String GetMeasureUnit(MeasureType measure_type);
3237 
3249  WString GetMeasureUnitW(MeasureType measure_type);
3250 
3263  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3264 
3276  float GetMeasureConversionFactor(MeasureType measure_type);
3277 };
3278 
3298 class FreeText FS_FINAL : public Markup {
3299  public:
3307  explicit FreeText(const Annot& annot);
3308 
3311 
3322  RGB GetFillColor() const;
3323 
3337  void SetFillColor(RGB fill_color);
3338 
3354 
3373  void SetAlignment(common::Alignment alignment);
3374 
3385  RectF GetInnerRect() const;
3386 
3401  void SetInnerRect(const RectF& inner_rect);
3402 
3412 
3435  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
3436 
3448 
3463  void SetCalloutLineEndingStyle(EndingStyle ending_style);
3464 
3479 
3502  void SetCalloutLinePoints(const PointFArray& point_array);
3503 
3519  void SetTextMatrix(const Matrix& text_matrix);
3520 
3532  Matrix GetTextMatrix() const;
3533 
3541 
3556  void SetRotation(common::Rotation rotation);
3557 
3570  void Rotate(common::Rotation rotation);
3571 
3589  void AllowTextOverflow(bool is_text_overflow);
3590 };
3591 
3610 class Line FS_FINAL : public Markup {
3611  public:
3617  typedef enum _CapPos {
3622  } CapPos;
3623 
3624 
3626  Line() {}
3632  explicit Line(const Annot& annot);
3634  ~Line() {}
3635 
3657  void SetLineStartStyle(EndingStyle ending_style);
3666  EndingStyle GetLineEndStyle() const;
3679  void SetLineEndStyle(EndingStyle ending_style);
3680 
3691  RGB GetStyleFillColor() const;
3692 
3706  void SetStyleFillColor(RGB color);
3707 
3716  PointF GetStartPoint() const;
3729  void SetStartPoint(const PointF& point);
3730 
3739  PointF GetEndPoint() const;
3752  void SetEndPoint(const PointF& point);
3753 
3762  bool HasCaption() const;
3775  void EnableCaption(bool cap);
3776 
3804  void SetCaptionPositionType(CapPos cap_position);
3817  Offset GetCaptionOffset() const;
3833  void SetCaptionOffset(const Offset& offset);
3834 
3849  float GetLeaderLineLength() const;
3867  void SetLeaderLineLength(float length);
3877  float GetLeaderLineExtensionLength() const;
3890  void SetLeaderLineExtensionLength(float extension_length);
3891 
3902  float GetLeaderLineOffset() const;
3916  void SetLeaderLineOffset(float offset);
3917 
3931  void SetMeasureRatio(const String& ratio);
3932 
3943 
3954 
3967  void SetMeasureUnit(MeasureType measure_type, const String& unit);
3968 
3980  String GetMeasureUnit(MeasureType measure_type);
3981 
3993  WString GetMeasureUnitW(MeasureType measure_type);
3994 
4007  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4008 
4020  float GetMeasureConversionFactor(MeasureType measure_type);
4021 };
4022 
4040 class Ink FS_FINAL : public Markup {
4041  public:
4043  Ink() {}
4049  explicit Ink(const Annot& annot);
4051  ~Ink() {}
4079 
4112  void SetInkList(const common::Path& ink_list);
4113 
4125  void EnableUseBezier(bool use_bezier);
4126 
4127 };
4128 
4153 class Stamp FS_FINAL : public Markup {
4154  public:
4156  Stamp() {}
4162  explicit Stamp(const Annot& annot);
4163 #ifndef __EMSCRIPTEN_RENDER__
4164 
4165  ~Stamp();
4166 #endif
4167 
4178  String GetIconName() const;
4201  void SetIconName(const char* icon_name);
4212  void SetBitmap(const common::Bitmap& bitmap);
4213 
4236  void SetImage(const common::Image& image, int frame_index, int compress);
4237 
4248  void SetRotation(int angle);
4249 
4255  int GetRotation();
4256 
4266  void Rotate(int angle);
4267 };
4268 
4281 class Screen FS_FINAL : public Annot {
4282  public:
4284  Screen() {}
4290  explicit Screen(const Annot& annot);
4292  virtual ~Screen() {}
4293 
4316  void SetImage(const common::Image& image, int frame_index, int compress);
4317 
4325 
4337 
4345 
4358  void SetRotation(common::Rotation rotate);
4359 
4367 
4376  float GetOpacity() const;
4389  void SetOpacity(float opacity);
4390 
4396  WString GetTitle() const;
4404  void SetTitle(const WString& title);
4405 
4439  void SetAction(const actions::Action& action);
4448  void RemoveAction();
4449 };
4450 
4469 class Polygon FS_FINAL : public Markup {
4470  public:
4472  Polygon() {}
4478  explicit Polygon(const Annot& annot);
4489  RGB GetFillColor() const;
4490 
4502  void SetFillColor(RGB fill_color);
4503 
4513 
4525  void SetVertexes(const PointFArray& vertexes);
4526 
4540  void SetMeasureRatio(const String& ratio);
4541 
4552 
4563 
4576  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4577 
4589  String GetMeasureUnit(MeasureType measure_type);
4590 
4602  WString GetMeasureUnitW(MeasureType measure_type);
4603 
4616  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4617 
4629  float GetMeasureConversionFactor(MeasureType measure_type);
4630 };
4631 
4651 class PolyLine FS_FINAL : public Markup {
4652  public:
4660  explicit PolyLine(const Annot& annot);
4673  RGB GetStyleFillColor() const;
4685  void SetStyleFillColor(RGB fill_color);
4686 
4696 
4708  void SetVertexes(const PointFArray& vertexes);
4731  void SetLineStartStyle(EndingStyle starting_style);
4740  EndingStyle GetLineEndStyle() const;
4754  void SetLineEndStyle(EndingStyle ending_style);
4755 
4769  void SetMeasureRatio(const String& ratio);
4770 
4781 
4792 
4805  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4806 
4818  String GetMeasureUnit(MeasureType measure_type);
4819 
4831  WString GetMeasureUnitW(MeasureType measure_type);
4832 
4845  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4846 
4858  float GetMeasureConversionFactor(MeasureType measure_type);
4859 };
4860 
4873 class Caret FS_FINAL : public Markup {
4874  public:
4876  Caret() {}
4882  explicit Caret(const Annot& annot);
4884  ~Caret() {}
4885 
4895  RectF GetInnerRect() const;
4909  void SetInnerRect(const RectF& inner_rect);
4910 };
4911 
4924 class FileAttachment FS_FINAL : public Markup {
4925  public:
4933  explicit FileAttachment(const Annot& annot);
4936 
4944  bool SetFileSpec(const FileSpec& file_spec);
4945 
4953 
4964  String GetIconName() const;
4965 
4981  void SetIconName(const char* icon_name);
4982 };
4983 
4993 class Popup FS_FINAL : public Annot {
4994  public:
4996  Popup() {}
5002  explicit Popup(const Annot& annot);
5003  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5004  explicit Popup(FS_HANDLE handle);
5006  ~Popup() {}
5007 
5020  bool GetOpenStatus() const;
5035  void SetOpenStatus(bool status);
5036 
5044  Markup GetParent();
5045 };
5046 #ifndef __FSDK_NO_PSINK__
5047 
5066 class PSInk FS_FINAL : public Annot {
5067  public:
5069  PSInk() {}
5075  explicit PSInk(const Annot& annot);
5076  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5077  explicit PSInk(FS_HANDLE handle);
5079  ~PSInk() {}
5080 
5081 };
5082 #endif
5083 
5096 class Widget FS_FINAL : public Annot {
5097  public:
5103  typedef enum _LineSpacingStyle {
5114  } LineSpacingStyle;
5115 
5116 
5118  Widget() {}
5124  explicit Widget(const Annot& annot);
5125  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5126  explicit Widget(FS_HANDLE handle);
5127 #ifndef __EMSCRIPTEN_RENDER__
5128 
5129  ~Widget();
5130 #endif
5131 
5137 
5144 
5155 
5168 
5179 
5203  void SetAction(const actions::Action& action);
5204 
5213  void RemoveAction();
5214 
5226  bool HasMKEntry(MKEntry mk_entry);
5227 
5239  void RemoveMKEntry(MKEntry mk_entry);
5240 
5254 
5267  void SetMKRotation(common::Rotation rotation);
5268 
5279  RGB GetMKBorderColor() const;
5280 
5291  void SetMKBorderColor(RGB color);
5292 
5303  RGB GetMKBackgroundColor() const;
5304 
5315  void SetMKBackgroundColor(RGB color);
5316 
5330  WString GetMKNormalCaption() const;
5331 
5345  void SetMKNormalCaption(const wchar_t* caption);
5346 
5361  WString GetMKRolloverCaption() const;
5362 
5377  void SetMKRolloverCaption(const wchar_t* caption);
5378 
5392  WString GetMKDownCaption() const;
5393 
5407  void SetMKDownCaption(const wchar_t* caption);
5408 
5422 
5436  void SetMKNormalIconBitmap(const common::Bitmap& bitmap);
5437 
5453  void SetMKNormalIconImage(const common::Image& image, int frame_index);
5454 
5469 
5484  void SetMKRolloverIconBitmap(const common::Bitmap& bitmap);
5485 
5502  void SetMKRolloverIconImage(const common::Image& image, int frame_index);
5503 
5517 
5531  void SetMKDownIconBitmap(const common::Bitmap& bitmap);
5532 
5548  void SetMKDownIconImage(const common::Image& image, int frame_index);
5549 
5564  IconFit GetMKIconFit() const;
5565 
5583  void SetMKIconFit(const IconFit& icon_fit);
5584 
5599 
5616 
5624  void SetAppearanceState(const String& appearance_state);
5625 
5631  String GetAppearanceState() const;
5632 
5639 
5651  LineSpacingStyle GetLineSpacing(float& line_spacing_value);
5652 
5668  void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value);
5669 
5670 #ifdef _SUPPORTWEBSDK_
5671  //Set push button icon form icon stream. stream is from doc::createIcon.
5672  //face: 0: normal, 1: down, 2: roller
5673  void SetButtonIcon(objects::PDFStream* icon, int face);
5674 #endif
5675 };
5676 
5693 class Redact FS_FINAL : public Markup {
5694  public:
5696  Redact() {}
5702  explicit Redact(const Annot& annot);
5703  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5704  explicit Redact(FS_HANDLE handle);
5705 #ifndef __EMSCRIPTEN_RENDER__
5706 
5707  ~Redact();
5708 #endif
5709 
5723 
5742  void SetQuadPoints(const QuadPointsArray& quad_points_array);
5743 
5750  RGB GetFillColor() const;
5758  void SetFillColor(RGB fill_color);
5759 
5766  RGB GetApplyFillColor() const;
5767 
5775  void SetApplyFillColor(RGB fill_color);
5776 
5782  WString GetOverlayText() const;
5783 
5791  void SetOverlayText(const WString& overlay_text);
5792 
5798  bool IsOverlayTextRepeated();
5799 
5808  void EnableRepeatOverlayText(bool is_to_repeat_overlay_text);
5809 
5819 
5833 
5839  void EnableAutoFontSize();
5840 
5850 
5873  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
5874 
5887  bool Apply();
5888 };
5889 
5899 class Sound FS_FINAL : public Markup{
5900  public:
5906  typedef enum _SampleEncodingFormat {
5916 
5917 
5919  Sound() {}
5920 
5926  explicit Sound(const Annot& annot);
5927 
5928  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5929  explicit Sound(FS_HANDLE handle);
5930 
5931 #ifndef __EMSCRIPTEN_RENDER__
5932 
5933  ~Sound();
5934 #endif
5935 
5948 
5954  float GetSamplingRate() const;
5955 
5961  int GetChannelCount() const;
5962 
5968  int GetBits() const;
5969 
5977 
5983  String GetCompressionFormat() const;
5984 
5998  FileSpec GetFileSpec() const;
5999 };
6000 
6016 class PagingSeal FS_FINAL : public Annot {
6017  public:
6019  PagingSeal(const Annot& annot);
6020 
6022  ~PagingSeal();
6023 
6030 
6031  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
6032  explicit PagingSeal(FS_HANDLE handle);
6033 };
6034 
6035 } // namespace annots
6036 } // namespace pdf
6037 } // namespace foxit
6038 
6039 #endif // FS_ANNOT_H_
6040 
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:625
Annotation flag: read only.
Definition: fs_annot.h:1098
void SetFillColor(RGB fill_color)
Set fill color.
Definition: fs_annot.h:1717
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:375
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:1187
~Line()
Destructor.
Definition: fs_annot.h:3634
Square()
Constructor.
Definition: fs_annot.h:2946
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:3310
IconFit()
Constructor.
Definition: fs_annot.h:764
void SetBorderColor(RGB color)
Set border color.
Definition: fs_pdfobject.h:422
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:302
WString GetMKNormalCaption() const
Get the normal caption string in the MK dictionary.
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1878
Definition: fs_annot.h:1628
Definition: fs_annot.h:2638
Definition: fs_annot.h:2734
~Popup()
Destructor.
Definition: fs_annot.h:5006
Line spacing style: auto line spacing.
Definition: fs_annot.h:5113
String GetAppearanceState() const
Get the annotation's appearance state, which selects the applicable appearance stream from an appeara...
Definition: fs_annot.h:4281
Redact()
Constructor.
Definition: fs_annot.h:5696
Definition: fs_annot.h:203
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:719
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:1227
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:999
Annotation flag: no view.
Definition: fs_annot.h:1089
RectF GetInnerRect() const
Get the inner rectangle.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Definition: fs_annot.h:4924
Markup()
Constructor.
Definition: fs_annot.h:1988
PDFPage GetPage() const
Get the related PDF page.
WString GetContent() const
Get content.
Twos-complement values.
Definition: fs_annot.h:5910
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1011
Annot()
Constructor.
Definition: fs_annot.h:1278
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5908
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:1207
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
float width
Border width, in points.
Definition: fs_annot.h:591
Annotation type: free text annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:983
State GetState()
Get the state.
StrikeOut()
Constructor.
Definition: fs_annot.h:2767
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:1032
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:4654
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1703
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:1625
void SetOverlayText(const WString &overlay_text)
Set the overlay text.
Screen()
Constructor.
Definition: fs_annot.h:4284
Sound()
Constructor.
Definition: fs_annot.h:5919
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:795
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:1219
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:214
Definition: fs_annot.h:743
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:1067
Definition: fs_basictypes.h:452
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:366
BorderInfo(const BorderInfo &border_info)
Constructor, with another border information object.
Definition: fs_annot.h:495
RichTextStyle()
Constructor.
Definition: fs_annot.h:249
Definition: fs_annot.h:408
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:415
bool HasMKEntry(MKEntry mk_entry)
Check if a specified entry exists in the MK dictionary.
~Highlight()
Destructor.
Definition: fs_annot.h:2715
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:1799
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1744
Definition: fs_annot.h:2943
No caption; icon only.
Definition: fs_annot.h:1231
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
bool IsOverlayTextRepeated()
Check whether the overlay text is repeated or not.
void EnableRepeatOverlayText(bool is_to_repeat_overlay_text)
Set the flag to decide whether to repeat the overlay text.
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:1963
Annotation type: unknown.
Definition: fs_annot.h:974
Caption above the icon.
Definition: fs_annot.h:1235
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
PagingSeal(const Annot &annot)
Constructor.
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:972
Annotation type: redact annotation.
Definition: fs_annot.h:1034
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:1859
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:1251
Definition: fs_annot.h:737
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1046
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:100
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:52
Annotation type: square annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:987
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:610
~Caret()
Destructor.
Definition: fs_annot.h:4884
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:2737
void SetMKIconCaptionRelation(MKIconCaptionRelation relation)
Set the relation of icon and caption in the MK dictionary.
Annotation property: creation date.
Definition: fs_annot.h:1151
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_annot.h:578
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:5096
RGB GetFillColor() const
Get fill color.
Definition: fs_annot.h:4469
WIDE STRING CLASS.
Definition: fx_string.h:1452
Corner mark style: subscript.
Definition: fs_annot.h:216
void SetOpenStatus(bool status)
Set open status.
Definition: fs_annot.h:2483
void SetAlignment(common::Alignment alignment)
Set alignment value.
Annotation type: movie annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1015
Annotation property: modified date.
Definition: fs_annot.h:1146
actions::Action GetAction()
Get action.
DateTime GetModifiedDateTime() const
Get last modified date time.
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1197
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:4292
void SetIconName(const char *icon_name)
Set icon name.
Caption below the icon.
Definition: fs_annot.h:1233
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:387
RGB GetStyleFillColor() const
Get fill color for some line ending styles.
RectF GetInnerRect() const
Get the inner rectangle.
void EnableAutoFontSize()
Enable auto font size for the overlay text.
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
bool Apply()
Apply current redact annotation: remove the text, graphics and annotations under annotation rectangle...
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:526
FileSpec GetFileSpec()
Get the file specification.
Annotation flag: no rotate.
Definition: fs_annot.h:1081
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:1022
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:692
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:264
~StrikeOut()
Destructor.
Definition: fs_annot.h:2775
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:902
~PolyLine()
Destructor.
Definition: fs_annot.h:4662
DefaultAppearance()
Constructor.
Definition: fs_annot.h:90
Annotation property: fill color.
Definition: fs_annot.h:1163
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:83
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1650
Annotation property: border color.
Definition: fs_annot.h:1157
Widget()
Constructor.
Definition: fs_annot.h:5118
float vertical_fraction
The vertical fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:923
void SetAction(const actions::Action &action)
Set action.
WString GetMeasureRatioW()
Get the scale ratio string for measuring.
Definition: fs_pdfform.h:1236
Highlight()
Constructor.
Definition: fs_annot.h:2707
float horizontal_fraction
The horizontal fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:917
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:63
Annotation flag: toggle no view.
Definition: fs_annot.h:1111
void SetFillColor(RGB fill_color)
Set fill color.
~Underline()
Destructor.
Definition: fs_annot.h:2745
Definition: fs_annot.h:4153
Definition: fs_annot.h:3619
RGB text_color
Text color. Format: 0xRRGGBB.
Definition: fs_annot.h:379
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:5693
FreeText()
Constructor.
Definition: fs_annot.h:3301
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:510
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:888
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1636
Border style: Solid.
Definition: fs_annot.h:417
~Note()
Destructor.
Definition: fs_annot.h:2496
Annotation type: rich media annotation.
Definition: fs_annot.h:1036
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:1074
Annotation's rollover appearance.
Definition: fs_annot.h:1253
PagingSealSignature GetPagingSealSignature()
Get the associated paging seal signature.
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:808
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:1171
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:1255
uint32 flags
Flags to indicate which properties of default appearance are meaningful.
Definition: fs_annot.h:178
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1705
μ-law-encoded samples
Definition: fs_annot.h:5912
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:3115
Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
Definition: fs_annot.h:1130
Line()
Constructor.
Definition: fs_annot.h:3626
PointF GetEndPoint() const
Get the end point.
Annotation type: polygon annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:991
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:437
int GetChannelCount() const
Get the count of sound channels.
Circle()
Constructor.
Definition: fs_annot.h:3118
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.
Definition: fs_signature.h:2072
Highlighting mode: Outline, which is to invert the annotation's border.
Definition: fs_annot.h:1132
common::Font font
A font for default appearance. It should be a valid font object when it is useful.
Definition: fs_annot.h:184
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1697
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:704
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:911
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:2764
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:733
Popup()
Constructor.
Definition: fs_annot.h:4996
Definition: fs_annot.h:4873
Definition: fs_annot.h:5066
Annot & operator=(const Annot &annot)
Assign operator.
Annotation type: widget annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1020
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:979
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:1866
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:2805
void SetAction(const actions::Action &action)
Set action.
~Polygon()
Destructor.
Definition: fs_annot.h:4480
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1007
Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:981
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1175
bool fit_bounds
A boolean value that indicates whether to scale button appearance to fit fully within bounds or not.
Definition: fs_annot.h:930
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:729
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:59
RGB GetFillColor() const
Get fill color.
Definition: fs_common.h:1958
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:1931
Definition: fs_annot.h:4040
RGB GetMKBorderColor() const
Get the border color in the MK dictionary.
Caret()
Constructor.
Definition: fs_annot.h:4876
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:749
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:546
Annotation flag: locked.
Definition: fs_annot.h:1105
void SetRotation(common::Rotation rotate)
Set the rotation of the image used for the appearance of current screen annotation.
Annotation type: paging seal annotation. A Foxit PDF SDK custom annotation type (not a standard annot...
Definition: fs_annot.h:1038
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
~Ink()
Destructor.
Definition: fs_annot.h:4051
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:1009
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:677
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:3621
bool operator !=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:321
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1202
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:430
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:1144
Annotation flag: invisible.
Definition: fs_annot.h:1053
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:1026
float text_size
Text size. It should not be negative value. 0 means text will not be shown.
Definition: fs_annot.h:370
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:5105
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Constructor, with parameters.
Definition: fs_annot.h:648
Matrix GetTextMatrix() const
Get matrix in default appearance data for text in current free text annotation.
Definition: fs_annot.h:1836
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:5109
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:993
Ink()
Constructor.
Definition: fs_annot.h:4043
Caption overlaid directly on the icon.
Definition: fs_annot.h:1241
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:731
float text_size
Text size for default appearance.
Definition: fs_annot.h:193
Definition: fs_annot.h:3298
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:391
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1136
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:419
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1024
TextMarkup()
Constructor.
Definition: fs_annot.h:2641
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:1128
Caption to the right of the icon.
Definition: fs_annot.h:1237
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:1769
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:113
void SetOpacity(float opacity)
Set opacity value.
PointF first
First point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:727
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1126
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
FileAttachment()
Constructor.
Definition: fs_annot.h:4927
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:995
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:5914
~BorderInfo()
Destructor.
Definition: fs_annot.h:488
Definition: fs_annot.h:965
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:663
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:4472
Annotation type: sound annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1013
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:1001
Definition: fs_common.h:1344
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:809
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:1212
PSInk()
Constructor.
Definition: fs_annot.h:5069
Corner mark style: none.
Definition: fs_annot.h:212
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:1756
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:997
Definition: fs_annot.h:1840
~PSInk()
Destructor.
Definition: fs_annot.h:5079
Definition: fs_action.h:418
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:199
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1173
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:985
Squiggly()
Constructor.
Definition: fs_annot.h:2797
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:128
Border style: Cloudy.
Definition: fs_annot.h:451
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:141
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:1249
Indicates property font of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:61
float dash_phase
Dash phase.
Definition: fs_annot.h:617
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:400
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:343
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:597
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:1005
~Square()
Destructor.
Definition: fs_annot.h:2954
String GetMeasureRatio()
Get the scale ratio string for measuring.
Definition: fs_annot.h:4993
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:1030
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Border style: Inset.
Definition: fs_annot.h:444
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:395
No icon; captin only.
Definition: fs_annot.h:1229
void SetBorderInfo(const BorderInfo &border)
Set border information.
CornerMarkStyle
Enumeration for corner mark style.
Definition: fs_annot.h:210
~Circle()
Destructor.
Definition: fs_annot.h:3126
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:4651
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
BorderInfo()
Constructor.
Definition: fs_annot.h:481
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:1028
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:5906
void Set(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Set value.
Definition: fs_annot.h:164
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
Definition: fs_annot.h:3610
RGB GetFillColor() const
Get fill color.
void SetRotation(int angle)
Set rotation angle (in clockwise).
~FileAttachment()
Destructor.
Definition: fs_annot.h:4935
LineSpacingStyle
Enumeration for line spacing style.
Definition: fs_annot.h:5103
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:383
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
Definition: fs_annot.h:638
RGB GetBorderColor() const
Get border color.
Definition: fs_annot.h:2794
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:236
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:1813
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:1826
Line spacing style: one and half times line spacing.
Definition: fs_annot.h:5107
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:989
WString GetTitle() const
Get title of current screen annotation.
Caption to the left of the icon.
Definition: fs_annot.h:1239
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:3617
Indicates property text size of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:65
Note()
Constructor.
Definition: fs_annot.h:2486
Stamp()
Constructor.
Definition: fs_annot.h:4156
ShadingColor()
Constructor.
Definition: fs_annot.h:1641
virtual String GetProviderID()
A callback function used to get provider ID.
Definition: fs_annot.h:1733
~Markup()
Destructor.
Definition: fs_annot.h:1991
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
Definition: fs_annot.h:2704
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1182
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1192
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2649
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:1177
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.
Definition: fs_annot.h:6016
RectF GetRect() const
Get rectangle, in PDF coordinate system.
QuadPoints()
Constructor.
Definition: fs_annot.h:656
Annotation flag: locked contents.
Definition: fs_annot.h:1118
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1003
Definition: fs_image.h:448
Annotation flag: hidden.
Definition: fs_annot.h:1059
Definition: fs_annot.h:5899
Line spacing style: exact value line spacing.
Definition: fs_annot.h:5111
Border style: Dashed.
Definition: fs_annot.h:424
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:282
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:1134
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_annot.h:472