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 
foxit::pdf::annots::Annot::e_Caret
Annotation type: caret annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1034
foxit::pdf::annots::Screen
Definition: fs_annot.h:4357
foxit::pdf::annots::Line::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
foxit::pdf::annots::Annot::e_Sound
Annotation type: sound annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1042
foxit::pdf::annots::FileAttachment::~FileAttachment
~FileAttachment()
Destructor.
Definition: fs_annot.h:5011
foxit::pdf::annots::Popup
Definition: fs_annot.h:5069
foxit::pdf::annots::Annot::e_StrikeOut
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1030
foxit::pdf::annots::Redact::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::interform::Control
Definition: fs_pdfform.h:1236
foxit::pdf::annots::ShadingColor
Definition: fs_annot.h:1657
foxit::pdf::annots::PolyLine::GetStyleFillColor
RGB GetStyleFillColor() const
Get fill color for some line ending styles.
foxit::pdf::annots::Annot::e_Watermark
Annotation type: watermark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1057
foxit::pdf::annots::FreeText::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
foxit::pdf::annots::PolyLine::GetLineEndStyle
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
foxit::pdf::annots::Widget::SetMKNormalIconBitmap
void SetMKNormalIconBitmap(const common::Bitmap &bitmap)
Set a bitmap as normal icon in the MK dictionary.
foxit::pdf::annots::Line::SetLeaderLineExtensionLength
void SetLeaderLineExtensionLength(float extension_length)
Set the length of leader line extension.
foxit::pdf::annots::Annot::GetDict
objects::PDFDictionary * GetDict() const
Get annotation's dictionary object.
foxit::pdf::annots::Sound::e_SampleEncodingFormatSigned
Twos-complement values.
Definition: fs_annot.h:5986
foxit::pdf::annots::Note::GetReplyTo
Markup GetReplyTo()
Get the markup annotation, which current note annotation is in reply to.
foxit::pdf::annots::Note::~Note
~Note()
Destructor.
Definition: fs_annot.h:2569
foxit::pdf::annots::Annot::e_MKRelationCaptionAboveIcon
Caption above the icon.
Definition: fs_annot.h:1264
foxit::pdf::annots::FileAttachment::FileAttachment
FileAttachment()
Constructor.
Definition: fs_annot.h:5003
CFX_ArrayTemplate::GetSize
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1360
foxit::pdf::annots::Annot::e_Redact
Annotation type: redact annotation.
Definition: fs_annot.h:1063
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor()
Constructor.
Definition: fs_annot.h:1670
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
foxit::pdf::annots::Widget::SetMKDownCaption
void SetMKDownCaption(const wchar_t *caption)
Set the down caption string in the MK dictionary.
foxit::pdf::annots::Annot::GetIndex
int GetIndex() const
Get the index of current annotation in the page which current annotation belongs to.
foxit::pdf::annots::Polygon::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Annot::e_Square
Annotation type: square annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1016
foxit::pdf::annots::Caret::GetInnerRect
RectF GetInnerRect() const
Get the inner rectangle.
foxit::pdf::annots::Widget::SetMKIconFit
void SetMKIconFit(const IconFit &icon_fit)
Set the icon fit information in the MK dictionary.
foxit::pdf::annots::Square::SetMeasureRatio
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
foxit::pdf::FileSpec
Definition: fs_filespec.h:38
foxit::pdf::annots::Widget::GetMKRolloverCaption
WString GetMKRolloverCaption() const
Get the rollover caption string in the MK dictionary.
foxit::pdf::annots::Note::SetIconName
void SetIconName(const char *icon_name)
Set icon name.
foxit::pdf::annots::Note
Definition: fs_annot.h:2556
foxit::pdf::annots::Circle::Circle
Circle()
Constructor.
Definition: fs_annot.h:3194
foxit::pdf::annots::Annot::GetType
Type GetType() const
Get actual annotation type of current annotation.
foxit::pdf::annots::Popup::~Popup
~Popup()
Destructor.
Definition: fs_annot.h:5082
foxit::pdf::annots::Line::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Underline::~Underline
~Underline()
Destructor.
Definition: fs_annot.h:2818
foxit::pdf::annots::FileAttachment::GetIconName
String GetIconName() const
Get icon name.
foxit::pdf::annots::Circle::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::actions::JavaScriptAction
Definition: fs_action.h:741
foxit::pdf::annots::QuadPoints::third
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:760
foxit::pdf::annots::FreeText::AllowTextOverflow
void AllowTextOverflow(bool is_text_overflow)
Decide whether to allow the text of freetext to overflow or not.
foxit::pdf::annots::Stamp::SetIconName
void SetIconName(const char *icon_name)
Set icon name.
foxit::pdf::annots::Annot::e_MKEntryBackgroundColor
Background color entry. "BG" in MK dictionary.
Definition: fs_annot.h:1206
foxit::pdf::actions::Action
Definition: fs_action.h:418
foxit::pdf::annots::Annot::SetModifiedDateTime
void SetModifiedDateTime(const DateTime &date_time)
Set last modified date time.
foxit::DateTime
Definition: fs_basictypes.h:476
foxit::pdf::annots::Annot::e_3D
Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1059
foxit::pdf::annots::Annot::GetRect
RectF GetRect() const
Get rectangle, in PDF coordinate system.
foxit::pdf::annots::Annot::e_FlagLockedContents
Annotation flag: locked contents.
Definition: fs_annot.h:1147
foxit::pdf::annots::Annot
Definition: fs_annot.h:994
foxit::pdf::annots::Annot::e_FlagHidden
Annotation flag: hidden.
Definition: fs_annot.h:1088
foxit::pdf::annots::Caret::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
foxit::pdf::annots::Redact::GetDefaultAppearance
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
foxit::pdf::annots::Annot::e_MKRelationNoIcon
No icon; captin only.
Definition: fs_annot.h:1258
foxit::pdf::annots::Ink::EnableUseBezier
void EnableUseBezier(bool use_bezier)
Enable to use bezier spline to generate ink path for ink annotation's appearance.
foxit::pdf::annots::Note::SetState
void SetState(State state)
Set the state.
foxit::pdf::annots::BorderInfo::Set
void Set(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_annot.h:607
foxit::pdf::annots::Square::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::annots::Annot::e_AppearanceTypeRollover
Annotation's rollover appearance.
Definition: fs_annot.h:1282
foxit::pdf::annots::Widget::e_LineSpacingDouble
Line spacing style: double line spacing.
Definition: fs_annot.h:5185
foxit::pdf::annots::Sound
Definition: fs_annot.h:5975
foxit::pdf::annots::Line::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
foxit::pdf::annots::Annot::e_MKRelationCaptionBelowIcon
Caption below the icon.
Definition: fs_annot.h:1262
foxit::pdf::annots::Line::SetLeaderLineOffset
void SetLeaderLineOffset(float offset)
Set the length of leader line offset.
foxit::pdf::RichTextStyle::is_bold
bool is_bold
A boolean value which indicates whether to make text bold or not.
Definition: fs_annot.h:401
foxit::pdf::annots::IconFit::is_proportional_scaling
bool is_proportional_scaling
A boolean value which indicates whether use proportional scaling or not.
Definition: fs_annot.h:940
foxit::pdf::annots::Sound::e_SampleEncodingFormatRaw
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5984
foxit::pdf::annots::Annot::ResetAppearanceStream
bool ResetAppearanceStream()
Reset appearance stream.
foxit::pdf::annots::Square::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::RichTextStyle::mark_style
CornerMarkStyle mark_style
Corner mark style. Corner mark style which can be used to make text as superscript or subscript or no...
Definition: fs_annot.h:422
foxit::pdf::annots::Highlight::~Highlight
~Highlight()
Destructor.
Definition: fs_annot.h:2788
foxit::pdf::annots::Polygon::GetVertexes
PointFArray GetVertexes()
Get vertexes.
foxit::pdf::annots::Annot::e_HighlightingPush
Highlighting mode: Push, which is to display the annotation's down appearance, if any.
Definition: fs_annot.h:1163
foxit::pdf::annots::Note::IsStateAnnot
bool IsStateAnnot()
Check if current note annotation is used as a state annotation.
foxit::pdf::annots::Line::GetLineStartStyle
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
foxit::pdf::annots::Highlight
Definition: fs_annot.h:2777
foxit::Object
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
foxit::pdf::annots::Annot::IsMarkup
bool IsMarkup() const
Check if current annotation is a markup annotation.
foxit::pdf::annots::Annot::e_Screen
Annotation type: screen annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1051
foxit::pdf::annots::Screen::SetImage
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current screen annotation, with a specified frame index.
foxit::pdf::annots::Widget::Widget
Widget()
Constructor.
Definition: fs_annot.h:5194
foxit::pdf::annots::Square::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Redact::GetOverlayText
WString GetOverlayText() const
Get the overlay text.
foxit::pdf::annots::Popup::GetOpenStatus
bool GetOpenStatus() const
Get open status.
foxit::pdf::annots::BorderInfo::style
Style style
Border style. Please refer to values starting from BorderInfo::e_Solid and this should be one of thes...
Definition: fs_annot.h:626
foxit::pdf::RichTextStyle::is_italic
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:406
foxit::pdf::annots::IconProviderCallback::GetIcon
virtual PDFPage GetIcon(Annot::Type annot_type, const char *icon_name, ARGB color)
A callback function used to get the icon as PDF page contents for a specified type.
foxit::pdf::annots::Highlight::Highlight
Highlight()
Constructor.
Definition: fs_annot.h:2780
foxit::pdf::annots::Annot::e_PropertyFillColor
Annotation property: fill color.
Definition: fs_annot.h:1192
foxit::pdf::annots::FreeText::SetCalloutLineEndingStyle
void SetCalloutLineEndingStyle(EndingStyle ending_style)
Set line ending style of the start point in a callout line.
foxit::pdf::annots::Annot::SetUniqueID
void SetUniqueID(const WString &unique_id)
Set unique ID.
foxit::pdf::annots::Square::Square
Square()
Constructor.
Definition: fs_annot.h:3022
foxit::pdf::annots::Screen::SetMKDict
void SetMKDict(pdf::objects::PDFDictionary *dict)
Set the appearance characteristics dictionary (known as "MK" dictionary as well).
foxit::pdf::annots::Square::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::Line::SetEndPoint
void SetEndPoint(const PointF &point)
Set the end point.
foxit::pdf::annots::Annot::e_MKRelationCaptionLeft
Caption to the left of the icon.
Definition: fs_annot.h:1268
foxit::pdf::annots::BorderInfo::operator=
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:539
foxit::pdf::annots::Stamp::~Stamp
~Stamp()
Destructor.
foxit::pdf::annots::PagingSeal::PagingSeal
PagingSeal(const Annot &annot)
Constructor.
foxit::pdf::annots::Annot::e_FlagToggleNoView
Annotation flag: toggle no view.
Definition: fs_annot.h:1140
foxit::pdf::annots::QuadPoints::operator!=
bool operator!=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:733
foxit::pdf::annots::FreeText::Rotate
void Rotate(common::Rotation rotation)
Rotate current annotation from current state with specified rotation value (in clockwise).
foxit::pdf::annots::Screen::GetAction
actions::Action GetAction()
Get action.
foxit::pdf::annots::Widget::SetMKRotation
void SetMKRotation(common::Rotation rotation)
Set the rotation value in the MK dictionary.
foxit::pdf::annots::Line::SetLineStartStyle
void SetLineStartStyle(EndingStyle ending_style)
Set line ending style of the start point.
foxit::pdf::annots::IconProviderCallback::GetDisplayWidth
virtual float GetDisplayWidth(Annot::Type annot_type, const char *icon_name)
A callback function used to get the width for display of a specified icon, in device size(pixel norma...
Definition: fs_annot.h:1842
foxit::pdf::annots::IconProviderCallback::GetProviderVersion
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1773
foxit::pdf::annots::FreeText::SetAlignment
void SetAlignment(common::Alignment alignment)
Set alignment value.
foxit::pdf::annots::Polygon::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
foxit::pdf::RichTextStyle::e_CornerMarkSuperscript
Corner mark style: superscript.
Definition: fs_annot.h:212
foxit::pdf::annots::Markup::State
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1907
foxit::pdf::annots::Popup::GetParent
Markup GetParent()
Get related parent markup annotation.
foxit::pdf::annots::Redact::SetOverlayTextAlignment
void SetOverlayTextAlignment(common::Alignment alignment)
Set alignment value of overlay text.
foxit::pdf::annots::PolyLine::~PolyLine
~PolyLine()
Destructor.
Definition: fs_annot.h:4738
foxit::pdf::annots::IconFit::IconFit
IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Constructor, with parameters.
Definition: fs_annot.h:824
foxit::pdf::annots::Line::SetCaptionPositionType
void SetCaptionPositionType(CapPos cap_position)
Set the position type of caption.
foxit::pdf::annots::Squiggly
Definition: fs_annot.h:2867
foxit::pdf::annots::Annot::SetContent
void SetContent(const WString &content)
Set content.
foxit::pdf::annots::Annot::e_RichMedia
Annotation type: rich media annotation.
Definition: fs_annot.h:1065
foxit::pdf::annots::Screen::GetMKDict
pdf::objects::PDFDictionary * GetMKDict() const
Get the appearance characteristics dictionary (known as "MK" dictionary as well).
foxit::pdf::RichTextStyle::text_size
float text_size
Text size. It should not be negative value. 0 means text will not be shown.
Definition: fs_annot.h:385
foxit::pdf::annots::Annot::e_FlagNoZoom
Annotation flag: no zoom.
Definition: fs_annot.h:1103
fs_common.h
Header file for common definitions and classes.
foxit::pdf::annots::TextMarkup::~TextMarkup
~TextMarkup()
Destructor.
Definition: fs_annot.h:2722
foxit::pdf::annots::Stamp::SetBitmap
void SetBitmap(const common::Bitmap &bitmap)
Set bitmap to current stamp annotation.
foxit::pdf::annots::Sound::~Sound
~Sound()
Destructor.
foxit::pdf::annots::Annot::~Annot
virtual ~Annot()
Destructor.
foxit::pdf::annots::FreeText::GetCalloutLineEndingStyle
EndingStyle GetCalloutLineEndingStyle() const
Get line ending style of the start point in a callout line.
foxit::pdf::annots::Square
Definition: fs_annot.h:3019
foxit::pdf::annots::Screen::Screen
Screen()
Constructor.
Definition: fs_annot.h:4360
foxit::pdf::annots::ShadingColor::second_color
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1734
foxit::pdf::annots::BorderInfo::e_Cloudy
Border style: Cloudy.
Definition: fs_annot.h:483
CFX_ArrayTemplate< float >
foxit::pdf::annots::Annot::e_Popup
Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1061
foxit::pdf::annots::Line::GetLeaderLineExtensionLength
float GetLeaderLineExtensionLength() const
Get the length of leader line extension.
foxit::pdf::annots::Redact::EnableRepeatOverlayText
void EnableRepeatOverlayText(bool is_to_repeat_overlay_text)
Set the flag to decide whether to repeat the overlay text.
foxit::pdf::annots::Annot::e_FreeText
Annotation type: free text annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1012
foxit::pdf::annots::BorderInfo::e_Solid
Border style: Solid.
Definition: fs_annot.h:449
foxit::pdf::annots::Circle::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::annots::IconFit::fit_bounds
bool fit_bounds
A boolean value that indicates whether to scale button appearance to fit fully within bounds or not.
Definition: fs_annot.h:959
foxit::pdf::annots::Underline
Definition: fs_annot.h:2807
foxit::pdf::annots::PolyLine::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
foxit::common::Alignment
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:94
foxit::pdf::annots::Sound::GetChannelCount
int GetChannelCount() const
Get the count of sound channels.
foxit::pdf::annots::PolyLine::PolyLine
PolyLine()
Constructor.
Definition: fs_annot.h:4730
foxit::pdf::annots::Line::GetLeaderLineOffset
float GetLeaderLineOffset() const
Get the length of leader line offset.
foxit::pdf::annots::Stamp
Definition: fs_annot.h:4229
foxit::pdf::annots::QuadPoints::Set
void Set(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Set value.
Definition: fs_annot.h:748
foxit::pdf::annots::Line::HasCaption
bool HasCaption() const
Check whether the content of current line annotation should be replicated as a caption in the appeara...
foxit::pdf::annots::Annot::e_HighlightingInvert
Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
Definition: fs_annot.h:1159
foxit::pdf::annots::Circle::~Circle
~Circle()
Destructor.
Definition: fs_annot.h:3202
foxit::pdf::annots::Annot::e_MKEntryBorderColor
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1204
foxit::pdf::annots::Annot::GetFlags
uint32 GetFlags() const
Get annotation flags.
fs_file.h
Header file for file operation related definitions and functions.
foxit::pdf::DefaultAppearance::e_FlagFont
Indicates property font of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:59
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1665
foxit::pdf::annots::Square::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
foxit::pdf::annots::Widget::SetMKRolloverCaption
void SetMKRolloverCaption(const wchar_t *caption)
Set the rollover caption string in the MK dictionary.
foxit::pdf::annots::Widget
Definition: fs_annot.h:5172
foxit::pdf::annots::ShadingColor::Set
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1726
foxit::ARGB
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
foxit::pdf::annots::Annot::GetUniqueID
WString GetUniqueID() const
Get unique ID.
foxit::pdf::annots::Sound::Sound
Sound()
Constructor.
Definition: fs_annot.h:5995
foxit::pdf::annots::Widget::SetAppearanceState
void SetAppearanceState(const String &appearance_state)
Set the annotation's appearance state, which selects the applicable appearance stream from an appeara...
foxit::pdf::annots::Sound::GetSoundStream
objects::PDFStream * GetSoundStream() const
Get the stream of sound data.
foxit::pdf::annots::PolyLine::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::annots::Circle::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
foxit::pdf::annots::IconFit::IconFit
IconFit()
Constructor.
Definition: fs_annot.h:793
foxit::pdf::annots::Widget::GetMKNormalIconBitmap
common::Bitmap GetMKNormalIconBitmap()
Get the normal icon bitmap in the MK dictionary.
foxit::pdf::annots::BorderInfo::e_Dashed
Border style: Dashed.
Definition: fs_annot.h:456
foxit::pdf::annots::Redact::SetQuadPoints
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
foxit::pdf::annots::FreeText::SetDefaultAppearance
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
foxit::pdf::annots::Annot::e_FlagPrint
Annotation flag: print.
Definition: fs_annot.h:1096
foxit::pdf::annots::Annot::SetBorderColor
void SetBorderColor(RGB color)
Set border color.
foxit::pdf::annots::Annot::e_FlagNoView
Annotation flag: no view.
Definition: fs_annot.h:1118
foxit::pdf::annots::Redact::GetOverlayTextAlignment
common::Alignment GetOverlayTextAlignment() const
Get alignment value of overlay text.
foxit::pdf::annots::FreeText::GetTextMatrix
Matrix GetTextMatrix() const
Get matrix in default appearance data for text in current free text annotation.
foxit::pdf::annots::Annot::GetDisplayMatrix
Matrix GetDisplayMatrix(const Matrix &page_display_matrix)
Get the display matrix, from PDF coordinate system to targeted device coordinate system.
foxit::pdf::annots::Redact::EnableAutoFontSize
void EnableAutoFontSize()
Enable auto font size for the overlay text.
foxit::pdf::annots::Widget::e_LineSpacingOneAndHalf
Line spacing style: one and half times line spacing.
Definition: fs_annot.h:5183
foxit::pdf::annots::Line::GetCaptionOffset
Offset GetCaptionOffset() const
Get caption offset values.
foxit::pdf::annots::PSInk::~PSInk
~PSInk()
Destructor.
Definition: fs_annot.h:5155
foxit::pdf::annots::Line::e_CapPosTop
Definition: fs_annot.h:3697
foxit::pdf::annots::PSInk::PSInk
PSInk()
Constructor.
Definition: fs_annot.h:5145
foxit::pdf::annots::Markup::Markup
Markup()
Constructor.
Definition: fs_annot.h:2017
foxit::pdf::annots::ShadingColor::first_color
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1732
foxit::pdf::annots::NoteArray
Definition: fs_annot.h:1869
foxit::pdf::annots::Note::GetStateModel
StateModel GetStateModel()
Get the state model.
foxit::pdf::annots::Annot::e_MKRelationNoCaption
No caption; icon only.
Definition: fs_annot.h:1260
foxit::pdf::annots::Widget::GetMKBorderColor
RGB GetMKBorderColor() const
Get the border color in the MK dictionary.
foxit::common::e_AlignmentLeft
Left alignment.
Definition: fs_common.h:96
foxit::pdf::RichTextStyle::e_CornerMarkSubscript
Corner mark style: subscript.
Definition: fs_annot.h:214
foxit::common::Path
Definition: fs_common.h:2060
foxit::pdf::annots::Annot::e_FileAttachment
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1040
foxit::pdf::annots::FreeText::GetInnerRect
RectF GetInnerRect() const
Get the inner rectangle.
foxit::pdf::annots::FreeText::SetRotation
void SetRotation(common::Rotation rotation)
Set rotation value (in clockwise).
foxit::pdf::annots::Screen::~Screen
virtual ~Screen()
Destructor.
Definition: fs_annot.h:4368
foxit::pdf::annots::Annot::e_Note
Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PD...
Definition: fs_annot.h:1008
foxit::pdf::annots::Line::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
foxit::pdf::annots::Note::GetOpenStatus
bool GetOpenStatus() const
Get open status.
foxit::pdf::annots::Annot::e_UnknownType
Annotation type: unknown.
Definition: fs_annot.h:1003
foxit::pdf::annots::Stamp::Stamp
Stamp()
Constructor.
Definition: fs_annot.h:4232
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1679
foxit::pdf::annots::Annot::e_FlagInvisible
Annotation flag: invisible.
Definition: fs_annot.h:1082
foxit::pdf::annots::Redact::SetDefaultAppearance
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
foxit::pdf::annots::StrikeOut
Definition: fs_annot.h:2837
foxit::pdf::annots::FreeText
Definition: fs_annot.h:3374
foxit::pdf::annots::Markup
Definition: fs_annot.h:1888
foxit::pdf::annots::Ink
Definition: fs_annot.h:4116
foxit::pdf::annots::Caret::Caret
Caret()
Constructor.
Definition: fs_annot.h:4952
foxit::pdf::annots::BorderInfo::dashes
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:654
foxit::pdf::annots::PolyLine::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
foxit::pdf::annots::Sound::e_SampleEncodingFormatMuLaw
μ-law-encoded samples.
Definition: fs_annot.h:5988
foxit::pdf::annots::Line::Line
Line()
Constructor.
Definition: fs_annot.h:3702
foxit::pdf::annots::Line::GetEndPoint
PointF GetEndPoint() const
Get the end point.
foxit::pdf::annots::Circle::SetMeasureRatio
void SetMeasureRatio(const char *ratio)
Set the scale ratio string for measuring.
foxit::pdf::annots::Polygon::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance(const DefaultAppearance &default_appearance)
Constructor, with another default appearance object.
Definition: fs_annot.h:98
foxit::pdf::annots::Circle
Definition: fs_annot.h:3191
foxit::pdf::annots::Annot::e_MKEntryIconCaptionRelation
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:1248
foxit::pdf::DefaultAppearance::DefAPFlags
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:57
foxit::pdf::annots::Ink::SetInkList
void SetInkList(const common::Path &ink_list)
Set ink list data.
foxit::pdf::annots::Widget::GetMKNormalCaption
WString GetMKNormalCaption() const
Get the normal caption string in the MK dictionary.
foxit::pdf::annots::Widget::SetLineSpacing
void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value)
Set line spacing for current widget.
foxit::pdf::annots::Redact
Definition: fs_annot.h:5769
foxit::pdf::annots::Annot::e_FlagLocked
Annotation flag: locked.
Definition: fs_annot.h:1134
foxit::pdf::annots::IconFit::scale_way_type
ScaleWayType scale_way_type
The circumstances under which the icon should be scaled inside the annotation rectangle....
Definition: fs_annot.h:931
foxit::pdf::annots::PagingSeal::GetPagingSealSignature
PagingSealSignature GetPagingSealSignature()
Get the associated paging seal signature.
foxit::pdf::annots::PolyLine::SetVertexes
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
foxit::pdf::annots::Annot::GetDeviceRect
RectI GetDeviceRect(const Matrix &matrix)
Get annotation rectangle in device coordinate system.
foxit::pdf::annots::Widget::SetHighlightingMode
void SetHighlightingMode(HighlightingMode mode)
Set highlighting mode.
foxit::pdf::annots::QuadPoints::first
PointF first
First point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:756
foxit::pdf::annots::Annot::e_MKRelationCaptionOvrlayOnIcon
Caption overlaid directly on the icon.
Definition: fs_annot.h:1270
foxit::pdf::annots::Annot::e_PropertyModifiedDate
Annotation property: modified date.
Definition: fs_annot.h:1175
foxit::pdf::annots::Redact::~Redact
~Redact()
Destructor.
foxit::pdf::RichTextStyle
Definition: fs_annot.h:201
foxit::pdf::annots::IconProviderCallback::CanChangeColor
virtual bool CanChangeColor(Annot::Type annot_type, const char *icon_name)
A callback function used to check if current icon provider supports to change color for a specified t...
Definition: fs_annot.h:1798
foxit::pdf::annots::Annot::e_MKEntryNormalIcon
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1226
foxit::pdf::annots::Screen::SetTitle
void SetTitle(const WString &title)
Set title of current screen annotation.
foxit::pdf::RichTextStyle::text_color
RGB text_color
Text color. Format: 0xRRGGBB.
Definition: fs_annot.h:396
foxit::pdf::annots::Widget::e_LineSpacingAuto
Line spacing style: auto line spacing.
Definition: fs_annot.h:5189
foxit::pdf::annots::Line::SetLineEndStyle
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_annot.h:504
foxit::pdf::annots::PolyLine::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Widget::e_LineSpacingExactValue
Line spacing style: exact value line spacing.
Definition: fs_annot.h:5187
foxit::pdf::annots::Stamp::GetRotation
int GetRotation()
Get current rotation angle (in clockwise).
foxit::pdf::annots::Annot::AppearanceType
AppearanceType
Enumeration for the type of annotation's appearance.
Definition: fs_annot.h:1278
foxit::pdf::annots::Annot::e_MKEntryRolloverIcon
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1231
foxit::pdf::annots::Square::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::IconProviderCallback::GetShadingColor
virtual bool GetShadingColor(Annot::Type annot_type, const char *icon_name, RGB referenced_color, int shading_index, ShadingColor &out_shading_color)
A callback function used to get the shading colors if current icon provider supports for a specified ...
Definition: fs_annot.h:1828
foxit::pdf::annots::Annot::e_HighlightingToggle
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1165
foxit::pdf::interform::Field
Definition: fs_pdfform.h:145
foxit::pdf::annots::Screen::RemoveAction
void RemoveAction()
Remove action.
foxit::pdf::DefaultAppearance::operator!=
bool operator!=(const DefaultAppearance &default_appearance) const
Not equal operator.
Definition: fs_annot.h:139
foxit::pdf::annots::Annot::e_HighlightingNone
Highlighting mode: No highlighting.
Definition: fs_annot.h:1157
foxit::pdf::annots::Annot::e_FlagNoRotate
Annotation flag: no rotate.
Definition: fs_annot.h:1110
foxit::pdf::annots::Square::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::annots::Widget::GetControl
interform::Control GetControl()
Get associated form control.
CFX_ByteString
BYTE STRING CLASS.
Definition: fx_string.h:317
fs_action.h
Header file for destination and action related definitions and classes.
foxit::pdf::annots::PolyLine::SetLineStartStyle
void SetLineStartStyle(EndingStyle starting_style)
Set line ending style of the start point.
foxit::pdf::annots::Line::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::annots::Square::GetInnerRect
RectF GetInnerRect() const
Get the inner rectangle.
foxit::pdf::annots::AnnotArray
Definition: fs_annot.h:1654
foxit::pdf::annots::Annot::SetBorderInfo
void SetBorderInfo(const BorderInfo &border)
Set border information.
foxit::pdf::annots::Annot::Property
Property
Enumeration for some PDF annotation property.
Definition: fs_annot.h:1173
foxit::pdf::annots::Polygon::SetVertexes
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance()
Constructor.
Definition: fs_annot.h:88
foxit::pdf::annots::Annot::GetPage
PDFPage GetPage() const
Get the related PDF page.
foxit::pdf::annots::Popup::SetOpenStatus
void SetOpenStatus(bool status)
Set open status.
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints(const QuadPoints &quad_points)
Constructor, with another quadrilateral points object.
Definition: fs_annot.h:692
foxit::pdf::annots::QuadPoints::fourth
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:762
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:81
foxit::pdf::annots::Annot::e_AppearanceTypeNormal
Annotation's normal appearance.
Definition: fs_annot.h:1280
foxit::pdf::annots::Annot::e_Highlight
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1024
foxit::pdf::annots::BorderInfo::e_UnderLine
Border style: Underline.
Definition: fs_annot.h:462
foxit::pdf::annots::Widget::GetMKIconFit
IconFit GetMKIconFit() const
Get the icon fit information in the MK dictionary.
foxit::pdf::annots::Widget::GetAction
actions::Action GetAction()
Get action.
foxit::pdf::annots::PolyLine::SetLineEndStyle
void SetLineEndStyle(EndingStyle ending_style)
Set line ending style of the end point.
foxit::pdf::RichTextStyle::font
common::Font font
A font used in rich text style. It should be a valid font object.
Definition: fs_annot.h:380
foxit::pdf::annots::Screen::SetRotation
void SetRotation(common::Rotation rotate)
Set the rotation of the image used for the appearance of current screen annotation.
foxit::pdf::annots::Polygon::Polygon
Polygon()
Constructor.
Definition: fs_annot.h:4548
foxit::pdf::annots::PolyLine::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio string for measuring.
foxit::pdf::annots::Polygon::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::annots::PagingSeal
Definition: fs_annot.h:6092
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo()
Constructor.
Definition: fs_annot.h:513
foxit::pdf::annots::Markup::StateModel
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1895
foxit::pdf::annots::FileAttachment::SetFileSpec
bool SetFileSpec(const FileSpec &file_spec)
Set a file specification, which should specify an embedded file.
CFX_PSVTemplate
Definition: fx_coordinates.h:30
foxit::pdf::annots::FileAttachment::GetFileSpec
FileSpec GetFileSpec()
Get the file specification.
foxit::pdf::annots::Annot::GetBorderColor
RGB GetBorderColor() const
Get border color.
foxit::pdf::annots::PolyLine::GetMeasureUnit
String GetMeasureUnit(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Annot::e_Movie
Annotation type: movie annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1044
foxit::pdf::annots::Sound::GetSamplingRate
float GetSamplingRate() const
Get the sampling rate, in samples per second.
foxit::pdf::annots::Sound::GetFileSpec
FileSpec GetFileSpec() const
Get the file specification object which represents an external sound file.
foxit::pdf::annots::Redact::SetOverlayText
void SetOverlayText(const WString &overlay_text)
Set the overlay text.
foxit::pdf::RichTextStyle::char_space
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
foxit::common::Rotation
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
foxit::pdf::annots::Annot::e_Underline
Annotation type: underline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1026
foxit::pdf::RichTextStyle::CornerMarkStyle
CornerMarkStyle
Enumeration for corner mark style.
Definition: fs_annot.h:208
foxit::pdf::annots::Redact::GetQuadPoints
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
foxit::pdf::annots::Markup::EndingStyle
EndingStyle
Enumeration for line ending style.
Definition: fs_annot.h:1960
foxit::pdf::annots::BorderInfo
Definition: fs_annot.h:440
foxit::pdf::annots::Screen::GetOpacity
float GetOpacity() const
Get opacity value.
foxit::pdf::annots::Widget::RemoveAction
void RemoveAction()
Remove action.
foxit::pdf::annots::Square::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const char *unit)
Set the label for displaying the units for measuring.
foxit::pdf::annots::Widget::HasMKEntry
bool HasMKEntry(MKEntry mk_entry)
Check if a specified entry exists in the MK dictionary.
foxit::pdf::annots::Widget::e_LineSpacingSingle
Line spacing style: single line spacing.
Definition: fs_annot.h:5181
foxit::pdf::annots::Widget::GetField
interform::Field GetField()
Get associated form field.
foxit::pdf::annots::Caret::~Caret
~Caret()
Destructor.
Definition: fs_annot.h:4960
foxit::pdf::annots::Widget::SetAction
void SetAction(const actions::Action &action)
Set action.
foxit::pdf::annots::Circle::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::Annot::MKEntry
MKEntry
Enumeration for annotation's MK dictionary (an appearance characteristics) entry.
Definition: fs_annot.h:1200
foxit::pdf::RichTextStyle::operator!=
bool operator!=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:331
operator==
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
foxit::pdf::annots::Circle::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label for displaying the units for measuring.
foxit::pdf::annots::Line::GetStyleFillColor
RGB GetStyleFillColor() const
Get fill color for ending styles.
foxit::pdf::annots::Annot::GetBorderInfo
BorderInfo GetBorderInfo() const
Get border information.
foxit::pdf::annots::Redact::SetApplyFillColor
void SetApplyFillColor(RGB fill_color)
Set the filling color which is used for rollover appearance and will be used after redaction is appli...
foxit::pdf::annots::Annot::GetOptionalContent
objects::PDFDictionary * GetOptionalContent() const
Get the PDF dictionary of annotation's optional content.
foxit::pdf::annots::Squiggly::~Squiggly
~Squiggly()
Destructor.
Definition: fs_annot.h:2878
foxit::pdf::annots::Annot::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::pdf::annots::Sound::SampleEncodingFormat
SampleEncodingFormat
Enumeration for encoding format of sound sample data.
Definition: fs_annot.h:5982
fs_pdfobject.h
Header file for PDF object related definitions and classes.
foxit::pdf::DefaultAppearance::flags
uint32 flags
Flags to indicate which properties of default appearance are meaningful.
Definition: fs_annot.h:176
foxit::pdf::annots::FreeText::SetCalloutLinePoints
void SetCalloutLinePoints(const PointFArray &point_array)
Set points for callout line.
foxit::pdf::annots::Annot::e_Polygon
Annotation type: polygon annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1020
foxit::pdf::annots::Annot::e_PropertyBorderColor
Annotation property: border color.
Definition: fs_annot.h:1186
foxit::pdf::annots::Widget::SetMKDownIconBitmap
void SetMKDownIconBitmap(const common::Bitmap &bitmap)
Set the down icon bitmap in the MK dictionary.
foxit::pdf::annots::Annot::RemoveProperty
bool RemoveProperty(Property property)
Remove a specified annotation's property.
foxit::pdf::annots::Widget::SetMKNormalCaption
void SetMKNormalCaption(const wchar_t *caption)
Set the normal caption string in the MK dictionary.
foxit::pdf::annots::StrikeOut::StrikeOut
StrikeOut()
Constructor.
Definition: fs_annot.h:2840
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
foxit::pdf::annots::Stamp::SetImage
void SetImage(const common::Image &image, int frame_index, int compress)
Set image to current stamp annotation, with a specified frame index.
foxit::pdf::annots::Annot::e_HighlightingOutline
Highlighting mode: Outline, which is to invert the annotation's border.
Definition: fs_annot.h:1161
foxit::pdf::annots::Underline::Underline
Underline()
Constructor.
Definition: fs_annot.h:2810
foxit::pdf::annots::Screen::SetOpacity
void SetOpacity(float opacity)
Set opacity value.
foxit::pdf::annots::Screen::GetTitle
WString GetTitle() const
Get title of current screen annotation.
foxit::pdf::annots::Widget::SetMKIconCaptionRelation
void SetMKIconCaptionRelation(MKIconCaptionRelation relation)
Set the relation of icon and caption in the MK dictionary.
foxit::pdf::annots::Widget::GetMKDownIconBitmap
common::Bitmap GetMKDownIconBitmap()
Get the down icon bitmap in the MK dictionary.
foxit::pdf::annots::Widget::SetMKBackgroundColor
void SetMKBackgroundColor(RGB color)
Set the background color in the MK dictionary.
foxit::pdf::DefaultAppearance::e_FlagFontSize
Indicates property text size of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:63
foxit::pdf::DefaultAppearance::font
common::Font font
A font for default appearance. It should be a valid font object when it is useful.
Definition: fs_annot.h:182
foxit::pdf::annots::FreeText::FreeText
FreeText()
Constructor.
Definition: fs_annot.h:3377
foxit::pdf::annots::Line::SetStartPoint
void SetStartPoint(const PointF &point)
Set the start point.
foxit::pdf::annots::FreeText::GetDefaultAppearance
DefaultAppearance GetDefaultAppearance()
Get default appearance data.
foxit::pdf::RichTextStyle::text_alignment
common::Alignment text_alignment
Alignment value. Please refer to values starting from common::e_AlignmentLeft and this should be one ...
Definition: fs_annot.h:391
foxit::pdf::annots::QuadPoints::operator==
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:721
foxit::pdf::annots::Square::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
foxit::pdf::annots::Annot::e_MKEntryIconFit
Icon fit information entry. "IF" in MK dictionary.
Definition: fs_annot.h:1241
foxit::pdf::annots::PagingSeal::~PagingSeal
~PagingSeal()
Destructor.
foxit::pdf::annots::Polygon::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const String &unit)
Set the label for displaying the units for measuring.
foxit::pdf::annots::StrikeOut::~StrikeOut
~StrikeOut()
Destructor.
Definition: fs_annot.h:2848
foxit::pdf::annots::Polygon::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::annots::FreeText::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::annots::IconProviderCallback::GetProviderID
virtual String GetProviderID()
A callback function used to get provider ID.
Definition: fs_annot.h:1762
foxit::pdf::annots::IconFit::ScaleWayType
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:778
foxit::pdf::RichTextStyle::e_CornerMarkNone
Corner mark style: none.
Definition: fs_annot.h:210
foxit::pdf::annots::Annot::e_MKEntryRotation
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1202
foxit::pdf::annots::QuadPoints
Definition: fs_annot.h:667
foxit::pdf::annots::Widget::GetMKRolloverIconBitmap
common::Bitmap GetMKRolloverIconBitmap()
Get the rollover icon bitmap in the MK dictionary.
fs_image.h
Header file for image and bitmap related definitions and classes.
foxit::pdf::annots::IconProviderCallback::GetDisplayHeight
virtual float GetDisplayHeight(Annot::Type annot_type, const char *icon_name)
A callback function used to get the height for display of a specified icon, in device size(pixel norm...
Definition: fs_annot.h:1855
foxit::pdf::annots::Annot::GetModifiedDateTime
DateTime GetModifiedDateTime() const
Get last modified date time.
foxit::pdf::annots::QuadPoints::second
PointF second
Second point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:758
foxit::pdf::annots::PSInk
Definition: fs_annot.h:5142
foxit::pdf::annots::IconFit::Set
void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
Set value.
Definition: fs_annot.h:917
foxit::pdf::annots::BorderInfo::operator!=
bool operator!=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:575
foxit::pdf::DefaultAppearance::e_FlagTextColor
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:61
foxit::pdf::annots::Caret
Definition: fs_annot.h:4949
foxit::pdf::annots::Circle::GetInnerRect
RectF GetInnerRect() const
Get the inner rectangle.
foxit::pdf::annots::Sound::GetBits
int GetBits() const
Get the number of bits per sample value per channel.
foxit::pdf::annots::Widget::SetMKBorderColor
void SetMKBorderColor(RGB color)
Set the border color in the MK dictionary.
foxit::pdf::annots::Line::SetStyleFillColor
void SetStyleFillColor(RGB color)
Set fill color for ending styles.
foxit::pdf::objects::PDFDictionary
Definition: fs_pdfobject.h:809
foxit::pdf::annots::Annot::e_Circle
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1018
foxit::pdf::annots::Annot::e_Line
Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1014
foxit::pdf::annots::Square::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
operator!=
bool operator!=(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are not equal.
Definition: fs_basictypes.h:140
foxit::pdf::annots::Annot::e_AppearanceTypeDown
Annotation's down appearance.
Definition: fs_annot.h:1284
foxit::pdf::annots::Widget::GetMKIconCaptionRelation
MKIconCaptionRelation GetMKIconCaptionRelation() const
Get the relation of icon and caption in the MK dictionary.
foxit::pdf::annots::Annot::MKIconCaptionRelation
MKIconCaptionRelation
Enumeration for icon and caption relative position in annotation's MK dictionary.
Definition: fs_annot.h:1256
foxit::pdf::annots::IconFit::vertical_fraction
float vertical_fraction
The vertical fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:952
foxit::pdf::annots::Annot::e_MKEntryDownCaption
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1221
foxit::pdf::annots::Line::SetLeaderLineLength
void SetLeaderLineLength(float length)
Set the length of leader line.
foxit::pdf::annots::Widget::SetMKDownIconImage
void SetMKDownIconImage(const common::Image &image, int frame_index)
Set an image with specified frame index as down icon in the MK dictionary.
foxit::pdf::annots::Annot::e_MKEntryNormalCaption
Normal caption entry. "CA" in MK dictionary.
Definition: fs_annot.h:1211
foxit::pdf::annots::Annot::e_Ink
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1036
foxit::pdf::annots::IconFit::IconFit
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:837
foxit::pdf::annots::TextMarkup
Definition: fs_annot.h:2711
foxit::pdf::annots::BorderInfo::operator==
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:555
foxit::pdf::annots::FreeText::GetRotation
common::Rotation GetRotation()
Get current rotation value (in clockwise).
foxit::pdf::annots::Annot::GetContent
WString GetContent() const
Get content.
foxit::pdf::RichTextStyle::RichTextStyle
RichTextStyle(const common::Font &font, float text_size, common::Alignment text_alignment, RGB text_color, bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style, float char_space, float word_space)
Constructor, with parameters.
Definition: fs_annot.h:236
foxit::pdf::annots::Polygon::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
foxit::pdf::annots::FreeText::~FreeText
~FreeText()
Destructor.
Definition: fs_annot.h:3386
foxit::pdf::annots::Annot::e_Stamp
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1032
foxit::pdf::annots::Circle::GetFillColor
RGB GetFillColor() const
Get fill color.
foxit::pdf::PagingSealSignature
Definition: fs_signature.h:2091
foxit::pdf::annots::Screen::GetBitmap
common::Bitmap GetBitmap()
Get the bitmap from current screen annotation.
foxit::pdf::annots::Line::GetLineEndStyle
EndingStyle GetLineEndStyle() const
Get line ending style of the end point.
foxit::pdf::annots::Widget::LineSpacingStyle
LineSpacingStyle
Enumeration for line spacing style.
Definition: fs_annot.h:5179
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:792
foxit::pdf::annots::Annot::Move
bool Move(const RectF &rect)
Move current annotation to a new position, specified by a new rectangle in PDF coordinate system.
foxit::pdf::DefaultAppearance::Set
void Set(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Set value.
Definition: fs_annot.h:162
foxit::pdf::RichTextStyle::RichTextStyle
RichTextStyle(const RichTextStyle &style)
Constructor, with another style object.
Definition: fs_annot.h:268
foxit::pdf::annots::FreeText::GetCalloutLinePoints
PointFArray GetCalloutLinePoints() const
Get a point of callout line points.
CFX_FloatRect
Definition: fx_coordinates.h:771
foxit::pdf::annots::BorderInfo::cloud_intensity
float cloud_intensity
Intensity of the cloudy effect.
Definition: fs_annot.h:639
foxit::pdf::DefaultAppearance::text_size
float text_size
Text size for default appearance.
Definition: fs_annot.h:191
foxit::pdf::DefaultAppearance::text_color
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:197
foxit::pdf::RichTextStyle::operator==
bool operator==(const RichTextStyle &style) const
Equal operator.
Definition: fs_annot.h:310
foxit::pdf::annots::Polygon::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
foxit::pdf::annots::Polygon::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::RGB
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
foxit::pdf::annots::Annot::e_FlagReadOnly
Annotation flag: read only.
Definition: fs_annot.h:1127
foxit::pdf::annots::Popup::Popup
Popup()
Constructor.
Definition: fs_annot.h:5072
foxit::pdf::annots::Line::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
foxit::pdf::annots::IconProviderCallback
Definition: fs_annot.h:1746
foxit::pdf::annots::BorderInfo::e_Beveled
Border style: Beveled.
Definition: fs_annot.h:469
foxit::pdf::annots::Circle::GetMeasureRatio
String GetMeasureRatio()
Get the scale ratio string for measuring.
foxit::pdf::annots::Annot::e_Widget
Annotation type: widget annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1049
foxit::pdf::annots::IconProviderCallback::HasIcon
virtual bool HasIcon(Annot::Type annot_type, const char *icon_name)
A callback function used to check if current icon provider supports icon for a specified type.
Definition: fs_annot.h:1785
foxit::pdf::PDFPage
Definition: fs_pdfpage.h:412
foxit::pdf::annots::TextMarkup::GetQuadPoints
QuadPointsArray GetQuadPoints() const
Get quadrilaterals.
foxit::pdf::annots::Markup::~Markup
~Markup()
Destructor.
Definition: fs_annot.h:2020
foxit::pdf::annots::PolyLine::SetStyleFillColor
void SetStyleFillColor(RGB fill_color)
Set fill color for some line ending styles.
foxit::pdf::annots::Widget::GetAppearanceOnStateName
String GetAppearanceOnStateName() const
Get the name of the annotation's appearance "ON" state.
foxit::pdf::annots::PolyLine::GetLineStartStyle
EndingStyle GetLineStartStyle() const
Get line ending style of the start point.
foxit::pdf::annots::Widget::GetMKRotation
common::Rotation GetMKRotation() const
Get the rotation value in the MK dictionary.
foxit::pdf::annots::Circle::SetInnerRect
void SetInnerRect(const RectF &inner_rect)
Set the inner rectangle.
foxit::pdf::annots::IconProviderCallback::Release
virtual void Release()=0
A callback function used to release current callback object itself.
foxit::pdf::annots::Redact::GetApplyFillColor
RGB GetApplyFillColor() const
Get the filling color which is used for rollover appearance and will be used after redaction is appli...
foxit::pdf::annots::TextMarkup::TextMarkup
TextMarkup()
Constructor.
Definition: fs_annot.h:2714
foxit::int32
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:194
foxit::pdf::RichTextStyle::is_strikethrough
bool is_strikethrough
A boolean value which indicates whether to cross text out with strike through or not.
Definition: fs_annot.h:416
foxit::pdf::annots::Note::GetIconName
String GetIconName() const
Get icon name.
foxit::pdf::annots::Line::GetMeasureRatioW
WString GetMeasureRatioW()
Get the scale ratio Unicode string for measuring.
foxit::pdf::annots::Line::CapPos
CapPos
Enumeration for the position type of caption.
Definition: fs_annot.h:3693
foxit::pdf::annots::Annot::operator!=
bool operator!=(const Annot &other) const
Not equal operator.
foxit::pdf::annots::Widget::SetMKRolloverIconBitmap
void SetMKRolloverIconBitmap(const common::Bitmap &bitmap)
Set the rollover icon bitmap in the MK dictionary.
foxit::pdf::annots::Annot::e_Link
Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1010
foxit::pdf::annots::Note::SetOpenStatus
void SetOpenStatus(bool status)
Set open status.
foxit::pdf::annots::Annot::e_TrapNet
Annotation type: trap network annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1055
foxit::pdf::annots::PolyLine::SetMeasureRatio
void SetMeasureRatio(const String &ratio)
Set the scale ratio string for measuring.
foxit::pdf::annots::Line::SetCaptionOffset
void SetCaptionOffset(const Offset &offset)
Set caption offset values.
foxit::pdf::annots::Widget::GetHighlightingMode
HighlightingMode GetHighlightingMode()
Get highlighting mode.
foxit::pdf::annots::Annot::operator=
Annot & operator=(const Annot &annot)
Assign operator.
foxit::pdf::annots::Sound::e_SampleEncodingFormatALaw
A-law-encoded samples.
Definition: fs_annot.h:5990
foxit::common::Image
Definition: fs_image.h:448
foxit::pdf::annots::Line::GetStartPoint
PointF GetStartPoint() const
Get the start point.
foxit::pdf::RichTextStyle::Set
void Set(const common::Font &font, float text_size, common::Alignment text_alignment, RGB text_color, bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style, float char_space, float word_space)
Set value.
Definition: fs_annot.h:355
foxit::pdf::annots::Stamp::SetRotation
void SetRotation(int angle)
Set rotation angle (in clockwise).
foxit::pdf::annots::MarkupArray
Definition: fs_annot.h:1865
foxit::pdf::annots::Annot::e_Squiggly
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1028
foxit::pdf::annots::Annot::Type
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:1001
foxit::pdf::annots::FreeText::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::Annot::e_PagingSeal
Annotation type: paging seal annotation. A Foxit PDF SDK custom annotation type (not a standard annot...
Definition: fs_annot.h:1067
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints(const PointF &first, const PointF &second, const PointF &third, const PointF &fourth)
Constructor, with parameters.
Definition: fs_annot.h:677
foxit::pdf::annots::Annot::SetFlags
void SetFlags(uint32 flags)
Set annotation flags.
foxit::pdf::annots::Widget::GetLineSpacing
LineSpacingStyle GetLineSpacing(float &line_spacing_value)
Get line spacing of current widget.
foxit::pdf::annots::Annot::GetAppearanceStream
objects::PDFStream * GetAppearanceStream(AppearanceType type, const char *appearance_state="") const
Get annotation's appearance stream with specified type and state.
foxit::pdf::annots::Annot::e_PSInk
Annotation type: pressure sensitive ink annotation.
Definition: fs_annot.h:1038
foxit::pdf::annots::Circle::SetMeasureUnit
void SetMeasureUnit(MeasureType measure_type, const char *unit)
Set the label for displaying the units for measuring.
foxit::pdf::annots::Screen::SetAction
void SetAction(const actions::Action &action)
Set action.
FX_RECT
Definition: fx_coordinates.h:596
foxit::pdf::annots::Annot::Annot
Annot()
Constructor.
Definition: fs_annot.h:1307
foxit::pdf::annots::Widget::RemoveMKEntry
void RemoveMKEntry(MKEntry mk_entry)
Remove a specified entry from the MK dictionary.
foxit::common::Font
Definition: fs_common.h:1428
foxit::pdf::annots::Widget::SetMKRolloverIconImage
void SetMKRolloverIconImage(const common::Image &image, int frame_index)
Set an image with specified frame index as rollover icon in the MK dictionary.
foxit::pdf::annots::Annot::e_MKEntryDownIcon
Down icon (or alternate icon) entry. "IX" in MK dictionary.
Definition: fs_annot.h:1236
foxit::pdf::annots::Annot::e_PrinterMark
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1053
foxit::pdf::annots::BorderInfo::dash_phase
float dash_phase
Dash phase.
Definition: fs_annot.h:646
foxit::pdf::annots::QuadPoints::operator=
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:706
CFX_Matrix
Definition: fx_coordinates.h:1076
foxit::pdf::annots::Annot::e_MKRelationCaptionRight
Caption to the right of the icon.
Definition: fs_annot.h:1266
foxit::pdf::annots::Widget::GetMKBackgroundColor
RGB GetMKBackgroundColor() const
Get the background color in the MK dictionary.
foxit::pdf::annots::Widget::~Widget
~Widget()
Destructor.
foxit::pdf::annots::Annot::e_MKEntryRolloverCaption
Rollover caption entry. "RC" in MK dictionary.
Definition: fs_annot.h:1216
foxit::pdf::annots::Annot::operator==
bool operator==(const Annot &other) const
Equal operator.
foxit::pdf::annots::PolyLine::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::DefaultAppearance::operator=
DefaultAppearance & operator=(const DefaultAppearance &default_appearance)
Assign operator.
Definition: fs_annot.h:111
foxit::pdf::annots::Widget::GetMKDownCaption
WString GetMKDownCaption() const
Get the down caption string in the MK dictionary.
foxit::pdf::annots::PolyLine::GetVertexes
PointFArray GetVertexes()
Get vertexes.
foxit::pdf::annots::QuadPoints::QuadPoints
QuadPoints()
Constructor.
Definition: fs_annot.h:685
foxit::pdf::annots::Redact::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::Squiggly::Squiggly
Squiggly()
Constructor.
Definition: fs_annot.h:2870
foxit::pdf::annots::FreeText::SetTextMatrix
void SetTextMatrix(const Matrix &text_matrix)
Set matrix in default appearance data for text in current free text annotation.
foxit::pdf::RichTextStyle::RichTextStyle
RichTextStyle()
Constructor.
Definition: fs_annot.h:251
foxit::pdf::annots::Polygon::~Polygon
~Polygon()
Destructor.
Definition: fs_annot.h:4556
foxit::pdf::annots::PolyLine
Definition: fs_annot.h:4727
foxit::pdf::DefaultAppearance
Definition: fs_annot.h:50
foxit::pdf::annots::Polygon::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
foxit::pdf::objects::PDFStream
Definition: fs_pdfobject.h:422
foxit::pdf::annots::BorderInfo::e_Inset
Border style: Inset.
Definition: fs_annot.h:476
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1461
foxit::pdf::annots::Line::EnableCaption
void EnableCaption(bool cap)
Set the flag which is used to decide whether the content of current line annotation should be replica...
foxit::String
CFX_ByteString String
Byte string.
Definition: fs_basictypes.h:225
foxit::pdf::annots::Line
Definition: fs_annot.h:3686
foxit::pdf::annots::Annot::HasProperty
bool HasProperty(Property property) const
Whether current annotation has the specified annotation's property.
foxit::common::Bitmap
Definition: fs_image.h:36
foxit::pdf::annots::Circle::GetMeasureConversionFactor
float GetMeasureConversionFactor(MeasureType measure_type)
Get the conversion factor for measuring.
foxit::pdf::annots::BorderInfo::width
float width
Border width, in points.
Definition: fs_annot.h:620
foxit::pdf::annots::Annot::e_PolyLine
Annotation type: polyline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1022
foxit::pdf::RichTextStyle::is_underline
bool is_underline
A boolean value which indicates whether to underline text or not.
Definition: fs_annot.h:411
foxit::pdf::annots::Ink::~Ink
~Ink()
Destructor.
Definition: fs_annot.h:4127
foxit::pdf::annots::Line::SetMeasureConversionFactor
void SetMeasureConversionFactor(MeasureType measure_type, float factor)
Set the conversion factor for measuring.
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo(const BorderInfo &border_info)
Constructor, with another border information object.
Definition: fs_annot.h:524
foxit::pdf::annots::Polygon
Definition: fs_annot.h:4545
foxit::pdf::annots::BorderInfo::Style
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:447
foxit::pdf::annots::Line::GetLeaderLineLength
float GetLeaderLineLength() const
Get the length of leader line.
foxit::pdf::annots::Markup::MeasureType
MeasureType
Enumeration for annotation's measure type.
Definition: fs_annot.h:1992
foxit::uint32
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
foxit::pdf::annots::FreeText::GetAlignment
common::Alignment GetAlignment() const
Get alignment value.
foxit::pdf::annots::Widget::SetMKNormalIconImage
void SetMKNormalIconImage(const common::Image &image, int frame_index)
Set an image with specified frame index as normal icon in the MK dictionary.
foxit::pdf::annots::Sound::GetCompressionFormat
String GetCompressionFormat() const
Get the name of the sound compression format used on the sample data.
foxit::pdf::annots::TextMarkup::SetQuadPoints
void SetQuadPoints(const QuadPointsArray &quad_points_array)
Set quadrilaterals.
foxit::pdf::annots::Screen::GetRotation
common::Rotation GetRotation()
Get the rotation of the image used for the appearance of current screen annotation.
foxit::pdf::annots::QuadPointsArray
Definition: fs_annot.h:766
foxit::pdf::annots::Stamp::GetIconName
String GetIconName() const
Get icon name.
foxit::Base
Definition: fs_basictypes.h:443
foxit::pdf::annots::Annot::Flags
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1075
foxit::pdf::annots::Line::~Line
~Line()
Destructor.
Definition: fs_annot.h:3710
foxit::pdf::annots::Stamp::Rotate
void Rotate(int angle)
Rotate current annotation from current state with specified angle degree in clockwise.
foxit::pdf::annots::Note::GetState
State GetState()
Get the state.
foxit::pdf::annots::FileAttachment::SetIconName
void SetIconName(const char *icon_name)
Set icon name.
foxit::pdf::annots::IconFit
Definition: fs_annot.h:772
foxit::pdf::DefaultAppearance::operator==
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:126
foxit::pdf::annots::Note::Note
Note()
Constructor.
Definition: fs_annot.h:2559
foxit::pdf::annots::Ink::Ink
Ink()
Constructor.
Definition: fs_annot.h:4119
foxit::pdf::annots::Annot::HighlightingMode
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1155
foxit::pdf::annots::Sound::GetSampleEncodingFormat
SampleEncodingFormat GetSampleEncodingFormat() const
Get the encoding format for the sample data.
foxit::pdf::annots::Widget::GetAppearanceState
String GetAppearanceState() const
Get the annotation's appearance state, which selects the applicable appearance stream from an appeara...
foxit::pdf::annots::Line::GetCaptionPositionType
CapPos GetCaptionPositionType() const
Get the position type of caption.
foxit::pdf::annots::Line::e_CapPosInline
Definition: fs_annot.h:3695
foxit::pdf::annots::Annot::e_PropertyCreationDate
Annotation property: creation date.
Definition: fs_annot.h:1180
foxit::pdf::annots::FileAttachment
Definition: fs_annot.h:5000
foxit::pdf::annots::Redact::Apply
bool Apply()
Apply current redact annotation: remove the text, graphics and annotations under annotation rectangle...
foxit::pdf::RichTextStyle::word_space
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
foxit::pdf::annots::Redact::IsOverlayTextRepeated
bool IsOverlayTextRepeated()
Check whether the overlay text is repeated or not.
foxit::pdf::annots::Redact::Redact
Redact()
Constructor.
Definition: fs_annot.h:5772
foxit::pdf::RichTextStyle::operator=
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:288
foxit::pdf::annots::IconFit::horizontal_fraction
float horizontal_fraction
The horizontal fraction of left-over space to allocate at the left and bottom of the icon.
Definition: fs_annot.h:946
foxit::pdf::annots::Ink::GetInkList
common::Path GetInkList()
Get ink list data.
foxit::pdf::annots::Square::~Square
~Square()
Destructor.
Definition: fs_annot.h:3030