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 
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,
1035  } Type;
1036 
1042  typedef enum _Flags {
1055  e_FlagHidden = 0x0002,
1063  e_FlagPrint = 0x0004,
1070  e_FlagNoZoom = 0x0008,
1077  e_FlagNoRotate = 0x0010,
1085  e_FlagNoView = 0x0020,
1094  e_FlagReadOnly = 0x0040,
1101  e_FlagLocked = 0x0080,
1115  } Flags;
1116 
1122  typedef enum _HighlightingMode {
1133  } HighlightingMode;
1134 
1140  typedef enum _Property {
1156  } Property;
1157 
1163  typedef enum _MKEntry {
1212  } MKEntry;
1213 
1219  typedef enum _MKIconCaptionRelation {
1235 
1241  typedef enum _AppearanceType {
1248  } AppearanceType;
1249 
1250 
1251  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1252  explicit Annot(FS_HANDLE handle);
1260  Annot(const PDFPage& page, objects::PDFDictionary* annot_dict);
1261 #ifndef __EMSCRIPTEN_RENDER__
1262 
1267  Annot(const Annot& annot);
1268 #endif
1269 
1270  Annot() {}
1271 #ifndef __EMSCRIPTEN_RENDER__
1272 
1279  Annot& operator = (const Annot& annot);
1280 #endif
1281 
1288  bool operator ==(const Annot& other) const;
1296  bool operator != (const Annot& other) const;
1297 #ifndef __EMSCRIPTEN_RENDER__
1298 
1299  virtual ~Annot();
1300 #endif
1301 
1308  bool IsEmpty() const;
1309 
1315  PDFPage GetPage() const;
1322  bool IsMarkup() const;
1328  Type GetType() const;
1334  int GetIndex() const;
1340  WString GetContent() const;
1354  void SetContent(const WString& content);
1361  DateTime GetModifiedDateTime() const;
1369  void SetModifiedDateTime(const DateTime& date_time);
1376  uint32 GetFlags() const;
1385  void SetFlags(uint32 flags);
1391  WString GetUniqueID() const;
1399  void SetUniqueID(const WString& unique_id);
1406  RectF GetRect() const;
1407 
1420  Matrix GetDisplayMatrix(const Matrix& page_display_matrix);
1421 
1431  bool Move(const RectF& rect);
1448  BorderInfo GetBorderInfo() const;
1466  void SetBorderInfo(const BorderInfo& border);
1475  RGB GetBorderColor() const;
1487  void SetBorderColor(RGB color);
1500  bool ResetAppearanceStream();
1516  RectI GetDeviceRect(const Matrix& matrix);
1523 
1533  bool HasProperty(Property property) const;
1534 
1552  bool RemoveProperty(Property property);
1553 
1560 
1576  objects::PDFStream* GetAppearanceStream(AppearanceType type, const char* appearance_state = "") const;
1577 };
1578 
1580 FSDK_DEFINE_ARRAY(AnnotArray, Annot)
1581 
1582 
1583 class ShadingColor FS_FINAL : public Object {
1584  public:
1591  ShadingColor(ARGB firstcolor, ARGB secondcolor)
1592  : first_color(firstcolor)
1593  , second_color(secondcolor) {}
1594 
1597  : first_color(0xFFFFFFFF)
1598  , second_color(0xFFFFFFFF) {}
1599 
1605  ShadingColor(const ShadingColor& shading_color)
1606  : first_color(shading_color.first_color)
1607  , second_color(shading_color.second_color) {}
1608 
1616  ShadingColor& operator = (const ShadingColor& shading_color) {
1617  this->first_color = shading_color.first_color;
1618  this->second_color = shading_color.second_color;
1619  return *this;
1620  }
1621 
1629  bool operator == (const ShadingColor& shading_color) const {
1630  return (first_color == shading_color.first_color && second_color == shading_color.second_color);
1631  }
1632 
1640  bool operator != (const ShadingColor& shading_color) const {
1641  return (first_color != shading_color.first_color || second_color != shading_color.second_color);
1642  }
1643 
1652  void Set(ARGB firstcolor, ARGB secondcolor) {
1653  this->first_color = firstcolor;
1654  this->second_color = secondcolor;
1655  }
1656 
1661 };
1662 
1673  public:
1679  virtual void Release() = 0;
1688  virtual String GetProviderID() {
1689  return String();
1690  }
1700  return String();
1701  }
1711  virtual bool HasIcon(Annot::Type annot_type, const char* icon_name) {
1712  return false;
1713  }
1724  virtual bool CanChangeColor(Annot::Type annot_type, const char* icon_name) {
1725  return false;
1726  }
1727 #ifndef __EMSCRIPTEN_RENDER__
1728 
1738  virtual PDFPage GetIcon(Annot::Type annot_type, const char* icon_name, ARGB color);
1739 #endif
1740 
1754  virtual bool GetShadingColor(Annot::Type annot_type, const char* icon_name,
1755  RGB referenced_color, int shading_index, ShadingColor& out_shading_color) {
1756  return false;
1757  }
1768  virtual float GetDisplayWidth(Annot::Type annot_type, const char* icon_name) {
1769  return 0.0f;
1770  }
1781  virtual float GetDisplayHeight(Annot::Type annot_type, const char* icon_name) {
1782  return 0.0f;
1783  }
1784 
1785  protected:
1786  ~IconProviderCallback() {}
1787 };
1788 
1789 class Markup;
1791 FSDK_DEFINE_ARRAY(MarkupArray, Markup)
1792 
1793 class Note;
1795 FSDK_DEFINE_ARRAY(NoteArray, Note)
1796 
1797 
1815 class Markup : public Annot {
1816  public:
1822  typedef enum _StateModel {
1824  e_StateModelMarked = 1,
1826  e_StateModelReview = 2
1827  } StateModel;
1828 
1834  typedef enum _State {
1839  e_StateMarked = 1,
1844  e_StateUnmarked = 2,
1849  e_StateAccepted = 3,
1854  e_StateRejected = 4,
1859  e_StateCancelled = 5,
1864  e_StateCompleted = 6,
1869  e_StateNone = 7
1870  } State;
1871 
1877  typedef enum _EndingStyle {
1879  e_EndingStyleNone = 0,
1881  e_EndingStyleSquare = 1,
1883  e_EndingStyleCircle = 2,
1885  e_EndingStyleDiamond = 3,
1887  e_EndingStyleOpenArrow = 4,
1893  e_EndingStyleClosedArrow = 5,
1895  e_EndingStyleButt = 6,
1897  e_EndingStyleROpenArrow = 7,
1899  e_EndingStyleRClosedArrow = 8,
1901  e_EndingStyleSlash = 9
1902  } EndingStyle;
1903 
1909  typedef enum _MeasureType {
1911  e_MeasureTypeX = 0,
1913  e_MeasureTypeY = 1,
1915  e_MeasureTypeD = 2,
1917  e_MeasureTypeA = 3,
1919  e_MeasureTypeT = 4,
1921  e_MeasureTypeS = 5
1922  } MeasureType;
1923 
1924 
1930  explicit Markup(const Annot& annot);
1931  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1932  explicit Markup(FS_HANDLE handle);
1934  Markup() {}
1935 
1937  ~Markup() {}
1938 
1956  Popup GetPopup();
1973  void SetPopup(const Popup& popup);
1981  WString GetTitle() const;
1991  void SetTitle(const WString& title);
1997  WString GetSubject() const;
2005  void SetSubject(const WString& subject);
2014  float GetOpacity() const;
2027  void SetOpacity(float opacity);
2049  String GetIntent() const;
2085  void SetIntent(const String& intent);
2092  DateTime GetCreationDateTime() const;
2100  void SetCreationDateTime(const DateTime& date_time);
2106  int GetReplyCount();
2115  Note GetReply(int index) const;
2121  Note AddReply();
2132  bool RemoveReply(int index);
2138  bool RemoveAllReplies();
2139 
2156  bool IsGrouped();
2157 
2176  Markup GetGroupHeader();
2177 
2194  MarkupArray GetGroupElements();
2195 
2211  bool Ungroup();
2212 
2228  NoteArray GetStateAnnots(StateModel model);
2229 
2265  Note AddStateAnnot(const WString& title, StateModel model, State state);
2266 
2276  bool RemoveAllStateAnnots();
2284  int32 GetRichTextCount();
2295  WString GetRichTextContent(int32 index);
2307  void SetRichTextContent(int32 index, const WString& content);
2308 
2321  RichTextStyle GetRichTextStyle(int32 index);
2337  void SetRichTextStyle(int32 index, const RichTextStyle& style);
2352  void AddRichText(const WString& content, const RichTextStyle& style);
2371  void InsertRichText(int32 index, const WString& content, const RichTextStyle& style);
2384  void RemoveRichText(int index);
2385 };
2386 
2409 class Note FS_FINAL : public Markup {
2410  public:
2412  Note() {}
2418  explicit Note(const Annot& annot);
2419  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2420  explicit Note(FS_HANDLE handle);
2422  ~Note() {}
2423 
2436  bool GetOpenStatus() const;
2451  void SetOpenStatus(bool status);
2463  String GetIconName() const;
2481  void SetIconName(const char* icon_name);
2491  Markup GetReplyTo();
2498  bool IsStateAnnot();
2499 
2512 
2524  State GetState();
2525 
2548  void SetState(State state);
2549 
2550 };
2551 
2563 class TextMarkup: public Markup {
2564  public:
2572  explicit TextMarkup(const Annot& annot);
2575 
2610  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2611 };
2612 
2629 class Highlight FS_FINAL : public TextMarkup {
2630  public:
2638  explicit Highlight(const Annot& annot);
2641 };
2642 
2659 class Underline FS_FINAL : public TextMarkup {
2660  public:
2668  explicit Underline(const Annot& annot);
2671 };
2672 
2689 class StrikeOut FS_FINAL : public TextMarkup {
2690  public:
2698  explicit StrikeOut(const Annot& annot);
2701 };
2702 
2719 class Squiggly FS_FINAL : public TextMarkup {
2720  public:
2728  explicit Squiggly(const Annot& annot);
2731 };
2732 
2746 class Link FS_FINAL : public Annot {
2747  public:
2749  Link() {}
2755  explicit Link(const Annot& annot);
2756  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2757  explicit Link(FS_HANDLE handle);
2759  ~Link() {}
2760 
2793  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2794 
2803 
2814 
2822 
2837  void SetAction(const actions::Action& action);
2838 
2844  bool RemoveAction();
2845 };
2846 
2861 class Square FS_FINAL : public Markup {
2862  public:
2864  Square() {}
2870  explicit Square(const Annot& annot);
2872  ~Square() {}
2873 
2880  RGB GetFillColor() const;
2881 
2889  void SetFillColor(RGB fill_color);
2890 
2900  RectF GetInnerRect() const;
2912  void SetInnerRect(const RectF& inner_rect);
2913 };
2914 
2929 class Circle FS_FINAL : public Markup {
2930  public:
2932  Circle() {}
2938  explicit Circle(const Annot& annot);
2940  ~Circle() {}
2941 
2948  RGB GetFillColor() const;
2949 
2960  void SetFillColor(RGB fill_color);
2961 
2971  RectF GetInnerRect() const;
2972 
2986  void SetInnerRect(const RectF& inner_rect);
2987 };
2988 
3008 class FreeText FS_FINAL : public Markup {
3009  public:
3017  explicit FreeText(const Annot& annot);
3020 
3031  RGB GetFillColor() const;
3045  void SetFillColor(RGB fill_color);
3046 
3056 
3070  void SetAlignment(common::Alignment alignment);
3071 
3082  RectF GetInnerRect() const;
3083 
3098  void SetInnerRect(const RectF& inner_rect);
3099 
3109 
3132  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
3133 
3145 
3160  void SetCalloutLineEndingStyle(EndingStyle ending_style);
3161 
3176 
3199  void SetCalloutLinePoints(const PointFArray& point_array);
3200 
3216  void SetTextMatrix(const Matrix& text_matrix);
3217 
3229  Matrix GetTextMatrix() const;
3230 
3238 
3253  void SetRotation(common::Rotation rotation);
3254 
3267  void Rotate(common::Rotation rotation);
3268 
3269 };
3270 
3289 class Line FS_FINAL : public Markup {
3290  public:
3296  typedef enum _CapPos {
3301  } CapPos;
3302 
3303 
3305  Line() {}
3311  explicit Line(const Annot& annot);
3313  ~Line() {}
3314 
3336  void SetLineStartStyle(EndingStyle ending_style);
3345  EndingStyle GetLineEndStyle() const;
3358  void SetLineEndStyle(EndingStyle ending_style);
3359 
3370  RGB GetStyleFillColor() const;
3371 
3385  void SetStyleFillColor(RGB color);
3386 
3395  PointF GetStartPoint() const;
3408  void SetStartPoint(const PointF& point);
3409 
3418  PointF GetEndPoint() const;
3431  void SetEndPoint(const PointF& point);
3432 
3441  bool HasCaption() const;
3454  void EnableCaption(bool cap);
3455 
3483  void SetCaptionPositionType(CapPos cap_position);
3496  Offset GetCaptionOffset() const;
3512  void SetCaptionOffset(const Offset& offset);
3513 
3528  float GetLeaderLineLength() const;
3546  void SetLeaderLineLength(float length);
3556  float GetLeaderLineExtensionLength() const;
3569  void SetLeaderLineExtensionLength(float extension_length);
3570 
3581  float GetLeaderLineOffset() const;
3595  void SetLeaderLineOffset(float offset);
3596 
3610  void SetMeasureRatio(const String& ratio);
3611 
3622 
3633 
3646  void SetMeasureUnit(MeasureType measure_type, const String& unit);
3647 
3659  String GetMeasureUnit(MeasureType measure_type);
3660 
3672  WString GetMeasureUnitW(MeasureType measure_type);
3673 
3686  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3687 
3699  float GetMeasureConversionFactor(MeasureType measure_type);
3700 };
3701 
3719 class Ink FS_FINAL : public Markup {
3720  public:
3722  Ink() {}
3728  explicit Ink(const Annot& annot);
3730  ~Ink() {}
3758 
3791  void SetInkList(const common::Path& ink_list);
3792 
3804  void EnableUseBezier(bool use_bezier);
3805 };
3806 
3831 class Stamp FS_FINAL : public Markup {
3832  public:
3834  Stamp() {}
3840  explicit Stamp(const Annot& annot);
3841 #ifndef __EMSCRIPTEN_RENDER__
3842 
3843  ~Stamp();
3844 #endif
3845 
3856  String GetIconName() const;
3879  void SetIconName(const char* icon_name);
3890  void SetBitmap(const common::Bitmap& bitmap);
3891 
3914  void SetImage(const common::Image& image, int frame_index, int compress);
3915 
3926  void SetRotation(int angle);
3927 
3933  int GetRotation();
3934 
3944  void Rotate(int angle);
3945 };
3946 
3959 class Screen FS_FINAL : public Annot {
3960  public:
3962  Screen() {}
3968  explicit Screen(const Annot& annot);
3970  virtual ~Screen() {}
3971 
3994  void SetImage(const common::Image& image, int frame_index, int compress);
3995 
4005 
4013 
4026  void SetRotation(common::Rotation rotate);
4027 
4035 
4044  float GetOpacity() const;
4057  void SetOpacity(float opacity);
4058 
4064  WString GetTitle() const;
4072  void SetTitle(const WString& title);
4073 
4107  void SetAction(const actions::Action& action);
4116  void RemoveAction();
4117 };
4118 
4137 class Polygon FS_FINAL : public Markup {
4138  public:
4140  Polygon() {}
4146  explicit Polygon(const Annot& annot);
4157  RGB GetFillColor() const;
4158 
4170  void SetFillColor(RGB fill_color);
4171 
4181 
4193  void SetVertexes(const PointFArray& vertexes);
4194 
4208  void SetMeasureRatio(const String& ratio);
4209 
4220 
4231 
4244  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4245 
4257  String GetMeasureUnit(MeasureType measure_type);
4258 
4270  WString GetMeasureUnitW(MeasureType measure_type);
4271 
4284  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4285 
4297  float GetMeasureConversionFactor(MeasureType measure_type);
4298 };
4299 
4319 class PolyLine FS_FINAL : public Markup {
4320  public:
4328  explicit PolyLine(const Annot& annot);
4341  RGB GetStyleFillColor() const;
4353  void SetStyleFillColor(RGB fill_color);
4354 
4364 
4376  void SetVertexes(const PointFArray& vertexes);
4399  void SetLineStartStyle(EndingStyle starting_style);
4408  EndingStyle GetLineEndStyle() const;
4422  void SetLineEndStyle(EndingStyle ending_style);
4423 
4437  void SetMeasureRatio(const String& ratio);
4438 
4449 
4460 
4473  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4474 
4486  String GetMeasureUnit(MeasureType measure_type);
4487 
4499  WString GetMeasureUnitW(MeasureType measure_type);
4500 
4513  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4514 
4526  float GetMeasureConversionFactor(MeasureType measure_type);
4527 };
4528 
4541 class Caret FS_FINAL : public Markup {
4542  public:
4544  Caret() {}
4550  explicit Caret(const Annot& annot);
4552  ~Caret() {}
4553 
4563  RectF GetInnerRect() const;
4577  void SetInnerRect(const RectF& inner_rect);
4578 };
4579 
4592 class FileAttachment FS_FINAL : public Markup {
4593  public:
4601  explicit FileAttachment(const Annot& annot);
4604 
4612  bool SetFileSpec(const FileSpec& file_spec);
4613 
4621 
4632  String GetIconName() const;
4633 
4649  void SetIconName(const char* icon_name);
4650 };
4651 
4661 class Popup FS_FINAL : public Annot {
4662  public:
4664  Popup() {}
4670  explicit Popup(const Annot& annot);
4671  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
4672  explicit Popup(FS_HANDLE handle);
4674  ~Popup() {}
4675 
4688  bool GetOpenStatus() const;
4703  void SetOpenStatus(bool status);
4704 
4712  Markup GetParent();
4713 };
4714 #ifndef __FSDK_NO_PSINK__
4715 
4733 class PSInk FS_FINAL : public Annot {
4734  public:
4736  PSInk() {}
4742  explicit PSInk(const Annot& annot);
4743  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
4744  explicit PSInk(FS_HANDLE handle);
4746  ~PSInk() {}
4747 };
4748 #endif
4749 
4761 class Widget FS_FINAL : public Annot {
4762  public:
4764  Widget() {}
4770  explicit Widget(const Annot& annot);
4771  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
4772  explicit Widget(FS_HANDLE handle);
4773 #ifndef __EMSCRIPTEN_RENDER__
4774 
4775  ~Widget();
4776 #endif
4777 
4783 
4790 
4801 
4814 
4825 
4849  void SetAction(const actions::Action& action);
4850 
4859  void RemoveAction();
4860 
4872  bool HasMKEntry(MKEntry mk_entry);
4884  void RemoveMKEntry(MKEntry mk_entry);
4910  void SetMKRotation(common::Rotation rotation);
4921  RGB GetMKBorderColor() const;
4932  void SetMKBorderColor(RGB color);
4943  RGB GetMKBackgroundColor() const;
4954  void SetMKBackgroundColor(RGB color);
4968  WString GetMKNormalCaption() const;
4982  void SetMKNormalCaption(const wchar_t* caption);
4997  WString GetMKRolloverCaption() const;
4998 
5013  void SetMKRolloverCaption(const wchar_t* caption);
5014 
5028  WString GetMKDownCaption() const;
5029 
5043  void SetMKDownCaption(const wchar_t* caption);
5044 
5058 
5072  void SetMKNormalIconBitmap(const common::Bitmap& bitmap);
5073 
5089  void SetMKNormalIconImage(const common::Image& image, int frame_index);
5090 
5105 
5120  void SetMKRolloverIconBitmap(const common::Bitmap& bitmap);
5121 
5138  void SetMKRolloverIconImage(const common::Image& image, int frame_index);
5139 
5153 
5167  void SetMKDownIconBitmap(const common::Bitmap& bitmap);
5168 
5184  void SetMKDownIconImage(const common::Image& image, int frame_index);
5185 
5200  IconFit GetMKIconFit() const;
5218  void SetMKIconFit(const IconFit& icon_fit);
5219 
5234 
5251 
5259  void SetAppearanceState(const String& appearance_state);
5260 
5266  String GetAppearanceState() const;
5267 
5274 
5275 #ifdef _SUPPORTWEBSDK_
5276  //Set push button icon form icon stream. stream is from doc::createIcon.
5277  //face: 0: normal, 1: down, 2: roller
5278  void SetButtonIcon(objects::PDFStream* icon, int face);
5279 #endif
5280 };
5281 
5298 class Redact FS_FINAL : public Markup {
5299  public:
5301  Redact() {}
5307  explicit Redact(const Annot& annot);
5308  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5309  explicit Redact(FS_HANDLE handle);
5310 #ifndef __EMSCRIPTEN_RENDER__
5311 
5312  ~Redact();
5313 #endif
5314 
5328 
5347  void SetQuadPoints(const QuadPointsArray& quad_points_array);
5348 
5355  RGB GetFillColor() const;
5363  void SetFillColor(RGB fill_color);
5364 
5371  RGB GetApplyFillColor() const;
5372 
5380  void SetApplyFillColor(RGB fill_color);
5381 
5387  WString GetOverlayText() const;
5388 
5396  void SetOverlayText(const WString& overlay_text);
5397 
5407 
5421 
5431 
5454  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
5455 
5467  bool Apply();
5468 };
5469 
5479 class Sound FS_FINAL : public Markup{
5480  public:
5486  typedef enum _SampleEncodingFormat {
5496 
5497 
5499  Sound() {}
5500 
5506  explicit Sound(const Annot& annot);
5507 
5508  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5509  explicit Sound(FS_HANDLE handle);
5510 
5511 #ifndef __EMSCRIPTEN_RENDER__
5512 
5513  ~Sound();
5514 #endif
5515 
5528 
5534  float GetSamplingRate() const;
5535 
5541  int GetChannelCount() const;
5542 
5548  int GetBits() const;
5549 
5557 
5563  String GetCompressionFormat() const;
5564 
5578  FileSpec GetFileSpec() const;
5579 };
5580 
5581 } // namespace annots
5582 } // namespace pdf
5583 } // namespace foxit
5584 
5585 #endif // FS_ANNOT_H_
5586 
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:624
Annotation flag: read only.
Definition: fs_annot.h:1094
void SetFillColor(RGB fill_color)
Set fill color.
Definition: fs_annot.h:1672
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:1179
~Line()
Destructor.
Definition: fs_annot.h:3313
Square()
Constructor.
Definition: fs_annot.h:2864
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:3019
IconFit()
Constructor.
Definition: fs_annot.h:763
void SetBorderColor(RGB color)
Set border color.
Definition: fs_pdfobject.h:407
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:1834
Definition: fs_annot.h:1583
Definition: fs_annot.h:2563
Definition: fs_annot.h:2659
~Popup()
Destructor.
Definition: fs_annot.h:4674
String GetAppearanceState() const
Get the annotation's appearance state, which selects the applicable appearance stream from an appeara...
Definition: fs_annot.h:3959
Redact()
Constructor.
Definition: fs_annot.h:5301
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:1219
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:1085
RectF GetInnerRect() const
Get the inner rectangle.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Definition: fs_annot.h:4592
Markup()
Constructor.
Definition: fs_annot.h:1934
PDFPage GetPage() const
Get the related PDF page.
WString GetContent() const
Get content.
Twos-complement values.
Definition: fs_annot.h:5490
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1011
Annot()
Constructor.
Definition: fs_annot.h:1270
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5488
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:1199
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:983
State GetState()
Get the state.
StrikeOut()
Constructor.
Definition: fs_annot.h:2692
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:4322
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1658
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:1580
void SetOverlayText(const WString &overlay_text)
Set the overlay text.
Screen()
Constructor.
Definition: fs_annot.h:3962
Sound()
Constructor.
Definition: fs_annot.h:5499
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:1211
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.
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:1063
Definition: fs_basictypes.h:430
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:2640
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:1754
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1699
Definition: fs_annot.h:2861
No caption; icon only.
Definition: fs_annot.h:1223
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:1909
Annotation type: unknown.
Definition: fs_annot.h:974
Caption above the icon.
Definition: fs_annot.h:1227
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
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:1815
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1351
void SetIconName(const char *icon_name)
Set icon name.
Annotation's normal appearance.
Definition: fs_annot.h:1243
Definition: fs_annot.h:736
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1042
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:987
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:609
~Caret()
Destructor.
Definition: fs_annot.h:4552
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor 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:2662
void SetMKIconCaptionRelation(MKIconCaptionRelation relation)
Set the relation of icon and caption in the MK dictionary.
Annotation property: creation date.
Definition: fs_annot.h:1147
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:4761
RGB GetFillColor() const
Get fill color.
Definition: fs_annot.h:4137
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:2409
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:1142
actions::Action GetAction()
Get action.
DateTime GetModifiedDateTime() const
Get last modified date time.
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1189
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:3970
void SetIconName(const char *icon_name)
Set icon name.
Caption below the icon.
Definition: fs_annot.h:1225
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.
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:1077
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: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:2700
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:4330
DefaultAppearance()
Constructor.
Definition: fs_annot.h:89
Annotation property: fill color.
Definition: fs_annot.h:1155
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:1605
Annotation property: border color.
Definition: fs_annot.h:1149
Widget()
Constructor.
Definition: fs_annot.h:4764
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:1103
Highlight()
Constructor.
Definition: fs_annot.h:2632
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:62
Annotation flag: toggle no view.
Definition: fs_annot.h:1107
void SetFillColor(RGB fill_color)
Set fill color.
~Underline()
Destructor.
Definition: fs_annot.h:2670
Definition: fs_annot.h:3831
Definition: fs_annot.h:3298
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:5298
FreeText()
Constructor.
Definition: fs_annot.h:3011
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:888
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1591
Border style: Solid.
Definition: fs_annot.h:416
~Note()
Destructor.
Definition: fs_annot.h:2422
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:1070
Annotation's rollover appearance.
Definition: fs_annot.h:1245
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:1163
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.
String GetMeasureRatio()
Get the scale ratio string for measuring.
common::Path GetInkList()
Get ink list data.
Annotation's down appearance.
Definition: fs_annot.h:1247
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:1660
μ-law-encoded samples
Definition: fs_annot.h:5492
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:2929
Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
Definition: fs_annot.h:1126
Line()
Constructor.
Definition: fs_annot.h:3305
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:436
int GetChannelCount() const
Get the count of sound channels.
Circle()
Constructor.
Definition: fs_annot.h:2932
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:1128
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:1652
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.
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:2689
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:4664
Definition: fs_annot.h:4541
Definition: fs_annot.h:4733
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.
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1822
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
~Squiggly()
Destructor.
Definition: fs_annot.h:2730
void SetAction(const actions::Action &action)
Set action.
~Polygon()
Destructor.
Definition: fs_annot.h:4148
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:1167
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:728
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:58
RGB GetFillColor() const
Get fill color.
Definition: fs_common.h:1720
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:1877
Definition: fs_annot.h:3719
RGB GetMKBorderColor() const
Get the border color in the MK dictionary.
Caret()
Constructor.
Definition: fs_annot.h:4544
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.
bool operator !=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:545
Annotation flag: locked.
Definition: fs_annot.h:1101
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:3730
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: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:3300
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:1194
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:367
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.
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:1140
Annotation flag: invisible.
Definition: fs_annot.h:1049
Header file for common definitions and classes.
virtual ~Annot()
Destructor.
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:369
String GetCompressionFormat() const
Get the name of the sound compression format used on the sample data.
common::Alignment GetAlignment() const
Get alignment value.
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:1791
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
PointF GetStartPoint() const
Get the start point.
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:3722
Caption overlaid directly on the icon.
Definition: fs_annot.h:1233
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:74
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:3008
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:1132
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:397
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:2566
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:1124
Caption to the right of the icon.
Definition: fs_annot.h:1229
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:1724
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:1122
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
FileAttachment()
Constructor.
Definition: fs_annot.h:4595
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:5494
~BorderInfo()
Destructor.
Definition: fs_annot.h:487
Definition: fs_annot.h:965
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:4140
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:1146
void SetStartPoint(const PointF &point)
Set the start point.
Definition: fs_pdfobject.h:785
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:56
Icon fit information entry. "IF" in MK dictionary.
Definition: fs_annot.h:1204
PSInk()
Constructor.
Definition: fs_annot.h:4736
Corner mark style: none.
Definition: fs_annot.h:211
Foxit namespace.
Definition: fs_compare.h:27
Left alignment.
Definition: fs_common.h:76
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:1711
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:997
Definition: fs_annot.h:1795
~PSInk()
Destructor.
Definition: fs_annot.h:4746
Definition: fs_action.h:418
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:198
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1165
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:2722
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:1241
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:1005
~Square()
Destructor.
Definition: fs_annot.h:2872
Definition: fs_annot.h:4661
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:443
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:1221
void SetBorderInfo(const BorderInfo &border)
Set border information.
CornerMarkStyle
Enumeration for conermark style.
Definition: fs_annot.h:209
~Circle()
Destructor.
Definition: fs_annot.h:2940
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:4319
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: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:5486
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:3289
RGB GetFillColor() const
Get fill color.
void SetRotation(int angle)
Set rotation angle (in clockwise).
~FileAttachment()
Destructor.
Definition: fs_annot.h:4603
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:2719
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:1768
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:1781
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:1231
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:3296
Indicates property text size of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:64
Note()
Constructor.
Definition: fs_annot.h:2412
Stamp()
Constructor.
Definition: fs_annot.h:3834
ShadingColor()
Constructor.
Definition: fs_annot.h:1596
virtual String GetProviderID()
A callback function used to get provider ID.
Definition: fs_annot.h:1688
~Markup()
Destructor.
Definition: fs_annot.h:1937
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
Definition: fs_annot.h:2629
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1174
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1184
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2574
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:1169
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:1114
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1003
Definition: fs_image.h:430
Annotation flag: hidden.
Definition: fs_annot.h:1055
Definition: fs_annot.h:5479
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:1130
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_annot.h:471