wx.dataview.DataViewRenderer

This class is used by wx.dataview.DataViewCtrl to render the individual cells.

One instance of a renderer class is owned by a wx.dataview.DataViewColumn. There is a number of ready-to-use renderers provided:

• wx.dataview.DataViewTextRenderer,

• wx.dataview.DataViewIconTextRenderer,

• wx.dataview.DataViewCheckIconTextRenderer,

• wx.dataview.DataViewToggleRenderer,

• wx.dataview.DataViewProgressRenderer,

• wx.dataview.DataViewBitmapRenderer,

• wx.dataview.DataViewDateRenderer,

• wx.dataview.DataViewSpinRenderer.

• wx.dataview.DataViewChoiceRenderer.

Additionally, the user can write their own renderers by deriving from wx.dataview.DataViewCustomRenderer.

The wx.dataview.DataViewCellMode and wx.dataview.DataViewCellRenderState flags accepted by the constructors respectively controls what actions the cell data allows and how the renderer should display its contents in a cell.

Class Hierarchy

Inheritance diagram for class DataViewRenderer:

Known Subclasses

wx.dataview.DataViewBitmapRenderer, wx.dataview.DataViewCheckIconTextRenderer, wx.dataview.DataViewChoiceRenderer, wx.dataview.DataViewCustomRenderer, wx.dataview.DataViewDateRenderer, wx.dataview.DataViewIconTextRenderer, wx.dataview.DataViewProgressRenderer, wx.dataview.DataViewTextRenderer, wx.dataview.DataViewToggleRenderer

Methods Summary

__init__	Constructor.
CancelEditing
CreateEditorCtrl
DisableEllipsize	Disable replacing parts of the item text with ellipsis.
EnableEllipsize	Enable or disable replacing parts of the item text with ellipsis to make it fit the column width.
FinishEditing
GetAlignment	Returns the alignment.
GetEditorCtrl
GetEllipsizeMode	Returns the ellipsize mode used by the renderer.
GetMode	Returns the cell mode.
GetOwner	Returns pointer to the owning wx.dataview.DataViewColumn.
GetValue	This methods retrieves the value from the renderer in order to transfer the value back to the data model.
GetValueFromEditorCtrl
GetVariantType	Returns a string with the type of the Variant supported by this renderer.
GetView
HasEditorCtrl
IsCompatibleVariantType	Check if the given variant type is compatible with the type expected by this renderer.
SetAlignment	Sets the alignment of the renderer’s content.
SetOwner	Sets the owning wx.dataview.DataViewColumn.
SetValue	Set the value of the renderer (and thus its cell) to value.
SetValueAdjuster	Set the transformer object to be used to customize values before they are rendered.
StartEditing
Validate	Before data is committed to the data model, it is passed to this method where it can be checked for validity.

Properties Summary

Alignment	See GetAlignment and SetAlignment
EditorCtrl	See GetEditorCtrl
EllipsizeMode	See GetEllipsizeMode
Mode	See GetMode
Owner	See GetOwner and SetOwner
VariantType	See GetVariantType
View	See GetView

Class API

class wx.dataview.DataViewRenderer(Object)

Possible constructors:

DataViewRenderer(varianttype, mode=DATAVIEW_CELL_INERT,
                 align=DVR_DEFAULT_ALIGNMENT)

This class is used by DataViewCtrl to render the individual cells.

Methods

__init__(self, varianttype, mode=DATAVIEW_CELL_INERT, align=DVR_DEFAULT_ALIGNMENT)

Constructor.

The varianttype parameter is the main type of Variant objects supported by this renderer, i.e. those that can be passed to its SetValue , e.g. “string” for wx.dataview.DataViewTextRenderer. The value of this parameter is returned by GetVariantType .

When deriving a custom renderer, either an existing variant type or a new custom one can be used, see Variant documentation for more details.

Parameters

• varianttype (string) –

• mode (DataViewCellMode) –

• align (int) –

---

CancelEditing(self)

---

CreateEditorCtrl(self, parent, labelRect, value)

Parameters

• parent (wx.Window) –

• labelRect (wx.Rect) –

• value (DVCVariant) –

Return type

Window

---

DisableEllipsize(self)

Disable replacing parts of the item text with ellipsis.

If ellipsizing is disabled, the string will be truncated if it doesn’t fit.

This is the same as:

EnableEllipsize(wx.ELLIPSIZE_NONE)

New in version 2.9.1.

---

EnableEllipsize(self, mode=ELLIPSIZE_MIDDLE)

Enable or disable replacing parts of the item text with ellipsis to make it fit the column width.

This method only makes sense for the renderers working with text, such as wx.dataview.DataViewTextRenderer or wx.dataview.DataViewIconTextRenderer.

By default wx.ELLIPSIZE_MIDDLE is used.

Parameters

mode (EllipsizeMode) – Ellipsization mode, use wx.ELLIPSIZE_NONE to disable.

New in version 2.9.1.

---

FinishEditing(self)

Return type

bool

---

GetAlignment(self)

Returns the alignment.

See SetAlignment

Return type

int

---

GetEditorCtrl(self)

Return type

Window

---

GetEllipsizeMode(self)

Returns the ellipsize mode used by the renderer.

If the return value is wx.ELLIPSIZE_NONE, the text is simply truncated if it doesn’t fit.

Return type

wx.EllipsizeMode

See also

EnableEllipsize

---

GetMode(self)

Returns the cell mode.

Return type

wx.dataview.DataViewCellMode

---

GetOwner(self)

Returns pointer to the owning wx.dataview.DataViewColumn.

Return type

wx.dataview.DataViewColumn

---

GetValue(self)

This methods retrieves the value from the renderer in order to transfer the value back to the data model.

Returns False on failure.

Return type

value

---

GetValueFromEditorCtrl(self, editor)

Parameters

editor (wx.Window) –

Return type

value

---

GetVariantType(self)

Returns a string with the type of the Variant supported by this renderer.

Note that a renderer may support more than one variant type, in which case it needs to override IsCompatibleVariantType to return True for all types it supports. But by default only the type returned by this function is supported.

Return type

string

---

GetView(self)

Return type

wx.dataview.DataViewCtrl

---

HasEditorCtrl(self)

Return type

bool

---

IsCompatibleVariantType(self, variantType)

Check if the given variant type is compatible with the type expected by this renderer.

The base class implementation just compares variantType with the value returned by GetVariantType , but this function can be overridden to accept other types that can be converted to the type needed by the renderer.

Parameters

variantType (string) –

Return type

bool

New in version 4.1/wxWidgets-3.1.7.

---

SetAlignment(self, align)

Sets the alignment of the renderer’s content.

The default value of DVR_DEFAULT_ALIGNMENT indicates that the content should have the same alignment as the column header.

The method is not implemented under macOS and the renderer always aligns its contents as the column header on that platform. The other platforms support both vertical and horizontal alignment.

Parameters

align (int) –

---

SetOwner(self, owner)

Sets the owning wx.dataview.DataViewColumn.

This is usually called from within wx.dataview.DataViewColumn.

Parameters

owner (wx.dataview.DataViewColumn) –

---

SetValue(self, value)

Set the value of the renderer (and thus its cell) to value.

The internal code will then render this cell with this data.

Parameters

value (DVCVariant) – A valid, i.e. non-null, value to be shown.

Return type

bool

---

SetValueAdjuster(self, transformer)

Set the transformer object to be used to customize values before they are rendered.

Can be used to change the value if it is shown on a highlighted row (i.e. in selection) which typically has dark background. It is useful in combination with wx.dataview.DataViewTextRenderer with markup and can be used e.g. to remove background color attributes inside selection, as a lightweight alternative to implementing an entire wx.dataview.DataViewCustomRenderer specialization.

transformer can be None to reset any transformer currently being used.

Takes ownership of transformer.

Parameters

transformer (wx.dataview.DataViewValueAdjuster) –

New in version 4.1/wxWidgets-3.1.1.

See also

wx.dataview.DataViewValueAdjuster

---

StartEditing(self, item, labelRect)

Parameters

• item (wx.dataview.DataViewItem) –

• labelRect (wx.Rect) –

Return type

bool

---

Validate(self, value)

Before data is committed to the data model, it is passed to this method where it can be checked for validity.

This can also be used for checking a valid range or limiting the user input in a certain aspect (e.g. max number of characters or only alphanumeric input, ASCII only etc.). Return False if the value is not valid.

Please note that due to implementation limitations, this validation is done after the editing control already is destroyed and the editing process finished.

Parameters

value (DVCVariant) –

Return type

bool

Properties

Alignment

See GetAlignment and SetAlignment

---

EditorCtrl

See GetEditorCtrl

---

EllipsizeMode

See GetEllipsizeMode

---

Mode

See GetMode

---

Owner

See GetOwner and SetOwner

---

VariantType

See GetVariantType

---

View

See GetView