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
}

Public Member Functions

BorderStyle (Style s, int b_width, int b_hr, int b_vr)

Creates a new border style with given parameters.

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

BorderStyle (const BorderStyle &)

~BorderStyle ()

Style GetStyle ()

void SetStyle (Style style)

int GetHR ()

void SetHR (int hr)

int GetVR ()

void SetVR (int vr)

int GetWidth ()

void SetWidth (int width)

std::vector< double > GetDash ()

void SetDash (std::vector< double > dash)

BorderStyle (TRN_AnnotBorderStyle impl)

Detailed Description

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

The border is specified as a rounded rectangle.

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.

pdftron::PDF::Annot::BorderStyle::BorderStyle	(	Style	s,
		int	b_width,
		int	b_hr,
		int	b_vr
	)

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,
		int	b_width,
		int	b_hr,
		int	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 )

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

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

int pdftron::PDF::Annot::BorderStyle::GetHR ( )

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

int pdftron::PDF::Annot::BorderStyle::GetVR ( )

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

int pdftron::PDF::Annot::BorderStyle::GetWidth ( )

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

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

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


Public Types
enum	Style { e_solid, e_dashed, e_beveled, e_inset, e_underline }
Public Member Functions
	BorderStyle (Style s, int b_width, int b_hr, int b_vr)
	Creates a new border style with given parameters.
	BorderStyle (Style s, int b_width, int b_hr, int b_vr, const std::vector< double > &b_dash)
	BorderStyle (const BorderStyle &)
	~BorderStyle ()
Style	GetStyle ()
void	SetStyle (Style style)
int	GetHR ()
void	SetHR (int hr)
int	GetVR ()
void	SetVR (int vr)
int	GetWidth ()
void	SetWidth (int width)
std::vector< double >	GetDash ()
void	SetDash (std::vector< double > dash)
	BorderStyle (TRN_AnnotBorderStyle impl)