wx.lib.mixins.listctrl.TextEditMixin

A mixin class that enables any text in any column of a multi-column listctrl to be edited by clicking on the given row and column. You close the text editor by hitting the ENTER key or clicking somewhere else on the listctrl. You switch to the next column by hiting TAB.

To use the mixin you have to include it in the class definition and call the __init__ function:

class TestListCtrl(wx.ListCtrl, TextEditMixin):
    def __init__(self, parent, ID, pos=wx.DefaultPosition,
                 size=wx.DefaultSize, style=0):
        wx.ListCtrl.__init__(self, parent, ID, pos, size, style)
        TextEditMixin.__init__(self)

Authors: Steve Zatz, Pim Van Heuven (pim@think-wize.com)

Class Hierarchy

Inheritance diagram for class TextEditMixin:

Methods Summary

__init__	Initialize self. See help(type(self)) for accurate signature.
CloseEditor	Close the editor and save the new value to the ListCtrl.
make_editor
OnChar	Catch the TAB, Shift-TAB, cursor DOWN/UP key code
OnItemSelected
OnLeftDown	Examine the click and double
OpenEditor	Opens an editor at the current position.

Class API

class TextEditMixin

A mixin class that enables any text in any column of a multi-column listctrl to be edited by clicking on the given row and column. You close the text editor by hitting the ENTER key or clicking somewhere else on the listctrl. You switch to the next column by hiting TAB.

To use the mixin you have to include it in the class definition and call the __init__ function:

class TestListCtrl(wx.ListCtrl, TextEditMixin):
    def __init__(self, parent, ID, pos=wx.DefaultPosition,
                 size=wx.DefaultSize, style=0):
        wx.ListCtrl.__init__(self, parent, ID, pos, size, style)
        TextEditMixin.__init__(self)

Authors: Steve Zatz, Pim Van Heuven (pim@think-wize.com)

Methods

__init__(self)

Initialize self. See help(type(self)) for accurate signature.

---

CloseEditor(self, evt=None)

Close the editor and save the new value to the ListCtrl.

---

make_editor(self, col_style=wx.LIST_FORMAT_LEFT)

---

OnChar(self, event)

Catch the TAB, Shift-TAB, cursor DOWN/UP key code so we can open the editor at the next column (if any).

---

OnItemSelected(self, evt)

---

OnLeftDown(self, evt=None)

Examine the click and double click events to see if a row has been click on twice. If so, determine the current row and columnn and open the editor.

---

OpenEditor(self, col, row)

Opens an editor at the current position.