#include <RubberStamp.h>
Public Member Functions | |
RubberStamp (SDF::Obj d=0) | |
RubberStamp (const Annot &ann) | |
Icon | GetIcon () const |
void | SetIcon (Icon type=e_Draft) |
const char * | GetIconName () const |
void | SetIcon (const char *icon) |
void | SetOpacity (double opacity) |
Public Member Functions inherited from pdftron::PDF::Annots::Markup | |
Markup (SDF::Obj d=0) | |
Markup (const Annot &ann) | |
UString | GetTitle () |
void | SetTitle (const UString &title) |
void | SetTitle (const char *title) |
Popup | GetPopup () const |
void | SetPopup (const Popup &ppup) |
double | GetOpacity () const |
void | SetOpacity (double op) |
UString | GetSubject () const |
void | SetSubject (const UString &contents) |
Date | GetCreationDates () const |
void | SetCreationDates (const Date &dt) |
BorderEffect | GetBorderEffect () const |
void | SetBorderEffect (BorderEffect effect=e_None) |
double | GetBorderEffectIntensity () const |
void | SetBorderEffectIntensity (double intensity=0) |
ColorPt | GetInteriorColor () const |
int | GetInteriorColorCompNum () const |
void | SetInteriorColor (const ColorPt &c, int CompNum) |
Rect | GetContentRect () const |
void | SetContentRect (const Rect &cr) |
Rect | GetPadding () const |
void | SetPadding (const Rect &rd) |
void | SetPadding (double x) |
void | RotateAppearance (double angle) |
Public Member Functions inherited from pdftron::PDF::Annot | |
Annot (SDF::Obj d=0) | |
Annot (const Annot &d) | |
Annot & | operator= (const Annot &d) |
bool | operator== (const Annot &d) |
bool | IsValid () const |
SDF::Obj | GetSDFObj () const |
Type | GetType () const |
Rect | GetRect () const |
Rect | GetVisibleContentBox () const |
bool | IsMarkup () const |
void | SetRect (const Rect &pos) |
Page | GetPage () const |
void | SetPage (const Page &page) |
SDF::Obj | GetUniqueID () const |
void | SetUniqueID (const char *id, int id_buf_sz=0) |
Date | GetDate () const |
void | SetDate (const Date &date) |
bool | GetFlag (Flag flag) const |
void | SetFlag (Flag flag, bool value) |
SDF::Obj | GetTriggerAction (Annot::ActionTriggerEvent trigger) |
BorderStyle | GetBorderStyle () const |
void | SetBorderStyle (const BorderStyle &bs, bool oldStyleOnly=false) |
SDF::Obj | GetAppearance (AnnotationState annot_state=e_normal, const char *app_state=0) |
void | SetAppearance (SDF::Obj app_stream, AnnotationState annot_state=e_normal, const char *app_state=0) |
void | RemoveAppearance (AnnotationState annot_state=e_normal, const char *app_state=0) |
void | Flatten (class Page page) |
const char * | GetActiveAppearanceState () const |
void | SetActiveAppearanceState (const char *astate) |
ColorPt | GetColorAsRGB () const |
ColorPt | GetColorAsCMYK () const |
ColorPt | GetColorAsGray () const |
int | GetColorCompNum () const |
void | SetColor (const ColorPt &col, int numcomp=3) |
int | GetStructParent () const |
void | SetStructParent (const int parkeyval) |
SDF::Obj | GetOptionalContent () const |
void | SetOptionalContent (SDF::Obj content) |
void | SetContents (const UString &contents) |
UString | GetContents () const |
int | GetRotation () const |
void | SetRotation (int angle) |
void | RefreshAppearance () |
void | RefreshAppearance (const RefreshOptions &options) |
UString | GetCustomData (const UString &key) const |
void | SetCustomData (const UString &key, const UString &value) |
void | DeleteCustomData (const UString &key) |
void | Resize (const Rect &newrect) |
ptrdiff_t | GetHandleInternal () |
Static Public Member Functions | |
static RubberStamp | Create (SDF::SDFDoc &doc, const Rect &pos, Icon icon=e_Draft) |
static RubberStamp | CreateAnnot (SDF::SDFDoc &doc, const Rect &pos, Icon icon=e_Draft) |
static RubberStamp | Create (SDF::SDFDoc &doc, const Rect &pos, SDF::Obj *form_xobject) |
static RubberStamp | CreateAnnot (SDF::SDFDoc &doc, const Rect &pos, SDF::Obj *form_xobject) |
Static Public Member Functions inherited from pdftron::PDF::Annot | |
static Annot | Create (SDF::SDFDoc &doc, Type type, const Rect &pos) |
static Annot * | CreateInternal (ptrdiff_t impl) |
A RubberStamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp.
Definition at line 17 of file RubberStamp.h.
This enum represents the Icon type of the RubberStamp annotation
Definition at line 39 of file RubberStamp.h.
pdftron::PDF::Annots::RubberStamp::RubberStamp | ( | SDF::Obj | d = 0 | ) |
Creates a RubberStamp annotation and initializes it using given Cos/SDF object.
d | The Cos/SDF object to initialze the annotation with. |
|
inline |
Creates a RubberStamp annotation and initializes it using given annotation object.
ann | Annot object used to initialize the RubberStamp annotation. |
Definition at line 34 of file RubberStamp.h.
|
static |
Creates a new RubberStamp annotation in the specified document.
doc | A document to which the annotation is added. |
pos | A rectangle specifying the annotation's bounds in default user space units. |
|
static |
Creates a new RubberStamp annotation in the specified document.
doc | A document to which the annotation is added. |
pos | A rectangle specifying the annotation's bounds in default user space units. |
form_xobject | An object specifying a custom appearance for the annotation, containing TEXT as string (mandatory): The text to be displayed in rubber stamp TEXT_BELOW as string (optional): The text to be displayed below the first text FILL_COLOR as an array of three or four numbers between 0.0 to 1.0 (optional): The fill color TEXT_COLOR as an array of three or four numbers between 0.0 to 1.0 (optional): The text color BORDER_COLOR as an array of three or four numbers between 0.0 to 1.0 (optional): The border color FILL_COLOR_START as an array of three or four numbers between 0.0 to 1.0 (optional): The start fill color if background is gradient FILL_COLOR_END as an array of three or four numbers between 0.0 to 1.0 (optional): The end fill color if background is gradient FILL_OPACITY as a number (optional): the fill opacity TEXT_OPACITY as a number (optional): the text opacity ROTATION as a number (optional): rotation. valid numbers are {0, 90, 180, 270} POINTING_LEFT as a boolean (optional): if the stamp is pointing left POINTING_RIGHT as a boolean (optional): if the stamp is pointing right |
|
static |
|
static |
Icon pdftron::PDF::Annots::RubberStamp::GetIcon | ( | ) | const |
Returns the type of the icon associated with the RubberStamp annotation.
const char* pdftron::PDF::Annots::RubberStamp::GetIconName | ( | ) | const |
Returns the name of the icon associated with the RubberStamp annotation.
Sets the type of the icon associated with the RubberStamp annotation.
type | A value of enum "Icon" type that represents the type of icon associated with the annotation. Default value: e_Draft. |
void pdftron::PDF::Annots::RubberStamp::SetIcon | ( | const char * | icon | ) |
Sets the name of the icon associated with the RubberStamp annotation.
iconstring | the name of the icon associated with the RubberStamp annotation. |
void pdftron::PDF::Annots::RubberStamp::SetOpacity | ( | double | opacity | ) |
Updates the appearance of the stamp with the given opacity value Opacity value does not accumulate in case of subsequent calls - i.e. last call sets the final opacity