wxPdfDocument 1.2.0
Public Member Functions | List of all members
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 (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.
 
wxPdfImageGetImage () 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.
 

Detailed Description

Class representing patterns.

Constructor & Destructor Documentation

◆ wxPdfPattern() [1/4]

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

Constructor for pattern.

Parameters
indexThe pattern index
widthThe pattern width
heightThe pattern height

◆ wxPdfPattern() [2/4]

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

Constructor for pattern.

Parameters
indexThe pattern index
widthThe pattern width
heightThe pattern height
templateIdThe id of the template to be used as a pattern

◆ wxPdfPattern() [3/4]

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

Constructor for pattern.

Parameters
indexThe pattern index
widthThe pattern width
heightThe pattern height
patternStyleThe hatch style pattern to be used
drawColourThe foreground colour to be used for hatching
fillColourThe background colour to be used to fill the pattern background (optional)

◆ wxPdfPattern() [4/4]

wxPdfPattern::wxPdfPattern ( const wxPdfPattern & pattern)

Copy constructor.

Member Function Documentation

◆ GetDrawColour()

wxColour wxPdfPattern::GetDrawColour ( ) const
inline

Get draw color.

◆ GetFillColour()

wxColour wxPdfPattern::GetFillColour ( ) const
inline

Get fill color.

◆ GetHeight()

double wxPdfPattern::GetHeight ( ) const
inline

Get pattern height.

◆ GetImage()

wxPdfImage * wxPdfPattern::GetImage ( ) const
inline

Get image.

◆ GetIndex()

int wxPdfPattern::GetIndex ( ) const
inline

Get pattern index.

◆ GetObjIndex()

int wxPdfPattern::GetObjIndex ( ) const
inline

Get object index.

◆ GetPatternStyle()

wxPdfPatternStyle wxPdfPattern::GetPatternStyle ( ) const
inline

Get pattern style.

◆ GetTemplateId()

int wxPdfPattern::GetTemplateId ( ) const
inline

Get template id.

◆ GetWidth()

double wxPdfPattern::GetWidth ( ) const
inline

Get pattern width.

◆ HasFillColour()

bool wxPdfPattern::HasFillColour ( ) const
inline

Check whether fill color is set.

◆ SetFillColour()

void wxPdfPattern::SetFillColour ( const wxColour & fillColour)
inline

Set fill color.

◆ SetImage()

void wxPdfPattern::SetImage ( wxPdfImage * image)
inline

Set image.

◆ SetObjIndex()

void wxPdfPattern::SetObjIndex ( int index)
inline

Set object index.


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