Inheritance diagram for wx.RendererNative:
First, a brief introduction to wx.Renderer and why it is needed.
Usually wxWidgets uses the underlying low level GUI system to draw all the controls – this is what we mean when we say that it is a “native” framework. However not all controls exist under all (or even any) platforms and in this case wxWidgets provides a default, generic, implementation of them written in wxWidgets itself.
These controls don’t have the native appearance if only the standard line drawing and other graphics primitives are used, because the native appearance is different under different platforms while the lines are always drawn in the same way.
This is why we have renderers: wx.Renderer is a class which virtualizes the drawing, i.e. it abstracts the drawing operations and allows you to draw say, a button, without caring about exactly how this is done. Of course, as we can draw the button differently in different renderers, this also allows us to emulate the native look and feel.
So the renderers work by exposing a large set of high-level drawing functions which are used by the generic controls. There is always a default global renderer but it may be changed or extended by the user.
All drawing functions take some standard parameters:
The following rendering flags are defined:
| Renderering Flags | Description |
|---|---|
| wx.CONTROL_DISABLED | 0x00000001, control is disabled |
| wx.CONTROL_FOCUSED | 0x00000002, currently has keyboard focus |
| wx.CONTROL_PRESSED | 0x00000004, (button) is pressed |
| wx.CONTROL_ISDEFAULT | 0x00000008, only applies to the buttons |
| wx.CONTROL_ISSUBMENU | wx.CONTROL_ISDEFAULT, only for menu items |
| wx.CONTROL_EXPANDED | wx.CONTROL_ISDEFAULT, only for the tree items |
| wx.CONTROL_CURRENT | 0x00000010, mouse is currently over the control |
| wx.CONTROL_SELECTED | 0x00000020, selected item in e.g. listbox |
| wx.CONTROL_CHECKED | 0x00000040, (check/radio button) is checked |
| wx.CONTROL_CHECKABLE | 0x00000080, (menu) item can be checked |
| wx.CONTROL_UNDETERMINED | wx.CONTROL_CHECKABLE (check) undetermined state |
Note
Note that each drawing function restores the wx.DC attributes if it changes them, so it is safe to assume that the same pen, brush and colours that were active before the call to this function are still in effect after it.
Draw a check box (used by wx.DataViewCtrl).
Parameters:
Draw a choice box.
Parameters:
Draw a combo box.
Parameters:
Draw a button like the one used by wx.ComboBox to show a drop down window. The usual appearance is a downwards pointing arrow.
Parameters:
Draw a drop down arrow that is suitable for use outside a combo box. Arrow will have transparent background.
rect is not entirely filled by the arrow. Instead, you should use bounding rectangle of a drop down button which arrow matches the size you need.
Parameters:
Draw the header control button (used, for example, by wx.ListCtrl).
Depending on platforms the flags parameter may support the wx.CONTROL_SELECTED wx.CONTROL_DISABLED and wx.CONTROL_CURRENT bits.
The sortArrow parameter can be one of wx.HDR_SORT_ICON_NONE, wx.HDR_SORT_ICON_UP, or wx.HDR_SORT_ICON_DOWN. Additional values controlling the drawing of a text or bitmap label can be passed in params.
The value returned is the optimal width to contain the the unabreviated label text or bitmap, the sort arrow if present, and internal margins.
Parameters:
Returns:
int
Draw the contents of a header control button, (label, sort arrows, etc...).
Normally this is only called by DrawHeaderButton.
Parameters:
Returns:
int
Draw a selection rectangle underneath the text as used e.g. in a wx.ListCtrl.
Parameters:
Draw a blank push button that looks very similar to wx.Button.
Parameters:
Draw a radio button.
Parameters:
Draw the border for sash window: this border must be such that the sash drawn by DrawSash blends into it well.
Parameters:
Draw a sash. The orient parameter defines whether the sash should be vertical or horizontal and how the position should be interpreted.
Parameters:
Draw a text control.
Parameters:
Draw the expanded/collapsed icon for a tree control item. To draw an expanded button the flags parameter must contain wx.CONTROL_EXPANDED bit.
Parameters:
Return the currently used renderer.
Returns:
Return the default (native) implementation for this platform – this is also the one used by default but this may be changed by calling Set in which case the return value of this method may be different from the return value of Get.
Returns:
Return the generic implementation of the renderer. Under some platforms, this is the default renderer implementation, others have platform-specific default renderer which can be retrieved by calling GetDefault.
Returns:
Returns the height of a header button, either a fixed platform height if available, or a generic height based on the window’s font.
Parameters:
Returns:
int
See also
This function is used for version checking.
The implementation of this method is always the same in all renderers (simply construct wx.RendererVersion using the wx.RendererVersion.Current_XXX values), but it has to be in the derived, not base, class, to detect mismatches between the renderers versions and so you have to implement it anew in all renderers.
Returns:
Set the renderer to use, passing None reverts to using the default renderer (the global renderer must always exist).
Return the previous renderer used with Set() or None if none.
Parameters:
Returns:
