Redactor.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_CPPPDFRedactor
#define PDFTRON_H_CPPPDFRedactor
 
#include <vector>
#include <PDF/PDFDoc.h>
#include <PDF/Element.h>
#include <C/PDF/TRN_Redactor.h>
 
namespace pdftron {
    namespace PDF {
 
class Redaction;
class Appearance;

class Redactor
{
public:
    typedef pdftron::PDF::Redaction Redaction;
    typedef pdftron::PDF::Appearance Appearance;
    static void Redact(PDFDoc& doc, const std::vector<Redaction>& red_arr, const Appearance& app, bool ext_neg_mode, bool page_coord_sys);
    static void Redact(PDFDoc& doc, const std::vector<Redaction>& red_arr, const Appearance& app, bool ext_neg_mode);
    static void Redact(PDFDoc& doc, const std::vector<Redaction>& red_arr, const Appearance& app);
    static void Redact(PDFDoc& doc, const std::vector<Redaction>& red_arr);
 
};
 
 
 
class Redaction
{
public:
    Redaction(int page_num, const Rect& bbox, bool negative, const UString& text);
    ~Redaction();

    void Destroy();
 
    // @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    Redaction();
    Redaction(const Redaction& other);
    Redaction(TRN_Redaction impl);
    TRN_Redaction mp_imp;
#endif
    // @endcond
};

class Appearance
{
public:
    Appearance()
    {
        // Defaults
        RedactionOverlay = true;
        PositiveOverlayColor.Set(1, 1, 1);
        NegativeOverlayColor.Set(1, 1, 1);
        UseOverlayText = true;
        MinFontSize = 2;
        MaxFontSize = 24;
        TextColor.Set(0, 0, 0);
        HorizTextAlignment = -1; // left justified
        VertTextAlignment = 1; // top justified
        EnableTextWrapping = false;
        Border = true;
        ShowRedactedContentRegions = false;
        RedactedContentColor.Set(0.3, 0.3, 0.3);  // Gray
    }

    bool RedactionOverlay;

    ColorPt PositiveOverlayColor;

    ColorPt NegativeOverlayColor;

    bool Border;

    bool UseOverlayText;

    Font TextFont;

    double MinFontSize, MaxFontSize;

    ColorPt TextColor;

    int HorizTextAlignment;

    int VertTextAlignment;

    bool EnableTextWrapping;

    bool ShowRedactedContentRegions;

    ColorPt RedactedContentColor;
};
    };  // namespace PDF
};  // namespace pdftron
 
#include <Impl/Redactor.inl>
 
#endif // PDFTRON_H_CPPPDFRedactor