Loading...
Searching...
No Matches
Redaction.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_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 static Redaction CreateAnnot(SDF::SDFDoc& doc, const Rect& pos);
80
89 int GetQuadPointCount();
90
101 QuadPoint GetQuadPoint(int idx) const;
102
113 void SetQuadPoint(int idx, const QuadPoint& qp);
114
126 SDF::Obj GetAppFormXO()const;
127
128
141 void SetAppFormXO(SDF::Obj formxo);
142
152 UString GetOverlayText() const;
153
163 void SetOverlayText(const UString& title);
164
175 bool GetUseRepeat() const;
176
187 void SetUseRepeat(bool userepeat=false);
188
198 UString GetOverlayTextAppearance() const;
199
209 void SetOverlayTextAppearance(const UString& app);
210
220 void SetOverlayTextFont(const UString& font_name);
221
232 void SetOverlayTextFontSize(double font_size);
233
238 enum QuadForm
239 {
240 e_LeftJustified,
241 e_Centered,
242 e_RightJustified,
243 e_None
244 };
245
252 QuadForm GetQuadForm() const;
253
263 void SetQuadForm(QuadForm form=e_LeftJustified);
264
265 // @cond PRIVATE_DOC
266 #ifndef SWIGHIDDEN
267 Redaction(TRN_Annot redaction);
268 #endif
269 // @endcond
270
271}; //class Redaction
272 }; //namespace Annot
273 }; //namespace PDF
274}; //namespace pdftron
275
276#ifdef SWIG
277#undef Redaction
278#endif
279
280#include <Impl/Page.inl>
281
282#endif // PDFTRON_H_CPPPDFAnnotsRedaction
Markup.h
QuadPoint.h
pdftron::PDF::Annot::Annot
Annot(SDF::Obj d=0)
pdftron::PDF::Annot::GetSDFObj
SDF::Obj GetSDFObj() const
pdftron::PDF::Annots::Markup::Markup
Markup(SDF::Obj d=0)
pdftron::PDF::Annots::Redaction::GetOverlayText
UString GetOverlayText() const
pdftron::PDF::Annots::Redaction::GetQuadPointCount
int GetQuadPointCount()
pdftron::PDF::Annots::Redaction::GetQuadPoint
QuadPoint GetQuadPoint(int idx) const
pdftron::PDF::Annots::Redaction::SetQuadPoint
void SetQuadPoint(int idx, const QuadPoint &qp)
pdftron::PDF::Annots::Redaction::SetQuadForm
void SetQuadForm(QuadForm form=e_LeftJustified)
pdftron::PDF::Annots::Redaction::SetOverlayTextFontSize
void SetOverlayTextFontSize(double font_size)
pdftron::PDF::Annots::Redaction::CreateAnnot
static Redaction CreateAnnot(SDF::SDFDoc &doc, const Rect &pos)
pdftron::PDF::Annots::Redaction::SetOverlayTextAppearance
void SetOverlayTextAppearance(const UString &app)
pdftron::PDF::Annots::Redaction::Redaction
Redaction(SDF::Obj d=0)
pdftron::PDF::Annots::Redaction::SetOverlayText
void SetOverlayText(const UString &title)
pdftron::PDF::Annots::Redaction::SetUseRepeat
void SetUseRepeat(bool userepeat=false)
pdftron::PDF::Annots::Redaction::GetUseRepeat
bool GetUseRepeat() const
pdftron::PDF::Annots::Redaction::Create
static Redaction Create(SDF::SDFDoc &doc, const Rect &pos)
pdftron::PDF::Annots::Redaction::GetOverlayTextAppearance
UString GetOverlayTextAppearance() const
pdftron::PDF::Annots::Redaction::QuadForm
QuadForm
Definition Redaction.h:239
pdftron::PDF::Annots::Redaction::e_None
@ e_None
No justification to the overlay text.
Definition Redaction.h:243
pdftron::PDF::Annots::Redaction::e_LeftJustified
@ e_LeftJustified
Overlay text is left justified.
Definition Redaction.h:240
pdftron::PDF::Annots::Redaction::e_Centered
@ e_Centered
Overlay text is centered.
Definition Redaction.h:241
pdftron::PDF::Annots::Redaction::e_RightJustified
@ e_RightJustified
Overlay text is right justified.
Definition Redaction.h:242
pdftron::PDF::Annots::Redaction::SetAppFormXO
void SetAppFormXO(SDF::Obj formxo)
pdftron::PDF::Annots::Redaction::SetOverlayTextFont
void SetOverlayTextFont(const UString &font_name)
pdftron::PDF::Annots::Redaction::GetAppFormXO
SDF::Obj GetAppFormXO() const
pdftron::PDF::Annots::Redaction::Redaction
Redaction(const Annot &ann)
Definition Redaction.h:68
pdftron::PDF::Annots::Redaction::GetQuadForm
QuadForm GetQuadForm() const
pdftron::PDF::QuadPoint
Definition QuadPoint.h:15
pdftron::PDF::Rect
Definition Rect.h:29
pdftron::SDF::Obj
Definition Obj.h:41
pdftron::SDF::SDFDoc
Definition SDFDoc.h:68
pdftron::UString
Definition UString.h:28
pdftron::PDF::Annots
Definition Caret.h:12
pdftron::PDF
Definition Action.h:15
pdftron
Definition BasicTypes.h:10