Foxit PDF SDK
|
Public Member Functions | |
Redact () | |
Constructor. | |
Redact (const Annot &annot) | |
Constructor, with parent class object. More... | |
~Redact () | |
Destructor. | |
bool | Apply () |
Apply current redact annotation: remove the text or graphics under annotation rectangle permanently. More... | |
RGB | GetApplyFillColor () const |
Get the filling color which is used for rollover appearance and will be used after redaction is applied. More... | |
DefaultAppearance | GetDefaultAppearance () |
Get default appearance data. More... | |
RGB | GetFillColor () const |
Get fill color. More... | |
WString | GetOverlayText () const |
Get the overlay text. More... | |
common::Alignment | GetOverlayTextAlignment () const |
Get alignment value of overlay text. More... | |
QuadPointsArray | GetQuadPoints () const |
Get quadrilaterals. More... | |
void | SetApplyFillColor (RGB fill_color) |
Set the filling color which is used for rollover appearance and will be used after redaction is applied. More... | |
bool | SetDefaultAppearance (const DefaultAppearance &default_ap) |
Set default appearance data. More... | |
void | SetFillColor (RGB fill_color) |
Set fill color. More... | |
void | SetOverlayText (const WString &overlay_text) |
Set the overlay text. More... | |
void | SetOverlayTextAlignment (common::Alignment alignment) |
Set alignment value of overlay text. More... | |
void | SetQuadPoints (const QuadPointsArray &quad_points_array) |
Set quadrilaterals. More... | |
![]() | |
Markup (const Annot &annot) | |
Constructor, with parent class object. More... | |
Markup () | |
Constructor. | |
~Markup () | |
Destructor. | |
Note | AddReply () |
Add a new reply to the end of reply list. More... | |
Note | AddStateAnnot (StateModel model, State state) |
Add a new state annotation. More... | |
DateTime | GetCreationDateTime () const |
Get creation date time. More... | |
MarkupArray | GetGroupElements () |
Get an element (as markup annotation) from the group that current markup annotation belongs to. More... | |
Markup | GetGroupHeader () |
Get the header annotation (as primary annotation) of the group that current markup annotation belongs to. More... | |
String | GetIntent () const |
Get intent name. More... | |
float | GetOpacity () const |
Get opacity value. More... | |
Popup | GetPopup () |
Get related pop-up annotation. More... | |
Note | GetReply (int index) const |
Get a reply by index. More... | |
int | GetReplyCount () |
Count all replies. More... | |
Note | GetStateAnnot (StateModel model, int index) |
Get a state annotation, under a specified state model. More... | |
int | GetStateAnnotCount (StateModel model) |
Get the count of state annotations, under a specified state model. More... | |
WString | GetSubject () const |
Get subject string. More... | |
WString | GetTitle () const |
Get title string. More... | |
bool | IsGrouped () |
Check whether current markup annotation is in a group or not. More... | |
bool | RemoveAllReplies () |
Remove all the replies. More... | |
bool | RemoveAllStateAnnots () |
Remove all state annotations. More... | |
bool | RemoveReply (int index) |
Remove a reply by index. More... | |
void | SetCreationDateTime (const DateTime &date_time) |
Set creation date time. More... | |
void | SetIntent (const String &intent) |
Set intent name. More... | |
void | SetOpacity (float opacity) |
Set opacity value. More... | |
void | SetPopup (const Popup &popup) |
Set related pop-up annotation. More... | |
void | SetSubject (const WString &subject) |
Set subject string. More... | |
void | SetTitle (const WString &title) |
Set title string. More... | |
bool | Ungroup () |
Ungroup current markup annotation from the group it belongs to. More... | |
![]() | |
Annot (const PDFPage &page, objects::PDFDictionary *annot_dict) | |
Constructor, with PDF page and annotation's PDF dictionary. More... | |
Annot (const Annot &annot) | |
Constructor, with another annotation object. More... | |
Annot () | |
Constructor. | |
virtual | ~Annot () |
Destructor. | |
objects::PDFStream * | GetAppearanceStream (AppearanceType type, const char *appearance_state="") const |
Get annotation's appearance stream with specified type and state. More... | |
RGB | GetBorderColor () const |
Get border color. More... | |
BorderInfo | GetBorderInfo () const |
Get border information. More... | |
WString | GetContent () const |
Get content. More... | |
RectI | GetDeviceRect (const Matrix &matrix) |
Get annotation rectangle in device coordinate system. More... | |
objects::PDFDictionary * | GetDict () const |
Get annotation's dictionary object. More... | |
Matrix | GetDisplayMatrix (const Matrix &page_display_matrix) |
Get the display matrix, from PDF coordinate system to targeted device coordinate system. More... | |
uint32 | GetFlags () const |
Get annotation flags. More... | |
int | GetIndex () const |
Get the index of current annotation in the page which current annotation belongs to. More... | |
DateTime | GetModifiedDateTime () const |
Get last modified date time. More... | |
objects::PDFDictionary * | GetOptionalContent () const |
Get the PDF dictionary of annotation's optional content. More... | |
PDFPage | GetPage () const |
Get the related PDF page. More... | |
RectF | GetRect () const |
Get rectangle, in PDF coordinate system. More... | |
Type | GetType () const |
Get actual annotation type of current annotation. More... | |
WString | GetUniqueID () const |
Get unique ID. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | IsMarkup () const |
Check if current annotation is a markup annotation. More... | |
bool | Move (const RectF &rect) |
Move current annotation to a new position, specified by a new rectangle in PDF coordinate system. More... | |
bool | operator!= (const Annot &other) const |
Not equal operator. More... | |
Annot & | operator= (const Annot &annot) |
Assign operator. More... | |
bool | operator== (const Annot &other) const |
Equal operator. More... | |
bool | RemoveProperty (Property property) |
Remove a specified annotation's property. More... | |
bool | ResetAppearanceStream () |
Reset appearance stream. More... | |
void | SetBorderColor (RGB color) |
Set border color. More... | |
void | SetBorderInfo (const BorderInfo &border) |
Set border information. More... | |
void | SetContent (const WString &content) |
Set content. More... | |
void | SetFlags (uint32 flags) |
Set annotation flags. More... | |
void | SetModifiedDateTime (const DateTime &date_time) |
Set last modified date time. More... | |
void | SetUniqueID (const WString &unique_id) |
Set unique ID. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
Class Redact represents a Foxit custom annotation type (not a standard annotation type). This kind of annotation is used to mark some content of a PDF page and these content will be removed once the redact annotations are applied. An existed redact annotation can be retrieved from PDF page by functions pdf::PDFPage::GetAnnot and pdf::PDFPage::GetAnnotAtPoint. A new redact annotation would be returned by function addon::Redaction::MarkRedactAnnot, instead of pdf::PDFPage::AddAnnot.
Class annots::Redact is derived from class Markup and also offers functions to get/set markup annotation's basic properties of a redact annotation. Currently, Annot::SetBorderInfo can be used for a redact annotation, but will not have any effect on the appearance of redact annotation. Besides, redact annotation cannot be moved by function Annot::Move.
|
explicit |
Constructor, with parent class object.
[in] | annot | Parent class object. |
bool foxit::pdf::annots::Redact::Apply | ( | ) |
Apply current redact annotation: remove the text or graphics under annotation rectangle permanently.
Once this functions is called successfully, all page content(text object, image object, and path object) within area of current redact annotation rectangle will be removed permanently. And current redact annotation will be removed (with its pop-up annotation if any) as well - that means current annotation object will be useless when this function succeeds. Area of current redact annotation rectangle will be filled by the color specified by function pdf::annots::Redact::SetApplyFillColor.
RGB foxit::pdf::annots::Redact::GetApplyFillColor | ( | ) | const |
Get the filling color which is used for rollover appearance and will be used after redaction is applied.
DefaultAppearance foxit::pdf::annots::Redact::GetDefaultAppearance | ( | ) |
Get default appearance data.
This property has effect on redact annotation's appearance. Default appearance data can be used in formatting text.
RGB foxit::pdf::annots::Redact::GetFillColor | ( | ) | const |
Get fill color.
WString foxit::pdf::annots::Redact::GetOverlayText | ( | ) | const |
Get the overlay text.
common::Alignment foxit::pdf::annots::Redact::GetOverlayTextAlignment | ( | ) | const |
Get alignment value of overlay text.
This property has effect on the overlay text of redact annotation's appearance.
QuadPointsArray foxit::pdf::annots::Redact::GetQuadPoints | ( | ) | const |
Get quadrilaterals.
The order of points in a quadrilateral should be:
void foxit::pdf::annots::Redact::SetApplyFillColor | ( | RGB | fill_color | ) |
Set the filling color which is used for rollover appearance and will be used after redaction is applied.
[in] | fill_color | New fill color to be set. Format: 0xRRGGBB. |
bool foxit::pdf::annots::Redact::SetDefaultAppearance | ( | const DefaultAppearance & | default_ap | ) |
Set default appearance data.
This property has effect on redact annotation's appearance. Default appearance data can be used in formatting text.
If user wants the new default appearance data has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting new default appearance data.
[in] | default_ap | The new default appearance data to be set. flags of input data can be used to decide which information is/are to be updated with the new data; for those no updated data, they will keep to use old data. |
void foxit::pdf::annots::Redact::SetFillColor | ( | RGB | fill_color | ) |
Set fill color.
[in] | fill_color | New fill color to be set. Format: 0xRRGGBB. |
void foxit::pdf::annots::Redact::SetOverlayText | ( | const WString & | overlay_text | ) |
Set the overlay text.
[in] | overlay_text | The overlay text string to be set. |
void foxit::pdf::annots::Redact::SetOverlayTextAlignment | ( | common::Alignment | alignment | ) |
Set alignment value of overlay text.
This property has effect on the overlay text of redact annotation's appearance. If user wants the new alignment has effect on the overlay text of annotation's appearance, please call function Annot::ResetAppearanceStream after setting new alignment.
[in] | alignment | The new alignment value. Please refer to values starting from common::e_AlignmentLeft and this should be one of these values. |
void foxit::pdf::annots::Redact::SetQuadPoints | ( | const QuadPointsArray & | quad_points_array | ) |
Set quadrilaterals.
This property has effect on the redact annotation's appearance.The order of points in a quadrilateral should be :
If user wants the new quadrilaterals has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting quadrilaterals.
[in] | quad_points_array | A valid array of quadrilaterals. It should not be an empty array. |