|
| 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) |
|
| 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 () |
|
Markup is a base class for a number of annotations types that are used to mark up PDF documents. These annotations have text that appears as part of the annotation and may be displayed in other ways by a conforming reader, such as in a Comments pane. Markup annotations may be divided into the following groups:
- Free text annotations display text directly on the page. The annotation's Contents entry specifies the displayed text.
- Most other markup annotations have an associated pop-up window that may contain text. The annotation's Contents entry specifies the text that shall be displayed when the pop-up window is opened. These include text, line, square, circle, polygon, polyline, highlight,underline, squiggly-underline, strikeout, rubber stamp, caret, ink, and file attachment annotations.
- Sound annotations do not have a pop-up window but may also have associated text specified by the Contents entry.
- A subset of markup annotations are intended to markup text of a document (e.g. highlight, strikeout, jagged, underline) and they are derived from TextMarkup base class.
- Note
- The pop-up annotation type must not appear by itself; it must be associated with a markup annotation that uses it to display text.
The meaning of an annotation's Contents entry varies by annotation type. Typically, it is the text that shall be displayed for the annotation or, if the annotation does not display text, an alternate description of the annotation's contents in human-readable form. When separating text into paragraphs, a CARRIAGE RETURN (0Dh) must be used.
Definition at line 43 of file Markup.h.
Sets the border effect of the markup annotation. (Optional; PDF 1.5 )
Beginning with PDF 1.5, some annotations (square, circle, and polygon) may have a 'BE' entry, which is a border effect dictionary that specifies an effect that shall be applied to the border of the annotations. Beginning with PDF 1.6, the free text annotation may also have a BE entry.
- Parameters
-
effect | An entry from the enum "BorderEffect" that represents the border effect of the Markup annotation. Default value: e_None. |
- Note
- When "e_Cloudy" is chosen,the width and dash array specified by the annotation's BorderStyle entry needs to be taken into consideration.
void pdftron::PDF::Annots::Markup::SetBorderEffectIntensity |
( |
double |
intensity = 0 | ) |
|
Sets the border effect intensity of the markup annotation. (Optional; valid only if Border effect is Cloudy)
Beginning with PDF 1.5, some annotations (square, circle, and polygon) may have a 'BE' entry, which is a border effect dictionary that specifies an effect that shall be applied to the border of the annotations. Beginning with PDF 1.6, the free text annotation may also have a BE entry.
- Parameters
-
intensity | A number describing the intensity of the border effect, in the range 0 (which is default) to 2. |
- Note
- this parameter applies only if Border effect is e_Cloudy.