#include <Link.h>
Public Member Functions | |
Link (SDF::Obj d=0) | |
Link (const Annot &ann) | |
void | RemoveAction () |
Action | GetAction () const |
void | SetAction (const Action &action) |
HighlightingMode | GetHighlightingMode () const |
void | SetHighlightingMode (HighlightingMode mode) |
int | GetQuadPointCount () const |
QuadPoint | GetQuadPoint (int idx) const |
void | SetQuadPoint (int idx, const QuadPoint &qp) |
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 Link | Create (SDF::SDFDoc &doc, const Rect &pos) |
static Link | CreateAnnot (SDF::SDFDoc &doc, const Rect &pos) |
static Link | Create (SDF::SDFDoc &doc, const Rect &pos, const Action &action) |
static Link | CreateAnnot (SDF::SDFDoc &doc, const Rect &pos, const Action &action) |
static UString | GetNormalizedUrl (const UString &url) |
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 link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed.
This enum specifies the highlighting mode of the Link Annotation. The annotation's highlighting mode is the visual effect that shall be used when the mouse button is pressed or held down inside its active area, possible values as follows:
e_none - No highlighting. e_invert - Invert the contents of the annotation rectangle. e_outline - Invert the annotation's border. e_push - Display the annotation as if it were being pushed below the surface of the page.
Enumerator | |
---|---|
e_none | |
e_invert | |
e_outline | |
e_push |
pdftron::PDF::Annots::Link::Link | ( | SDF::Obj | d = 0 | ) |
Creates a Link annotation and initializes it using given Cos/SDF object.
d | The Cos/SDF object to initialze the annotation with. |
|
inline |
|
static |
|
static |
|
static |
|
static |
Action pdftron::PDF::Annots::Link::GetAction | ( | ) | const |
HighlightingMode pdftron::PDF::Annots::Link::GetHighlightingMode | ( | ) | const |
Returns the highlighting mode of this Link annotation.
Prepends http:// to a string if it does not contain :// or This can be important when passing a url to other APIs that expect a URI scheme.
url | The string to possibly be prepended |
QuadPoint pdftron::PDF::Annots::Link::GetQuadPoint | ( | int | idx | ) | const |
Returns the QuadPoint located at a certain index of the QuadPoint array of the Link annotation.
idx | The index of the QuadPoint, starts at zero and should be less than the return value of GetQuadPointCount(). |
int pdftron::PDF::Annots::Link::GetQuadPointCount | ( | ) | const |
Returns the number of QuadPoints in the 'QuadPoints' array of the Link annotation.
void pdftron::PDF::Annots::Link::RemoveAction | ( | ) |
Removes this annotation's action.
void pdftron::PDF::Annots::Link::SetAction | ( | const Action & | action | ) |
void pdftron::PDF::Annots::Link::SetHighlightingMode | ( | HighlightingMode | mode | ) |
void pdftron::PDF::Annots::Link::SetQuadPoint | ( | int | idx, |
const QuadPoint & | qp | ||
) |
Set the QuadPoint to be located at a certain index of the QuadPoint array of the Link annotation. (Optional; PDF 1.6 )
idx | The index of the QuadPoint, starts at zero and should be less than the return value of GetQuadPointCount(). |
qp | The QuadPoint to be stored in the annotation. |