Foxit PDF SDK
fs_redaction.h
Go to the documentation of this file.
1 
15 #ifndef FS_REDACTION_H_
16 #define FS_REDACTION_H_
17 
18 #include "common/fs_common.h"
19 #include "pdf/fs_pdfdoc.h"
20 #include "pdf/fs_pdfpage.h"
21 #include "pdf/annots/fs_annot.h"
22 
28 namespace foxit {
32 namespace addon {
41 class Redaction FS_FINAL : public Base {
42  public:
52  explicit Redaction(const pdf::PDFDoc& document);
53 
59  Redaction(const Redaction& other);
60 
61  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
62  explicit Redaction(FS_HANDLE handle);
64  ~Redaction();
65 
73  Redaction& operator = (const Redaction& other);
81  bool operator == (const Redaction& other) const;
89  bool operator != (const Redaction& other) const;
90 
98  bool IsEmpty() const;
99 
127  pdf::annots::Redact MarkRedactAnnot(const pdf::PDFPage& page, const RectFArray& rects);
128 
139  bool Apply();
140 
157 };
158 } // namespace addon
159 } // namespace foxit
160 
161 #endif // FS_REDACTION_H_
162 
foxit::addon::Redaction
Definition: fs_redaction.h:41
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
foxit::addon::Redaction::operator!=
bool operator!=(const Redaction &other) const
Not equal operator.
foxit::common::Progressive
Definition: fs_common.h:346
foxit::addon::Redaction::StartApply
common::Progressive StartApply(common::PauseCallback *pause=0)
Start to apply redaction in marked areas: remove the text or graphics under marked areas permanently.
foxit::addon::Redaction::operator==
bool operator==(const Redaction &other) const
Equal operator.
fs_common.h
Header file for common definitions and classes.
CFX_ArrayTemplate< RectF >
foxit::addon::Redaction::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::addon::Redaction::Redaction
Redaction(const pdf::PDFDoc &document)
Constructor, from a PDF document object.
foxit::pdf::annots::Redact
Definition: fs_annot.h:5724
foxit::addon::Redaction::MarkRedactAnnot
pdf::annots::Redact MarkRedactAnnot(const pdf::PDFPage &page, const RectFArray &rects)
Mark page contents (text object, image object, and path object) which are to be redacted.
fs_pdfpage.h
Header file for PDF page related definitions and classes.
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
IFX_Pause
Definition: fx_basic.h:3761
fs_pdfdoc.h
Header file for PDF document related definitions and classes.
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:780
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:610
foxit::addon::Redaction::operator=
Redaction & operator=(const Redaction &other)
Assign operator.
foxit::pdf::PDFPage
Definition: fs_pdfpage.h:412
fs_annot.h
Header file for annotation related definitions and classes.
foxit::addon::Redaction::Apply
bool Apply()
Apply redaction in marked areas: remove the text or graphics under marked areas permanently.
foxit::Base
Definition: fs_basictypes.h:427
foxit::addon::Redaction::~Redaction
~Redaction()
Destructor.