wxPen

Implements methods from the following classes

• wxGDIObject

Methods

• wxPen
  Default constructor.
• GetCap
  Returns the pen cap style, which may be one of wxCAP_ROUND, wxCAP_PROJECTING and wxCAP_BUTT.
• GetColour
  Returns a reference to the pen colour.
• GetJoin
  Returns the pen join style, which may be one of wxJOIN_BEVEL, wxJOIN_ROUND and wxJOIN_MITER.
• GetStipple
  Gets a pointer to the stipple bitmap.
• GetStyle
  Returns the pen style.
• GetWidth
  Returns the pen width.
• IsNonTransparent
  Returns true if the pen is a valid non-transparent pen.
• IsOk
  Returns true if the pen is initialised.
• IsTransparent
  Returns true if the pen is transparent.
• SetCap
  Sets the pen cap style, which may be one of wxCAP_ROUND, wxCAP_PROJECTING and wxCAP_BUTT.
• SetColour
  The pen's colour is changed to the given colour.
• SetJoin
  Sets the pen join style, which may be one of wxJOIN_BEVEL, wxJOIN_ROUND and wxJOIN_MITER.
• SetStipple
  Sets the bitmap for stippling.
• SetStyle
  Set the pen style.
• SetWidth
  Sets the pen width.

Static Methods

wxPen

wxPen ( )

Default constructor.
wxPen ( wxColour $colour, integer $width=1, wxPenStyle $style=wxPENSTYLE_SOLID )

Constructs a pen from a colour object, pen width and style.

GetCap

wxPenCap GetCap ( )

Returns the pen cap style, which may be one of wxCAP_ROUND, wxCAP_PROJECTING and wxCAP_BUTT.

GetColour

wxColour GetColour ( )

Returns a reference to the pen colour.

GetJoin

wxPenJoin GetJoin ( )

Returns the pen join style, which may be one of wxJOIN_BEVEL, wxJOIN_ROUND and wxJOIN_MITER.

GetStipple

wxBitmap& GetStipple ( )

Gets a pointer to the stipple bitmap.

GetStyle

wxPenStyle GetStyle ( )

Returns the pen style.

GetWidth

integer GetWidth ( )

Returns the pen width.

IsNonTransparent

bool IsNonTransparent ( )

Returns true if the pen is a valid non-transparent pen.

IsOk

bool IsOk ( )

Returns true if the pen is initialised.

IsTransparent

bool IsTransparent ( )

Returns true if the pen is transparent.

SetCap

SetCap ( wxPenCap $capStyle )

Sets the pen cap style, which may be one of wxCAP_ROUND, wxCAP_PROJECTING and wxCAP_BUTT.

SetColour

SetColour ( wxColour &$colour )

The pen's colour is changed to the given colour.
SetColour ( integer $red, integer $green, integer $blue )

The pen's colour is changed to the given colour.

SetJoin

SetJoin ( wxPenJoin $join_style )

Sets the pen join style, which may be one of wxJOIN_BEVEL, wxJOIN_ROUND and wxJOIN_MITER.

SetStipple

SetStipple ( wxBitmap $stipple )

Sets the bitmap for stippling.

SetStyle

SetStyle ( wxPenStyle $style )

Set the pen style.

SetWidth

SetWidth ( integer $width )

Sets the pen width.