Version: 3.1.4
wxPenInfo Class Reference

#include <wx/pen.h>

Detailed Description

This class is a helper used for wxPen creation using named parameter idiom: it allows specifying various wxPen attributes using the chained calls to its clearly named methods instead of passing them in the fixed order to wxPen constructors.

For instance, to create a dotted blue pen with the given join style you could do

wxPen pen(wxPenInfo(*wxBLUE).Style(wxPENSTYLE_DOT).Join(wxJOIN_BEVEL));
A pen is a drawing tool for drawing outlines.
Definition: pen.h:204
wxPenInfo(const wxColour &colour=wxColour(), int width=1, wxPenStyle style=wxPENSTYLE_SOLID)
@ wxJOIN_BEVEL
Definition: pen.h:82
@ wxPENSTYLE_DOT
Dotted style.
Definition: pen.h:21
Since
3.1.1

Public Member Functions

 wxPenInfo (const wxColour &colour=wxColour(), int width=1, wxPenStyle style=wxPENSTYLE_SOLID)
 
wxPenInfoColour (const wxColour &col)
 
wxPenInfoWidth (int width)
 
wxPenInfoStyle (wxPenStyle style)
 
wxPenInfoStipple (const wxBitmap &stipple)
 
wxPenInfoDashes (int nb_dashes, const wxDash *dash)
 
wxPenInfoJoin (wxPenJoin join)
 
wxPenInfoCap (wxPenCap cap)
 
wxColour GetColour () const
 
wxBitmap GetStipple () const
 
wxPenStyle GetStyle () const
 
wxPenJoin GetJoin () const
 
wxPenCap GetCap () const
 
int GetDashes (wxDash **ptr)
 
int GetDashCount () const
 
wxDash * GetDash () const
 
bool IsTransparent () const
 
int GetWidth () const
 

Constructor & Destructor Documentation

◆ wxPenInfo()

wxPenInfo::wxPenInfo ( const wxColour colour = wxColour(),
int  width = 1,
wxPenStyle  style = wxPENSTYLE_SOLID 
)
explicit

Member Function Documentation

◆ Cap()

wxPenInfo& wxPenInfo::Cap ( wxPenCap  cap)

◆ Colour()

wxPenInfo& wxPenInfo::Colour ( const wxColour col)

◆ Dashes()

wxPenInfo& wxPenInfo::Dashes ( int  nb_dashes,
const wxDash *  dash 
)

◆ GetCap()

wxPenCap wxPenInfo::GetCap ( ) const

◆ GetColour()

wxColour wxPenInfo::GetColour ( ) const

◆ GetDash()

wxDash* wxPenInfo::GetDash ( ) const

◆ GetDashCount()

int wxPenInfo::GetDashCount ( ) const

◆ GetDashes()

int wxPenInfo::GetDashes ( wxDash **  ptr)

◆ GetJoin()

wxPenJoin wxPenInfo::GetJoin ( ) const

◆ GetStipple()

wxBitmap wxPenInfo::GetStipple ( ) const

◆ GetStyle()

wxPenStyle wxPenInfo::GetStyle ( ) const

◆ GetWidth()

int wxPenInfo::GetWidth ( ) const

◆ IsTransparent()

bool wxPenInfo::IsTransparent ( ) const

◆ Join()

wxPenInfo& wxPenInfo::Join ( wxPenJoin  join)

◆ Stipple()

wxPenInfo& wxPenInfo::Stipple ( const wxBitmap stipple)

◆ Style()

wxPenInfo& wxPenInfo::Style ( wxPenStyle  style)

◆ Width()

wxPenInfo& wxPenInfo::Width ( int  width)