All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Markup.h
Go to the documentation of this file.
1 //---------------------------------------------------------------------------------------
2 // Copyright (c) 2001-2023 by Apryse Software Inc. All Rights Reserved.
3 // Consult legal.txt regarding legal and license information.
4 //---------------------------------------------------------------------------------------
5 #ifndef PDFTRON_H_CPPPDFAnnotsMarkup
6 #define PDFTRON_H_CPPPDFAnnotsMarkup
7 
8 #include <PDF/Annots/Popup.h>
9 #include <PDF/Date.h>
10 
11 namespace pdftron {
12  namespace PDF {
13  namespace Annots {
43 class Markup : public Annot
44 {
45  public:
46 
53  Markup(SDF::Obj d = 0);
54 
61  Markup(const Annot& ann) : Annot(ann.GetSDFObj()) {}
62 
75  UString GetTitle();
76 
88  void SetTitle(const UString& title);
100  void SetTitle(const char* title);
101 
109  Popup GetPopup() const;
110 
119  void SetPopup(const Popup& ppup);
120 
132  double GetOpacity() const;
133 
148  void SetOpacity(double op);
149 
158  UString GetSubject() const;
159 
168  void SetSubject(const UString& contents);
169 
175  Date GetCreationDates() const;
176 
184  void SetCreationDates(const Date& dt);
185 
190  {
193  };
194 
207 
221  void SetBorderEffect(BorderEffect effect = e_None);
222 
230  double GetBorderEffectIntensity() const;
231 
243  void SetBorderEffectIntensity(double intensity = 0);
244 
258  ColorPt GetInteriorColor() const;
259 
267  int GetInteriorColorCompNum() const;
268 
290  void SetInteriorColor(const ColorPt& c, int CompNum);
291 
308  Rect GetContentRect() const;
309 
325  void SetContentRect(const Rect& cr);
326 
343  Rect GetPadding() const;
344 
362  void SetPadding(const Rect& rd);
363  void SetPadding(double x); // this creates 'x' amount of space between the content and the outer rectangle
364 
375  void RotateAppearance(double angle);
376 
377 
378 // @cond PRIVATE_DOC
379 #ifndef SWIGHIDDEN
380  Markup(TRN_Annot markup);
381 #endif
382 // @endcond
383 
384 };//class Markup
385  };//namespace Annot
386  };//namespace PDF
387 };//namespace pdftron
388 #include <Impl/Markup.inl>
389 
390 #endif // PDFTRON_H_CPPPDFAnnotsMarkup
SDF::Obj GetSDFObj() const
void SetTitle(const UString &title)
void SetBorderEffectIntensity(double intensity=0)
void SetPopup(const Popup &ppup)
void SetContentRect(const Rect &cr)
void SetSubject(const UString &contents)
BorderEffect GetBorderEffect() const
void SetBorderEffect(BorderEffect effect=e_None)
int GetInteriorColorCompNum() const
double GetBorderEffectIntensity() const
void RotateAppearance(double angle)
void SetInteriorColor(const ColorPt &c, int CompNum)
Markup(const Annot &ann)
Definition: Markup.h:61
UString GetSubject() const
void SetCreationDates(const Date &dt)
void SetPadding(const Rect &rd)
ColorPt GetInteriorColor() const
Use &quot;cloudy&quot; border.
Definition: Markup.h:192