pdftron::PDF::Annot::BorderStyle Class Reference

BorderStyle structure specifies the characteristics of the annotation's border. More...

#include <Annot.h>

List of all members.

Public Types

enum  Style {
  e_solid, e_dashed, e_beveled, e_inset,
  e_underline
}
 The border style. More...

Public Member Functions

 BorderStyle (Style s, double b_width, double b_hr=0, double b_vr=0)
 Creates a new border style with given parameters.
 BorderStyle (Style s, double b_width, double b_hr, double b_vr, const std::vector< double > &b_dash)
 BorderStyle (const BorderStyle &)
 ~BorderStyle ()
BorderStyleoperator= (const BorderStyle &)
Style GetStyle () const
void SetStyle (Style style)
 Sets the border style.
double GetHR () const
void SetHR (double hr)
 Sets horizontal corner radius.
double GetVR () const
void SetVR (double vr)
 Sets vertical corner radius.
double GetWidth () const
void SetWidth (double width)
 Sets the border width.
std::vector< double > GetDash () const
void SetDash (const std::vector< double > &dash)
 Sets the border dash pattern.
 BorderStyle (TRN_AnnotBorderStyle impl)

Friends

bool operator== (const BorderStyle &a, const BorderStyle &b)
bool operator!= (const BorderStyle &a, const BorderStyle &b)


Detailed Description

BorderStyle structure specifies the characteristics of the annotation's border.

The border is specified as a rounded rectangle.


Member Enumeration Documentation

The border style.

Enumerator:
e_solid  A solid rectangle surrounding the annotation.
e_dashed  A dashed rectangle surrounding the annotation.
e_beveled  A simulated embossed rectangle that appears to be raised above the surface of the page.
e_inset  A simulated engraved rectangle that appears to be recessed below the surface of the page.
e_underline  A single line along the bottom of the annotation rectangle.


Constructor & Destructor Documentation

pdftron::PDF::Annot::BorderStyle::BorderStyle ( Style  s,
double  b_width,
double  b_hr = 0,
double  b_vr = 0 
)

Creates a new border style with given parameters.

Parameters:
s The border style.
b_width The border width expressed in the default user space.
b_hr The horizontal corner radius expressed in the default user space.
b_vr The vertical corner radius expressed in the default user space.
b_dash An array of numbers defining a pattern of dashes and gaps to be used in drawing the border. The dash array is specified in the same format as in the line dash pattern parameter of the graphics state except that the phase is assumed to be 0.
Note:
If the corner radii are 0, the border has square (not rounded) corners; if the border width is 0, no border is drawn.

pdftron::PDF::Annot::BorderStyle::BorderStyle ( Style  s,
double  b_width,
double  b_hr,
double  b_vr,
const std::vector< double > &  b_dash 
)

pdftron::PDF::Annot::BorderStyle::BorderStyle ( const BorderStyle  ) 

pdftron::PDF::Annot::BorderStyle::~BorderStyle (  ) 

pdftron::PDF::Annot::BorderStyle::BorderStyle ( TRN_AnnotBorderStyle  impl  ) 


Member Function Documentation

BorderStyle& pdftron::PDF::Annot::BorderStyle::operator= ( const BorderStyle  ) 

Style pdftron::PDF::Annot::BorderStyle::GetStyle (  )  const

Returns:
the border style.

void pdftron::PDF::Annot::BorderStyle::SetStyle ( Style  style  ) 

Sets the border style.

double pdftron::PDF::Annot::BorderStyle::GetHR (  )  const

Returns:
horizontal corner radius.

void pdftron::PDF::Annot::BorderStyle::SetHR ( double  hr  ) 

Sets horizontal corner radius.

double pdftron::PDF::Annot::BorderStyle::GetVR (  )  const

Returns:
vertical corner radius.

void pdftron::PDF::Annot::BorderStyle::SetVR ( double  vr  ) 

Sets vertical corner radius.

double pdftron::PDF::Annot::BorderStyle::GetWidth (  )  const

Returns:
the border width.

void pdftron::PDF::Annot::BorderStyle::SetWidth ( double  width  ) 

Sets the border width.

std::vector<double> pdftron::PDF::Annot::BorderStyle::GetDash (  )  const

Returns:
the border dash pattern.
See also:
BorderStyle()

void pdftron::PDF::Annot::BorderStyle::SetDash ( const std::vector< double > &  dash  ) 

Sets the border dash pattern.

See also:
BorderStyle()


Friends And Related Function Documentation

bool operator== ( const BorderStyle a,
const BorderStyle b 
) [friend]

bool operator!= ( const BorderStyle a,
const BorderStyle b 
) [friend]


© 2002-2010 PDFTron Systems Inc.