- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

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-2025 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
189 enum BorderEffect
190 {
191 e_None,
192 e_Cloudy
193 };
194
206 BorderEffect GetBorderEffect() const;
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
pdftron::PDF::Annot::GetSDFObj
SDF::Obj GetSDFObj() const
pdftron::PDF::Annots::Markup::SetTitle
void SetTitle(const UString &title)
pdftron::PDF::Annots::Markup::SetBorderEffectIntensity
void SetBorderEffectIntensity(double intensity=0)
pdftron::PDF::Annots::Markup::SetPopup
void SetPopup(const Popup &ppup)
Popup.h
pdftron::PDF::Annots::Markup::SetContentRect
void SetContentRect(const Rect &cr)
pdftron::PDF::ColorPt
Definition: ColorSpace.h:20
pdftron::PDF::Annots::Markup::SetSubject
void SetSubject(const UString &contents)
pdftron::PDF::Annots::Markup::GetBorderEffect
BorderEffect GetBorderEffect() const
pdftron::PDF::Date
Definition: Date.h:28
pdftron::PDF::Annots::Markup::GetPopup
Popup GetPopup() const
pdftron::PDF::Annots::Markup::GetTitle
UString GetTitle()
pdftron::PDF::Annots::Markup::SetBorderEffect
void SetBorderEffect(BorderEffect effect=e_None)
pdftron::PDF::Rect
Definition: Rect.h:28
pdftron::PDF::Annots::Markup::GetContentRect
Rect GetContentRect() const
pdftron::PDF::Annots::Markup::GetPadding
Rect GetPadding() const
pdftron::PDF::Annots::Markup::e_None
No effect.
Definition: Markup.h:191
pdftron::PDF::Annots::Markup::GetInteriorColorCompNum
int GetInteriorColorCompNum() const
pdftron::PDF::Annots::Markup::Markup
Markup(SDF::Obj d=0)
pdftron::PDF::Annots::Markup::GetBorderEffectIntensity
double GetBorderEffectIntensity() const
Date.h
pdftron::PDF::Annots::Markup::GetOpacity
double GetOpacity() const
pdftron::PDF::Annots::Markup::RotateAppearance
void RotateAppearance(double angle)
pdftron::PDF::Annots::Markup::SetInteriorColor
void SetInteriorColor(const ColorPt &c, int CompNum)
pdftron::PDF::Annots::Popup
Definition: Popup.h:20
pdftron::PDF::Annots::Markup::Markup
Markup(const Annot &ann)
Definition: Markup.h:61
pdftron::PDF::Annots::Markup::GetSubject
UString GetSubject() const
pdftron::PDF::Annots::Markup::SetCreationDates
void SetCreationDates(const Date &dt)
pdftron::PDF::Annots::Markup::GetCreationDates
Date GetCreationDates() const
pdftron::PDF::Annots::Markup::SetPadding
void SetPadding(const Rect &rd)
pdftron::PDF::Annot
Definition: Annot.h:33
pdftron::SDF::Obj
Definition: Obj.h:40
pdftron::PDF::Annots::Markup
Definition: Markup.h:43
pdftron::PDF::Annots::Markup::GetInteriorColor
ColorPt GetInteriorColor() const
pdftron::PDF::Annots::Markup::e_Cloudy
Use &quot;cloudy&quot; border.
Definition: Markup.h:192
pdftron::UString
Definition: UString.h:27
pdftron::PDF::Annots::Markup::SetOpacity
void SetOpacity(double op)
pdftron::PDF::Annots::Markup::BorderEffect
BorderEffect
Definition: Markup.h:189