#include <Line.h>
Public Member Functions | |
Line (SDF::Obj d=0) | |
Line (const Annot &ann) | |
Point | GetStartPoint () const |
void | SetStartPoint (const Point &sp) |
Point | GetEndPoint () const |
void | SetEndPoint (const Point &ep) |
EndingStyle | GetStartStyle () const |
void | SetStartStyle (EndingStyle sst) |
EndingStyle | GetEndStyle () const |
void | SetEndStyle (EndingStyle est) |
double | GetLeaderLineLength () const |
void | SetLeaderLineLength (const double &length) |
double | GetLeaderLineExtensionLength () const |
void | SetLeaderLineExtensionLength (const double &length) |
bool | GetShowCaption () const |
void | SetShowCaption (bool showCaption) |
IntentType | GetIntentType () const |
void | SetIntentType (IntentType it) |
double | GetLeaderLineOffset () const |
void | SetLeaderLineOffset (double length) |
CapPos | GetCaptionPosition () const |
void | SetCaptionPosition (const CapPos &style) |
double | GetTextHOffset () const |
void | SetTextHOffset (double offset) |
double | GetTextVOffset () const |
void | SetTextVOffset (double offset) |
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 Line | Create (SDF::SDFDoc &doc, const Rect &pos) |
static Line | CreateAnnot (SDF::SDFDoc &doc, const Rect &pos) |
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 line annotation (PDF 1.3) is used to display a single straight line on the page. When opened, it should display a pop-up window containing the text of the associated note.
Enumeration type describing the annotation's caption positioning. Valid values are e_Inline, meaning the caption shall be centered inside the line, and e_Top, meaning the caption shall be on top of the line.
Enumerator | |
---|---|
e_Inline |
the caption shall be centered inside the line |
e_Top |
the caption shall be on top of the line |
For each line, one can choose a separate style for the start and the end of the line. The styles are defined by the "EndingStyle" enumeration.
pdftron::PDF::Annots::Line::Line | ( | SDF::Obj | d = 0 | ) |
Creates a Line annotation and initializes it using given Cos/SDF object.
|
inline |
|
static |
|
static |
CapPos pdftron::PDF::Annots::Line::GetCaptionPosition | ( | ) | const |
Returns the caption position of a line.
Point pdftron::PDF::Annots::Line::GetEndPoint | ( | ) | const |
Returns the coordinates of the end of a line.
EndingStyle pdftron::PDF::Annots::Line::GetEndStyle | ( | ) | const |
Returns the ending style that applies to the second point of the line.
IntentType pdftron::PDF::Annots::Line::GetIntentType | ( | ) | const |
Returns the intent type of the line.
double pdftron::PDF::Annots::Line::GetLeaderLineExtensionLength | ( | ) | const |
Returns the leader line extension length of a line.
double pdftron::PDF::Annots::Line::GetLeaderLineLength | ( | ) | const |
Returns the leader line length of a line.
double pdftron::PDF::Annots::Line::GetLeaderLineOffset | ( | ) | const |
Returns the leader line offset length of a line.
bool pdftron::PDF::Annots::Line::GetShowCaption | ( | ) | const |
Returns true if caption is to be shown, otherwise false.
Point pdftron::PDF::Annots::Line::GetStartPoint | ( | ) | const |
Returns the coordinates of the start of a line.
EndingStyle pdftron::PDF::Annots::Line::GetStartStyle | ( | ) | const |
Returns the ending style that applies to the first point of the line.
double pdftron::PDF::Annots::Line::GetTextHOffset | ( | ) | const |
Returns the horizontal offset of the caption.
double pdftron::PDF::Annots::Line::GetTextVOffset | ( | ) | const |
Returns the vertical offset of the caption.
void pdftron::PDF::Annots::Line::SetCaptionPosition | ( | const CapPos & | style | ) |
void pdftron::PDF::Annots::Line::SetEndPoint | ( | const Point & | ep | ) |
Sets the coordinates of the end of a line.
ep | - A point specifying the coordinates of the end of the line. |
void pdftron::PDF::Annots::Line::SetEndStyle | ( | EndingStyle | est | ) |
Sets the ending style that applies to the second point of the line. (Optional; PDF 1.4)
est | A enum value from the "EndingStyle". |
void pdftron::PDF::Annots::Line::SetIntentType | ( | IntentType | it | ) |
Sets the intent type of the line. (For PDF 1.6)
it | An intent type value from the "IntentType" enum. |
void pdftron::PDF::Annots::Line::SetLeaderLineExtensionLength | ( | const double & | length | ) |
Sets the leader line extension length of a line. (PDF 1.6)
length | A number denoting the length of the leader line extension in default user space units. |
void pdftron::PDF::Annots::Line::SetLeaderLineLength | ( | const double & | length | ) |
Sets the leader line length of a line. (PDF 1.6)
length | A number denoting the length of the leader line in default user space units. |
void pdftron::PDF::Annots::Line::SetLeaderLineOffset | ( | double | length | ) |
Sets the leader line offset length of a line. (PDF 1.7)
length | A number denoting the length of the leader line offset in default user space units. |
void pdftron::PDF::Annots::Line::SetShowCaption | ( | bool | showCaption | ) |
Sets the option of whether to show caption.
showCaption | A boolean value indicating whether the caption will be shown. |
void pdftron::PDF::Annots::Line::SetStartPoint | ( | const Point & | sp | ) |
Sets the coordinates of the start of a line.
sp | A point specifying the coordinates of the end of the line. |
void pdftron::PDF::Annots::Line::SetStartStyle | ( | EndingStyle | sst | ) |
Sets the ending style that applies to the first point of the line. (Optional; PDF 1.4.)
sst | A enum value from the "EndingStyle". |
void pdftron::PDF::Annots::Line::SetTextHOffset | ( | double | offset | ) |
Sets the horizontal offset of the caption. (For PDF 1.7 )
offset | A number denoting the horizontal offset of the caption in default user space units. |
void pdftron::PDF::Annots::Line::SetTextVOffset | ( | double | offset | ) |
Sets the vertical offset of the caption. (For PDF 1.7 )
offset | A number denoting the vertical offset of the caption in default user space units. |