wxPdfDocument 0.9.2
Public Member Functions
wxPdfLineStyle Class Reference

Class representing line styles. More...

#include <pdflinestyle.h>

List of all members.

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.
wxPdfLineStyleoperator= (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 wxPdfColourGetColour () const
 Get the line colour.

Detailed Description

Class representing line styles.


Constructor & Destructor Documentation

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]widthWidth of the line in user units.
[in]capType 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]joinform of line joining: miter, round or bevel
[in]dashpattern 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]phaseModifier of the dash pattern which is used to shift the point at which the pattern starts
[in]colourline colour.
See also:
SetLineStyle(), Curve(), Line(), Circle(), Ellipse(), Rect(), RoundedRect(), Polygon(), RegularPolygon(), StarPolygon()
wxPdfLineStyle::wxPdfLineStyle ( const wxPdfLineStyle lineStyle)

Copy constructor.

virtual wxPdfLineStyle::~wxPdfLineStyle ( ) [virtual]

Destructor.


Member Function Documentation

const wxPdfColour& wxPdfLineStyle::GetColour ( ) const [inline]

Get the line colour.

const wxPdfArrayDouble& wxPdfLineStyle::GetDash ( ) const [inline]

Get the dash pattern.

wxPdfLineCap wxPdfLineStyle::GetLineCap ( ) const [inline]

Get the line ending style.

wxPdfLineJoin wxPdfLineStyle::GetLineJoin ( ) const [inline]

Get the line join style.

double wxPdfLineStyle::GetPhase ( ) const [inline]

Get the dash pattern phase.

double wxPdfLineStyle::GetWidth ( ) const [inline]

Get the line width.

bool wxPdfLineStyle::IsSet ( ) const [inline]

Check whether the style is initialized.

wxPdfLineStyle& wxPdfLineStyle::operator= ( const wxPdfLineStyle lineStyle)

Assignment operator.

void wxPdfLineStyle::SetColour ( const wxPdfColour colour) [inline]

Set the line colour.

void wxPdfLineStyle::SetDash ( const wxPdfArrayDouble &  dash) [inline]

Set the dash pattern.

void wxPdfLineStyle::SetLineCap ( const wxPdfLineCap  cap) [inline]

Set the line ending style.

void wxPdfLineStyle::SetLineJoin ( const wxPdfLineJoin  join) [inline]

Set the line join style.

void wxPdfLineStyle::SetPhase ( double  phase) [inline]

Set the dash pattern phase.

void wxPdfLineStyle::SetWidth ( double  width) [inline]

Set the line width.


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