Redaction.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFAnnotsRedaction
#define PDFTRON_H_CPPPDFAnnotsRedaction

#include <PDF/Annots/Markup.h>
#include <PDF/QuadPoint.h>

#ifdef SWIG
#define Redaction RedactionAnnot
#endif

namespace pdftron { 
        namespace PDF {
            namespace Annots {
class Redaction : public Markup
{
    public:
    Redaction(SDF::Obj d = 0);  

    Redaction(const Annot& ann) : Markup(ann.GetSDFObj()) {} 

    static Redaction Create(SDF::SDFDoc& doc, const Rect& pos);
    static Redaction CreateAnnot(SDF::SDFDoc& doc, const Rect& pos);

    int GetQuadPointCount();

    QuadPoint GetQuadPoint(int idx) const;

    void SetQuadPoint(int idx, const QuadPoint& qp);

    SDF::Obj GetAppFormXO()const;

    
    void SetAppFormXO(SDF::Obj formxo);

    UString GetOverlayText() const;

    void SetOverlayText(const UString& title);

    bool GetUseRepeat() const;

    void SetUseRepeat(bool userepeat=false);

    UString GetOverlayTextAppearance() const;

    void SetOverlayTextAppearance(const UString& app);

    void SetOverlayTextFont(const UString& font_name);

    void SetOverlayTextFontSize(double font_size);

    enum QuadForm
    {
        e_LeftJustified,  
        e_Centered,       
        e_RightJustified, 
        e_None            
    };

    QuadForm GetQuadForm() const;

    void SetQuadForm(QuadForm form=e_LeftJustified);

    // @cond PRIVATE_DOC
    #ifndef SWIGHIDDEN
    Redaction(TRN_Annot redaction);
    #endif
    // @endcond
    
}; //class Redaction
            }; //namespace Annot
        }; //namespace PDF
}; //namespace pdftron

#ifdef SWIG
#undef Redaction
#endif

#include <Impl/Page.inl>

#endif // PDFTRON_H_CPPPDFAnnotsRedaction