wx.propgrid.PGCellRenderer

Base class for wx.propgrid.PropertyGrid cell renderers.

Class Hierarchy

Inheritance diagram for class PGCellRenderer:

Known Subclasses

wx.propgrid.PGDefaultRenderer

Methods Summary

__init__
DrawCaptionSelectionRect	Paints property category selection rectangle.
DrawEditorValue	Utility to draw editor’s value, or vertically aligned text if editor is None.
DrawText	Utility to draw vertically centered text.
GetImageSize	Returns size of the image in front of the editable area.
PostDrawCell	Utility to be called after drawing is done, to revert whatever changes PreDrawCell did.
PreDrawCell	Utility to render cell bitmap and set text colour plus bg brush colour.
Render	Returns True if rendered something in the foreground (text or bitmap).

Class API

class wx.propgrid.PGCellRenderer(RefCounter)

Possible constructors:

PGCellRenderer() -> None

Base class for PropertyGrid cell renderers.

Methods

__init__(self)

Return type:

None

---

DrawCaptionSelectionRect(self, dc : DC, x : int, y : int, w : int, h : int)

Paints property category selection rectangle.

Parameters:

• dc (wx.DC) –

• x (int) –

• y (int) –

• w (int) –

• h (int) –

Return type:

None

---

DrawEditorValue(self, dc : DC, rect : Rect, xOffset : int, text : str, property : PGProperty, editor : PGEditor)

Utility to draw editor’s value, or vertically aligned text if editor is None.

Parameters:

• dc (wx.DC) –

• rect (wx.Rect) –

• xOffset (int) –

• text (string) –

• property (wx.propgrid.PGProperty) –

• editor (wx.propgrid.PGEditor) –

Return type:

None

---

DrawText(self, dc : DC, rect : Rect, imageWidth : int, text : str)

Utility to draw vertically centered text.

Parameters:

• dc (wx.DC) –

• rect (wx.Rect) –

• imageWidth (int) –

• text (string) –

Return type:

None

---

GetImageSize(self, property : PGProperty, column : int, item : int)

Returns size of the image in front of the editable area.

Parameters:

• property (wx.propgrid.PGProperty) –

• column (int) –

• item (int) –

Return type:

Size

Note

If property is None, then this call is for a custom value. In that case the item is index to wx.propgrid.PropertyGrid’s custom values.

---

PostDrawCell(self, dc : DC, propGrid : PropertyGrid, cell : PGCell, flags : int)

Utility to be called after drawing is done, to revert whatever changes PreDrawCell did.

Parameters:

• dc (wx.DC) – wx.DC which was used to paint on.

• propGrid (wx.propgrid.PropertyGrid) – Property grid to which the cell belongs.

• cell (wx.propgrid.PGCell) – Cell information.

• flags (int) – Same as those passed to PreDrawCell . See list of render flags.

Return type:

None

---

PreDrawCell(self, dc : DC, rect : Rect, propGrid : PropertyGrid, cell : PGCell, flags : int)

Utility to render cell bitmap and set text colour plus bg brush colour.

Parameters:

• dc (wx.DC) – wx.DC to paint on.

• rect (wx.Rect) – Box reserved for drawing.

• propGrid (wx.propgrid.PropertyGrid) – Property grid to which the cell belongs.

• cell (wx.propgrid.PGCell) – Cell information.

• flags (int) – See list of render flags.

Return type:

int

Returns:

Returns image width, which, for instance, can be passed to DrawText .

---

Render(self, dc : DC, rect : Rect, propertyGrid : PropertyGrid, property : PGProperty, column : int, item : int, flags : int)

Returns True if rendered something in the foreground (text or bitmap).

Parameters:

• dc (wx.DC) – wx.DC to paint on.

• rect (wx.Rect) – Box reserved for drawing.

• propertyGrid (wx.propgrid.PropertyGrid) – Property grid in which property is displayed.

• property (wx.propgrid.PGProperty) – Property to be rendered.

• column (int) – Property cell column.

• item (int) – Index of chosen item if combo popup is drawn, -1 otherwise.

• flags (int) – See list of render flags.

Return type:

bool