.. 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.agw.ultimatelistctrl
.. highlight:: python
.. _wx.lib.agw.ultimatelistctrl.UltimateListTextCtrl:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.ultimatelistctrl.UltimateListTextCtrl**
==========================================================================================================================================
Control used for in-place edit.
This is a subclass of :class:`~wx.lib.expando.ExpandoTextCtrl` as :class:`UltimateListCtrl`
supports multiline text items.
.. note:: To add a newline character in a multiline item, press ``Shift`` + ``Enter``
as the ``Enter`` key alone is consumed by :class:`UltimateListCtrl` to finish
the editing and ``Ctrl`` + ``Enter`` is consumed by the platform for tab navigation.
|
|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>UltimateListTextCtrl</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.agw.ultimatelistctrl.UltimateListTextCtrl_inheritance.png" alt="Inheritance diagram of UltimateListTextCtrl" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.agw.ultimatelistctrl.UltimateListTextCtrl.html" title="Control used for in-place edit." alt="" coords="7,547,339,576"/> <area shape="rect" id="node2" href="wx.lib.expando.ExpandoTextCtrl.html" title="The ExpandoTextCtrl is a multi-line wx.TextCtrl that will" alt="" coords="54,469,293,499"/> <area shape="rect" id="node3" href="wx.TextCtrl.html" title="A text control allows text to be displayed and edited." alt="" coords="124,392,223,421"/> <area shape="rect" id="node4" href="wx.Control.html" title="This is the base class for a control or 'widget'." alt="" coords="64,315,157,344"/> <area shape="rect" id="node5" href="wx.TextEntry.html" title="Common base class for single line text entry fields." alt="" coords="181,315,291,344"/> <area shape="rect" id="node6" href="wx.Window.html" title="wx.Window is the base class for all windows and represents any visible object on screen." alt="" coords="62,237,159,267"/> <area shape="rect" id="node7" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="45,160,176,189"/> <area shape="rect" id="node8" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="51,83,170,112"/> <area shape="rect" id="node9" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,93,35"/> <area shape="rect" id="node10" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="118,5,229,35"/> </map>
</p>
</div>
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.expando.ExpandoTextCtrl`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListTextCtrl.__init__` Default class constructor.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListTextCtrl.AcceptChanges` Accepts/refuses the changes made by the user.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListTextCtrl.Finish` Finish editing.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListTextCtrl.OnChar` Handles the ``wx.EVT_CHAR`` event for :class:`UltimateListTextCtrl`.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListTextCtrl.OnKeyUp` Handles the ``wx.EVT_KEY_UP`` event for :class:`UltimateListTextCtrl`.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListTextCtrl.OnKillFocus` Handles the ``wx.EVT_KILL_FOCUS`` event for :class:`UltimateListTextCtrl`.
:meth:`~wx.lib.agw.ultimatelistctrl.UltimateListTextCtrl.StopEditing` Suddenly stops the editing.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: UltimateListTextCtrl(ExpandoTextCtrl)
Control used for in-place edit.
This is a subclass of :class:`~wx.lib.expando.ExpandoTextCtrl` as :class:`UltimateListCtrl`
supports multiline text items.
.. note:: To add a newline character in a multiline item, press ``Shift`` + ``Enter``
as the ``Enter`` key alone is consumed by :class:`UltimateListCtrl` to finish
the editing and ``Ctrl`` + ``Enter`` is consumed by the platform for tab navigation.
.. method:: __init__(self, owner, itemEdit)
Default class constructor.
For internal use: do not call it in your code!
:param `owner`: the control parent (an instance of :class:`UltimateListCtrl` );
:param `itemEdit`: an instance of :class:`UltimateListItem`.
.. method:: AcceptChanges(self)
Accepts/refuses the changes made by the user.
.. method:: Finish(self)
Finish editing.
.. method:: OnChar(self, event)
Handles the ``wx.EVT_CHAR`` event for :class:`UltimateListTextCtrl`.
:param `event`: a :class:`KeyEvent` event to be processed.
.. method:: OnKeyUp(self, event)
Handles the ``wx.EVT_KEY_UP`` event for :class:`UltimateListTextCtrl`.
:param `event`: a :class:`KeyEvent` event to be processed.
.. method:: OnKillFocus(self, event)
Handles the ``wx.EVT_KILL_FOCUS`` event for :class:`UltimateListTextCtrl`.
:param `event`: a :class:`FocusEvent` event to be processed.
.. method:: StopEditing(self)
Suddenly stops the editing.