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 
177 
184 
193  float text_size;
194 
201 };
202 
204 class RichTextStyle FS_FINAL : public Object{
205  public:
211  typedef enum _CornerMarkStyle {
218  } CornerMarkStyle;
219 
220 
241  : font(font)
245  , is_bold(is_bold)
251  , word_space(word_space) {}
252 
255  : text_size(0)
257  , text_color(0x000000)
258  , is_bold(false)
259  , is_italic(false)
260  , is_underline(false)
261  , is_strikethrough(false)
263  , char_space(0.0f)
264  , word_space(0.0f) {}
265 
272  : font(style.font)
273  , text_size(style.text_size)
275  , text_color(style.text_color)
276  , is_bold(style.is_bold)
277  , is_italic(style.is_italic)
278  , is_underline(style.is_underline)
280  , mark_style(style.mark_style)
281  , char_space(style.char_space)
282  , word_space(style.word_space) {}
283 
292  font = style.font;
293  text_size = style.text_size;
295  text_color = style.text_color;
296  is_bold = style.is_bold;
297  is_italic = style.is_italic;
298  is_underline = style.is_underline;
300  mark_style = style.mark_style;
301  char_space = style.char_space;
302  word_space = style.word_space;
303  return *this;
304  }
305 
313  bool operator == (const RichTextStyle& style) const {
314  return (font == style.font &&
315  fabs(text_size- style.text_size) <= FLT_EPSILON &&
316  text_alignment == style.text_alignment &&
317  text_color == style.text_color &&
318  is_bold == style.is_bold &&
319  is_italic == style.is_italic &&
320  is_underline == style.is_underline &&
322  mark_style == style.mark_style &&
323  char_space == style.char_space &&
324  word_space == style.word_space);
325  }
326 
334  bool operator != (const RichTextStyle& style) const {
335  return !((*this) == style);
336  }
337 
360  this->font = font;
361  this->text_size = text_size;
362  this->text_alignment = text_alignment;
363  this->text_color = text_color;
364  this->is_bold = is_bold;
365  this->is_italic = is_italic;
366  this->is_underline = is_underline;
367  this->is_strikethrough = is_strikethrough;
368  this->mark_style = mark_style;
369  this->char_space = char_space;
370  this->word_space = word_space;
371  }
372 
384 
388  float text_size;
389 
395 
400 
404  bool is_bold;
405 
409  bool is_italic;
410 
415 
420 
426 
430  float char_space;
431 
435  float word_space;
436 };
437 
441 namespace annots {
443 class BorderInfo FS_FINAL : public Object {
444  public:
450  typedef enum _Style {
452  e_Solid = 0,
459  e_Dashed = 1,
479  e_Inset = 4,
487  } Style;
488 
489 
507  BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
508  this->width = width;
509  this->style = style;
510  this->cloud_intensity = intensity;
511  this->dash_phase = dash_phase;
512  this->dashes = dashes;
513  }
514 
517  : width(1.0f)
519  , cloud_intensity(0)
520  , dash_phase(0) {}
521 
527  BorderInfo(const BorderInfo& border_info) {
528  this->width = border_info.width;
529  this->style = border_info.style;
530  this->cloud_intensity = border_info.cloud_intensity;
531  this->dash_phase = border_info.dash_phase;
532  this->dashes = border_info.dashes;
533  }
534 
542  BorderInfo& operator = (const BorderInfo& border_info) {
543  this->width = border_info.width;
544  this->style = border_info.style;
545  this->cloud_intensity = border_info.cloud_intensity;
546  this->dash_phase = border_info.dash_phase;
547  this->dashes = border_info.dashes;
548  return *this;
549  }
550 
558  bool operator == (const BorderInfo& border_info) const {
559  if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
560  fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
561  fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
562  dashes.GetSize() != border_info.dashes.GetSize())
563  return false;
564  for (int i=0; i<dashes.GetSize(); i++) {
565  if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
566  return false;
567  }
568  return true;
569  }
570 
578  bool operator != (const BorderInfo& border_info) const{
579  if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
580  fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
581  fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
582  dashes.GetSize() != border_info.dashes.GetSize())
583  return true;
584  for (int i=0; i<dashes.GetSize(); i++) {
585  if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
586  return true;
587  }
588  return false;
589  }
590 
610  void Set(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
611  this->width = width;
612  this->style = style;
613  this->cloud_intensity = intensity;
614  this->dash_phase = dash_phase;
615  this->dashes = dashes;
616  }
617 
623  float width;
624 
630 
643 
649  float dash_phase;
650 
658 };
659 
670 class QuadPoints FS_FINAL : public Object {
671  public:
680  QuadPoints(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
681  this->first = first;
682  this->second = second;
683  this->third = third;
684  this->fourth = fourth;
685  }
686 
689 
695  QuadPoints(const QuadPoints& quad_points) {
696  first = quad_points.first;
697  second = quad_points.second;
698  third = quad_points.third;
699  fourth = quad_points.fourth;
700  }
701 
709  QuadPoints& operator = (const QuadPoints& quad_points) {
710  first = quad_points.first;
711  second = quad_points.second;
712  third = quad_points.third;
713  fourth = quad_points.fourth;
714  return *this;
715  }
716 
724  bool operator == (const QuadPoints& quad_points) const {
725  return (first == quad_points.first && second == quad_points.second &&
726  third == quad_points.third && fourth == quad_points.fourth);
727  }
728 
736  bool operator != (const QuadPoints& quad_points) const {
737  return (first != quad_points.first || second != quad_points.second ||
738  third != quad_points.third || fourth != quad_points.fourth);
739  }
740 
751  void Set(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
752  this->first = first;
753  this->second = second;
754  this->third = third;
755  this->fourth = fourth;
756  }
757 
766 };
767 
769 FSDK_DEFINE_ARRAY(QuadPointsArray, QuadPoints)
770 
771 
775 class IconFit FS_FINAL : public Object {
776  public:
781  typedef enum _ScaleWayType {
783  e_ScaleWayNone = 0,
785  e_ScaleWayAlways = 1,
787  e_ScaleWayBigger = 2,
789  e_ScaleWaySmaller = 3,
791  e_ScaleWayNever = 4
792  } ScaleWayType;
793 
794 
797  : scale_way_type(e_ScaleWayNone)
798  , is_proportional_scaling(false)
799  , horizontal_fraction(0)
800  , vertical_fraction(0)
801  , fit_bounds(false) {}
802 
827  IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
828  float vertical_fraction, bool fit_bounds)
829  : scale_way_type(type)
830  , is_proportional_scaling(is_proportional_scaling)
831  , horizontal_fraction(horizontal_fraction)
832  , vertical_fraction(vertical_fraction)
833  , fit_bounds(fit_bounds) {}
834 
840  IconFit(const IconFit& icon_fit)
841  : scale_way_type(icon_fit.scale_way_type)
842  , is_proportional_scaling(icon_fit.is_proportional_scaling)
843  , horizontal_fraction(icon_fit.horizontal_fraction)
844  , vertical_fraction(icon_fit.vertical_fraction)
845  , fit_bounds(icon_fit.fit_bounds) {}
846 
854  IconFit& operator = (const IconFit& icon_fit) {
855  scale_way_type = icon_fit.scale_way_type;
856  is_proportional_scaling = icon_fit.is_proportional_scaling;
857  horizontal_fraction = icon_fit.horizontal_fraction;
858  vertical_fraction = icon_fit.vertical_fraction;
859  fit_bounds = icon_fit.fit_bounds;
860  return *this;
861  }
862 
870  bool operator == (const IconFit& icon_fit) const {
871  return (scale_way_type == icon_fit.scale_way_type &&
872  is_proportional_scaling == icon_fit.is_proportional_scaling &&
873  fabs(horizontal_fraction - icon_fit.horizontal_fraction) <= FLT_EPSILON &&
874  fabs(vertical_fraction - icon_fit.vertical_fraction) <= FLT_EPSILON &&
875  fit_bounds == icon_fit.fit_bounds);
876  }
877 
885  bool operator != (const IconFit& icon_fit) const {
886  return (scale_way_type != icon_fit.scale_way_type ||
887  is_proportional_scaling != icon_fit.is_proportional_scaling ||
888  fabs(horizontal_fraction - icon_fit.horizontal_fraction) > FLT_EPSILON ||
889  fabs(vertical_fraction - icon_fit.vertical_fraction) > FLT_EPSILON ||
890  fit_bounds != icon_fit.fit_bounds);
891  }
892 
920  void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
921  float vertical_fraction, bool fit_bounds) {
922  this->scale_way_type = type;
923  this->is_proportional_scaling = is_proportional_scaling;
924  this->horizontal_fraction = horizontal_fraction;
925  this->vertical_fraction = vertical_fraction;
926  this->fit_bounds = fit_bounds;
927  }
928 
963 };
964 
997 class Annot : public Base {
998  public:
1004  typedef enum _Type {
1011  e_Note = 1,
1013  e_Link = 2,
1017  e_Line = 4,
1035  e_Stamp = 13,
1037  e_Caret = 14,
1039  e_Ink = 15,
1041  e_PSInk = 16,
1045  e_Sound = 18,
1047  e_Movie = 19,
1052  e_Widget = 20,
1054  e_Screen = 21,
1062  e_3D = 25,
1064  e_Popup = 26,
1066  e_Redact = 27,
1071  } Type;
1072 
1078  typedef enum _Flags {
1091  e_FlagHidden = 0x0002,
1099  e_FlagPrint = 0x0004,
1106  e_FlagNoZoom = 0x0008,
1113  e_FlagNoRotate = 0x0010,
1121  e_FlagNoView = 0x0020,
1130  e_FlagReadOnly = 0x0040,
1137  e_FlagLocked = 0x0080,
1151  } Flags;
1152 
1158  typedef enum _HighlightingMode {
1169  } HighlightingMode;
1170 
1176  typedef enum _Property {
1196  } Property;
1197 
1203  typedef enum _MKEntry {
1252  } MKEntry;
1253 
1259  typedef enum _MKIconCaptionRelation {
1275 
1281  typedef enum _AppearanceType {
1288  } AppearanceType;
1289 
1290 
1291  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1292  explicit Annot(FS_HANDLE handle);
1300  Annot(const PDFPage& page, objects::PDFDictionary* annot_dict);
1301 #ifndef __EMSCRIPTEN_RENDER__
1302 
1307  Annot(const Annot& annot);
1308 #endif
1309 
1310  Annot() {}
1311 #ifndef __EMSCRIPTEN_RENDER__
1312 
1319  Annot& operator = (const Annot& annot);
1320 #endif
1321 
1328  bool operator ==(const Annot& other) const;
1336  bool operator != (const Annot& other) const;
1337 #ifndef __EMSCRIPTEN_RENDER__
1338 
1339  virtual ~Annot();
1340 #endif
1341 
1348  bool IsEmpty() const;
1349 
1355  PDFPage GetPage() const;
1362  bool IsMarkup() const;
1368  Type GetType() const;
1374  int GetIndex() const;
1380  WString GetContent() const;
1394  void SetContent(const WString& content);
1401  DateTime GetModifiedDateTime() const;
1409  void SetModifiedDateTime(const DateTime& date_time);
1416  uint32 GetFlags() const;
1425  void SetFlags(uint32 flags);
1431  WString GetUniqueID() const;
1439  void SetUniqueID(const WString& unique_id);
1446  RectF GetRect() const;
1447 
1460  Matrix GetDisplayMatrix(const Matrix& page_display_matrix);
1461 
1471  bool Move(const RectF& rect);
1472 
1483  bool Move(const RectF& rect, bool is_reset_appearance);
1484 
1501  BorderInfo GetBorderInfo() const;
1502 
1520  void SetBorderInfo(const BorderInfo& border);
1529  RGB GetBorderColor() const;
1541  void SetBorderColor(RGB color);
1554  bool ResetAppearanceStream();
1555 
1573  bool ResetAppearanceStream(bool is_generate_new_appearance_obj);
1574 
1590  RectI GetDeviceRect(const Matrix& matrix);
1591 
1598 
1608  bool HasProperty(Property property) const;
1609 
1627  bool RemoveProperty(Property property);
1628 
1636 
1653  objects::PDFStream* GetAppearanceStream(AppearanceType type, const char* appearance_state = "") const;
1654 };
1655 
1657 FSDK_DEFINE_ARRAY(AnnotArray, Annot)
1658 
1659 
1660 class ShadingColor FS_FINAL : public Object {
1661  public:
1668  ShadingColor(ARGB firstcolor, ARGB secondcolor)
1669  : first_color(firstcolor)
1670  , second_color(secondcolor) {}
1671 
1674  : first_color(0xFFFFFFFF)
1675  , second_color(0xFFFFFFFF) {}
1676 
1682  ShadingColor(const ShadingColor& shading_color)
1683  : first_color(shading_color.first_color)
1684  , second_color(shading_color.second_color) {}
1685 
1693  ShadingColor& operator = (const ShadingColor& shading_color) {
1694  this->first_color = shading_color.first_color;
1695  this->second_color = shading_color.second_color;
1696  return *this;
1697  }
1698 
1706  bool operator == (const ShadingColor& shading_color) const {
1707  return (first_color == shading_color.first_color && second_color == shading_color.second_color);
1708  }
1709 
1717  bool operator != (const ShadingColor& shading_color) const {
1718  return (first_color != shading_color.first_color || second_color != shading_color.second_color);
1719  }
1720 
1729  void Set(ARGB firstcolor, ARGB secondcolor) {
1730  this->first_color = firstcolor;
1731  this->second_color = secondcolor;
1732  }
1733 
1738 };
1739 
1750  public:
1756  virtual void Release() = 0;
1765  virtual String GetProviderID() {
1766  return String();
1767  }
1777  return String();
1778  }
1788  virtual bool HasIcon(Annot::Type annot_type, const char* icon_name) {
1789  return false;
1790  }
1801  virtual bool CanChangeColor(Annot::Type annot_type, const char* icon_name) {
1802  return false;
1803  }
1804 #ifndef __EMSCRIPTEN_RENDER__
1805 
1815  virtual PDFPage GetIcon(Annot::Type annot_type, const char* icon_name, ARGB color);
1816 #endif
1817 
1831  virtual bool GetShadingColor(Annot::Type annot_type, const char* icon_name,
1832  RGB referenced_color, int shading_index, ShadingColor& out_shading_color) {
1833  return false;
1834  }
1845  virtual float GetDisplayWidth(Annot::Type annot_type, const char* icon_name) {
1846  return 0.0f;
1847  }
1858  virtual float GetDisplayHeight(Annot::Type annot_type, const char* icon_name) {
1859  return 0.0f;
1860  }
1861 
1862  protected:
1863  ~IconProviderCallback() {}
1864 };
1865 
1866 class Markup;
1868 FSDK_DEFINE_ARRAY(MarkupArray, Markup)
1869 
1870 class Note;
1872 FSDK_DEFINE_ARRAY(NoteArray, Note)
1873 
1874 
1891 class Markup : public Annot {
1892  public:
1898  typedef enum _StateModel {
1900  e_StateModelMarked = 1,
1902  e_StateModelReview = 2
1903  } StateModel;
1904 
1910  typedef enum _State {
1915  e_StateNone = 0,
1920  e_StateMarked = 1,
1925  e_StateUnmarked = 2,
1930  e_StateAccepted = 3,
1935  e_StateRejected = 4,
1940  e_StateCancelled = 5,
1945  e_StateCompleted = 6,
1950  e_StateDeferred = 7,
1955  e_StateFuture = 8
1956  } State;
1957 
1963  typedef enum _EndingStyle {
1965  e_EndingStyleNone = 0,
1967  e_EndingStyleSquare = 1,
1969  e_EndingStyleCircle = 2,
1971  e_EndingStyleDiamond = 3,
1973  e_EndingStyleOpenArrow = 4,
1979  e_EndingStyleClosedArrow = 5,
1981  e_EndingStyleButt = 6,
1983  e_EndingStyleROpenArrow = 7,
1985  e_EndingStyleRClosedArrow = 8,
1987  e_EndingStyleSlash = 9
1988  } EndingStyle;
1989 
1995  typedef enum _MeasureType {
1997  e_MeasureTypeX = 0,
1999  e_MeasureTypeY = 1,
2001  e_MeasureTypeD = 2,
2003  e_MeasureTypeA = 3,
2005  e_MeasureTypeT = 4,
2007  e_MeasureTypeS = 5
2008  } MeasureType;
2009 
2010 
2016  explicit Markup(const Annot& annot);
2017  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2018  explicit Markup(FS_HANDLE handle);
2020  Markup() {}
2021 
2023  ~Markup() {}
2024 
2042  Popup GetPopup();
2059  void SetPopup(const Popup& popup);
2060 
2067  bool RemovePopup();
2068 
2076  WString GetTitle() const;
2077 
2087  void SetTitle(const WString& title);
2088 
2094  WString GetSubject() const;
2095 
2103  void SetSubject(const WString& subject);
2104 
2113  float GetOpacity() const;
2114 
2127  void SetOpacity(float opacity);
2128 
2150  String GetIntent() const;
2151 
2188  void SetIntent(const String& intent);
2189 
2196  DateTime GetCreationDateTime() const;
2197 
2205  void SetCreationDateTime(const DateTime& date_time);
2206 
2212  int GetReplyCount();
2213 
2222  Note GetReply(int index) const;
2223 
2229  Note AddReply();
2230 
2241  bool RemoveReply(int index);
2242 
2248  bool RemoveAllReplies();
2249 
2266  bool IsGrouped();
2267 
2286  Markup GetGroupHeader();
2287 
2304  MarkupArray GetGroupElements();
2305 
2321  bool Ungroup();
2322 
2338  NoteArray GetStateAnnots(StateModel model);
2339 
2376  Note AddStateAnnot(const WString& title, StateModel model, State state);
2377 
2387  bool RemoveAllStateAnnots();
2395  int32 GetRichTextCount();
2396 
2407  WString GetRichTextContent(int32 index);
2408 
2420  void SetRichTextContent(int32 index, const WString& content);
2421 
2432  RichTextStyle GetRichTextStyle(int32 index);
2433 
2447  void SetRichTextStyle(int32 index, const RichTextStyle& style);
2448 
2461  void AddRichText(const WString& content, const RichTextStyle& style);
2462 
2479  void InsertRichText(int32 index, const WString& content, const RichTextStyle& style);
2480 
2491  void RemoveRichText(int index);
2492 
2505  void SetBorderOpacity(float opacity);
2506 
2513  float GetBorderOpacity() const;
2514 
2527  void SetFillOpacity(float opacity);
2528 
2535  float GetFillOpacity() const;
2536 };
2537 
2560 class Note FS_FINAL : public Markup {
2561  public:
2563  Note() {}
2569  explicit Note(const Annot& annot);
2570  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2571  explicit Note(FS_HANDLE handle);
2573  ~Note() {}
2574 
2587  bool GetOpenStatus() const;
2602  void SetOpenStatus(bool status);
2614  String GetIconName() const;
2632  void SetIconName(const char* icon_name);
2642  Markup GetReplyTo();
2649  bool IsStateAnnot();
2650 
2663 
2675  State GetState();
2676 
2700  void SetState(State state);
2701 
2702 };
2703 
2715 class TextMarkup: public Markup {
2716  public:
2724  explicit TextMarkup(const Annot& annot);
2727 
2762  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2763 };
2764 
2781 class Highlight FS_FINAL : public TextMarkup {
2782  public:
2790  explicit Highlight(const Annot& annot);
2793 };
2794 
2811 class Underline FS_FINAL : public TextMarkup {
2812  public:
2820  explicit Underline(const Annot& annot);
2823 };
2824 
2841 class StrikeOut FS_FINAL : public TextMarkup {
2842  public:
2850  explicit StrikeOut(const Annot& annot);
2853 };
2854 
2871 class Squiggly FS_FINAL : public TextMarkup {
2872  public:
2880  explicit Squiggly(const Annot& annot);
2883 };
2884 
2898 class Link FS_FINAL : public Annot {
2899  public:
2901  Link() {}
2907  explicit Link(const Annot& annot);
2908  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2909  explicit Link(FS_HANDLE handle);
2911  ~Link() {}
2912 
2945  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2946 
2955 
2966 
2974 
2989  void SetAction(const actions::Action& action);
2990 
2996  bool RemoveAction();
2997 
3007 };
3008 
3023 class Square FS_FINAL : public Markup {
3024  public:
3026  Square() {}
3032  explicit Square(const Annot& annot);
3034  ~Square() {}
3035 
3042  RGB GetFillColor() const;
3043 
3051  void SetFillColor(RGB fill_color);
3052 
3062  RectF GetInnerRect() const;
3074  void SetInnerRect(const RectF& inner_rect);
3075 
3089  void SetMeasureRatio(const char* ratio);
3090 
3101 
3112 
3125  void SetMeasureUnit(MeasureType measure_type, const char* unit);
3126 
3138  String GetMeasureUnit(MeasureType measure_type);
3139 
3151  WString GetMeasureUnitW(MeasureType measure_type);
3152 
3165  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3166 
3178  float GetMeasureConversionFactor(MeasureType measure_type);
3179 };
3180 
3195 class Circle FS_FINAL : public Markup {
3196  public:
3198  Circle() {}
3204  explicit Circle(const Annot& annot);
3206  ~Circle() {}
3207 
3214  RGB GetFillColor() const;
3215 
3226  void SetFillColor(RGB fill_color);
3227 
3237  RectF GetInnerRect() const;
3238 
3252  void SetInnerRect(const RectF& inner_rect);
3253 
3267  void SetMeasureRatio(const char* ratio);
3268 
3279 
3290 
3303  void SetMeasureUnit(MeasureType measure_type, const char* unit);
3304 
3316  String GetMeasureUnit(MeasureType measure_type);
3317 
3329  WString GetMeasureUnitW(MeasureType measure_type);
3330 
3343  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3344 
3356  float GetMeasureConversionFactor(MeasureType measure_type);
3357 };
3358 
3378 class FreeText FS_FINAL : public Markup {
3379  public:
3387  explicit FreeText(const Annot& annot);
3388 
3391 
3402  RGB GetFillColor() const;
3403 
3417  void SetFillColor(RGB fill_color);
3418 
3434 
3453  void SetAlignment(common::Alignment alignment);
3454 
3465  RectF GetInnerRect() const;
3466 
3481  void SetInnerRect(const RectF& inner_rect);
3482 
3492 
3515  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
3516 
3528 
3543  void SetCalloutLineEndingStyle(EndingStyle ending_style);
3544 
3559 
3582  void SetCalloutLinePoints(const PointFArray& point_array);
3583 
3599  void SetTextMatrix(const Matrix& text_matrix);
3600 
3612  Matrix GetTextMatrix() const;
3613 
3621 
3636  void SetRotation(common::Rotation rotation);
3637 
3650  void Rotate(common::Rotation rotation);
3651 
3669  void AllowTextOverflow(bool is_text_overflow);
3670 };
3671 
3690 class Line FS_FINAL : public Markup {
3691  public:
3697  typedef enum _CapPos {
3702  } CapPos;
3703 
3704 
3706  Line() {}
3712  explicit Line(const Annot& annot);
3714  ~Line() {}
3715 
3737  void SetLineStartStyle(EndingStyle ending_style);
3746  EndingStyle GetLineEndStyle() const;
3759  void SetLineEndStyle(EndingStyle ending_style);
3760 
3771  RGB GetStyleFillColor() const;
3772 
3786  void SetStyleFillColor(RGB color);
3787 
3796  PointF GetStartPoint() const;
3809  void SetStartPoint(const PointF& point);
3810 
3819  PointF GetEndPoint() const;
3832  void SetEndPoint(const PointF& point);
3833 
3842  bool HasCaption() const;
3855  void EnableCaption(bool cap);
3856 
3884  void SetCaptionPositionType(CapPos cap_position);
3897  Offset GetCaptionOffset() const;
3913  void SetCaptionOffset(const Offset& offset);
3914 
3929  float GetLeaderLineLength() const;
3947  void SetLeaderLineLength(float length);
3957  float GetLeaderLineExtensionLength() const;
3970  void SetLeaderLineExtensionLength(float extension_length);
3971 
3982  float GetLeaderLineOffset() const;
3996  void SetLeaderLineOffset(float offset);
3997 
4011  void SetMeasureRatio(const String& ratio);
4012 
4023 
4034 
4047  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4048 
4060  String GetMeasureUnit(MeasureType measure_type);
4061 
4073  WString GetMeasureUnitW(MeasureType measure_type);
4074 
4087  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4088 
4100  float GetMeasureConversionFactor(MeasureType measure_type);
4101 };
4102 
4120 class Ink FS_FINAL : public Markup {
4121  public:
4123  Ink() {}
4129  explicit Ink(const Annot& annot);
4131  ~Ink() {}
4159 
4192  void SetInkList(const common::Path& ink_list);
4193 
4205  void EnableUseBezier(bool use_bezier);
4206 
4207 };
4208 
4233 class Stamp FS_FINAL : public Markup {
4234  public:
4236  Stamp() {}
4242  explicit Stamp(const Annot& annot);
4243 #ifndef __EMSCRIPTEN_RENDER__
4244 
4245  ~Stamp();
4246 #endif
4247 
4258  String GetIconName() const;
4281  void SetIconName(const char* icon_name);
4292  void SetBitmap(const common::Bitmap& bitmap);
4293 
4316  void SetImage(const common::Image& image, int frame_index, int compress);
4317 
4328  void SetRotation(int angle);
4329 
4335  int GetRotation();
4336 
4346  void Rotate(int angle);
4347 };
4348 
4361 class Screen FS_FINAL : public Annot {
4362  public:
4364  Screen() {}
4370  explicit Screen(const Annot& annot);
4372  virtual ~Screen() {}
4373 
4396  void SetImage(const common::Image& image, int frame_index, int compress);
4397 
4405 
4417 
4425 
4438  void SetRotation(common::Rotation rotate);
4439 
4447 
4456  float GetOpacity() const;
4469  void SetOpacity(float opacity);
4470 
4476  WString GetTitle() const;
4484  void SetTitle(const WString& title);
4485 
4519  void SetAction(const actions::Action& action);
4528  void RemoveAction();
4529 };
4530 
4549 class Polygon FS_FINAL : public Markup {
4550  public:
4552  Polygon() {}
4558  explicit Polygon(const Annot& annot);
4569  RGB GetFillColor() const;
4570 
4582  void SetFillColor(RGB fill_color);
4583 
4593 
4605  void SetVertexes(const PointFArray& vertexes);
4606 
4620  void SetMeasureRatio(const String& ratio);
4621 
4632 
4643 
4656  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4657 
4669  String GetMeasureUnit(MeasureType measure_type);
4670 
4682  WString GetMeasureUnitW(MeasureType measure_type);
4683 
4696  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4697 
4709  float GetMeasureConversionFactor(MeasureType measure_type);
4710 };
4711 
4731 class PolyLine FS_FINAL : public Markup {
4732  public:
4740  explicit PolyLine(const Annot& annot);
4753  RGB GetStyleFillColor() const;
4765  void SetStyleFillColor(RGB fill_color);
4766 
4776 
4788  void SetVertexes(const PointFArray& vertexes);
4811  void SetLineStartStyle(EndingStyle starting_style);
4820  EndingStyle GetLineEndStyle() const;
4834  void SetLineEndStyle(EndingStyle ending_style);
4835 
4849  void SetMeasureRatio(const String& ratio);
4850 
4861 
4872 
4885  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4886 
4898  String GetMeasureUnit(MeasureType measure_type);
4899 
4911  WString GetMeasureUnitW(MeasureType measure_type);
4912 
4925  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4926 
4938  float GetMeasureConversionFactor(MeasureType measure_type);
4939 };
4940 
4953 class Caret FS_FINAL : public Markup {
4954  public:
4956  Caret() {}
4962  explicit Caret(const Annot& annot);
4964  ~Caret() {}
4965 
4975  RectF GetInnerRect() const;
4989  void SetInnerRect(const RectF& inner_rect);
4990 };
4991 
5004 class FileAttachment FS_FINAL : public Markup {
5005  public:
5013  explicit FileAttachment(const Annot& annot);
5016 
5024  bool SetFileSpec(const FileSpec& file_spec);
5025 
5033 
5044  String GetIconName() const;
5045 
5061  void SetIconName(const char* icon_name);
5062 };
5063 
5073 class Popup FS_FINAL : public Annot {
5074  public:
5076  Popup() {}
5082  explicit Popup(const Annot& annot);
5083  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5084  explicit Popup(FS_HANDLE handle);
5086  ~Popup() {}
5087 
5100  bool GetOpenStatus() const;
5115  void SetOpenStatus(bool status);
5116 
5124  Markup GetParent();
5125 };
5126 #ifndef __FSDK_NO_PSINK__
5127 
5146 class PSInk FS_FINAL : public Annot {
5147  public:
5149  PSInk() {}
5155  explicit PSInk(const Annot& annot);
5156  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5157  explicit PSInk(FS_HANDLE handle);
5159  ~PSInk() {}
5160 
5161 };
5162 #endif
5163 
5176 class Widget FS_FINAL : public Annot {
5177  public:
5183  typedef enum _LineSpacingStyle {
5194  } LineSpacingStyle;
5195 
5196 
5198  Widget() {}
5204  explicit Widget(const Annot& annot);
5205  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5206  explicit Widget(FS_HANDLE handle);
5207 #ifndef __EMSCRIPTEN_RENDER__
5208 
5209  ~Widget();
5210 #endif
5211 
5217 
5224 
5235 
5248 
5259 
5283  void SetAction(const actions::Action& action);
5284 
5293  void RemoveAction();
5294 
5306  bool HasMKEntry(MKEntry mk_entry);
5307 
5319  void RemoveMKEntry(MKEntry mk_entry);
5320 
5334 
5347  void SetMKRotation(common::Rotation rotation);
5348 
5359  RGB GetMKBorderColor() const;
5360 
5371  void SetMKBorderColor(RGB color);
5372 
5383  RGB GetMKBackgroundColor() const;
5384 
5395  void SetMKBackgroundColor(RGB color);
5396 
5410  WString GetMKNormalCaption() const;
5411 
5425  void SetMKNormalCaption(const wchar_t* caption);
5426 
5441  WString GetMKRolloverCaption() const;
5442 
5457  void SetMKRolloverCaption(const wchar_t* caption);
5458 
5472  WString GetMKDownCaption() const;
5473 
5487  void SetMKDownCaption(const wchar_t* caption);
5488 
5502 
5516  void SetMKNormalIconBitmap(const common::Bitmap& bitmap);
5517 
5533  void SetMKNormalIconImage(const common::Image& image, int frame_index);
5534 
5549 
5564  void SetMKRolloverIconBitmap(const common::Bitmap& bitmap);
5565 
5582  void SetMKRolloverIconImage(const common::Image& image, int frame_index);
5583 
5597 
5611  void SetMKDownIconBitmap(const common::Bitmap& bitmap);
5612 
5628  void SetMKDownIconImage(const common::Image& image, int frame_index);
5629 
5644  IconFit GetMKIconFit() const;
5645 
5663  void SetMKIconFit(const IconFit& icon_fit);
5664 
5679 
5696 
5704  void SetAppearanceState(const String& appearance_state);
5705 
5711  String GetAppearanceState() const;
5712 
5719 
5731  LineSpacingStyle GetLineSpacing(float& line_spacing_value);
5732 
5748  void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value);
5749 
5750 #ifdef _SUPPORTWEBSDK_
5751  //Set push button icon form icon stream. stream is from doc::createIcon.
5752  //face: 0: normal, 1: down, 2: roller
5753  void SetButtonIcon(objects::PDFStream* icon, int face);
5754 #endif
5755 };
5756 
5773 class Redact FS_FINAL : public Markup {
5774  public:
5776  Redact() {}
5782  explicit Redact(const Annot& annot);
5783  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5784  explicit Redact(FS_HANDLE handle);
5785 #ifndef __EMSCRIPTEN_RENDER__
5786 
5787  ~Redact();
5788 #endif
5789 
5803 
5822  void SetQuadPoints(const QuadPointsArray& quad_points_array);
5823 
5830  RGB GetFillColor() const;
5838  void SetFillColor(RGB fill_color);
5839 
5846  RGB GetApplyFillColor() const;
5847 
5855  void SetApplyFillColor(RGB fill_color);
5856 
5862  WString GetOverlayText() const;
5863 
5871  void SetOverlayText(const WString& overlay_text);
5872 
5878  bool IsOverlayTextRepeated();
5879 
5888  void EnableRepeatOverlayText(bool is_to_repeat_overlay_text);
5889 
5899 
5913 
5919  void EnableAutoFontSize();
5920 
5930 
5953  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
5954 
5967  bool Apply();
5968 };
5969 
5979 class Sound FS_FINAL : public Markup{
5980  public:
5986  typedef enum _SampleEncodingFormat {
5996 
5997 
5999  Sound() {}
6000 
6006  explicit Sound(const Annot& annot);
6007 
6008  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
6009  explicit Sound(FS_HANDLE handle);
6010 
6011 #ifndef __EMSCRIPTEN_RENDER__
6012 
6013  ~Sound();
6014 #endif
6015 
6028 
6034  float GetSamplingRate() const;
6035 
6041  int GetChannelCount() const;
6042 
6048  int GetBits() const;
6049 
6057 
6063  String GetCompressionFormat() const;
6064 
6078  FileSpec GetFileSpec() const;
6079 };
6080 
6096 class PagingSeal FS_FINAL : public Annot {
6097  public:
6099  PagingSeal(const Annot& annot);
6100 
6102  ~PagingSeal();
6103 
6110 
6111  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
6112  explicit PagingSeal(FS_HANDLE handle);
6113 };
6114 
6115 } // namespace annots
6116 } // namespace pdf
6117 } // namespace foxit
6118 
6119 #endif // FS_ANNOT_H_
6120 
foxit::pdf::annots::Annot::e_Caret
Annotation type: caret annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1037
foxit::pdf::annots::Screen
Definition: fs_annot.h:4361
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:1045
foxit::pdf::annots::FileAttachment::~FileAttachment
~FileAttachment()
Destructor.
Definition: fs_annot.h:5015
foxit::pdf::annots::Popup
Definition: fs_annot.h:5073
foxit::pdf::annots::Annot::e_StrikeOut
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1033
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:1660
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:1060
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:5990
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:2573
foxit::pdf::annots::Annot::e_MKRelationCaptionAboveIcon
Caption above the icon.
Definition: fs_annot.h:1267
foxit::pdf::annots::FileAttachment::FileAttachment
FileAttachment()
Constructor.
Definition: fs_annot.h:5007
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:1066
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor()
Constructor.
Definition: fs_annot.h:1673
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:1019
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:2560
foxit::pdf::annots::Circle::Circle
Circle()
Constructor.
Definition: fs_annot.h:3198
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:5086
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:2822
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:743
foxit::pdf::annots::QuadPoints::third
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:763
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:1209
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:482
foxit::pdf::annots::Annot::e_3D
Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1062
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:1150
foxit::pdf::annots::Annot
Definition: fs_annot.h:997
foxit::pdf::annots::Annot::e_FlagHidden
Annotation flag: hidden.
Definition: fs_annot.h:1091
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:1261
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:610
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:1285
foxit::pdf::annots::Widget::e_LineSpacingDouble
Line spacing style: double line spacing.
Definition: fs_annot.h:5189
foxit::pdf::annots::Sound
Definition: fs_annot.h:5979
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:1265
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:404
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:943
foxit::pdf::annots::Sound::e_SampleEncodingFormatRaw
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5988
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:425
foxit::pdf::annots::Highlight::~Highlight
~Highlight()
Destructor.
Definition: fs_annot.h:2792
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:1166
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:2781
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:1054
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:5198
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:629
foxit::pdf::RichTextStyle::is_italic
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:409
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:2784
foxit::pdf::annots::Annot::e_PropertyFillColor
Annotation property: fill color.
Definition: fs_annot.h:1195
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:3026
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:1271
foxit::pdf::annots::BorderInfo::operator=
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:542
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:1143
foxit::pdf::annots::QuadPoints::operator!=
bool operator!=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:736
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:1845
foxit::pdf::annots::IconProviderCallback::GetProviderVersion
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1776
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:215
foxit::pdf::annots::Markup::State
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1910
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:4742
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:827
foxit::pdf::annots::Line::SetCaptionPositionType
void SetCaptionPositionType(CapPos cap_position)
Set the position type of caption.
foxit::pdf::annots::Squiggly
Definition: fs_annot.h:2871
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:1068
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:388
foxit::pdf::annots::Annot::e_FlagNoZoom
Annotation flag: no zoom.
Definition: fs_annot.h:1106
fs_common.h
Header file for common definitions and classes.
foxit::pdf::annots::TextMarkup::~TextMarkup
~TextMarkup()
Destructor.
Definition: fs_annot.h:2726
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:3023
foxit::pdf::annots::Screen::Screen
Screen()
Constructor.
Definition: fs_annot.h:4364
foxit::pdf::annots::ShadingColor::second_color
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1737
foxit::pdf::annots::BorderInfo::e_Cloudy
Border style: Cloudy.
Definition: fs_annot.h:486
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:1064
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:1015
foxit::pdf::annots::BorderInfo::e_Solid
Border style: Solid.
Definition: fs_annot.h:452
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:962
foxit::pdf::annots::Underline
Definition: fs_annot.h:2811
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:4734
foxit::pdf::annots::Line::GetLeaderLineOffset
float GetLeaderLineOffset() const
Get the length of leader line offset.
foxit::pdf::annots::Stamp
Definition: fs_annot.h:4233
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:751
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:1162
foxit::pdf::annots::Circle::~Circle
~Circle()
Destructor.
Definition: fs_annot.h:3206
foxit::pdf::annots::Annot::e_MKEntryBorderColor
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1207
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:1668
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:5176
foxit::pdf::annots::ShadingColor::Set
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1729
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:5999
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:796
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:459
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:1099
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:1121
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:5187
foxit::pdf::annots::Line::GetCaptionOffset
Offset GetCaptionOffset() const
Get caption offset values.
foxit::pdf::annots::PSInk::~PSInk
~PSInk()
Destructor.
Definition: fs_annot.h:5159
foxit::pdf::annots::Line::e_CapPosTop
Definition: fs_annot.h:3701
foxit::pdf::annots::PSInk::PSInk
PSInk()
Constructor.
Definition: fs_annot.h:5149
foxit::pdf::annots::Markup::Markup
Markup()
Constructor.
Definition: fs_annot.h:2020
foxit::pdf::annots::ShadingColor::first_color
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1735
foxit::pdf::annots::NoteArray
Definition: fs_annot.h:1872
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:1263
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:217
foxit::common::Path
Definition: fs_common.h:2143
foxit::pdf::annots::Annot::e_FileAttachment
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1043
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:4372
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:1011
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:1006
foxit::pdf::annots::Stamp::Stamp
Stamp()
Constructor.
Definition: fs_annot.h:4236
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1682
foxit::pdf::annots::Annot::e_FlagInvisible
Annotation flag: invisible.
Definition: fs_annot.h:1085
foxit::pdf::annots::Redact::SetDefaultAppearance
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
foxit::pdf::annots::StrikeOut
Definition: fs_annot.h:2841
foxit::pdf::annots::FreeText
Definition: fs_annot.h:3378
foxit::pdf::annots::Markup
Definition: fs_annot.h:1891
foxit::pdf::annots::Ink
Definition: fs_annot.h:4120
foxit::pdf::annots::Caret::Caret
Caret()
Constructor.
Definition: fs_annot.h:4956
foxit::pdf::annots::BorderInfo::dashes
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:657
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:5992
foxit::pdf::annots::Line::Line
Line()
Constructor.
Definition: fs_annot.h:3706
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:3195
foxit::pdf::annots::Annot::e_MKEntryIconCaptionRelation
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:1251
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:5773
foxit::pdf::annots::Annot::e_FlagLocked
Annotation flag: locked.
Definition: fs_annot.h:1137
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:934
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:759
foxit::pdf::annots::Annot::e_MKRelationCaptionOvrlayOnIcon
Caption overlaid directly on the icon.
Definition: fs_annot.h:1273
foxit::pdf::annots::Annot::e_PropertyModifiedDate
Annotation property: modified date.
Definition: fs_annot.h:1178
foxit::pdf::annots::Redact::~Redact
~Redact()
Destructor.
foxit::pdf::RichTextStyle
Definition: fs_annot.h:204
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:1801
foxit::pdf::annots::Annot::e_MKEntryNormalIcon
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1229
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:399
foxit::pdf::annots::Widget::e_LineSpacingAuto
Line spacing style: auto line spacing.
Definition: fs_annot.h:5193
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:507
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:5191
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:1281
foxit::pdf::annots::Annot::e_MKEntryRolloverIcon
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1234
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:1831
foxit::pdf::annots::Annot::e_HighlightingToggle
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1168
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:1160
foxit::pdf::annots::Annot::e_FlagNoRotate
Annotation flag: no rotate.
Definition: fs_annot.h:1113
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:1657
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:1176
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:695
foxit::pdf::annots::QuadPoints::fourth
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:765
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:1283
foxit::pdf::annots::Annot::e_Highlight
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1027
foxit::pdf::annots::BorderInfo::e_UnderLine
Border style: Underline.
Definition: fs_annot.h:465
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:383
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:4552
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:6096
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo()
Constructor.
Definition: fs_annot.h:516
foxit::pdf::annots::Markup::StateModel
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1898
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:1047
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:430
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:1029
foxit::pdf::RichTextStyle::CornerMarkStyle
CornerMarkStyle
Enumeration for corner mark style.
Definition: fs_annot.h:211
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:1963
foxit::pdf::annots::BorderInfo
Definition: fs_annot.h:443
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:5185
foxit::pdf::annots::Widget::GetField
interform::Field GetField()
Get associated form field.
foxit::pdf::annots::Caret::~Caret
~Caret()
Destructor.
Definition: fs_annot.h:4964
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:1203
foxit::pdf::RichTextStyle::operator!=
bool operator!=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:334
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:2882
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:5986
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:1023
foxit::pdf::annots::Annot::e_PropertyBorderColor
Annotation property: border color.
Definition: fs_annot.h:1189
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:2844
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:1164
foxit::pdf::annots::Underline::Underline
Underline()
Constructor.
Definition: fs_annot.h:2814
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:183
foxit::pdf::annots::FreeText::FreeText
FreeText()
Constructor.
Definition: fs_annot.h:3381
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:394
foxit::pdf::annots::QuadPoints::operator==
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:724
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:1244
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:2852
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:1765
foxit::pdf::annots::IconFit::ScaleWayType
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:781
foxit::pdf::RichTextStyle::e_CornerMarkNone
Corner mark style: none.
Definition: fs_annot.h:213
foxit::pdf::annots::Annot::e_MKEntryRotation
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1205
foxit::pdf::annots::QuadPoints
Definition: fs_annot.h:670
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:1858
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:761
foxit::pdf::annots::PSInk
Definition: fs_annot.h:5146
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:920
foxit::pdf::annots::BorderInfo::operator!=
bool operator!=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:578
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:4953
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:850
foxit::pdf::annots::Annot::e_Circle
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1021
foxit::pdf::annots::Annot::e_Line
Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1017
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:1287
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:1259
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:955
foxit::pdf::annots::Annot::e_MKEntryDownCaption
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1224
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:1214
foxit::pdf::annots::Annot::e_Ink
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1039
foxit::pdf::annots::IconFit::IconFit
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:840
foxit::pdf::annots::TextMarkup
Definition: fs_annot.h:2715
foxit::pdf::annots::BorderInfo::operator==
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:558
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:239
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:3390
foxit::pdf::annots::Annot::e_Stamp
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1035
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:5183
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:271
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:642
foxit::pdf::DefaultAppearance::text_size
float text_size
Text size for default appearance.
Definition: fs_annot.h:193
foxit::pdf::DefaultAppearance::text_color
RGB text_color
Text color for default appearance. Format: 0xRRGGBB.
Definition: fs_annot.h:200
foxit::pdf::RichTextStyle::operator==
bool operator==(const RichTextStyle &style) const
Equal operator.
Definition: fs_annot.h:313
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:1130
foxit::pdf::annots::Popup::Popup
Popup()
Constructor.
Definition: fs_annot.h:5076
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:1749
foxit::pdf::annots::BorderInfo::e_Beveled
Border style: Beveled.
Definition: fs_annot.h:472
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:1052
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:1788
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:2023
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:2718
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:419
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:3697
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:1013
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:1058
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:5994
foxit::common::Image
Definition: fs_image.h:460
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:358
foxit::pdf::annots::Stamp::SetRotation
void SetRotation(int angle)
Set rotation angle (in clockwise).
foxit::pdf::annots::MarkupArray
Definition: fs_annot.h:1868
foxit::pdf::annots::Annot::e_Squiggly
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1031
foxit::pdf::annots::Annot::Type
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:1004
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:1070
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:680
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:1041
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:1310
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:1503
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:1239
foxit::pdf::annots::Annot::e_PrinterMark
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1056
foxit::pdf::annots::BorderInfo::dash_phase
float dash_phase
Dash phase.
Definition: fs_annot.h:649
foxit::pdf::annots::QuadPoints::operator=
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:709
CFX_Matrix
Definition: fx_coordinates.h:1076
foxit::pdf::annots::Annot::e_MKRelationCaptionRight
Caption to the right of the icon.
Definition: fs_annot.h:1269
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:1219
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:688
foxit::pdf::annots::Redact::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::Squiggly::Squiggly
Squiggly()
Constructor.
Definition: fs_annot.h:2874
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:254
foxit::pdf::annots::Polygon::~Polygon
~Polygon()
Destructor.
Definition: fs_annot.h:4560
foxit::pdf::annots::PolyLine
Definition: fs_annot.h:4731
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:448
foxit::pdf::annots::BorderInfo::e_Inset
Border style: Inset.
Definition: fs_annot.h:479
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:3690
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:623
foxit::pdf::annots::Annot::e_PolyLine
Annotation type: polyline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1025
foxit::pdf::RichTextStyle::is_underline
bool is_underline
A boolean value which indicates whether to underline text or not.
Definition: fs_annot.h:414
foxit::pdf::annots::Ink::~Ink
~Ink()
Destructor.
Definition: fs_annot.h:4131
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:527
foxit::pdf::annots::Polygon
Definition: fs_annot.h:4549
foxit::pdf::annots::BorderInfo::Style
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:450
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:1995
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:769
foxit::pdf::annots::Stamp::GetIconName
String GetIconName() const
Get icon name.
foxit::Base
Definition: fs_basictypes.h:449
foxit::pdf::annots::Annot::Flags
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1078
foxit::pdf::annots::Line::~Line
~Line()
Destructor.
Definition: fs_annot.h:3714
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:775
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:2563
foxit::pdf::annots::Ink::Ink
Ink()
Constructor.
Definition: fs_annot.h:4123
foxit::pdf::annots::Annot::HighlightingMode
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1158
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:3699
foxit::pdf::annots::Annot::e_PropertyCreationDate
Annotation property: creation date.
Definition: fs_annot.h:1183
foxit::pdf::annots::FileAttachment
Definition: fs_annot.h:5004
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:435
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:5776
foxit::pdf::RichTextStyle::operator=
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:291
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:949
foxit::pdf::annots::Ink::GetInkList
common::Path GetInkList()
Get ink list data.
foxit::pdf::annots::Square::~Square
~Square()
Destructor.
Definition: fs_annot.h:3034