.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.mixins.listctrl
.. highlight:: python
.. _wx.lib.mixins.listctrl.ListRowHighlighter:
==========================================================================================================================================
|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
=================================
.. raw:: html

Inheritance diagram for class
ListRowHighlighter:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.mixins.listctrl.ListRowHighlighter.__init__` Initialize the highlighter mixin
:meth:`~wx.lib.mixins.listctrl.ListRowHighlighter.RefreshRows` Re-color all the rows
:meth:`~wx.lib.mixins.listctrl.ListRowHighlighter.SetHighlightColor` Set the color used to highlight the rows. Call :meth:`~wx.lib.mixins.listctrl.ListRowHighlighter.RefreshRows` after
:meth:`~wx.lib.mixins.listctrl.ListRowHighlighter.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.
.. method:: __init__(self, color=None, mode=HIGHLIGHT_EVEN)
Initialize the highlighter mixin
:keyword color: Set a custom highlight color (default uses system color)
:keyword mode: HIGHLIGHT_EVEN (default) or HIGHLIGHT_ODD
.. method:: RefreshRows(self)
Re-color all the rows
.. method:: SetHighlightColor(self, color)
Set the color used to highlight the rows. Call :meth:`RefreshRows` after
this if you wish to update all the rows highlight colors.
:param color: wx.Color or None to set default
.. method:: SetHighlightMode(self, mode)
Set the highlighting mode to either HIGHLIGHT_EVEN or to
HIGHLIGHT_ODD. Call :meth:`RefreshRows` afterwards to update the list
state.
:param mode: HIGHLIGHT_* mode value