wx.PenInfo

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

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

pen = wx.Pen(wx.PenInfo(wx.BLUE).Style(wx.PENSTYLE_DOT).Join(wx.JOIN_BEVEL))

Added in version 4.1/wxWidgets-3.1.1.

Class Hierarchy

Inheritance diagram for class PenInfo:

Methods Summary

__init__
Cap
Colour
GetCap
GetColour
GetJoin
GetQuality
GetStipple
GetStyle
GetWidth
HighQuality	Set high pen quality.
IsTransparent
Join
LowQuality	Set low pen quality.
Quality	Set the pen quality.
Stipple
Style
Width

Class API

class wx.PenInfo(object)

Possible constructors:

PenInfo(colour=Colour(), width=1, style=PENSTYLE_SOLID) -> None

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

Methods

__init__(self, colour=Colour(), width=1, style=PENSTYLE_SOLID)

Parameters:

• colour (wx.Colour)

• width (int)

• style (PenStyle)

Return type:

None

---

Cap(self, cap)

Parameters:

cap (PenCap)

Return type:

wx.PenInfo

---

Colour(self, col)

Parameters:

col (wx.Colour)

Return type:

wx.PenInfo

---

GetCap(self)

Return type:

wx.PenCap

---

GetColour(self)

Return type:

wx.Colour

---

GetJoin(self)

Return type:

wx.PenJoin

---

GetQuality(self)

Return type:

wx.PenQuality

---

GetStipple(self)

Return type:

wx.Bitmap

---

GetStyle(self)

Return type:

wx.PenStyle

---

GetWidth(self)

Return type:

int

---

HighQuality(self)

Set high pen quality.

This is the same as calling Quality with PEN_QUALITY_HIGH.

Return type:

wx.PenInfo

Added in version 4.1/wxWidgets-3.1.5.

---

IsTransparent(self)

Return type:

bool

---

Join(self, join)

Parameters:

join (PenJoin)

Return type:

wx.PenInfo

---

LowQuality(self)

Set low pen quality.

This is the same as calling Quality with PEN_QUALITY_LOW.

Return type:

wx.PenInfo

Added in version 4.1/wxWidgets-3.1.5.

---

Quality(self, quality)

Set the pen quality.

Using LowQuality or HighQuality is usually more convenient.

Parameters:

quality (PenQuality)

Return type:

wx.PenInfo

Added in version 4.1/wxWidgets-3.1.5.

See also

wx.Pen.SetQuality

---

Stipple(self, stipple)

Parameters:

stipple (wx.Bitmap)

Return type:

wx.PenInfo

---

Style(self, style)

Parameters:

style (PenStyle)

Return type:

wx.PenInfo

---

Width(self, width)

Parameters:

width (int)

Return type:

wx.PenInfo