![]() |
#include <Link.h>
Public Types | |
enum | HighlightingMode { e_none, e_invert, e_outline, e_push } |
This enum specifies the highlighting mode of the Link Annotation. More... | |
Public Member Functions | |
Link (SDF::Obj d=0) | |
Creates a Link annotation and initializes it using given Cos/SDF object. | |
Link (const Annot &ann) | |
Creates a Link annotation and initializes it using given annotation object. | |
void | RemoveAction () |
Removes this annotation's action. | |
Action | GetAction () const |
Returns the Action of the Link Annotation. | |
void | SetAction (const Action &action) |
Sets the Action of the Link Annotation. | |
HighlightingMode | GetHighlightingMode () const |
Returns the highlighting mode of this Link annotation. | |
void | SetHighlightingMode (HighlightingMode mode) |
Sets the highlighting mode for this Link annotation. | |
int | GetQuadPointCount () const |
Returns the number of QuadPoints in the 'QuadPoints' array of the Link annotation. | |
QuadPoint | GetQuadPoint (int idx) const |
Returns the QuadPoint located at a certain index of the QuadPoint array of the Link annotation. | |
void | SetQuadPoint (int idx, const QuadPoint &qp) |
Set the QuadPoint to be located at a certain index of the QuadPoint array of the Link annotation. | |
Static Public Member Functions | |
static Link | Create (SDF::SDFDoc &doc, const Rect &pos) |
Creates a new Link annotation in the specified document. | |
static Link | Create (SDF::SDFDoc &doc, const Rect &pos, const Action &action) |
Creates a new Link annotation. |
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.
pdftron::PDF::Annots::Link::Link | ( | SDF::Obj | d = 0 |
) |
Creates a Link annotation and initializes it using given Cos/SDF object.
pdftron::PDF::Annots::Link::Link | ( | const Annot & | ann | ) | [inline] |
Creates a Link annotation and initializes it using given annotation object.
static Link pdftron::PDF::Annots::Link::Create | ( | SDF::SDFDoc & | doc, | |
const Rect & | pos | |||
) | [static] |
static Link pdftron::PDF::Annots::Link::Create | ( | SDF::SDFDoc & | doc, | |
const Rect & | pos, | |||
const Action & | action | |||
) | [static] |
void pdftron::PDF::Annots::Link::RemoveAction | ( | ) |
Removes this annotation's action.
Action pdftron::PDF::Annots::Link::GetAction | ( | ) | const |
void pdftron::PDF::Annots::Link::SetAction | ( | const Action & | action | ) |
HighlightingMode pdftron::PDF::Annots::Link::GetHighlightingMode | ( | ) | const |
Returns the highlighting mode of this Link annotation.
void pdftron::PDF::Annots::Link::SetHighlightingMode | ( | HighlightingMode | mode | ) |
Sets the highlighting mode for this Link annotation.
(Optional; PDF 1.2 )
mode | the mode as a value of the enum "HighlightingMode". |
int pdftron::PDF::Annots::Link::GetQuadPointCount | ( | ) | const |
Returns the number of QuadPoints in the 'QuadPoints' array of the Link annotation.
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(). |
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. |