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"
21 #include "pdf/actions/fs_action.h"
23 
29 namespace foxit {
33 namespace pdf {
34 // forward declaration
35 class PDFPage;
36 class FileSpec;
37 class PagingSealSignature;
38 namespace annots {
39 class Note;
40 class Popup;
41 } // namespace annots
42 namespace interform {
43 class Field;
44 class Control;
45 } // namespace interform
46 
50 class DefaultAppearance FS_FINAL : public Object {
51  public:
57  typedef enum _DefAPFlags {
59  e_FlagFont = 0x0001,
61  e_FlagTextColor = 0x0002,
63  e_FlagFontSize = 0x0004
64  } DefAPFlags;
65 
66 
82  : flags(flags)
83  , font(font)
86 
89  : flags(0)
90  , text_size(0)
91  , text_color(0x000000) {}
92 
98  DefaultAppearance(const DefaultAppearance& default_appearance)
99  : flags(default_appearance.flags)
100  , font(default_appearance.font)
101  , text_size(default_appearance.text_size)
102  , text_color(default_appearance.text_color) {}
103 
111  DefaultAppearance& operator = (const DefaultAppearance& default_appearance) {
112  flags = default_appearance.flags;
113  font = default_appearance.font;
114  text_size = default_appearance.text_size;
115  text_color = default_appearance.text_color;
116  return *this;
117  }
118 
126  bool operator == (const DefaultAppearance& default_appearance) const {
127  return (flags == default_appearance.flags && font == default_appearance.font &&
128  fabs(text_size-default_appearance.text_size) <= FLT_EPSILON &&
129  text_color == default_appearance.text_color);
130  }
131 
139  bool operator != (const DefaultAppearance& default_appearance) const {
140  return (flags != default_appearance.flags || font != default_appearance.font ||
141  fabs(text_size - default_appearance.text_size) > FLT_EPSILON ||
142  text_color != default_appearance.text_color);
143  }
144 
163  this->flags = flags;
164  this->font = font;
165  this->text_size = text_size;
166  this->text_color = text_color;
167  }
168 
191  float text_size;
198 };
199 
201 class RichTextStyle FS_FINAL : public Object{
202  public:
208  typedef enum _CornerMarkStyle {
215  } CornerMarkStyle;
216 
217 
238  : font(font)
242  , is_bold(is_bold)
248  , word_space(word_space) {}
249 
252  : text_size(0)
254  , text_color(0x000000)
255  , is_bold(false)
256  , is_italic(false)
257  , is_underline(false)
258  , is_strikethrough(false)
260  , char_space(0.0f)
261  , word_space(0.0f) {}
262 
269  : font(style.font)
270  , text_size(style.text_size)
272  , text_color(style.text_color)
273  , is_bold(style.is_bold)
274  , is_italic(style.is_italic)
275  , is_underline(style.is_underline)
277  , mark_style(style.mark_style)
278  , char_space(style.char_space)
279  , word_space(style.word_space) {}
280 
289  font = style.font;
290  text_size = style.text_size;
292  text_color = style.text_color;
293  is_bold = style.is_bold;
294  is_italic = style.is_italic;
295  is_underline = style.is_underline;
297  mark_style = style.mark_style;
298  char_space = style.char_space;
299  word_space = style.word_space;
300  return *this;
301  }
302 
310  bool operator == (const RichTextStyle& style) const {
311  return (font == style.font &&
312  fabs(text_size- style.text_size) <= FLT_EPSILON &&
313  text_alignment == style.text_alignment &&
314  text_color == style.text_color &&
315  is_bold == style.is_bold &&
316  is_italic == style.is_italic &&
317  is_underline == style.is_underline &&
319  mark_style == style.mark_style &&
320  char_space == style.char_space &&
321  word_space == style.word_space);
322  }
323 
331  bool operator != (const RichTextStyle& style) const {
332  return !((*this) == style);
333  }
334 
357  this->font = font;
358  this->text_size = text_size;
359  this->text_alignment = text_alignment;
360  this->text_color = text_color;
361  this->is_bold = is_bold;
362  this->is_italic = is_italic;
363  this->is_underline = is_underline;
364  this->is_strikethrough = is_strikethrough;
365  this->mark_style = mark_style;
366  this->char_space = char_space;
367  this->word_space = word_space;
368  }
369 
381 
385  float text_size;
386 
392 
397 
401  bool is_bold;
402 
406  bool is_italic;
407 
412 
417 
423 
427  float char_space;
428 
432  float word_space;
433 };
434 
438 namespace annots {
440 class BorderInfo FS_FINAL : public Object {
441  public:
447  typedef enum _Style {
449  e_Solid = 0,
456  e_Dashed = 1,
476  e_Inset = 4,
484  } Style;
485 
486 
504  BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
505  this->width = width;
506  this->style = style;
507  this->cloud_intensity = intensity;
508  this->dash_phase = dash_phase;
509  this->dashes = dashes;
510  }
511 
514  : width(1.0f)
516  , cloud_intensity(0)
517  , dash_phase(0) {}
518 
524  BorderInfo(const BorderInfo& border_info) {
525  this->width = border_info.width;
526  this->style = border_info.style;
527  this->cloud_intensity = border_info.cloud_intensity;
528  this->dash_phase = border_info.dash_phase;
529  this->dashes = border_info.dashes;
530  }
531 
539  BorderInfo& operator = (const BorderInfo& border_info) {
540  this->width = border_info.width;
541  this->style = border_info.style;
542  this->cloud_intensity = border_info.cloud_intensity;
543  this->dash_phase = border_info.dash_phase;
544  this->dashes = border_info.dashes;
545  return *this;
546  }
547 
555  bool operator == (const BorderInfo& border_info) const {
556  if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
557  fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
558  fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
559  dashes.GetSize() != border_info.dashes.GetSize())
560  return false;
561  for (int i=0; i<dashes.GetSize(); i++) {
562  if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
563  return false;
564  }
565  return true;
566  }
567 
575  bool operator != (const BorderInfo& border_info) const{
576  if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
577  fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
578  fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
579  dashes.GetSize() != border_info.dashes.GetSize())
580  return true;
581  for (int i=0; i<dashes.GetSize(); i++) {
582  if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
583  return true;
584  }
585  return false;
586  }
587 
607  void Set(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
608  this->width = width;
609  this->style = style;
610  this->cloud_intensity = intensity;
611  this->dash_phase = dash_phase;
612  this->dashes = dashes;
613  }
614 
620  float width;
621 
627 
640 
646  float dash_phase;
647 
655 };
656 
667 class QuadPoints FS_FINAL : public Object {
668  public:
677  QuadPoints(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
678  this->first = first;
679  this->second = second;
680  this->third = third;
681  this->fourth = fourth;
682  }
683 
686 
692  QuadPoints(const QuadPoints& quad_points) {
693  first = quad_points.first;
694  second = quad_points.second;
695  third = quad_points.third;
696  fourth = quad_points.fourth;
697  }
698 
706  QuadPoints& operator = (const QuadPoints& quad_points) {
707  first = quad_points.first;
708  second = quad_points.second;
709  third = quad_points.third;
710  fourth = quad_points.fourth;
711  return *this;
712  }
713 
721  bool operator == (const QuadPoints& quad_points) const {
722  return (first == quad_points.first && second == quad_points.second &&
723  third == quad_points.third && fourth == quad_points.fourth);
724  }
725 
733  bool operator != (const QuadPoints& quad_points) const {
734  return (first != quad_points.first || second != quad_points.second ||
735  third != quad_points.third || fourth != quad_points.fourth);
736  }
737 
748  void Set(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
749  this->first = first;
750  this->second = second;
751  this->third = third;
752  this->fourth = fourth;
753  }
754 
763 };
764 
766 FSDK_DEFINE_ARRAY(QuadPointsArray, QuadPoints)
767 
768 
772 class IconFit FS_FINAL : public Object {
773  public:
778  typedef enum _ScaleWayType {
780  e_ScaleWayNone = 0,
782  e_ScaleWayAlways = 1,
784  e_ScaleWayBigger = 2,
786  e_ScaleWaySmaller = 3,
788  e_ScaleWayNever = 4
789  } ScaleWayType;
790 
791 
794  : scale_way_type(e_ScaleWayNone)
795  , is_proportional_scaling(false)
796  , horizontal_fraction(0)
797  , vertical_fraction(0)
798  , fit_bounds(false) {}
799 
824  IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
825  float vertical_fraction, bool fit_bounds)
826  : scale_way_type(type)
827  , is_proportional_scaling(is_proportional_scaling)
828  , horizontal_fraction(horizontal_fraction)
829  , vertical_fraction(vertical_fraction)
830  , fit_bounds(fit_bounds) {}
831 
837  IconFit(const IconFit& icon_fit)
838  : scale_way_type(icon_fit.scale_way_type)
839  , is_proportional_scaling(icon_fit.is_proportional_scaling)
840  , horizontal_fraction(icon_fit.horizontal_fraction)
841  , vertical_fraction(icon_fit.vertical_fraction)
842  , fit_bounds(icon_fit.fit_bounds) {}
843 
851  IconFit& operator = (const IconFit& icon_fit) {
852  scale_way_type = icon_fit.scale_way_type;
853  is_proportional_scaling = icon_fit.is_proportional_scaling;
854  horizontal_fraction = icon_fit.horizontal_fraction;
855  vertical_fraction = icon_fit.vertical_fraction;
856  fit_bounds = icon_fit.fit_bounds;
857  return *this;
858  }
859 
867  bool operator == (const IconFit& icon_fit) const {
868  return (scale_way_type == icon_fit.scale_way_type &&
869  is_proportional_scaling == icon_fit.is_proportional_scaling &&
870  fabs(horizontal_fraction - icon_fit.horizontal_fraction) <= FLT_EPSILON &&
871  fabs(vertical_fraction - icon_fit.vertical_fraction) <= FLT_EPSILON &&
872  fit_bounds == icon_fit.fit_bounds);
873  }
874 
882  bool operator != (const IconFit& icon_fit) const {
883  return (scale_way_type != icon_fit.scale_way_type ||
884  is_proportional_scaling != icon_fit.is_proportional_scaling ||
885  fabs(horizontal_fraction - icon_fit.horizontal_fraction) > FLT_EPSILON ||
886  fabs(vertical_fraction - icon_fit.vertical_fraction) > FLT_EPSILON ||
887  fit_bounds != icon_fit.fit_bounds);
888  }
889 
917  void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
918  float vertical_fraction, bool fit_bounds) {
919  this->scale_way_type = type;
920  this->is_proportional_scaling = is_proportional_scaling;
921  this->horizontal_fraction = horizontal_fraction;
922  this->vertical_fraction = vertical_fraction;
923  this->fit_bounds = fit_bounds;
924  }
925 
960 };
961 
994 class Annot : public Base {
995  public:
1001  typedef enum _Type {
1008  e_Note = 1,
1010  e_Link = 2,
1014  e_Line = 4,
1032  e_Stamp = 13,
1034  e_Caret = 14,
1036  e_Ink = 15,
1038  e_PSInk = 16,
1042  e_Sound = 18,
1044  e_Movie = 19,
1049  e_Widget = 20,
1051  e_Screen = 21,
1059  e_3D = 25,
1061  e_Popup = 26,
1063  e_Redact = 27,
1068  } Type;
1069 
1075  typedef enum _Flags {
1088  e_FlagHidden = 0x0002,
1096  e_FlagPrint = 0x0004,
1103  e_FlagNoZoom = 0x0008,
1110  e_FlagNoRotate = 0x0010,
1118  e_FlagNoView = 0x0020,
1127  e_FlagReadOnly = 0x0040,
1134  e_FlagLocked = 0x0080,
1148  } Flags;
1149 
1155  typedef enum _HighlightingMode {
1166  } HighlightingMode;
1167 
1173  typedef enum _Property {
1193  } Property;
1194 
1200  typedef enum _MKEntry {
1249  } MKEntry;
1250 
1256  typedef enum _MKIconCaptionRelation {
1272 
1278  typedef enum _AppearanceType {
1285  } AppearanceType;
1286 
1287 
1288  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1289  explicit Annot(FS_HANDLE handle);
1297  Annot(const PDFPage& page, objects::PDFDictionary* annot_dict);
1298 #ifndef __EMSCRIPTEN_RENDER__
1299 
1304  Annot(const Annot& annot);
1305 #endif
1306 
1307  Annot() {}
1308 #ifndef __EMSCRIPTEN_RENDER__
1309 
1316  Annot& operator = (const Annot& annot);
1317 #endif
1318 
1325  bool operator ==(const Annot& other) const;
1333  bool operator != (const Annot& other) const;
1334 #ifndef __EMSCRIPTEN_RENDER__
1335 
1336  virtual ~Annot();
1337 #endif
1338 
1345  bool IsEmpty() const;
1346 
1352  PDFPage GetPage() const;
1359  bool IsMarkup() const;
1365  Type GetType() const;
1371  int GetIndex() const;
1377  WString GetContent() const;
1391  void SetContent(const WString& content);
1398  DateTime GetModifiedDateTime() const;
1406  void SetModifiedDateTime(const DateTime& date_time);
1413  uint32 GetFlags() const;
1422  void SetFlags(uint32 flags);
1428  WString GetUniqueID() const;
1436  void SetUniqueID(const WString& unique_id);
1443  RectF GetRect() const;
1444 
1457  Matrix GetDisplayMatrix(const Matrix& page_display_matrix);
1458 
1468  bool Move(const RectF& rect);
1469 
1480  bool Move(const RectF& rect, bool is_reset_appearance);
1481 
1498  BorderInfo GetBorderInfo() const;
1499 
1517  void SetBorderInfo(const BorderInfo& border);
1526  RGB GetBorderColor() const;
1538  void SetBorderColor(RGB color);
1551  bool ResetAppearanceStream();
1552 
1570  bool ResetAppearanceStream(bool is_generate_new_appearance_obj);
1571 
1587  RectI GetDeviceRect(const Matrix& matrix);
1588 
1595 
1605  bool HasProperty(Property property) const;
1606 
1624  bool RemoveProperty(Property property);
1625 
1633 
1650  objects::PDFStream* GetAppearanceStream(AppearanceType type, const char* appearance_state = "") const;
1651 };
1652 
1654 FSDK_DEFINE_ARRAY(AnnotArray, Annot)
1655 
1656 
1657 class ShadingColor FS_FINAL : public Object {
1658  public:
1665  ShadingColor(ARGB firstcolor, ARGB secondcolor)
1666  : first_color(firstcolor)
1667  , second_color(secondcolor) {}
1668 
1671  : first_color(0xFFFFFFFF)
1672  , second_color(0xFFFFFFFF) {}
1673 
1679  ShadingColor(const ShadingColor& shading_color)
1680  : first_color(shading_color.first_color)
1681  , second_color(shading_color.second_color) {}
1682 
1690  ShadingColor& operator = (const ShadingColor& shading_color) {
1691  this->first_color = shading_color.first_color;
1692  this->second_color = shading_color.second_color;
1693  return *this;
1694  }
1695 
1703  bool operator == (const ShadingColor& shading_color) const {
1704  return (first_color == shading_color.first_color && second_color == shading_color.second_color);
1705  }
1706 
1714  bool operator != (const ShadingColor& shading_color) const {
1715  return (first_color != shading_color.first_color || second_color != shading_color.second_color);
1716  }
1717 
1726  void Set(ARGB firstcolor, ARGB secondcolor) {
1727  this->first_color = firstcolor;
1728  this->second_color = secondcolor;
1729  }
1730 
1735 };
1736 
1747  public:
1753  virtual void Release() = 0;
1762  virtual String GetProviderID() {
1763  return String();
1764  }
1774  return String();
1775  }
1785  virtual bool HasIcon(Annot::Type annot_type, const char* icon_name) {
1786  return false;
1787  }
1798  virtual bool CanChangeColor(Annot::Type annot_type, const char* icon_name) {
1799  return false;
1800  }
1801 #ifndef __EMSCRIPTEN_RENDER__
1802 
1812  virtual PDFPage GetIcon(Annot::Type annot_type, const char* icon_name, ARGB color);
1813 #endif
1814 
1828  virtual bool GetShadingColor(Annot::Type annot_type, const char* icon_name,
1829  RGB referenced_color, int shading_index, ShadingColor& out_shading_color) {
1830  return false;
1831  }
1842  virtual float GetDisplayWidth(Annot::Type annot_type, const char* icon_name) {
1843  return 0.0f;
1844  }
1855  virtual float GetDisplayHeight(Annot::Type annot_type, const char* icon_name) {
1856  return 0.0f;
1857  }
1858 
1859  protected:
1860  ~IconProviderCallback() {}
1861 };
1862 
1863 class Markup;
1865 FSDK_DEFINE_ARRAY(MarkupArray, Markup)
1866 
1867 class Note;
1869 FSDK_DEFINE_ARRAY(NoteArray, Note)
1870 
1871 
1888 class Markup : public Annot {
1889  public:
1895  typedef enum _StateModel {
1897  e_StateModelMarked = 1,
1899  e_StateModelReview = 2
1900  } StateModel;
1901 
1907  typedef enum _State {
1912  e_StateNone = 0,
1917  e_StateMarked = 1,
1922  e_StateUnmarked = 2,
1927  e_StateAccepted = 3,
1932  e_StateRejected = 4,
1937  e_StateCancelled = 5,
1942  e_StateCompleted = 6,
1947  e_StateDeferred = 7,
1952  e_StateFuture = 8
1953  } State;
1954 
1960  typedef enum _EndingStyle {
1962  e_EndingStyleNone = 0,
1964  e_EndingStyleSquare = 1,
1966  e_EndingStyleCircle = 2,
1968  e_EndingStyleDiamond = 3,
1970  e_EndingStyleOpenArrow = 4,
1976  e_EndingStyleClosedArrow = 5,
1978  e_EndingStyleButt = 6,
1980  e_EndingStyleROpenArrow = 7,
1982  e_EndingStyleRClosedArrow = 8,
1984  e_EndingStyleSlash = 9
1985  } EndingStyle;
1986 
1992  typedef enum _MeasureType {
1994  e_MeasureTypeX = 0,
1996  e_MeasureTypeY = 1,
1998  e_MeasureTypeD = 2,
2000  e_MeasureTypeA = 3,
2002  e_MeasureTypeT = 4,
2004  e_MeasureTypeS = 5
2005  } MeasureType;
2006 
2007 
2013  explicit Markup(const Annot& annot);
2014  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2015  explicit Markup(FS_HANDLE handle);
2017  Markup() {}
2018 
2020  ~Markup() {}
2021 
2039  Popup GetPopup();
2056  void SetPopup(const Popup& popup);
2057 
2064  bool RemovePopup();
2065 
2073  WString GetTitle() const;
2074 
2084  void SetTitle(const WString& title);
2085 
2091  WString GetSubject() const;
2092 
2100  void SetSubject(const WString& subject);
2101 
2110  float GetOpacity() const;
2111 
2124  void SetOpacity(float opacity);
2125 
2147  String GetIntent() const;
2148 
2184  void SetIntent(const String& intent);
2185 
2192  DateTime GetCreationDateTime() const;
2193 
2201  void SetCreationDateTime(const DateTime& date_time);
2202 
2208  int GetReplyCount();
2209 
2218  Note GetReply(int index) const;
2219 
2225  Note AddReply();
2226 
2237  bool RemoveReply(int index);
2238 
2244  bool RemoveAllReplies();
2245 
2262  bool IsGrouped();
2263 
2282  Markup GetGroupHeader();
2283 
2300  MarkupArray GetGroupElements();
2301 
2317  bool Ungroup();
2318 
2334  NoteArray GetStateAnnots(StateModel model);
2335 
2372  Note AddStateAnnot(const WString& title, StateModel model, State state);
2373 
2383  bool RemoveAllStateAnnots();
2391  int32 GetRichTextCount();
2392 
2403  WString GetRichTextContent(int32 index);
2404 
2416  void SetRichTextContent(int32 index, const WString& content);
2417 
2428  RichTextStyle GetRichTextStyle(int32 index);
2429 
2443  void SetRichTextStyle(int32 index, const RichTextStyle& style);
2444 
2457  void AddRichText(const WString& content, const RichTextStyle& style);
2458 
2475  void InsertRichText(int32 index, const WString& content, const RichTextStyle& style);
2476 
2487  void RemoveRichText(int index);
2488 
2501  void SetBorderOpacity(float opacity);
2502 
2509  float GetBorderOpacity() const;
2510 
2523  void SetFillOpacity(float opacity);
2524 
2531  float GetFillOpacity() const;
2532 };
2533 
2556 class Note FS_FINAL : public Markup {
2557  public:
2559  Note() {}
2565  explicit Note(const Annot& annot);
2566  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2567  explicit Note(FS_HANDLE handle);
2569  ~Note() {}
2570 
2583  bool GetOpenStatus() const;
2598  void SetOpenStatus(bool status);
2610  String GetIconName() const;
2628  void SetIconName(const char* icon_name);
2638  Markup GetReplyTo();
2645  bool IsStateAnnot();
2646 
2659 
2671  State GetState();
2672 
2696  void SetState(State state);
2697 
2698 };
2699 
2711 class TextMarkup: public Markup {
2712  public:
2720  explicit TextMarkup(const Annot& annot);
2723 
2758  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2759 };
2760 
2777 class Highlight FS_FINAL : public TextMarkup {
2778  public:
2786  explicit Highlight(const Annot& annot);
2789 };
2790 
2807 class Underline FS_FINAL : public TextMarkup {
2808  public:
2816  explicit Underline(const Annot& annot);
2819 };
2820 
2837 class StrikeOut FS_FINAL : public TextMarkup {
2838  public:
2846  explicit StrikeOut(const Annot& annot);
2849 };
2850 
2867 class Squiggly FS_FINAL : public TextMarkup {
2868  public:
2876  explicit Squiggly(const Annot& annot);
2879 };
2880 
2894 class Link FS_FINAL : public Annot {
2895  public:
2897  Link() {}
2903  explicit Link(const Annot& annot);
2904  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2905  explicit Link(FS_HANDLE handle);
2907  ~Link() {}
2908 
2941  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2942 
2951 
2962 
2970 
2985  void SetAction(const actions::Action& action);
2986 
2992  bool RemoveAction();
2993 
3003 };
3004 
3019 class Square FS_FINAL : public Markup {
3020  public:
3022  Square() {}
3028  explicit Square(const Annot& annot);
3030  ~Square() {}
3031 
3038  RGB GetFillColor() const;
3039 
3047  void SetFillColor(RGB fill_color);
3048 
3058  RectF GetInnerRect() const;
3070  void SetInnerRect(const RectF& inner_rect);
3071 
3085  void SetMeasureRatio(const char* ratio);
3086 
3097 
3108 
3121  void SetMeasureUnit(MeasureType measure_type, const char* unit);
3122 
3134  String GetMeasureUnit(MeasureType measure_type);
3135 
3147  WString GetMeasureUnitW(MeasureType measure_type);
3148 
3161  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3162 
3174  float GetMeasureConversionFactor(MeasureType measure_type);
3175 };
3176 
3191 class Circle FS_FINAL : public Markup {
3192  public:
3194  Circle() {}
3200  explicit Circle(const Annot& annot);
3202  ~Circle() {}
3203 
3210  RGB GetFillColor() const;
3211 
3222  void SetFillColor(RGB fill_color);
3223 
3233  RectF GetInnerRect() const;
3234 
3248  void SetInnerRect(const RectF& inner_rect);
3249 
3263  void SetMeasureRatio(const char* ratio);
3264 
3275 
3286 
3299  void SetMeasureUnit(MeasureType measure_type, const char* unit);
3300 
3312  String GetMeasureUnit(MeasureType measure_type);
3313 
3325  WString GetMeasureUnitW(MeasureType measure_type);
3326 
3339  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3340 
3352  float GetMeasureConversionFactor(MeasureType measure_type);
3353 };
3354 
3374 class FreeText FS_FINAL : public Markup {
3375  public:
3383  explicit FreeText(const Annot& annot);
3384 
3387 
3398  RGB GetFillColor() const;
3399 
3413  void SetFillColor(RGB fill_color);
3414 
3430 
3449  void SetAlignment(common::Alignment alignment);
3450 
3461  RectF GetInnerRect() const;
3462 
3477  void SetInnerRect(const RectF& inner_rect);
3478 
3488 
3511  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
3512 
3524 
3539  void SetCalloutLineEndingStyle(EndingStyle ending_style);
3540 
3555 
3578  void SetCalloutLinePoints(const PointFArray& point_array);
3579 
3595  void SetTextMatrix(const Matrix& text_matrix);
3596 
3608  Matrix GetTextMatrix() const;
3609 
3617 
3632  void SetRotation(common::Rotation rotation);
3633 
3646  void Rotate(common::Rotation rotation);
3647 
3665  void AllowTextOverflow(bool is_text_overflow);
3666 };
3667 
3686 class Line FS_FINAL : public Markup {
3687  public:
3693  typedef enum _CapPos {
3698  } CapPos;
3699 
3700 
3702  Line() {}
3708  explicit Line(const Annot& annot);
3710  ~Line() {}
3711 
3733  void SetLineStartStyle(EndingStyle ending_style);
3742  EndingStyle GetLineEndStyle() const;
3755  void SetLineEndStyle(EndingStyle ending_style);
3756 
3767  RGB GetStyleFillColor() const;
3768 
3782  void SetStyleFillColor(RGB color);
3783 
3792  PointF GetStartPoint() const;
3805  void SetStartPoint(const PointF& point);
3806 
3815  PointF GetEndPoint() const;
3828  void SetEndPoint(const PointF& point);
3829 
3838  bool HasCaption() const;
3851  void EnableCaption(bool cap);
3852 
3880  void SetCaptionPositionType(CapPos cap_position);
3893  Offset GetCaptionOffset() const;
3909  void SetCaptionOffset(const Offset& offset);
3910 
3925  float GetLeaderLineLength() const;
3943  void SetLeaderLineLength(float length);
3953  float GetLeaderLineExtensionLength() const;
3966  void SetLeaderLineExtensionLength(float extension_length);
3967 
3978  float GetLeaderLineOffset() const;
3992  void SetLeaderLineOffset(float offset);
3993 
4007  void SetMeasureRatio(const String& ratio);
4008 
4019 
4030 
4043  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4044 
4056  String GetMeasureUnit(MeasureType measure_type);
4057 
4069  WString GetMeasureUnitW(MeasureType measure_type);
4070 
4083  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4084 
4096  float GetMeasureConversionFactor(MeasureType measure_type);
4097 };
4098 
4116 class Ink FS_FINAL : public Markup {
4117  public:
4119  Ink() {}
4125  explicit Ink(const Annot& annot);
4127  ~Ink() {}
4155 
4188  void SetInkList(const common::Path& ink_list);
4189 
4201  void EnableUseBezier(bool use_bezier);
4202 
4203 };
4204 
4229 class Stamp FS_FINAL : public Markup {
4230  public:
4232  Stamp() {}
4238  explicit Stamp(const Annot& annot);
4239 #ifndef __EMSCRIPTEN_RENDER__
4240 
4241  ~Stamp();
4242 #endif
4243 
4254  String GetIconName() const;
4277  void SetIconName(const char* icon_name);
4288  void SetBitmap(const common::Bitmap& bitmap);
4289 
4312  void SetImage(const common::Image& image, int frame_index, int compress);
4313 
4324  void SetRotation(int angle);
4325 
4331  int GetRotation();
4332 
4342  void Rotate(int angle);
4343 };
4344 
4357 class Screen FS_FINAL : public Annot {
4358  public:
4360  Screen() {}
4366  explicit Screen(const Annot& annot);
4368  virtual ~Screen() {}
4369 
4392  void SetImage(const common::Image& image, int frame_index, int compress);
4393 
4401 
4413 
4421 
4434  void SetRotation(common::Rotation rotate);
4435 
4443 
4452  float GetOpacity() const;
4465  void SetOpacity(float opacity);
4466 
4472  WString GetTitle() const;
4480  void SetTitle(const WString& title);
4481 
4515  void SetAction(const actions::Action& action);
4524  void RemoveAction();
4525 };
4526 
4545 class Polygon FS_FINAL : public Markup {
4546  public:
4548  Polygon() {}
4554  explicit Polygon(const Annot& annot);
4565  RGB GetFillColor() const;
4566 
4578  void SetFillColor(RGB fill_color);
4579 
4589 
4601  void SetVertexes(const PointFArray& vertexes);
4602 
4616  void SetMeasureRatio(const String& ratio);
4617 
4628 
4639 
4652  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4653 
4665  String GetMeasureUnit(MeasureType measure_type);
4666 
4678  WString GetMeasureUnitW(MeasureType measure_type);
4679 
4692  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4693 
4705  float GetMeasureConversionFactor(MeasureType measure_type);
4706 };
4707 
4727 class PolyLine FS_FINAL : public Markup {
4728  public:
4736  explicit PolyLine(const Annot& annot);
4749  RGB GetStyleFillColor() const;
4761  void SetStyleFillColor(RGB fill_color);
4762 
4772 
4784  void SetVertexes(const PointFArray& vertexes);
4807  void SetLineStartStyle(EndingStyle starting_style);
4816  EndingStyle GetLineEndStyle() const;
4830  void SetLineEndStyle(EndingStyle ending_style);
4831 
4845  void SetMeasureRatio(const String& ratio);
4846 
4857 
4868 
4881  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4882 
4894  String GetMeasureUnit(MeasureType measure_type);
4895 
4907  WString GetMeasureUnitW(MeasureType measure_type);
4908 
4921  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4922 
4934  float GetMeasureConversionFactor(MeasureType measure_type);
4935 };
4936 
4949 class Caret FS_FINAL : public Markup {
4950  public:
4952  Caret() {}
4958  explicit Caret(const Annot& annot);
4960  ~Caret() {}
4961 
4971  RectF GetInnerRect() const;
4985  void SetInnerRect(const RectF& inner_rect);
4986 };
4987 
5000 class FileAttachment FS_FINAL : public Markup {
5001  public:
5009  explicit FileAttachment(const Annot& annot);
5012 
5020  bool SetFileSpec(const FileSpec& file_spec);
5021 
5029 
5040  String GetIconName() const;
5041 
5057  void SetIconName(const char* icon_name);
5058 };
5059 
5069 class Popup FS_FINAL : public Annot {
5070  public:
5072  Popup() {}
5078  explicit Popup(const Annot& annot);
5079  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5080  explicit Popup(FS_HANDLE handle);
5082  ~Popup() {}
5083 
5096  bool GetOpenStatus() const;
5111  void SetOpenStatus(bool status);
5112 
5120  Markup GetParent();
5121 };
5122 #ifndef __FSDK_NO_PSINK__
5123 
5142 class PSInk FS_FINAL : public Annot {
5143  public:
5145  PSInk() {}
5151  explicit PSInk(const Annot& annot);
5152  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5153  explicit PSInk(FS_HANDLE handle);
5155  ~PSInk() {}
5156 
5157 };
5158 #endif
5159 
5172 class Widget FS_FINAL : public Annot {
5173  public:
5179  typedef enum _LineSpacingStyle {
5190  } LineSpacingStyle;
5191 
5192 
5194  Widget() {}
5200  explicit Widget(const Annot& annot);
5201  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5202  explicit Widget(FS_HANDLE handle);
5203 #ifndef __EMSCRIPTEN_RENDER__
5204 
5205  ~Widget();
5206 #endif
5207 
5213 
5220 
5231 
5244 
5255 
5279  void SetAction(const actions::Action& action);
5280 
5289  void RemoveAction();
5290 
5302  bool HasMKEntry(MKEntry mk_entry);
5303 
5315  void RemoveMKEntry(MKEntry mk_entry);
5316 
5330 
5343  void SetMKRotation(common::Rotation rotation);
5344 
5355  RGB GetMKBorderColor() const;
5356 
5367  void SetMKBorderColor(RGB color);
5368 
5379  RGB GetMKBackgroundColor() const;
5380 
5391  void SetMKBackgroundColor(RGB color);
5392 
5406  WString GetMKNormalCaption() const;
5407 
5421  void SetMKNormalCaption(const wchar_t* caption);
5422 
5437  WString GetMKRolloverCaption() const;
5438 
5453  void SetMKRolloverCaption(const wchar_t* caption);
5454 
5468  WString GetMKDownCaption() const;
5469 
5483  void SetMKDownCaption(const wchar_t* caption);
5484 
5498 
5512  void SetMKNormalIconBitmap(const common::Bitmap& bitmap);
5513 
5529  void SetMKNormalIconImage(const common::Image& image, int frame_index);
5530 
5545 
5560  void SetMKRolloverIconBitmap(const common::Bitmap& bitmap);
5561 
5578  void SetMKRolloverIconImage(const common::Image& image, int frame_index);
5579 
5593 
5607  void SetMKDownIconBitmap(const common::Bitmap& bitmap);
5608 
5624  void SetMKDownIconImage(const common::Image& image, int frame_index);
5625 
5640  IconFit GetMKIconFit() const;
5641 
5659  void SetMKIconFit(const IconFit& icon_fit);
5660 
5675 
5692 
5700  void SetAppearanceState(const String& appearance_state);
5701 
5707  String GetAppearanceState() const;
5708 
5715 
5727  LineSpacingStyle GetLineSpacing(float& line_spacing_value);
5728 
5744  void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value);
5745 
5746 #ifdef _SUPPORTWEBSDK_
5747  //Set push button icon form icon stream. stream is from doc::createIcon.
5748  //face: 0: normal, 1: down, 2: roller
5749  void SetButtonIcon(objects::PDFStream* icon, int face);
5750 #endif
5751 };
5752 
5769 class Redact FS_FINAL : public Markup {
5770  public:
5772  Redact() {}
5778  explicit Redact(const Annot& annot);
5779  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5780  explicit Redact(FS_HANDLE handle);
5781 #ifndef __EMSCRIPTEN_RENDER__
5782 
5783  ~Redact();
5784 #endif
5785 
5799 
5818  void SetQuadPoints(const QuadPointsArray& quad_points_array);
5819 
5826  RGB GetFillColor() const;
5834  void SetFillColor(RGB fill_color);
5835 
5842  RGB GetApplyFillColor() const;
5843 
5851  void SetApplyFillColor(RGB fill_color);
5852 
5858  WString GetOverlayText() const;
5859 
5867  void SetOverlayText(const WString& overlay_text);
5868 
5874  bool IsOverlayTextRepeated();
5875 
5884  void EnableRepeatOverlayText(bool is_to_repeat_overlay_text);
5885 
5895 
5909 
5915  void EnableAutoFontSize();
5916 
5926 
5949  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
5950 
5963  bool Apply();
5964 };
5965 
5975 class Sound FS_FINAL : public Markup{
5976  public:
5982  typedef enum _SampleEncodingFormat {
5992 
5993 
5995  Sound() {}
5996 
6002  explicit Sound(const Annot& annot);
6003 
6004  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
6005  explicit Sound(FS_HANDLE handle);
6006 
6007 #ifndef __EMSCRIPTEN_RENDER__
6008 
6009  ~Sound();
6010 #endif
6011 
6024 
6030  float GetSamplingRate() const;
6031 
6037  int GetChannelCount() const;
6038 
6044  int GetBits() const;
6045 
6053 
6059  String GetCompressionFormat() const;
6060 
6074  FileSpec GetFileSpec() const;
6075 };
6076 
6092 class PagingSeal FS_FINAL : public Annot {
6093  public:
6095  PagingSeal(const Annot& annot);
6096 
6098  ~PagingSeal();
6099 
6106 
6107  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
6108  explicit PagingSeal(FS_HANDLE handle);
6109 };
6110 
6111 } // namespace annots
6112 } // namespace pdf
6113 } // namespace foxit
6114 
6115 #endif // FS_ANNOT_H_
6116 
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:654
Annotation flag: read only.
Definition: fs_annot.h:1127
void SetFillColor(RGB fill_color)
Set fill color.
Definition: fs_annot.h:1746
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:391
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:1216
~Line()
Destructor.
Definition: fs_annot.h:3710
Square()
Constructor.
Definition: fs_annot.h:3022
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:3386
IconFit()
Constructor.
Definition: fs_annot.h:793
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:310
WString GetMKNormalCaption() const
Get the normal caption string in the MK dictionary.
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1907
Definition: fs_annot.h:1657
Definition: fs_annot.h:2711
Definition: fs_annot.h:2807
~Popup()
Destructor.
Definition: fs_annot.h:5082
Line spacing style: auto line spacing.
Definition: fs_annot.h:5189
String GetAppearanceState() const
Get the annotation's appearance state, which selects the applicable appearance stream from an appeara...
Definition: fs_annot.h:4357
Redact()
Constructor.
Definition: fs_annot.h:5772
Definition: fs_annot.h:201
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:748
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:1256
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1028
Annotation flag: no view.
Definition: fs_annot.h:1118
RectF GetInnerRect() const
Get the inner rectangle.
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
Definition: fs_annot.h:5000
Markup()
Constructor.
Definition: fs_annot.h:2017
PDFPage GetPage() const
Get the related PDF page.
WString GetContent() const
Get content.
Twos-complement values.
Definition: fs_annot.h:5986
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1040
Annot()
Constructor.
Definition: fs_annot.h:1307
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5984
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:1236
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
float width
Border width, in points.
Definition: fs_annot.h:620
Annotation type: free text annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1012
State GetState()
Get the state.
StrikeOut()
Constructor.
Definition: fs_annot.h:2840
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1061
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:4730
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1732
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:1654
void SetOverlayText(const WString &overlay_text)
Set the overlay text.
Screen()
Constructor.
Definition: fs_annot.h:4360
Sound()
Constructor.
Definition: fs_annot.h:5995
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:824
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:1248
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:212
Definition: fs_annot.h:772
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:1096
Definition: fs_basictypes.h:476
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...
float word_space
The word space. It should not be negative value for table generator. It is only used in pdf::PDFPage:...
Definition: fs_annot.h:432
common::Font font
A font used in rich text style. It should be a valid font object.
Definition: fs_annot.h:380
BorderInfo(const BorderInfo &border_info)
Constructor, with another border information object.
Definition: fs_annot.h:524
RichTextStyle()
Constructor.
Definition: fs_annot.h:251
Definition: fs_annot.h:440
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:447
bool HasMKEntry(MKEntry mk_entry)
Check if a specified entry exists in the MK dictionary.
~Highlight()
Destructor.
Definition: fs_annot.h:2788
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:1828
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1773
Definition: fs_annot.h:3019
No caption; icon only.
Definition: fs_annot.h:1260
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:1992
Annotation type: unknown.
Definition: fs_annot.h:1003
Caption above the icon.
Definition: fs_annot.h:1264
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
PagingSeal(const Annot &annot)
Constructor.
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:1001
Annotation type: redact annotation.
Definition: fs_annot.h:1063
void SetIconName(const char *icon_name)
Set icon name.
Definition: fs_annot.h:1888
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:1280
Definition: fs_annot.h:766
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1075
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:98
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:50
Annotation type: square annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1016
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:639
~Caret()
Destructor.
Definition: fs_annot.h:4960
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:2810
void SetMKIconCaptionRelation(MKIconCaptionRelation relation)
Set the relation of icon and caption in the MK dictionary.
Annotation property: creation date.
Definition: fs_annot.h:1180
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_annot.h:607
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:5172
RGB GetFillColor() const
Get fill color.
Definition: fs_annot.h:4545
WIDE STRING CLASS.
Definition: fx_string.h:1461
Corner mark style: subscript.
Definition: fs_annot.h:214
void SetOpenStatus(bool status)
Set open status.
Definition: fs_annot.h:2556
void SetAlignment(common::Alignment alignment)
Set alignment value.
Annotation type: movie annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1044
Annotation property: modified date.
Definition: fs_annot.h:1175
actions::Action GetAction()
Get action.
DateTime GetModifiedDateTime() const
Get last modified date time.
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1226
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:4368
void SetIconName(const char *icon_name)
Set icon name.
Caption below the icon.
Definition: fs_annot.h:1262
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:406
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:555
FileSpec GetFileSpec()
Get the file specification.
Annotation flag: no rotate.
Definition: fs_annot.h:1110
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:1051
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:721
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:268
~StrikeOut()
Destructor.
Definition: fs_annot.h:2848
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:931
~PolyLine()
Destructor.
Definition: fs_annot.h:4738
DefaultAppearance()
Constructor.
Definition: fs_annot.h:88
Annotation property: fill color.
Definition: fs_annot.h:1192
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:81
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1679
Annotation property: border color.
Definition: fs_annot.h:1186
Widget()
Constructor.
Definition: fs_annot.h:5194
float vertical_fraction
The vertical fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:952
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:2780
float horizontal_fraction
The horizontal fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:946
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:61
Annotation flag: toggle no view.
Definition: fs_annot.h:1140
void SetFillColor(RGB fill_color)
Set fill color.
~Underline()
Destructor.
Definition: fs_annot.h:2818
Definition: fs_annot.h:4229
Definition: fs_annot.h:3695
RGB text_color
Text color. Format: 0xRRGGBB.
Definition: fs_annot.h:396
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:5769
FreeText()
Constructor.
Definition: fs_annot.h:3377
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:539
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:917
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1665
Border style: Solid.
Definition: fs_annot.h:449
~Note()
Destructor.
Definition: fs_annot.h:2569
Annotation type: rich media annotation.
Definition: fs_annot.h:1065
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:1103
Annotation's rollover appearance.
Definition: fs_annot.h:1282
PagingSealSignature GetPagingSealSignature()
Get the associated paging seal signature.
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:837
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:1200
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
float char_space
The char space. It should not be negative value for table generator. It is only used in pdf::PDFPage:...
Definition: fs_annot.h:427
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:1284
uint32 flags
Flags to indicate which properties of default appearance are meaningful.
Definition: fs_annot.h:176
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1734
μ-law-encoded samples
Definition: fs_annot.h:5988
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
Definition: fs_annot.h:3191
Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
Definition: fs_annot.h:1159
Line()
Constructor.
Definition: fs_annot.h:3702
PointF GetEndPoint() const
Get the end point.
Annotation type: polygon annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1020
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:469
int GetChannelCount() const
Get the count of sound channels.
Circle()
Constructor.
Definition: fs_annot.h:3194
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:2091
Highlighting mode: Outline, which is to invert the annotation's border.
Definition: fs_annot.h:1161
common::Font font
A font for default appearance. It should be a valid font object when it is useful.
Definition: fs_annot.h:182
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1726
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:733
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:940
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:2837
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:762
Popup()
Constructor.
Definition: fs_annot.h:5072
Definition: fs_annot.h:4949
Definition: fs_annot.h:5142
Annot & operator=(const Annot &annot)
Assign operator.
Annotation type: widget annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1049
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:1008
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:1895
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:2878
void SetAction(const actions::Action &action)
Set action.
~Polygon()
Destructor.
Definition: fs_annot.h:4556
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1036
Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1010
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1204
bool fit_bounds
A boolean value that indicates whether to scale button appearance to fit fully within bounds or not.
Definition: fs_annot.h:959
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:758
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:57
RGB GetFillColor() const
Get fill color.
Definition: fs_common.h:2060
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:1960
Definition: fs_annot.h:4116
RGB GetMKBorderColor() const
Get the border color in the MK dictionary.
Caret()
Constructor.
Definition: fs_annot.h:4952
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:778
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:575
Annotation flag: locked.
Definition: fs_annot.h:1134
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:1067
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
~Ink()
Destructor.
Definition: fs_annot.h:4127
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:1038
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:706
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:3697
bool operator !=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:331
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1231
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:412
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:225
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Border style: Underline.
Definition: fs_annot.h:462
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:1173
Annotation flag: invisible.
Definition: fs_annot.h:1082
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:1055
float text_size
Text size. It should not be negative value. 0 means text will not be shown.
Definition: fs_annot.h:385
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:5181
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Constructor, with parameters.
Definition: fs_annot.h:677
Matrix GetTextMatrix() const
Get matrix in default appearance data for text in current free text annotation.
Definition: fs_annot.h:1865
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:5185
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:1022
Ink()
Constructor.
Definition: fs_annot.h:4119
void Set(const common::Font &font, float text_size, common::Alignment text_alignment, RGB text_color, bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style, float char_space, float word_space)
Set value.
Definition: fs_annot.h:355
RichTextStyle(const common::Font &font, float text_size, common::Alignment text_alignment, RGB text_color, bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style, float char_space, float word_space)
Constructor, with parameters.
Definition: fs_annot.h:236
Caption overlaid directly on the icon.
Definition: fs_annot.h:1270
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:94
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:760
float text_size
Text size for default appearance.
Definition: fs_annot.h:191
Definition: fs_annot.h:3374
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:411
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1165
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:443
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1053
TextMarkup()
Constructor.
Definition: fs_annot.h:2714
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:1157
Caption to the right of the icon.
Definition: fs_annot.h:1266
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.
Definition: fs_action.h:741
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:1798
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:111
void SetOpacity(float opacity)
Set opacity value.
PointF first
First point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:756
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1155
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
FileAttachment()
Constructor.
Definition: fs_annot.h:5003
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1024
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:5990
Definition: fs_annot.h:994
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:692
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:4548
Annotation type: sound annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1042
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:1030
Definition: fs_common.h:1428
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:1241
PSInk()
Constructor.
Definition: fs_annot.h:5145
Corner mark style: none.
Definition: fs_annot.h:210
Foxit namespace.
Definition: fs_pdf3d.h:27
Left alignment.
Definition: fs_common.h:96
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:1785
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1026
Definition: fs_annot.h:1869
~PSInk()
Destructor.
Definition: fs_annot.h:5155
Definition: fs_action.h:418
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:197
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1202
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:1014
Squiggly()
Constructor.
Definition: fs_annot.h:2870
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:126
Border style: Cloudy.
Definition: fs_annot.h:483
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:139
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:1278
Indicates property font of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:59
float dash_phase
Dash phase.
Definition: fs_annot.h:646
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:422
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:626
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:1034
~Square()
Destructor.
Definition: fs_annot.h:3030
String GetMeasureRatio()
Get the scale ratio string for measuring.
Definition: fs_annot.h:5069
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:1059
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
Border style: Inset.
Definition: fs_annot.h:476
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:416
No icon; captin only.
Definition: fs_annot.h:1258
void SetBorderInfo(const BorderInfo &border)
Set border information.
CornerMarkStyle
Enumeration for corner mark style.
Definition: fs_annot.h:208
~Circle()
Destructor.
Definition: fs_annot.h:3202
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:4727
#define NULL
The null-pointer value.
Definition: fx_system.h:792
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
BorderInfo()
Constructor.
Definition: fs_annot.h:513
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:1057
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:5982
void Set(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Set value.
Definition: fs_annot.h:162
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
Definition: fs_annot.h:3686
RGB GetFillColor() const
Get fill color.
void SetRotation(int angle)
Set rotation angle (in clockwise).
~FileAttachment()
Destructor.
Definition: fs_annot.h:5011
LineSpacingStyle
Enumeration for line spacing style.
Definition: fs_annot.h:5179
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:401
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
Definition: fs_annot.h:667
RGB GetBorderColor() const
Get border color.
Definition: fs_annot.h:2867
String GetIconName() const
Get icon name.
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
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:1842
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:1855
Line spacing style: one and half times line spacing.
Definition: fs_annot.h:5183
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1018
Header file for destination and action related definitions and classes.
WString GetTitle() const
Get title of current screen annotation.
Caption to the left of the icon.
Definition: fs_annot.h:1268
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:3693
Indicates property text size of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:63
Note()
Constructor.
Definition: fs_annot.h:2559
Stamp()
Constructor.
Definition: fs_annot.h:4232
ShadingColor()
Constructor.
Definition: fs_annot.h:1670
virtual String GetProviderID()
A callback function used to get provider ID.
Definition: fs_annot.h:1762
~Markup()
Destructor.
Definition: fs_annot.h:2020
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
Definition: fs_annot.h:2777
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1211
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1221
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
~TextMarkup()
Destructor.
Definition: fs_annot.h:2722
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:1206
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:6092
RectF GetRect() const
Get rectangle, in PDF coordinate system.
QuadPoints()
Constructor.
Definition: fs_annot.h:685
Annotation flag: locked contents.
Definition: fs_annot.h:1147
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1032
Definition: fs_image.h:448
Annotation flag: hidden.
Definition: fs_annot.h:1088
Definition: fs_annot.h:5975
Line spacing style: exact value line spacing.
Definition: fs_annot.h:5187
Border style: Dashed.
Definition: fs_annot.h:456
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:288
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:1163
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_annot.h:504