Foxit PDF SDK
fs_annot.h
Go to the documentation of this file.
1 
15 #ifndef FS_ANNOT_H_
16 #define FS_ANNOT_H_
17 
18 #include "common/fs_common.h"
19 #include "common/file/fs_file.h"
20 #include "common/fs_image.h"
22 
28 namespace foxit {
32 namespace pdf {
33 // forward declaration
34 class PDFPage;
35 class FileSpec;
36 class PagingSealSignature;
37 namespace actions {
38 class Action;
39 } // namespace actions
40 namespace annots {
41 class Note;
42 class Popup;
43 } // namespace annots
44 namespace interform {
45 class Field;
46 class Control;
47 } // namespace interform
48 
52 class DefaultAppearance FS_FINAL : public Object {
53  public:
59  typedef enum _DefAPFlags {
61  e_FlagFont = 0x0001,
63  e_FlagTextColor = 0x0002,
65  e_FlagFontSize = 0x0004
66  } DefAPFlags;
67 
68 
84  : flags(flags)
85  , font(font)
88 
91  : flags(0)
92  , text_size(0)
93  , text_color(0x000000) {}
94 
100  DefaultAppearance(const DefaultAppearance& default_appearance)
101  : flags(default_appearance.flags)
102  , font(default_appearance.font)
103  , text_size(default_appearance.text_size)
104  , text_color(default_appearance.text_color) {}
105 
113  DefaultAppearance& operator = (const DefaultAppearance& default_appearance) {
114  flags = default_appearance.flags;
115  font = default_appearance.font;
116  text_size = default_appearance.text_size;
117  text_color = default_appearance.text_color;
118  return *this;
119  }
120 
128  bool operator == (const DefaultAppearance& default_appearance) const {
129  return (flags == default_appearance.flags && font == default_appearance.font &&
130  fabs(text_size-default_appearance.text_size) <= FLT_EPSILON &&
131  text_color == default_appearance.text_color);
132  }
133 
141  bool operator != (const DefaultAppearance& default_appearance) const {
142  return (flags != default_appearance.flags || font != default_appearance.font ||
143  fabs(text_size - default_appearance.text_size) > FLT_EPSILON ||
144  text_color != default_appearance.text_color);
145  }
146 
165  this->flags = flags;
166  this->font = font;
167  this->text_size = text_size;
168  this->text_color = text_color;
169  }
170 
193  float text_size;
200 };
201 
203 class RichTextStyle FS_FINAL : public Object{
204  public:
210  typedef enum _CornerMarkStyle {
217  } CornerMarkStyle;
218 
219 
240  : font(font)
244  , is_bold(is_bold)
250  , word_space(word_space) {}
251 
254  : text_size(0)
256  , text_color(0x000000)
257  , is_bold(false)
258  , is_italic(false)
259  , is_underline(false)
260  , is_strikethrough(false)
262  , char_space(0.0f)
263  , word_space(0.0f) {}
264 
271  : font(style.font)
272  , text_size(style.text_size)
274  , text_color(style.text_color)
275  , is_bold(style.is_bold)
276  , is_italic(style.is_italic)
277  , is_underline(style.is_underline)
279  , mark_style(style.mark_style)
280  , char_space(style.char_space)
281  , word_space(style.word_space) {}
282 
291  font = style.font;
292  text_size = style.text_size;
294  text_color = style.text_color;
295  is_bold = style.is_bold;
296  is_italic = style.is_italic;
297  is_underline = style.is_underline;
299  mark_style = style.mark_style;
300  char_space = style.char_space;
301  word_space = style.word_space;
302  return *this;
303  }
304 
312  bool operator == (const RichTextStyle& style) const {
313  return (font == style.font &&
314  fabs(text_size- style.text_size) <= FLT_EPSILON &&
315  text_alignment == style.text_alignment &&
316  text_color == style.text_color &&
317  is_bold == style.is_bold &&
318  is_italic == style.is_italic &&
319  is_underline == style.is_underline &&
321  mark_style == style.mark_style &&
322  char_space == style.char_space &&
323  word_space == style.word_space);
324  }
325 
333  bool operator != (const RichTextStyle& style) const {
334  return !((*this) == style);
335  }
336 
359  this->font = font;
360  this->text_size = text_size;
361  this->text_alignment = text_alignment;
362  this->text_color = text_color;
363  this->is_bold = is_bold;
364  this->is_italic = is_italic;
365  this->is_underline = is_underline;
366  this->is_strikethrough = is_strikethrough;
367  this->mark_style = mark_style;
368  this->char_space = char_space;
369  this->word_space = word_space;
370  }
371 
383 
387  float text_size;
388 
394 
399 
403  bool is_bold;
404 
408  bool is_italic;
409 
414 
419 
425 
429  float char_space;
430 
434  float word_space;
435 };
436 
440 namespace annots {
442 class BorderInfo FS_FINAL : public Object {
443  public:
449  typedef enum _Style {
451  e_Solid = 0,
458  e_Dashed = 1,
478  e_Inset = 4,
486  } Style;
487 
488 
506  BorderInfo(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
507  this->width = width;
508  this->style = style;
509  this->cloud_intensity = intensity;
510  this->dash_phase = dash_phase;
511  this->dashes = dashes;
512  }
513 
516  : width(1.0f)
518  , cloud_intensity(0)
519  , dash_phase(0) {}
520 
526  BorderInfo(const BorderInfo& border_info) {
527  this->width = border_info.width;
528  this->style = border_info.style;
529  this->cloud_intensity = border_info.cloud_intensity;
530  this->dash_phase = border_info.dash_phase;
531  this->dashes = border_info.dashes;
532  }
533 
541  BorderInfo& operator = (const BorderInfo& border_info) {
542  this->width = border_info.width;
543  this->style = border_info.style;
544  this->cloud_intensity = border_info.cloud_intensity;
545  this->dash_phase = border_info.dash_phase;
546  this->dashes = border_info.dashes;
547  return *this;
548  }
549 
557  bool operator == (const BorderInfo& border_info) const {
558  if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
559  fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
560  fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
561  dashes.GetSize() != border_info.dashes.GetSize())
562  return false;
563  for (int i=0; i<dashes.GetSize(); i++) {
564  if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
565  return false;
566  }
567  return true;
568  }
569 
577  bool operator != (const BorderInfo& border_info) const{
578  if (fabs(width - border_info.width) > FLT_EPSILON || style != border_info.style ||
579  fabs(cloud_intensity - border_info.cloud_intensity) > FLT_EPSILON ||
580  fabs(dash_phase - border_info.dash_phase) > FLT_EPSILON ||
581  dashes.GetSize() != border_info.dashes.GetSize())
582  return true;
583  for (int i=0; i<dashes.GetSize(); i++) {
584  if (fabs(dashes[i]-border_info.dashes[i])>FLT_EPSILON)
585  return true;
586  }
587  return false;
588  }
589 
609  void Set(float width, Style style, float intensity, float dash_phase, const FloatArray& dashes) {
610  this->width = width;
611  this->style = style;
612  this->cloud_intensity = intensity;
613  this->dash_phase = dash_phase;
614  this->dashes = dashes;
615  }
616 
622  float width;
623 
629 
642 
648  float dash_phase;
649 
657 };
658 
669 class QuadPoints FS_FINAL : public Object {
670  public:
679  QuadPoints(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
680  this->first = first;
681  this->second = second;
682  this->third = third;
683  this->fourth = fourth;
684  }
685 
688 
694  QuadPoints(const QuadPoints& quad_points) {
695  first = quad_points.first;
696  second = quad_points.second;
697  third = quad_points.third;
698  fourth = quad_points.fourth;
699  }
700 
708  QuadPoints& operator = (const QuadPoints& quad_points) {
709  first = quad_points.first;
710  second = quad_points.second;
711  third = quad_points.third;
712  fourth = quad_points.fourth;
713  return *this;
714  }
715 
723  bool operator == (const QuadPoints& quad_points) const {
724  return (first == quad_points.first && second == quad_points.second &&
725  third == quad_points.third && fourth == quad_points.fourth);
726  }
727 
735  bool operator != (const QuadPoints& quad_points) const {
736  return (first != quad_points.first || second != quad_points.second ||
737  third != quad_points.third || fourth != quad_points.fourth);
738  }
739 
750  void Set(const PointF& first, const PointF& second, const PointF& third, const PointF& fourth) {
751  this->first = first;
752  this->second = second;
753  this->third = third;
754  this->fourth = fourth;
755  }
756 
765 };
766 
768 FSDK_DEFINE_ARRAY(QuadPointsArray, QuadPoints)
769 
770 
774 class IconFit FS_FINAL : public Object {
775  public:
780  typedef enum _ScaleWayType {
782  e_ScaleWayNone = 0,
784  e_ScaleWayAlways = 1,
786  e_ScaleWayBigger = 2,
788  e_ScaleWaySmaller = 3,
790  e_ScaleWayNever = 4
791  } ScaleWayType;
792 
793 
796  : scale_way_type(e_ScaleWayNone)
797  , is_proportional_scaling(false)
798  , horizontal_fraction(0)
799  , vertical_fraction(0)
800  , fit_bounds(false) {}
801 
826  IconFit(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
827  float vertical_fraction, bool fit_bounds)
828  : scale_way_type(type)
829  , is_proportional_scaling(is_proportional_scaling)
830  , horizontal_fraction(horizontal_fraction)
831  , vertical_fraction(vertical_fraction)
832  , fit_bounds(fit_bounds) {}
833 
839  IconFit(const IconFit& icon_fit)
840  : scale_way_type(icon_fit.scale_way_type)
841  , is_proportional_scaling(icon_fit.is_proportional_scaling)
842  , horizontal_fraction(icon_fit.horizontal_fraction)
843  , vertical_fraction(icon_fit.vertical_fraction)
844  , fit_bounds(icon_fit.fit_bounds) {}
845 
853  IconFit& operator = (const IconFit& icon_fit) {
854  scale_way_type = icon_fit.scale_way_type;
855  is_proportional_scaling = icon_fit.is_proportional_scaling;
856  horizontal_fraction = icon_fit.horizontal_fraction;
857  vertical_fraction = icon_fit.vertical_fraction;
858  fit_bounds = icon_fit.fit_bounds;
859  return *this;
860  }
861 
869  bool operator == (const IconFit& icon_fit) const {
870  return (scale_way_type == icon_fit.scale_way_type &&
871  is_proportional_scaling == icon_fit.is_proportional_scaling &&
872  fabs(horizontal_fraction - icon_fit.horizontal_fraction) <= FLT_EPSILON &&
873  fabs(vertical_fraction - icon_fit.vertical_fraction) <= FLT_EPSILON &&
874  fit_bounds == icon_fit.fit_bounds);
875  }
876 
884  bool operator != (const IconFit& icon_fit) const {
885  return (scale_way_type != icon_fit.scale_way_type ||
886  is_proportional_scaling != icon_fit.is_proportional_scaling ||
887  fabs(horizontal_fraction - icon_fit.horizontal_fraction) > FLT_EPSILON ||
888  fabs(vertical_fraction - icon_fit.vertical_fraction) > FLT_EPSILON ||
889  fit_bounds != icon_fit.fit_bounds);
890  }
891 
919  void Set(ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction,
920  float vertical_fraction, bool fit_bounds) {
921  this->scale_way_type = type;
922  this->is_proportional_scaling = is_proportional_scaling;
923  this->horizontal_fraction = horizontal_fraction;
924  this->vertical_fraction = vertical_fraction;
925  this->fit_bounds = fit_bounds;
926  }
927 
962 };
963 
996 class Annot : public Base {
997  public:
1003  typedef enum _Type {
1010  e_Note = 1,
1012  e_Link = 2,
1016  e_Line = 4,
1034  e_Stamp = 13,
1036  e_Caret = 14,
1038  e_Ink = 15,
1040  e_PSInk = 16,
1044  e_Sound = 18,
1046  e_Movie = 19,
1051  e_Widget = 20,
1053  e_Screen = 21,
1061  e_3D = 25,
1063  e_Popup = 26,
1065  e_Redact = 27,
1070  } Type;
1071 
1077  typedef enum _Flags {
1090  e_FlagHidden = 0x0002,
1098  e_FlagPrint = 0x0004,
1105  e_FlagNoZoom = 0x0008,
1112  e_FlagNoRotate = 0x0010,
1120  e_FlagNoView = 0x0020,
1129  e_FlagReadOnly = 0x0040,
1136  e_FlagLocked = 0x0080,
1150  } Flags;
1151 
1157  typedef enum _HighlightingMode {
1168  } HighlightingMode;
1169 
1175  typedef enum _Property {
1195  } Property;
1196 
1202  typedef enum _MKEntry {
1251  } MKEntry;
1252 
1258  typedef enum _MKIconCaptionRelation {
1274 
1280  typedef enum _AppearanceType {
1287  } AppearanceType;
1288 
1289 
1290  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1291  explicit Annot(FS_HANDLE handle);
1299  Annot(const PDFPage& page, objects::PDFDictionary* annot_dict);
1300 #ifndef __EMSCRIPTEN_RENDER__
1301 
1306  Annot(const Annot& annot);
1307 #endif
1308 
1309  Annot() {}
1310 #ifndef __EMSCRIPTEN_RENDER__
1311 
1318  Annot& operator = (const Annot& annot);
1319 #endif
1320 
1327  bool operator ==(const Annot& other) const;
1335  bool operator != (const Annot& other) const;
1336 #ifndef __EMSCRIPTEN_RENDER__
1337 
1338  virtual ~Annot();
1339 #endif
1340 
1347  bool IsEmpty() const;
1348 
1354  PDFPage GetPage() const;
1361  bool IsMarkup() const;
1367  Type GetType() const;
1373  int GetIndex() const;
1379  WString GetContent() const;
1393  void SetContent(const WString& content);
1400  DateTime GetModifiedDateTime() const;
1408  void SetModifiedDateTime(const DateTime& date_time);
1415  uint32 GetFlags() const;
1424  void SetFlags(uint32 flags);
1430  WString GetUniqueID() const;
1438  void SetUniqueID(const WString& unique_id);
1445  RectF GetRect() const;
1446 
1459  Matrix GetDisplayMatrix(const Matrix& page_display_matrix);
1460 
1470  bool Move(const RectF& rect);
1471 
1482  bool Move(const RectF& rect, bool is_reset_appearance);
1483 
1500  BorderInfo GetBorderInfo() const;
1501 
1519  void SetBorderInfo(const BorderInfo& border);
1528  RGB GetBorderColor() const;
1540  void SetBorderColor(RGB color);
1553  bool ResetAppearanceStream();
1554 
1572  bool ResetAppearanceStream(bool is_generate_new_appearance_obj);
1573 
1589  RectI GetDeviceRect(const Matrix& matrix);
1590 
1597 
1607  bool HasProperty(Property property) const;
1608 
1626  bool RemoveProperty(Property property);
1627 
1635 
1652  objects::PDFStream* GetAppearanceStream(AppearanceType type, const char* appearance_state = "") const;
1653 };
1654 
1656 FSDK_DEFINE_ARRAY(AnnotArray, Annot)
1657 
1658 
1659 class ShadingColor FS_FINAL : public Object {
1660  public:
1667  ShadingColor(ARGB firstcolor, ARGB secondcolor)
1668  : first_color(firstcolor)
1669  , second_color(secondcolor) {}
1670 
1673  : first_color(0xFFFFFFFF)
1674  , second_color(0xFFFFFFFF) {}
1675 
1681  ShadingColor(const ShadingColor& shading_color)
1682  : first_color(shading_color.first_color)
1683  , second_color(shading_color.second_color) {}
1684 
1692  ShadingColor& operator = (const ShadingColor& shading_color) {
1693  this->first_color = shading_color.first_color;
1694  this->second_color = shading_color.second_color;
1695  return *this;
1696  }
1697 
1705  bool operator == (const ShadingColor& shading_color) const {
1706  return (first_color == shading_color.first_color && second_color == shading_color.second_color);
1707  }
1708 
1716  bool operator != (const ShadingColor& shading_color) const {
1717  return (first_color != shading_color.first_color || second_color != shading_color.second_color);
1718  }
1719 
1728  void Set(ARGB firstcolor, ARGB secondcolor) {
1729  this->first_color = firstcolor;
1730  this->second_color = secondcolor;
1731  }
1732 
1737 };
1738 
1749  public:
1755  virtual void Release() = 0;
1764  virtual String GetProviderID() {
1765  return String();
1766  }
1776  return String();
1777  }
1787  virtual bool HasIcon(Annot::Type annot_type, const char* icon_name) {
1788  return false;
1789  }
1800  virtual bool CanChangeColor(Annot::Type annot_type, const char* icon_name) {
1801  return false;
1802  }
1803 #ifndef __EMSCRIPTEN_RENDER__
1804 
1814  virtual PDFPage GetIcon(Annot::Type annot_type, const char* icon_name, ARGB color);
1815 #endif
1816 
1830  virtual bool GetShadingColor(Annot::Type annot_type, const char* icon_name,
1831  RGB referenced_color, int shading_index, ShadingColor& out_shading_color) {
1832  return false;
1833  }
1844  virtual float GetDisplayWidth(Annot::Type annot_type, const char* icon_name) {
1845  return 0.0f;
1846  }
1857  virtual float GetDisplayHeight(Annot::Type annot_type, const char* icon_name) {
1858  return 0.0f;
1859  }
1860 
1861  protected:
1862  ~IconProviderCallback() {}
1863 };
1864 
1865 class Markup;
1867 FSDK_DEFINE_ARRAY(MarkupArray, Markup)
1868 
1869 class Note;
1871 FSDK_DEFINE_ARRAY(NoteArray, Note)
1872 
1873 
1890 class Markup : public Annot {
1891  public:
1897  typedef enum _StateModel {
1899  e_StateModelMarked = 1,
1901  e_StateModelReview = 2
1902  } StateModel;
1903 
1909  typedef enum _State {
1914  e_StateNone = 0,
1919  e_StateMarked = 1,
1924  e_StateUnmarked = 2,
1929  e_StateAccepted = 3,
1934  e_StateRejected = 4,
1939  e_StateCancelled = 5,
1944  e_StateCompleted = 6,
1949  e_StateDeferred = 7,
1954  e_StateFuture = 8
1955  } State;
1956 
1962  typedef enum _EndingStyle {
1964  e_EndingStyleNone = 0,
1966  e_EndingStyleSquare = 1,
1968  e_EndingStyleCircle = 2,
1970  e_EndingStyleDiamond = 3,
1972  e_EndingStyleOpenArrow = 4,
1978  e_EndingStyleClosedArrow = 5,
1980  e_EndingStyleButt = 6,
1982  e_EndingStyleROpenArrow = 7,
1984  e_EndingStyleRClosedArrow = 8,
1986  e_EndingStyleSlash = 9
1987  } EndingStyle;
1988 
1994  typedef enum _MeasureType {
1996  e_MeasureTypeX = 0,
1998  e_MeasureTypeY = 1,
2000  e_MeasureTypeD = 2,
2002  e_MeasureTypeA = 3,
2004  e_MeasureTypeT = 4,
2006  e_MeasureTypeS = 5
2007  } MeasureType;
2008 
2009 
2015  explicit Markup(const Annot& annot);
2016  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2017  explicit Markup(FS_HANDLE handle);
2019  Markup() {}
2020 
2022  ~Markup() {}
2023 
2041  Popup GetPopup();
2058  void SetPopup(const Popup& popup);
2059 
2066  bool RemovePopup();
2067 
2075  WString GetTitle() const;
2076 
2086  void SetTitle(const WString& title);
2087 
2093  WString GetSubject() const;
2094 
2102  void SetSubject(const WString& subject);
2103 
2112  float GetOpacity() const;
2113 
2126  void SetOpacity(float opacity);
2127 
2149  String GetIntent() const;
2150 
2186  void SetIntent(const String& intent);
2187 
2194  DateTime GetCreationDateTime() const;
2195 
2203  void SetCreationDateTime(const DateTime& date_time);
2204 
2210  int GetReplyCount();
2211 
2220  Note GetReply(int index) const;
2221 
2227  Note AddReply();
2228 
2239  bool RemoveReply(int index);
2240 
2246  bool RemoveAllReplies();
2247 
2264  bool IsGrouped();
2265 
2284  Markup GetGroupHeader();
2285 
2302  MarkupArray GetGroupElements();
2303 
2319  bool Ungroup();
2320 
2336  NoteArray GetStateAnnots(StateModel model);
2337 
2374  Note AddStateAnnot(const WString& title, StateModel model, State state);
2375 
2385  bool RemoveAllStateAnnots();
2393  int32 GetRichTextCount();
2394 
2405  WString GetRichTextContent(int32 index);
2406 
2418  void SetRichTextContent(int32 index, const WString& content);
2419 
2430  RichTextStyle GetRichTextStyle(int32 index);
2431 
2445  void SetRichTextStyle(int32 index, const RichTextStyle& style);
2446 
2459  void AddRichText(const WString& content, const RichTextStyle& style);
2460 
2477  void InsertRichText(int32 index, const WString& content, const RichTextStyle& style);
2478 
2489  void RemoveRichText(int index);
2490 };
2491 
2514 class Note FS_FINAL : public Markup {
2515  public:
2517  Note() {}
2523  explicit Note(const Annot& annot);
2524  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2525  explicit Note(FS_HANDLE handle);
2527  ~Note() {}
2528 
2541  bool GetOpenStatus() const;
2556  void SetOpenStatus(bool status);
2568  String GetIconName() const;
2586  void SetIconName(const char* icon_name);
2596  Markup GetReplyTo();
2603  bool IsStateAnnot();
2604 
2617 
2629  State GetState();
2630 
2654  void SetState(State state);
2655 
2656 };
2657 
2669 class TextMarkup: public Markup {
2670  public:
2678  explicit TextMarkup(const Annot& annot);
2681 
2716  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2717 };
2718 
2735 class Highlight FS_FINAL : public TextMarkup {
2736  public:
2744  explicit Highlight(const Annot& annot);
2747 };
2748 
2765 class Underline FS_FINAL : public TextMarkup {
2766  public:
2774  explicit Underline(const Annot& annot);
2777 };
2778 
2795 class StrikeOut FS_FINAL : public TextMarkup {
2796  public:
2804  explicit StrikeOut(const Annot& annot);
2807 };
2808 
2825 class Squiggly FS_FINAL : public TextMarkup {
2826  public:
2834  explicit Squiggly(const Annot& annot);
2837 };
2838 
2852 class Link FS_FINAL : public Annot {
2853  public:
2855  Link() {}
2861  explicit Link(const Annot& annot);
2862  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2863  explicit Link(FS_HANDLE handle);
2865  ~Link() {}
2866 
2899  void SetQuadPoints(const QuadPointsArray& quad_points_array);
2900 
2909 
2920 
2928 
2943  void SetAction(const actions::Action& action);
2944 
2950  bool RemoveAction();
2951 
2957  bool ExecuteJavaScriptAction();
2958 };
2959 
2974 class Square FS_FINAL : public Markup {
2975  public:
2977  Square() {}
2983  explicit Square(const Annot& annot);
2985  ~Square() {}
2986 
2993  RGB GetFillColor() const;
2994 
3002  void SetFillColor(RGB fill_color);
3003 
3013  RectF GetInnerRect() const;
3025  void SetInnerRect(const RectF& inner_rect);
3026 
3040  void SetMeasureRatio(const char* ratio);
3041 
3052 
3063 
3076  void SetMeasureUnit(MeasureType measure_type, const char* unit);
3077 
3089  String GetMeasureUnit(MeasureType measure_type);
3090 
3102  WString GetMeasureUnitW(MeasureType measure_type);
3103 
3116  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3117 
3129  float GetMeasureConversionFactor(MeasureType measure_type);
3130 };
3131 
3146 class Circle FS_FINAL : public Markup {
3147  public:
3149  Circle() {}
3155  explicit Circle(const Annot& annot);
3157  ~Circle() {}
3158 
3165  RGB GetFillColor() const;
3166 
3177  void SetFillColor(RGB fill_color);
3178 
3188  RectF GetInnerRect() const;
3189 
3203  void SetInnerRect(const RectF& inner_rect);
3204 
3218  void SetMeasureRatio(const char* ratio);
3219 
3230 
3241 
3254  void SetMeasureUnit(MeasureType measure_type, const char* unit);
3255 
3267  String GetMeasureUnit(MeasureType measure_type);
3268 
3280  WString GetMeasureUnitW(MeasureType measure_type);
3281 
3294  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
3295 
3307  float GetMeasureConversionFactor(MeasureType measure_type);
3308 };
3309 
3329 class FreeText FS_FINAL : public Markup {
3330  public:
3338  explicit FreeText(const Annot& annot);
3339 
3342 
3353  RGB GetFillColor() const;
3354 
3368  void SetFillColor(RGB fill_color);
3369 
3385 
3404  void SetAlignment(common::Alignment alignment);
3405 
3416  RectF GetInnerRect() const;
3417 
3432  void SetInnerRect(const RectF& inner_rect);
3433 
3443 
3466  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
3467 
3479 
3494  void SetCalloutLineEndingStyle(EndingStyle ending_style);
3495 
3510 
3533  void SetCalloutLinePoints(const PointFArray& point_array);
3534 
3550  void SetTextMatrix(const Matrix& text_matrix);
3551 
3563  Matrix GetTextMatrix() const;
3564 
3572 
3587  void SetRotation(common::Rotation rotation);
3588 
3601  void Rotate(common::Rotation rotation);
3602 
3620  void AllowTextOverflow(bool is_text_overflow);
3621 };
3622 
3641 class Line FS_FINAL : public Markup {
3642  public:
3648  typedef enum _CapPos {
3653  } CapPos;
3654 
3655 
3657  Line() {}
3663  explicit Line(const Annot& annot);
3665  ~Line() {}
3666 
3688  void SetLineStartStyle(EndingStyle ending_style);
3697  EndingStyle GetLineEndStyle() const;
3710  void SetLineEndStyle(EndingStyle ending_style);
3711 
3722  RGB GetStyleFillColor() const;
3723 
3737  void SetStyleFillColor(RGB color);
3738 
3747  PointF GetStartPoint() const;
3760  void SetStartPoint(const PointF& point);
3761 
3770  PointF GetEndPoint() const;
3783  void SetEndPoint(const PointF& point);
3784 
3793  bool HasCaption() const;
3806  void EnableCaption(bool cap);
3807 
3835  void SetCaptionPositionType(CapPos cap_position);
3848  Offset GetCaptionOffset() const;
3864  void SetCaptionOffset(const Offset& offset);
3865 
3880  float GetLeaderLineLength() const;
3898  void SetLeaderLineLength(float length);
3908  float GetLeaderLineExtensionLength() const;
3921  void SetLeaderLineExtensionLength(float extension_length);
3922 
3933  float GetLeaderLineOffset() const;
3947  void SetLeaderLineOffset(float offset);
3948 
3962  void SetMeasureRatio(const String& ratio);
3963 
3974 
3985 
3998  void SetMeasureUnit(MeasureType measure_type, const String& unit);
3999 
4011  String GetMeasureUnit(MeasureType measure_type);
4012 
4024  WString GetMeasureUnitW(MeasureType measure_type);
4025 
4038  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4039 
4051  float GetMeasureConversionFactor(MeasureType measure_type);
4052 };
4053 
4071 class Ink FS_FINAL : public Markup {
4072  public:
4074  Ink() {}
4080  explicit Ink(const Annot& annot);
4082  ~Ink() {}
4110 
4143  void SetInkList(const common::Path& ink_list);
4144 
4156  void EnableUseBezier(bool use_bezier);
4157 
4158 };
4159 
4184 class Stamp FS_FINAL : public Markup {
4185  public:
4187  Stamp() {}
4193  explicit Stamp(const Annot& annot);
4194 #ifndef __EMSCRIPTEN_RENDER__
4195 
4196  ~Stamp();
4197 #endif
4198 
4209  String GetIconName() const;
4232  void SetIconName(const char* icon_name);
4243  void SetBitmap(const common::Bitmap& bitmap);
4244 
4267  void SetImage(const common::Image& image, int frame_index, int compress);
4268 
4279  void SetRotation(int angle);
4280 
4286  int GetRotation();
4287 
4297  void Rotate(int angle);
4298 };
4299 
4312 class Screen FS_FINAL : public Annot {
4313  public:
4315  Screen() {}
4321  explicit Screen(const Annot& annot);
4323  virtual ~Screen() {}
4324 
4347  void SetImage(const common::Image& image, int frame_index, int compress);
4348 
4356 
4368 
4376 
4389  void SetRotation(common::Rotation rotate);
4390 
4398 
4407  float GetOpacity() const;
4420  void SetOpacity(float opacity);
4421 
4427  WString GetTitle() const;
4435  void SetTitle(const WString& title);
4436 
4470  void SetAction(const actions::Action& action);
4479  void RemoveAction();
4480 };
4481 
4500 class Polygon FS_FINAL : public Markup {
4501  public:
4503  Polygon() {}
4509  explicit Polygon(const Annot& annot);
4520  RGB GetFillColor() const;
4521 
4533  void SetFillColor(RGB fill_color);
4534 
4544 
4556  void SetVertexes(const PointFArray& vertexes);
4557 
4571  void SetMeasureRatio(const String& ratio);
4572 
4583 
4594 
4607  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4608 
4620  String GetMeasureUnit(MeasureType measure_type);
4621 
4633  WString GetMeasureUnitW(MeasureType measure_type);
4634 
4647  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4648 
4660  float GetMeasureConversionFactor(MeasureType measure_type);
4661 };
4662 
4682 class PolyLine FS_FINAL : public Markup {
4683  public:
4691  explicit PolyLine(const Annot& annot);
4704  RGB GetStyleFillColor() const;
4716  void SetStyleFillColor(RGB fill_color);
4717 
4727 
4739  void SetVertexes(const PointFArray& vertexes);
4762  void SetLineStartStyle(EndingStyle starting_style);
4771  EndingStyle GetLineEndStyle() const;
4785  void SetLineEndStyle(EndingStyle ending_style);
4786 
4800  void SetMeasureRatio(const String& ratio);
4801 
4812 
4823 
4836  void SetMeasureUnit(MeasureType measure_type, const String& unit);
4837 
4849  String GetMeasureUnit(MeasureType measure_type);
4850 
4862  WString GetMeasureUnitW(MeasureType measure_type);
4863 
4876  void SetMeasureConversionFactor(MeasureType measure_type, float factor);
4877 
4889  float GetMeasureConversionFactor(MeasureType measure_type);
4890 };
4891 
4904 class Caret FS_FINAL : public Markup {
4905  public:
4907  Caret() {}
4913  explicit Caret(const Annot& annot);
4915  ~Caret() {}
4916 
4926  RectF GetInnerRect() const;
4940  void SetInnerRect(const RectF& inner_rect);
4941 };
4942 
4955 class FileAttachment FS_FINAL : public Markup {
4956  public:
4964  explicit FileAttachment(const Annot& annot);
4967 
4975  bool SetFileSpec(const FileSpec& file_spec);
4976 
4984 
4995  String GetIconName() const;
4996 
5012  void SetIconName(const char* icon_name);
5013 };
5014 
5024 class Popup FS_FINAL : public Annot {
5025  public:
5027  Popup() {}
5033  explicit Popup(const Annot& annot);
5034  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5035  explicit Popup(FS_HANDLE handle);
5037  ~Popup() {}
5038 
5051  bool GetOpenStatus() const;
5066  void SetOpenStatus(bool status);
5067 
5075  Markup GetParent();
5076 };
5077 #ifndef __FSDK_NO_PSINK__
5078 
5097 class PSInk FS_FINAL : public Annot {
5098  public:
5100  PSInk() {}
5106  explicit PSInk(const Annot& annot);
5107  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5108  explicit PSInk(FS_HANDLE handle);
5110  ~PSInk() {}
5111 
5112 };
5113 #endif
5114 
5127 class Widget FS_FINAL : public Annot {
5128  public:
5134  typedef enum _LineSpacingStyle {
5145  } LineSpacingStyle;
5146 
5147 
5149  Widget() {}
5155  explicit Widget(const Annot& annot);
5156  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5157  explicit Widget(FS_HANDLE handle);
5158 #ifndef __EMSCRIPTEN_RENDER__
5159 
5160  ~Widget();
5161 #endif
5162 
5168 
5175 
5186 
5199 
5210 
5234  void SetAction(const actions::Action& action);
5235 
5244  void RemoveAction();
5245 
5257  bool HasMKEntry(MKEntry mk_entry);
5258 
5270  void RemoveMKEntry(MKEntry mk_entry);
5271 
5285 
5298  void SetMKRotation(common::Rotation rotation);
5299 
5310  RGB GetMKBorderColor() const;
5311 
5322  void SetMKBorderColor(RGB color);
5323 
5334  RGB GetMKBackgroundColor() const;
5335 
5346  void SetMKBackgroundColor(RGB color);
5347 
5361  WString GetMKNormalCaption() const;
5362 
5376  void SetMKNormalCaption(const wchar_t* caption);
5377 
5392  WString GetMKRolloverCaption() const;
5393 
5408  void SetMKRolloverCaption(const wchar_t* caption);
5409 
5423  WString GetMKDownCaption() const;
5424 
5438  void SetMKDownCaption(const wchar_t* caption);
5439 
5453 
5467  void SetMKNormalIconBitmap(const common::Bitmap& bitmap);
5468 
5484  void SetMKNormalIconImage(const common::Image& image, int frame_index);
5485 
5500 
5515  void SetMKRolloverIconBitmap(const common::Bitmap& bitmap);
5516 
5533  void SetMKRolloverIconImage(const common::Image& image, int frame_index);
5534 
5548 
5562  void SetMKDownIconBitmap(const common::Bitmap& bitmap);
5563 
5579  void SetMKDownIconImage(const common::Image& image, int frame_index);
5580 
5595  IconFit GetMKIconFit() const;
5596 
5614  void SetMKIconFit(const IconFit& icon_fit);
5615 
5630 
5647 
5655  void SetAppearanceState(const String& appearance_state);
5656 
5662  String GetAppearanceState() const;
5663 
5670 
5682  LineSpacingStyle GetLineSpacing(float& line_spacing_value);
5683 
5699  void SetLineSpacing(LineSpacingStyle line_spacing_style, float line_spacing_value);
5700 
5701 #ifdef _SUPPORTWEBSDK_
5702  //Set push button icon form icon stream. stream is from doc::createIcon.
5703  //face: 0: normal, 1: down, 2: roller
5704  void SetButtonIcon(objects::PDFStream* icon, int face);
5705 #endif
5706 };
5707 
5724 class Redact FS_FINAL : public Markup {
5725  public:
5727  Redact() {}
5733  explicit Redact(const Annot& annot);
5734  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5735  explicit Redact(FS_HANDLE handle);
5736 #ifndef __EMSCRIPTEN_RENDER__
5737 
5738  ~Redact();
5739 #endif
5740 
5754 
5773  void SetQuadPoints(const QuadPointsArray& quad_points_array);
5774 
5781  RGB GetFillColor() const;
5789  void SetFillColor(RGB fill_color);
5790 
5797  RGB GetApplyFillColor() const;
5798 
5806  void SetApplyFillColor(RGB fill_color);
5807 
5813  WString GetOverlayText() const;
5814 
5822  void SetOverlayText(const WString& overlay_text);
5823 
5829  bool IsOverlayTextRepeated();
5830 
5839  void EnableRepeatOverlayText(bool is_to_repeat_overlay_text);
5840 
5850 
5864 
5870  void EnableAutoFontSize();
5871 
5881 
5904  bool SetDefaultAppearance(const DefaultAppearance& default_ap);
5905 
5918  bool Apply();
5919 };
5920 
5930 class Sound FS_FINAL : public Markup{
5931  public:
5937  typedef enum _SampleEncodingFormat {
5947 
5948 
5950  Sound() {}
5951 
5957  explicit Sound(const Annot& annot);
5958 
5959  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
5960  explicit Sound(FS_HANDLE handle);
5961 
5962 #ifndef __EMSCRIPTEN_RENDER__
5963 
5964  ~Sound();
5965 #endif
5966 
5979 
5985  float GetSamplingRate() const;
5986 
5992  int GetChannelCount() const;
5993 
5999  int GetBits() const;
6000 
6008 
6014  String GetCompressionFormat() const;
6015 
6029  FileSpec GetFileSpec() const;
6030 };
6031 
6047 class PagingSeal FS_FINAL : public Annot {
6048  public:
6050  PagingSeal(const Annot& annot);
6051 
6053  ~PagingSeal();
6054 
6061 
6062  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
6063  explicit PagingSeal(FS_HANDLE handle);
6064 };
6065 
6066 } // namespace annots
6067 } // namespace pdf
6068 } // namespace foxit
6069 
6070 #endif // FS_ANNOT_H_
6071 
foxit::pdf::annots::Annot::e_Caret
Annotation type: caret annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1036
foxit::pdf::annots::Screen
Definition: fs_annot.h:4312
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:1044
foxit::pdf::annots::FileAttachment::~FileAttachment
~FileAttachment()
Destructor.
Definition: fs_annot.h:4966
foxit::pdf::annots::Popup
Definition: fs_annot.h:5024
foxit::pdf::annots::Annot::e_StrikeOut
Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1032
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:1659
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:1059
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:5941
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:2527
foxit::pdf::annots::Annot::e_MKRelationCaptionAboveIcon
Caption above the icon.
Definition: fs_annot.h:1266
foxit::pdf::annots::FileAttachment::FileAttachment
FileAttachment()
Constructor.
Definition: fs_annot.h:4958
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:1065
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor()
Constructor.
Definition: fs_annot.h:1672
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:1018
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:2514
foxit::pdf::annots::Circle::Circle
Circle()
Constructor.
Definition: fs_annot.h:3149
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:5037
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:2776
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::annots::QuadPoints::third
PointF third
Third point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:762
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:1208
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:460
foxit::pdf::annots::Annot::e_3D
Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1061
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:1149
foxit::pdf::annots::Annot
Definition: fs_annot.h:996
foxit::pdf::annots::Annot::e_FlagHidden
Annotation flag: hidden.
Definition: fs_annot.h:1090
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:1260
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:609
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:1284
foxit::pdf::annots::Widget::e_LineSpacingDouble
Line spacing style: double line spacing.
Definition: fs_annot.h:5140
foxit::pdf::annots::Sound
Definition: fs_annot.h:5930
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:1264
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:403
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:942
foxit::pdf::annots::Sound::e_SampleEncodingFormatRaw
Unspecified or unsigned values in the range 0 to (2^B - 1).
Definition: fs_annot.h:5939
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:424
foxit::pdf::annots::Highlight::~Highlight
~Highlight()
Destructor.
Definition: fs_annot.h:2746
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:1165
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:2735
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:1053
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:5149
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:628
foxit::pdf::RichTextStyle::is_italic
bool is_italic
A boolean value which indicates whether to italicize text or not.
Definition: fs_annot.h:408
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:2738
foxit::pdf::annots::Annot::e_PropertyFillColor
Annotation property: fill color.
Definition: fs_annot.h:1194
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:2977
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:1270
foxit::pdf::annots::BorderInfo::operator=
BorderInfo & operator=(const BorderInfo &border_info)
Assign operator.
Definition: fs_annot.h:541
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:1142
foxit::pdf::annots::QuadPoints::operator!=
bool operator!=(const QuadPoints &quad_points) const
Not equal operator.
Definition: fs_annot.h:735
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:1844
foxit::pdf::annots::IconProviderCallback::GetProviderVersion
virtual String GetProviderVersion()
A callback function used to get provider version.
Definition: fs_annot.h:1775
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:214
foxit::pdf::annots::Markup::State
State
Enumeration for markup annotation's state.
Definition: fs_annot.h:1909
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:4693
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:826
foxit::pdf::annots::Line::SetCaptionPositionType
void SetCaptionPositionType(CapPos cap_position)
Set the position type of caption.
foxit::pdf::annots::Squiggly
Definition: fs_annot.h:2825
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:1067
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:387
foxit::pdf::annots::Annot::e_FlagNoZoom
Annotation flag: no zoom.
Definition: fs_annot.h:1105
fs_common.h
Header file for common definitions and classes.
foxit::pdf::annots::TextMarkup::~TextMarkup
~TextMarkup()
Destructor.
Definition: fs_annot.h:2680
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:2974
foxit::pdf::annots::Screen::Screen
Screen()
Constructor.
Definition: fs_annot.h:4315
foxit::pdf::annots::ShadingColor::second_color
ARGB second_color
Second color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1736
foxit::pdf::annots::BorderInfo::e_Cloudy
Border style: Cloudy.
Definition: fs_annot.h:485
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:1063
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:1014
foxit::pdf::annots::BorderInfo::e_Solid
Border style: Solid.
Definition: fs_annot.h:451
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:961
foxit::pdf::annots::Underline
Definition: fs_annot.h:2765
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:75
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:4685
foxit::pdf::annots::Line::GetLeaderLineOffset
float GetLeaderLineOffset() const
Get the length of leader line offset.
foxit::pdf::annots::Stamp
Definition: fs_annot.h:4184
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:750
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:1161
foxit::pdf::annots::Circle::~Circle
~Circle()
Destructor.
Definition: fs_annot.h:3157
foxit::pdf::annots::Annot::e_MKEntryBorderColor
Border color entry. "BC" in MK dictionary.
Definition: fs_annot.h:1206
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:61
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor(ARGB firstcolor, ARGB secondcolor)
Constructor, with parameters.
Definition: fs_annot.h:1667
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:5127
foxit::pdf::annots::ShadingColor::Set
void Set(ARGB firstcolor, ARGB secondcolor)
Set value.
Definition: fs_annot.h:1728
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:5950
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:795
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:458
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:1098
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:1120
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:5138
foxit::pdf::annots::Line::GetCaptionOffset
Offset GetCaptionOffset() const
Get caption offset values.
foxit::pdf::annots::PSInk::~PSInk
~PSInk()
Destructor.
Definition: fs_annot.h:5110
foxit::pdf::annots::Line::e_CapPosTop
Definition: fs_annot.h:3652
foxit::pdf::annots::PSInk::PSInk
PSInk()
Constructor.
Definition: fs_annot.h:5100
foxit::pdf::annots::Markup::Markup
Markup()
Constructor.
Definition: fs_annot.h:2019
foxit::pdf::annots::ShadingColor::first_color
ARGB first_color
First color used for shading. Format: 0xAARRGGBB.
Definition: fs_annot.h:1734
foxit::pdf::annots::NoteArray
Definition: fs_annot.h:1871
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:1262
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:77
foxit::pdf::RichTextStyle::e_CornerMarkSubscript
Corner mark style: subscript.
Definition: fs_annot.h:216
foxit::common::Path
Definition: fs_common.h:2005
foxit::pdf::annots::Annot::e_FileAttachment
Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1042
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:4323
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:1010
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:1005
foxit::pdf::annots::Stamp::Stamp
Stamp()
Constructor.
Definition: fs_annot.h:4187
foxit::pdf::annots::ShadingColor::ShadingColor
ShadingColor(const ShadingColor &shading_color)
Constructor, with another shading color object.
Definition: fs_annot.h:1681
foxit::pdf::annots::Annot::e_FlagInvisible
Annotation flag: invisible.
Definition: fs_annot.h:1084
foxit::pdf::annots::Redact::SetDefaultAppearance
bool SetDefaultAppearance(const DefaultAppearance &default_ap)
Set default appearance data.
foxit::pdf::annots::StrikeOut
Definition: fs_annot.h:2795
foxit::pdf::annots::FreeText
Definition: fs_annot.h:3329
foxit::pdf::annots::Markup
Definition: fs_annot.h:1890
foxit::pdf::annots::Ink
Definition: fs_annot.h:4071
foxit::pdf::annots::Caret::Caret
Caret()
Constructor.
Definition: fs_annot.h:4907
foxit::pdf::annots::BorderInfo::dashes
FloatArray dashes
A dash array that represents the dash patterns.
Definition: fs_annot.h:656
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:5943
foxit::pdf::annots::Line::Line
Line()
Constructor.
Definition: fs_annot.h:3657
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:100
foxit::pdf::annots::Circle
Definition: fs_annot.h:3146
foxit::pdf::annots::Annot::e_MKEntryIconCaptionRelation
Icon and caption relation entry. "TP" in MK dictionary.
Definition: fs_annot.h:1250
foxit::pdf::DefaultAppearance::DefAPFlags
DefAPFlags
Enumeration for default appearance flags.
Definition: fs_annot.h:59
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:5724
foxit::pdf::annots::Annot::e_FlagLocked
Annotation flag: locked.
Definition: fs_annot.h:1136
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:933
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:758
foxit::pdf::annots::Annot::e_MKRelationCaptionOvrlayOnIcon
Caption overlaid directly on the icon.
Definition: fs_annot.h:1272
foxit::pdf::annots::Annot::e_PropertyModifiedDate
Annotation property: modified date.
Definition: fs_annot.h:1177
foxit::pdf::annots::Redact::~Redact
~Redact()
Destructor.
foxit::pdf::RichTextStyle
Definition: fs_annot.h:203
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:1800
foxit::pdf::annots::Annot::e_MKEntryNormalIcon
Normal icon entry. "I" in MK dictionary.
Definition: fs_annot.h:1228
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:398
foxit::pdf::annots::Widget::e_LineSpacingAuto
Line spacing style: auto line spacing.
Definition: fs_annot.h:5144
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:506
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:5142
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:1280
foxit::pdf::annots::Annot::e_MKEntryRolloverIcon
Rollover icon entry. "RI" in MK dictionary.
Definition: fs_annot.h:1233
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:1830
foxit::pdf::annots::Annot::e_HighlightingToggle
Highlighting mode: Toggle. This is only useful for widget annotation.
Definition: fs_annot.h:1167
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:141
foxit::pdf::annots::Annot::e_HighlightingNone
Highlighting mode: No highlighting.
Definition: fs_annot.h:1159
foxit::pdf::annots::Annot::e_FlagNoRotate
Annotation flag: no rotate.
Definition: fs_annot.h:1112
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
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:1656
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:1175
foxit::pdf::annots::Polygon::SetVertexes
void SetVertexes(const PointFArray &vertexes)
Set vertexes.
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance()
Constructor.
Definition: fs_annot.h:90
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:694
foxit::pdf::annots::QuadPoints::fourth
PointF fourth
Fourth point of quadrilateral, in PDF coordinate system.
Definition: fs_annot.h:764
foxit::pdf::DefaultAppearance::DefaultAppearance
DefaultAppearance(uint32 flags, const common::Font &font, float text_size, RGB text_color)
Constructor, with parameters.
Definition: fs_annot.h:83
foxit::pdf::annots::Annot::e_AppearanceTypeNormal
Annotation's normal appearance.
Definition: fs_annot.h:1282
foxit::pdf::annots::Annot::e_Highlight
Annotation type: highlight annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1026
foxit::pdf::annots::BorderInfo::e_UnderLine
Border style: Underline.
Definition: fs_annot.h:464
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:382
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:4503
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:6047
foxit::pdf::annots::BorderInfo::BorderInfo
BorderInfo()
Constructor.
Definition: fs_annot.h:515
foxit::pdf::annots::Markup::StateModel
StateModel
Enumeration for markup annotation's state model.
Definition: fs_annot.h:1897
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:1046
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. It is only used in pdf::PDFPage::AddText.
Definition: fs_annot.h:429
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:1028
foxit::pdf::RichTextStyle::CornerMarkStyle
CornerMarkStyle
Enumeration for corner mark style.
Definition: fs_annot.h:210
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:1962
foxit::pdf::annots::BorderInfo
Definition: fs_annot.h:442
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:5136
foxit::pdf::annots::Widget::GetField
interform::Field GetField()
Get associated form field.
foxit::pdf::annots::Caret::~Caret
~Caret()
Destructor.
Definition: fs_annot.h:4915
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:1202
foxit::pdf::RichTextStyle::operator!=
bool operator!=(const RichTextStyle &style) const
Not equal operator.
Definition: fs_annot.h:333
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:2836
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:5937
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:178
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:1022
foxit::pdf::annots::Annot::e_PropertyBorderColor
Annotation property: border color.
Definition: fs_annot.h:1188
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:2798
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:1163
foxit::pdf::annots::Underline::Underline
Underline()
Constructor.
Definition: fs_annot.h:2768
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:65
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:184
foxit::pdf::annots::FreeText::FreeText
FreeText()
Constructor.
Definition: fs_annot.h:3332
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:393
foxit::pdf::annots::QuadPoints::operator==
bool operator==(const QuadPoints &quad_points) const
Equal operator.
Definition: fs_annot.h:723
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:1243
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:2806
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:1764
foxit::pdf::annots::IconFit::ScaleWayType
ScaleWayType
Enumeration for the type of icon scaling way.
Definition: fs_annot.h:780
foxit::pdf::RichTextStyle::e_CornerMarkNone
Corner mark style: none.
Definition: fs_annot.h:212
foxit::pdf::annots::Annot::e_MKEntryRotation
Rotation entry. "R" in MK dictionary.
Definition: fs_annot.h:1204
foxit::pdf::annots::QuadPoints
Definition: fs_annot.h:669
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:1857
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:760
foxit::pdf::annots::PSInk
Definition: fs_annot.h:5097
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:919
foxit::pdf::annots::BorderInfo::operator!=
bool operator!=(const BorderInfo &border_info) const
Not equal operator.
Definition: fs_annot.h:577
foxit::pdf::DefaultAppearance::e_FlagTextColor
Indicates property text color of pdf::DefaultAppearance is meaningful.
Definition: fs_annot.h:63
foxit::pdf::annots::Caret
Definition: fs_annot.h:4904
foxit::pdf::annots::Circle::GetInnerRect
RectF GetInnerRect() const
Get the inner rectangle.
foxit::pdf::annots::Sound::GetBits
int GetBits() const
Get the number of bits per sample value per channel.
foxit::pdf::annots::Widget::SetMKBorderColor
void SetMKBorderColor(RGB color)
Set the border color in the MK dictionary.
foxit::pdf::annots::Line::SetStyleFillColor
void SetStyleFillColor(RGB color)
Set fill color for ending styles.
foxit::pdf::objects::PDFDictionary
Definition: fs_pdfobject.h:809
foxit::pdf::annots::Annot::e_Circle
Annotation type: circle annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1020
foxit::pdf::annots::Annot::e_Line
Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1016
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:1286
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:1258
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:954
foxit::pdf::annots::Annot::e_MKEntryDownCaption
Down caption (or alternate caption) entry. "AC" in MK dictionary.
Definition: fs_annot.h:1223
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:1213
foxit::pdf::annots::Annot::e_Ink
Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
Definition: fs_annot.h:1038
foxit::pdf::annots::IconFit::IconFit
IconFit(const IconFit &icon_fit)
Constructor, with another icon fit object.
Definition: fs_annot.h:839
foxit::pdf::annots::TextMarkup
Definition: fs_annot.h:2669
foxit::pdf::annots::BorderInfo::operator==
bool operator==(const BorderInfo &border_info) const
Equal operator.
Definition: fs_annot.h:557
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:238
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:3341
foxit::pdf::annots::Annot::e_Stamp
Annotation type: stamp annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1034
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:5134
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:164
foxit::pdf::RichTextStyle::RichTextStyle
RichTextStyle(const RichTextStyle &style)
Constructor, with another style object.
Definition: fs_annot.h:270
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:641
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:199
foxit::pdf::RichTextStyle::operator==
bool operator==(const RichTextStyle &style) const
Equal operator.
Definition: fs_annot.h:312
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:1129
foxit::pdf::annots::Popup::Popup
Popup()
Constructor.
Definition: fs_annot.h:5027
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:1748
foxit::pdf::annots::BorderInfo::e_Beveled
Border style: Beveled.
Definition: fs_annot.h:471
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:1051
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:1787
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:2022
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:2672
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:418
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:3648
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:1012
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:1057
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:5945
foxit::common::Image
Definition: fs_image.h:448
foxit::pdf::annots::Line::GetStartPoint
PointF GetStartPoint() const
Get the start point.
foxit::pdf::RichTextStyle::Set
void Set(const common::Font &font, float text_size, common::Alignment text_alignment, RGB text_color, bool is_bold, bool is_italic, bool is_underline, bool is_strikethrough, CornerMarkStyle mark_style, float char_space, float word_space)
Set value.
Definition: fs_annot.h:357
foxit::pdf::annots::Stamp::SetRotation
void SetRotation(int angle)
Set rotation angle (in clockwise).
foxit::pdf::annots::MarkupArray
Definition: fs_annot.h:1867
foxit::pdf::annots::Annot::e_Squiggly
Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1030
foxit::pdf::annots::Annot::Type
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:1003
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:1069
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:679
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:1040
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:1309
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:1391
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:1238
foxit::pdf::annots::Annot::e_PrinterMark
Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1055
foxit::pdf::annots::BorderInfo::dash_phase
float dash_phase
Dash phase.
Definition: fs_annot.h:648
foxit::pdf::annots::QuadPoints::operator=
QuadPoints & operator=(const QuadPoints &quad_points)
Assign operator.
Definition: fs_annot.h:708
CFX_Matrix
Definition: fx_coordinates.h:1076
foxit::pdf::annots::Annot::e_MKRelationCaptionRight
Caption to the right of the icon.
Definition: fs_annot.h:1268
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:1218
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:113
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:687
foxit::pdf::annots::Redact::SetFillColor
void SetFillColor(RGB fill_color)
Set fill color.
foxit::pdf::annots::Squiggly::Squiggly
Squiggly()
Constructor.
Definition: fs_annot.h:2828
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:253
foxit::pdf::annots::Polygon::~Polygon
~Polygon()
Destructor.
Definition: fs_annot.h:4511
foxit::pdf::annots::PolyLine
Definition: fs_annot.h:4682
foxit::pdf::DefaultAppearance
Definition: fs_annot.h:52
foxit::pdf::annots::Polygon::GetMeasureUnitW
WString GetMeasureUnitW(MeasureType measure_type)
Get the label (in Unicode string) for displaying the units for measuring.
foxit::pdf::objects::PDFStream
Definition: fs_pdfobject.h:422
foxit::pdf::annots::BorderInfo::e_Inset
Border style: Inset.
Definition: fs_annot.h:478
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1452
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:3641
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:622
foxit::pdf::annots::Annot::e_PolyLine
Annotation type: polyline annotation. One of standard annotation in <PDF reference 1....
Definition: fs_annot.h:1024
foxit::pdf::RichTextStyle::is_underline
bool is_underline
A boolean value which indicates whether to underline text or not.
Definition: fs_annot.h:413
foxit::pdf::annots::Ink::~Ink
~Ink()
Destructor.
Definition: fs_annot.h:4082
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:526
foxit::pdf::annots::Polygon
Definition: fs_annot.h:4500
foxit::pdf::annots::BorderInfo::Style
Style
Enumeration for PDF annotation border style.
Definition: fs_annot.h:449
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:1994
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:768
foxit::pdf::annots::Stamp::GetIconName
String GetIconName() const
Get icon name.
foxit::Base
Definition: fs_basictypes.h:427
foxit::pdf::annots::Annot::Flags
Flags
Enumeration for PDF annotation flags.
Definition: fs_annot.h:1077
foxit::pdf::annots::Line::~Line
~Line()
Destructor.
Definition: fs_annot.h:3665
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:774
foxit::pdf::DefaultAppearance::operator==
bool operator==(const DefaultAppearance &default_appearance) const
Equal operator.
Definition: fs_annot.h:128
foxit::pdf::annots::Note::Note
Note()
Constructor.
Definition: fs_annot.h:2517
foxit::pdf::annots::Ink::Ink
Ink()
Constructor.
Definition: fs_annot.h:4074
foxit::pdf::annots::Annot::HighlightingMode
HighlightingMode
Enumeration for PDF annotation highlighting mode.
Definition: fs_annot.h:1157
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:3650
foxit::pdf::annots::Annot::e_PropertyCreationDate
Annotation property: creation date.
Definition: fs_annot.h:1182
foxit::pdf::annots::FileAttachment
Definition: fs_annot.h:4955
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. It is only used in pdf::PDFPage::AddText.
Definition: fs_annot.h:434
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:5727
foxit::pdf::RichTextStyle::operator=
RichTextStyle & operator=(const RichTextStyle &style)
Assign operator.
Definition: fs_annot.h:290
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:948
foxit::pdf::annots::Ink::GetInkList
common::Path GetInkList()
Get ink list data.
foxit::pdf::annots::Square::~Square
~Square()
Destructor.
Definition: fs_annot.h:2985