wxPdfPattern Class Reference

Class representing patterns. More...

#include <pdfpattern.h>

Public Member Functions
	wxPdfPattern (int index, double width, double height)
	Constructor for pattern.
	wxPdfPattern (int index, double width, double height, int templateId)
	Constructor for pattern.
	wxPdfPattern (int index, double width, double height, wxPdfPatternStyle patternStyle, const wxColour &drawColour, const wxColour &fillColour=wxColour())
	Constructor for pattern.
	wxPdfPattern (int index, double x1, double y1, double x2, double y2, const wxGraphicsGradientStops &stops, const wxAffineMatrix2D &matrix)
	Constructor for linear gradient pattern.
	wxPdfPattern (int index, double startX, double startY, double startRadius, double endX, double endY, double endRadius, const wxGraphicsGradientStops &stops, const wxAffineMatrix2D &matrix)
	Constructor for radial gradient pattern.
	wxPdfPattern (const wxPdfPattern &pattern)
	Copy constructor.
void	SetObjIndex (int index)
	Set object index.
int	GetObjIndex () const
	Get object index.
int	GetIndex () const
	Get pattern index.
void	SetImage (wxPdfImage *image)
	Set image.
wxPdfImage *	GetImage () const
	Get image.
double	GetWidth () const
	Get pattern width.
double	GetHeight () const
	Get pattern height.
int	GetTemplateId () const
	Get template id.
wxPdfPatternStyle	GetPatternStyle () const
	Get pattern style.
wxColour	GetDrawColour () const
	Get draw color.
void	SetFillColour (const wxColour &fillColour)
	Set fill color.
wxColour	GetFillColour () const
	Get fill color.
bool	HasFillColour () const
	Check whether fill color is set.
double	GetX1 () const
	Get x-coordinate of start point (linear gradient).
double	GetY1 () const
	Get y-coordinate of start point (linear gradient).
double	GetX2 () const
	Get x-coordinate of end point (linear gradient).
double	GetY2 () const
	Get y-coordinate of end point (linear gradient).
double	GetStartX () const
	Get x-coordinate of center of start circle (radial gradient).
double	GetStartY () const
	Get y-coordinate of center of start circle (radial gradient).
double	GetEndX () const
	Get x-coordinate of center of end circle (radial gradient).
double	GetEndY () const
	Get y-coordinate of center of end circle (radial gradient).
double	GetStartRadius () const
	Get radius of start circle (radial gradient).
double	GetEndRadius () const
	Get radius of end circle (radial gradient).
wxGraphicsGradientStops	GetStops () const
	Get list of gradient stops.
const wxAffineMatrix2D	GetMatrix () const
	Get transformation matrix.

Detailed Description

Class representing patterns.

Constructor & Destructor Documentation

wxPdfPattern() [1/6]

wxPdfPattern::wxPdfPattern	(	int	index,
		double	width,
		double	height )

Constructor for pattern.

Parameters

index	The pattern index
width	The pattern width
height	The pattern height

wxPdfPattern() [2/6]

wxPdfPattern::wxPdfPattern	(	int	index,
		double	width,
		double	height,
		int	templateId )

Constructor for pattern.

Parameters

index	The pattern index
width	The pattern width
height	The pattern height
templateId	The id of the template to be used as a pattern

wxPdfPattern() [3/6]

wxPdfPattern::wxPdfPattern	(	int	index,
		double	width,
		double	height,
		wxPdfPatternStyle	patternStyle,
		const wxColour &	drawColour,
		const wxColour &	fillColour = wxColour() )

Constructor for pattern.

Parameters

index	The pattern index
width	The pattern width
height	The pattern height
patternStyle	The hatch style pattern to be used
drawColour	The foreground colour to be used for hatching
fillColour	The background colour to be used to fill the pattern background (optional)

wxPdfPattern() [4/6]

wxPdfPattern::wxPdfPattern	(	int	index,
		double	x1,
		double	y1,
		double	x2,
		double	y2,
		const wxGraphicsGradientStops &	stops,
		const wxAffineMatrix2D &	matrix )

Constructor for linear gradient pattern.

Parameters

index	The pattern index
x1	x-coordinate of start point
y1	y-coordinate of start point
x2	x-coordinate of end point
y2	y-coordinate of end point
stops	List of gradient stops
matrix	Transformation matrix (optional)

wxPdfPattern() [5/6]

wxPdfPattern::wxPdfPattern	(	int	index,
		double	startX,
		double	startY,
		double	startRadius,
		double	endX,
		double	endY,
		double	endRadius,
		const wxGraphicsGradientStops &	stops,
		const wxAffineMatrix2D &	matrix )

Constructor for radial gradient pattern.

Parameters

index	The pattern index
startX	x-coordinate of start circle
startY	y-coordinate of start circle
startRadius	radius of start circle
endX	x-coordinate of end circle
endY	y-coordinate of end circle
endRadius	radius of end circle
stops	List of gradient stops
matrix	Transformation matrix (optional)

wxPdfPattern() [6/6]

wxPdfPattern::wxPdfPattern

(

const wxPdfPattern &

pattern

)

Copy constructor.

Parameters

pattern

The pattern to copy

Member Function Documentation

GetDrawColour()

wxColour wxPdfPattern::GetDrawColour ( ) const

inline

Get draw color.

Returns

The draw colour

GetEndRadius()

double wxPdfPattern::GetEndRadius ( ) const

inline

Get radius of end circle (radial gradient).

Returns

end Radius

GetEndX()

double wxPdfPattern::GetEndX ( ) const

inline

Get x-coordinate of center of end circle (radial gradient).

Returns

end x-coordinate

GetEndY()

double wxPdfPattern::GetEndY ( ) const

inline

Get y-coordinate of center of end circle (radial gradient).

Returns

end y-coordinate

GetFillColour()

wxColour wxPdfPattern::GetFillColour ( ) const

inline

Get fill color.

Returns

The fill colour

GetHeight()

double wxPdfPattern::GetHeight ( ) const

inline

Get pattern height.

Returns

The pattern height

GetImage()

wxPdfImage * wxPdfPattern::GetImage ( ) const

inline

Get image.

Returns

The image used as a pattern

GetIndex()

int wxPdfPattern::GetIndex ( ) const

inline

Get pattern index.

Returns

The pattern index

GetMatrix()

const wxAffineMatrix2D wxPdfPattern::GetMatrix ( ) const

inline

Get transformation matrix.

Returns

affine transformation matrix

GetObjIndex()

int wxPdfPattern::GetObjIndex ( ) const

inline

Get object index.

Returns

The object index

GetPatternStyle()

wxPdfPatternStyle wxPdfPattern::GetPatternStyle ( ) const

inline

Get pattern style.

Returns

The pattern style

GetStartRadius()

double wxPdfPattern::GetStartRadius ( ) const

inline

Get radius of start circle (radial gradient).

Returns

start radius

GetStartX()

double wxPdfPattern::GetStartX ( ) const

inline

Get x-coordinate of center of start circle (radial gradient).

Returns

start x-coordinate

GetStartY()

double wxPdfPattern::GetStartY ( ) const

inline

Get y-coordinate of center of start circle (radial gradient).

Returns

start y-coordinate

GetStops()

wxGraphicsGradientStops wxPdfPattern::GetStops ( ) const

inline

Get list of gradient stops.

Returns

list of gradient stops

GetTemplateId()

int wxPdfPattern::GetTemplateId ( ) const

inline

Get template id.

Returns

The template ID

GetWidth()

double wxPdfPattern::GetWidth ( ) const

inline

Get pattern width.

Returns

The pattern width

GetX1()

double wxPdfPattern::GetX1 ( ) const

inline

Get x-coordinate of start point (linear gradient).

Returns

x1

GetX2()

double wxPdfPattern::GetX2 ( ) const

inline

Get x-coordinate of end point (linear gradient).

Returns

x2

GetY1()

double wxPdfPattern::GetY1 ( ) const

inline

Get y-coordinate of start point (linear gradient).

Returns

y1

GetY2()

double wxPdfPattern::GetY2 ( ) const

inline

Get y-coordinate of end point (linear gradient).

Returns

y2

HasFillColour()

bool wxPdfPattern::HasFillColour ( ) const

inline

Check whether fill color is set.

Returns

true if the pattern has a fill colour, false otherwise

SetFillColour()

void wxPdfPattern::SetFillColour ( const wxColour & fillColour )

inline

Set fill color.

Parameters

fillColour

The fill colour

SetImage()

void wxPdfPattern::SetImage ( wxPdfImage * image )

inline

Set image.

Parameters

image

The image to use as a pattern

SetObjIndex()

void wxPdfPattern::SetObjIndex ( int index )

inline

Set object index.

Parameters

index

The object index

---

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

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