All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Redaction.h
Go to the documentation of this file.
1 //---------------------------------------------------------------------------------------
2 // Copyright (c) 2001-2020 by PDFTron Systems Inc. All Rights Reserved.
3 // Consult legal.txt regarding legal and license information.
4 //---------------------------------------------------------------------------------------
5 #ifndef PDFTRON_H_CPPPDFAnnotsRedaction
6 #define PDFTRON_H_CPPPDFAnnotsRedaction
7 
8 #include <PDF/Annots/Markup.h>
9 #include <PDF/QuadPoint.h>
10 
11 #ifdef SWIG
12 #define Redaction RedactionAnnot
13 #endif
14 
15 namespace pdftron {
16  namespace PDF {
17  namespace Annots {
51 class Redaction : public Markup
52 {
53  public:
60  Redaction(SDF::Obj d = 0);
61 
68  Redaction(const Annot& ann) : Markup(ann.GetSDFObj()) {}
69 
78  static Redaction Create(SDF::SDFDoc& doc, const Rect& pos);
79 
88  int GetQuadPointCount();
89 
100  QuadPoint GetQuadPoint(int idx) const;
101 
112  void SetQuadPoint(int idx, const QuadPoint& qp);
113 
125  SDF::Obj GetAppFormXO()const;
126 
127 
140  void SetAppFormXO(SDF::Obj formxo);
141 
151  UString GetOverlayText() const;
152 
162  void SetOverlayText(const UString& title);
163 
174  bool GetUseRepeat() const;
175 
186  void SetUseRepeat(bool userepeat=false);
187 
198 
208  void SetOverlayTextAppearance(const UString& app);
209 
214  enum QuadForm
215  {
220  };
221 
228  QuadForm GetQuadForm() const;
229 
240 
241  // @cond PRIVATE_DOC
242  #ifndef SWIGHIDDEN
243  Redaction(TRN_Annot redaction);
244  #endif
245  // @endcond
246 
247 }; //class Redaction
248  }; //namespace Annot
249  }; //namespace PDF
250 }; //namespace pdftron
251 
252 #ifdef SWIG
253 #undef Redaction
254 #endif
255 
256 #include <Impl/Page.inl>
257 
258 #endif // PDFTRON_H_CPPPDFAnnotsRedaction
SDF::Obj GetSDFObj() const
void SetQuadForm(QuadForm form=e_LeftJustified)
Overlay text is right justified.
Definition: Redaction.h:218
UString GetOverlayTextAppearance() const
static Redaction Create(SDF::SDFDoc &doc, const Rect &pos)
void SetOverlayText(const UString &title)
void SetAppFormXO(SDF::Obj formxo)
Redaction(const Annot &ann)
Definition: Redaction.h:68
void SetQuadPoint(int idx, const QuadPoint &qp)
No justification to the overlay text.
Definition: Redaction.h:219
SDF::Obj GetAppFormXO() const
Overlay text is left justified.
Definition: Redaction.h:216
QuadPoint GetQuadPoint(int idx) const
void SetOverlayTextAppearance(const UString &app)
void SetUseRepeat(bool userepeat=false)