Phoenix Logo

phoenix_title wx.lib.mixins.listctrl.ListRowHighlighter

Editra Control Library: ListRowHighlighter Mixin class that handles automatic background highlighting of alternate rows in the a ListCtrl. The background of the rows are highlighted automatically as items are added or inserted in the control based on the mixins Mode and set Color. By default the Even rows will be highlighted with the systems highlight color.


class_hierarchy Class Hierarchy

Inheritance diagram for class ListRowHighlighter:

method_summary Methods Summary

__init__ Initialize the highlighter mixin
RefreshRows Re-color all the rows
SetHighlightColor Set the color used to highlight the rows. Call RefreshRows after
SetHighlightMode Set the highlighting mode to either HIGHLIGHT_EVEN or to

api Class API



class ListRowHighlighter

Editra Control Library: ListRowHighlighter Mixin class that handles automatic background highlighting of alternate rows in the a ListCtrl. The background of the rows are highlighted automatically as items are added or inserted in the control based on the mixins Mode and set Color. By default the Even rows will be highlighted with the systems highlight color.


Methods



__init__(self, color=None, mode=HIGHLIGHT_EVEN)

Initialize the highlighter mixin

Parameters:
  • color – Set a custom highlight color (default uses system color)
  • mode – HIGHLIGHT_EVEN (default) or HIGHLIGHT_ODD


RefreshRows(self)

Re-color all the rows



SetHighlightColor(self, color)

Set the color used to highlight the rows. Call RefreshRows after this if you wish to update all the rows highlight colors.

Parameters:color – wx.Color or None to set default


SetHighlightMode(self, mode)

Set the highlighting mode to either HIGHLIGHT_EVEN or to HIGHLIGHT_ODD. Call RefreshRows afterwards to update the list state.

Parameters:mode – HIGHLIGHT_* mode value