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 {
37 class ApplyRedactionCallback {
38 public:
44 virtual void Release() = 0;
45
51 virtual bool NeedToGenerateStreamFile() = 0;
52 };
53
62 class Redaction FS_FINAL : public Base {
63 public:
73 explicit Redaction(const pdf::PDFDoc& document);
74
80 Redaction(const Redaction& other);
81
82 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
83 explicit Redaction(FS_HANDLE handle);
85 ~Redaction();
86
94 Redaction& operator = (const Redaction& other);
102 bool operator == (const Redaction& other) const;
110 bool operator != (const Redaction& other) const;
111
119 bool IsEmpty() const;
120
148 pdf::annots::Redact MarkRedactAnnot(const pdf::PDFPage& page, const RectFArray& rects);
149
163 void EnableFileStream(const WString& temp_directory_path, ApplyRedactionCallback* apply_redaction_callback);
164
175 bool Apply();
176
192 common::Progressive StartApply(common::PauseCallback* pause = NULL);
193 };
194 } // namespace addon
195 } // namespace foxit
196
197 #endif // FS_REDACTION_H_
198
foxit::addon::Redaction
Definition: fs_redaction.h:62
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
foxit::addon::ApplyRedactionCallback::NeedToGenerateStreamFile
virtual bool NeedToGenerateStreamFile()=0
A callback function used to check whether to generate stream file or not.
foxit::addon::Redaction::operator!=
bool operator!=(const Redaction &other) const
Not equal operator.
foxit::addon::ApplyRedactionCallback::Release
virtual void Release()=0
A callback function used to release current callback object itself.
foxit::common::Progressive
Definition: fs_common.h:373
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:5784
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
foxit::addon::Redaction::EnableFileStream
void EnableFileStream(const WString &temp_directory_path, ApplyRedactionCallback *apply_redaction_callback)
Enable file stream for image object during applying.
IFX_Pause
Definition: fx_basic.h:3758
fs_pdfdoc.h
Header file for PDF document related definitions and classes.
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:792
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:776
foxit::addon::Redaction::operator=
Redaction & operator=(const Redaction &other)
Assign operator.
foxit::pdf::PDFPage
Definition: fs_pdfpage.h:412
foxit::addon::ApplyRedactionCallback
Definition: fs_redaction.h:37
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.
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1461
foxit::Base
Definition: fs_basictypes.h:451
foxit::addon::Redaction::~Redaction
~Redaction()
Destructor.