wxPdfLineStyle Class Reference

Class representing line styles. More...

#include <pdflinestyle.h>

Public Member Functions
	wxPdfLineStyle (double width=-1, wxPdfLineCap cap=wxPDF_LINECAP_NONE, wxPdfLineJoin join=wxPDF_LINEJOIN_NONE, const wxPdfArrayDouble &dash=wxPdfArrayDouble(), double phase=-1, const wxPdfColour &colour=wxPdfColour())
	Constructor.
	wxPdfLineStyle (const wxPdfLineStyle &lineStyle)
	Copy constructor.
wxPdfLineStyle &	operator= (const wxPdfLineStyle &lineStyle)
	Assignment operator.
virtual	~wxPdfLineStyle ()
	Destructor.
bool	IsSet () const
	Check whether the style is initialized.
void	SetWidth (double width)
	Set the line width.
double	GetWidth () const
	Get the line width.
void	SetLineCap (const wxPdfLineCap cap)
	Set the line ending style.
wxPdfLineCap	GetLineCap () const
	Get the line ending style.
void	SetLineJoin (const wxPdfLineJoin join)
	Set the line join style.
wxPdfLineJoin	GetLineJoin () const
	Get the line join style.
void	SetDash (const wxPdfArrayDouble &dash)
	Set the dash pattern.
const wxPdfArrayDouble &	GetDash () const
	Get the dash pattern.
void	SetPhase (double phase)
	Set the dash pattern phase.
double	GetPhase () const
	Get the dash pattern phase.
void	SetColour (const wxPdfColour &colour)
	Set the line colour.
const wxPdfColour &	GetColour () const
	Get the line colour.

Detailed Description

Class representing line styles.

Constructor & Destructor Documentation

wxPdfLineStyle() [1/2]

wxPdfLineStyle::wxPdfLineStyle	(	double	width = -1,
		wxPdfLineCap	cap = wxPDF_LINECAP_NONE,
		wxPdfLineJoin	join = wxPDF_LINEJOIN_NONE,
		const wxPdfArrayDouble &	dash = wxPdfArrayDouble(),
		double	phase = -1,
		const wxPdfColour &	colour = wxPdfColour() )

Constructor.

Creates a line style for use in graphics primitives.

Parameters

[in]	width	Width of the line in user units.
[in]	cap	Type of cap to put on the line (butt, round, square). The difference between 'square' and 'butt' is that 'square' projects a flat end past the end of the line.
[in]	join	form of line joining: miter, round or bevel
[in]	dash	pattern for dashed lines.Is an empty array (without dash) or array with series of length values, which are the lengths of the on and off dashes. For example: (2) represents 2 on, 2 off, 2 on , 2 off ... (2,1) is 2 on, 1 off, 2 on, 1 off.. etc
[in]	phase	Modifier of the dash pattern which is used to shift the point at which the pattern starts
[in]	colour	line colour.

See also

SetLineStyle(), Curve(), Line(), Circle(), Ellipse(), Rect(), RoundedRect(), Polygon(), RegularPolygon(), StarPolygon()

wxPdfLineStyle() [2/2]

wxPdfLineStyle::wxPdfLineStyle

(

const wxPdfLineStyle &

lineStyle

)

Copy constructor.

Parameters

lineStyle

The line style to copy

~wxPdfLineStyle()

virtual wxPdfLineStyle::~wxPdfLineStyle ( )

virtual

Destructor.

Member Function Documentation

GetColour()

const wxPdfColour & wxPdfLineStyle::GetColour ( ) const

inline

Get the line colour.

Returns

The line colour

GetDash()

const wxPdfArrayDouble & wxPdfLineStyle::GetDash ( ) const

inline

Get the dash pattern.

Returns

The dash pattern array

GetLineCap()

wxPdfLineCap wxPdfLineStyle::GetLineCap ( ) const

inline

Get the line ending style.

Returns

The line cap style

GetLineJoin()

wxPdfLineJoin wxPdfLineStyle::GetLineJoin ( ) const

inline

Get the line join style.

Returns

The line join style

GetPhase()

double wxPdfLineStyle::GetPhase ( ) const

inline

Get the dash pattern phase.

Returns

The dash pattern phase

GetWidth()

double wxPdfLineStyle::GetWidth ( ) const

inline

Get the line width.

Returns

The line width

IsSet()

bool wxPdfLineStyle::IsSet ( ) const

inline

Check whether the style is initialized.

Returns

true if the style is set, false otherwise

operator=()

wxPdfLineStyle & wxPdfLineStyle::operator=

(

const wxPdfLineStyle &

lineStyle

)

Assignment operator.

Parameters

lineStyle

The line style to copy

Returns

A reference to this line style

SetColour()

void wxPdfLineStyle::SetColour ( const wxPdfColour & colour )

inline

Set the line colour.

Parameters

colour

The line colour

SetDash()

void wxPdfLineStyle::SetDash ( const wxPdfArrayDouble & dash )

inline

Set the dash pattern.

Parameters

dash	The dash pattern array

SetLineCap()

void wxPdfLineStyle::SetLineCap ( const wxPdfLineCap cap )

inline

Set the line ending style.

Parameters

cap	The line cap style

SetLineJoin()

void wxPdfLineStyle::SetLineJoin ( const wxPdfLineJoin join )

inline

Set the line join style.

Parameters

join	The line join style

SetPhase()

void wxPdfLineStyle::SetPhase ( double phase )

inline

Set the dash pattern phase.

Parameters

phase

The dash pattern phase

SetWidth()

void wxPdfLineStyle::SetWidth ( double width )

inline

Set the line width.

Parameters

width

The line width

---

The documentation for this class was generated from the following file:

• E:/github/wxpdfdoc-current/include/wx/pdflinestyle.h