File: wx.lib.mixins.listctrl.TextEditMixin.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (138 lines) | stat: -rw-r--r-- 5,085 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.mixins.listctrl

.. highlight:: python



.. _wx.lib.mixins.listctrl.TextEditMixin:

==========================================================================================================================================
|phoenix_title|  **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| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>TextEditMixin</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.mixins.listctrl.TextEditMixin_inheritance.png" alt="Inheritance diagram of TextEditMixin" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.mixins.listctrl.TextEditMixin.html" title="wx.lib.mixins.listctrl.TextEditMixin" alt="" coords="5,5,232,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.mixins.listctrl.TextEditMixin.__init__`                           
:meth:`~wx.lib.mixins.listctrl.TextEditMixin.CloseEditor`                        Close the editor and save the new value to the ListCtrl.
:meth:`~wx.lib.mixins.listctrl.TextEditMixin.make_editor`                        
:meth:`~wx.lib.mixins.listctrl.TextEditMixin.OnChar`                             Catch the TAB, Shift-TAB, cursor DOWN/UP key code
:meth:`~wx.lib.mixins.listctrl.TextEditMixin.OnItemSelected`                     
:meth:`~wx.lib.mixins.listctrl.TextEditMixin.OnLeftDown`                         Examine the click and double
:meth:`~wx.lib.mixins.listctrl.TextEditMixin.OpenEditor`                         Opens an editor at the current position.
================================================================================ ================================================================================


|


|api| 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)

   .. method:: __init__(self)


   .. method:: CloseEditor(self, evt=None)

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


   .. method:: make_editor(self, col_style=wx.LIST_FORMAT_LEFT)


   .. method:: 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).


   .. method:: OnItemSelected(self, evt)


   .. method:: 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.


   .. method:: OpenEditor(self, col, row)

      Opens an editor at the current position.