![]() |
#include <Redaction.h>
Public Types | |
enum | QuadForm { e_LeftJustified, e_Centered, e_RightJustified, e_None } |
This enum represents the justification format of the Redaction annotation's overlay text. More... | |
Public Member Functions | |
Redaction (SDF::Obj d=0) | |
Creates a Redaction annotation and initializes it using given Cos/SDF object. | |
Redaction (const Annot &ann) | |
Creates an Redaction annotation and initializes it using given annotation object. | |
int | GetQuadPointCount () |
Returns the number of QuadPoints in the QuadPoints array of the Redaction annotation. | |
QuadPoint | GetQuadPoint (int idx) const |
Returns the QuadPoint located at a certain index of the QuadPoint array of the Redaction annotation. | |
void | SetQuadPoint (int idx, const QuadPoint &qp) |
Set the QuadPoint to be located at a certain index of the QuadPoint array of the Redaction annotation. | |
SDF::Obj | GetAppFormXO () const |
Returns Overlay appearance of the Redaction annotation. | |
void | SetAppFormXO (SDF::Obj formxo) |
Sets Overlay appearance of the Redaction annotation. | |
UString | GetOverlayText () const |
Returns Overlay text of the Redaction annotation. | |
void | SetOverlayText (const UString &title) |
Sets Overlay text of the Redaction annotation. | |
bool | GetUseRepeat () const |
Returns the option of whether to use repeat for the Redaction annotation. | |
void | SetUseRepeat (bool repeat=false) |
Sets the option of whether to use repeat for the Redaction annotation. | |
UString | GetOverlayTextAppearance () const |
Returns Overlay text appearance of the Redaction annotation. | |
void | SetOverlayTextAppearance (const UString &app) |
Sets Overlay text appearance of the Redaction annotation. | |
QuadForm | GetQuadForm () const |
Returns Overlay text quadding(justification) format of the Redaction annotation. | |
void | SetQuadForm (QuadForm form=e_LeftJustified) |
Sets Overlay text quadding (justification) format of the Redaction annotation. | |
Static Public Member Functions | |
static Redaction | Create (SDF::SDFDoc &doc, const Rect &pos) |
Creates a new Redaction annotation in the specified document. |
The intent of redaction annotations is to enable the following: a)Content identification. A user applies redact annotations that specify the pieces or regions of content that should be removed. Up until the next step is performed, the user can see, move and redefine these annotations. b)Content removal. The user instructs the viewer application to apply the redact annotations, after which the content in the area specified by the redact annotations is removed. In the removed content’s place, some marking appears to indicate the area has been redacted. Also, the redact annotations are removed from the PDF document. Redaction annotations provide a mechanism for the first step in the redaction process (content identification). This allows content to be marked for redaction in a non-destructive way, thus enabling a review process for evaluating potential redactions prior to removing the specified content. Redaction annotations shall provide enough information to be used in the second phase of the redaction process (content removal). This phase is application-specific and requires the conforming reader to remove all content identified by the redaction annotation, as well as the annotation itself. Conforming readers that support redaction annotations shall provide a mechanism for applying content removal, and they shall remove all traces of the specified content. If a portion of an image is contained in a redaction region, that portion of the image data shall be destroyed; clipping or image masks shall not be used to hide that data. Such conforming readers shall also be diligent in their consideration of all content that can exist in a PDF document, including XML Forms Architecture (XFA) content and Extensible Metadata Platform (XMP) content.
This enum represents the justification format of the Redaction annotation's overlay text.
pdftron::PDF::Annots::Redaction::Redaction | ( | SDF::Obj | d = 0 |
) |
Creates a Redaction annotation and initializes it using given Cos/SDF object.
pdftron::PDF::Annots::Redaction::Redaction | ( | const Annot & | ann | ) | [inline] |
Creates an Redaction annotation and initializes it using given annotation object.
static Redaction pdftron::PDF::Annots::Redaction::Create | ( | SDF::SDFDoc & | doc, | |
const Rect & | pos | |||
) | [static] |
int pdftron::PDF::Annots::Redaction::GetQuadPointCount | ( | ) |
Returns the number of QuadPoints in the QuadPoints array of the Redaction annotation.
QuadPoint pdftron::PDF::Annots::Redaction::GetQuadPoint | ( | int | idx | ) | const |
Returns the QuadPoint located at a certain index of the QuadPoint array of the Redaction annotation.
idx | The index of the QuadPoint, starts at zero and must be less than return value of GetQuadPointCount(). |
void pdftron::PDF::Annots::Redaction::SetQuadPoint | ( | int | idx, | |
const QuadPoint & | qp | |||
) |
SDF::Obj pdftron::PDF::Annots::Redaction::GetAppFormXO | ( | ) | const |
Returns Overlay appearance of the Redaction annotation.
void pdftron::PDF::Annots::Redaction::SetAppFormXO | ( | SDF::Obj | formxo | ) |
Sets Overlay appearance of the Redaction annotation.
(Optional)
formxo | An SDF object that represents the overlay appearance of the Redaction annotation. |
UString pdftron::PDF::Annots::Redaction::GetOverlayText | ( | ) | const |
Returns Overlay text of the Redaction annotation.
void pdftron::PDF::Annots::Redaction::SetOverlayText | ( | const UString & | title | ) |
Sets Overlay text of the Redaction annotation.
title | A string containing the overlay text of the annotation. |
bool pdftron::PDF::Annots::Redaction::GetUseRepeat | ( | ) | const |
Returns the option of whether to use repeat for the Redaction annotation.
void pdftron::PDF::Annots::Redaction::SetUseRepeat | ( | bool | repeat = false |
) |
Sets the option of whether to use repeat for the Redaction annotation.
app | A bool indicating whether to repeat for the Redaction annotation. |
UString pdftron::PDF::Annots::Redaction::GetOverlayTextAppearance | ( | ) | const |
Returns Overlay text appearance of the Redaction annotation.
void pdftron::PDF::Annots::Redaction::SetOverlayTextAppearance | ( | const UString & | app | ) |
Sets Overlay text appearance of the Redaction annotation.
app | A string containing the overlay text appearance of the annotation. |
QuadForm pdftron::PDF::Annots::Redaction::GetQuadForm | ( | ) | const |
void pdftron::PDF::Annots::Redaction::SetQuadForm | ( | QuadForm | form = e_LeftJustified |
) |
Sets Overlay text quadding (justification) format of the Redaction annotation.
form | A value of the "QuadForm" enum type, indicating the overlay text quadding(justification) format of the Redaction annotation. |