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 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
|
.. 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
.. _wx.grid.GridCellTextEditor:
==========================================================================================================================================
|phoenix_title| **wx.grid.GridCellTextEditor**
==========================================================================================================================================
Grid cell editor for string/text data.
.. seealso:: :ref:`wx.grid.GridCellEditor`, :ref:`wx.grid.GridCellAutoWrapStringEditor`, :ref:`wx.grid.GridCellBoolEditor`, :ref:`wx.grid.GridCellChoiceEditor`, :ref:`wx.grid.GridCellEnumEditor`, :ref:`wx.grid.GridCellFloatEditor`, :ref:`wx.grid.GridCellNumberEditor`
|
|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>GridCellTextEditor</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.grid.GridCellTextEditor_inheritance.png" alt="Inheritance diagram of GridCellTextEditor" 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.ClientDataContainer.html" title="wx.ClientDataContainer" alt="" coords="5,5,176,35"/> <area shape="rect" id="node3" href="wx.grid.GridCellEditor.html" title="wx.grid.GridCellEditor" alt="" coords="95,83,251,112"/> <area shape="rect" id="node2" href="wx.RefCounter.html" title="wx.RefCounter" alt="" coords="200,5,311,35"/> <area shape="rect" id="node4" href="wx.grid.GridCellTextEditor.html" title="wx.grid.GridCellTextEditor" alt="" coords="83,160,264,189"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.grid.GridCellAutoWrapStringEditor`, :ref:`wx.grid.GridCellFloatEditor`, :ref:`wx.grid.GridCellNumberEditor`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.grid.GridCellTextEditor.__init__` Text cell editor constructor.
:meth:`~wx.grid.GridCellTextEditor.EndEdit` End editing the cell.
:meth:`~wx.grid.GridCellTextEditor.SetParameters` The parameters string format is "n" where n is a number representing the maximum width.
:meth:`~wx.grid.GridCellTextEditor.SetValidator` Set validator to validate user input.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.grid.GridCellTextEditor(GridCellEditor)
**Possible constructors**::
GridCellTextEditor(maxChars=0)
Grid cell editor for string/text data.
.. method:: __init__(self, maxChars=0)
Text cell editor constructor.
:param `maxChars`: Maximum width of text (this parameter is supported starting since wxWidgets 2.9.5).
:type `maxChars`: int
.. method:: EndEdit(self, row, col, grid, oldval)
End editing the cell.
This function must check if the current value of the editing cell
is valid and different from the original value in its string
form. If not then simply return None. If it has changed then
this method should save the new value so that ApplyEdit can
apply it later and the string representation of the new value
should be returned.
Notice that this method shoiuld not modify the grid as the
change could still be vetoed.
.. method:: SetParameters(self, params)
The parameters string format is "n" where n is a number representing the maximum width.
:param `params`:
:type `params`: string
.. method:: SetValidator(self, validator)
Set validator to validate user input.
:param `validator`:
:type `validator`: wx.Validator
.. versionadded:: 2.9.5
|