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

Inheritance diagram for class
UltimateListTextCtrl:
|
|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.