.. include:: headings.inc

.. currentmodule:: lib.agw.customtreectrl

.. highlight:: python



.. _lib.agw.customtreectrl.TreeTextCtrl:

==========================================================================================================================================
|phoenix_title|  **TreeTextCtrl**
==========================================================================================================================================

Control used for in-place edit.

This is a subclass of :class:`lib.expando.ExpandoTextCtrl` as :class:`CustomTreeCtrl` 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:`CustomTreeCtrl` to finish the editing and ``Ctrl`` + ``Enter`` is
 consumed by the platform for tab navigation.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **TreeTextCtrl**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.agw.customtreectrl.TreeTextCtrl_inheritance.png" alt="Inheritance diagram of TreeTextCtrl" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="629,6,704,37"/> <area shape="rect" id="node2" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="472,5,552,35"/> <area shape="rect" id="node4" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="303,6,401,37"/> <area shape="rect" id="node6" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="153,6,225,37"/> <area shape="rect" id="node8" href="lib.agw.customtreectrl.TreeTextCtrl.html" title="Control used for in-place edit." alt="" coords="1301,58,1517,89"/> <area shape="rect" id="node9" href="lib.expando.ExpandoTextCtrl.html" title="The ExpandoTextCtrl is a multi-line wx.TextCtrl that will" alt="" coords="1048,58,1253,89"/> <area shape="rect" id="node14" href="TextEntry.html" title="Common base class for single line text entry fields." alt="" coords="621,110,712,141"/> <area shape="rect" id="node19" href="TextCtrl.html" title="A text control allows text to be displayed and edited." alt="" coords="924,58,999,89"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`lib.expando.ExpandoTextCtrl`

|


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

================================================================================ ================================================================================
:meth:`~lib.agw.customtreectrl.TreeTextCtrl.__init__`                            Default class constructor.
:meth:`~lib.agw.customtreectrl.TreeTextCtrl.AcceptChanges`                       Accepts/rejects the changes made by the user.
:meth:`~lib.agw.customtreectrl.TreeTextCtrl.Finish`                              Finish editing.
:meth:`~lib.agw.customtreectrl.TreeTextCtrl.item`                                Returns the item currently edited.
:meth:`~lib.agw.customtreectrl.TreeTextCtrl.OnChar`                              Handles the ``EVT_CHAR``    event for :class:`TreeTextCtrl`.
:meth:`~lib.agw.customtreectrl.TreeTextCtrl.OnKeyUp`                             Handles the ``EVT_KEY_UP``    event for :class:`TreeTextCtrl`.
:meth:`~lib.agw.customtreectrl.TreeTextCtrl.OnKillFocus`                         Handles the ``EVT_KILL_FOCUS``    event for :class:`TreeTextCtrl`.
:meth:`~lib.agw.customtreectrl.TreeTextCtrl.StopEditing`                         Suddenly stops the editing.
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: TreeTextCtrl(ExpandoTextCtrl)

   Control used for in-place edit.
   
   This is a subclass of :class:`lib.expando.ExpandoTextCtrl` as :class:`CustomTreeCtrl` 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:`CustomTreeCtrl` to finish the editing and ``Ctrl`` + ``Enter`` is
    consumed by the platform for tab navigation.

   .. method:: __init__(self, owner, item=None)

      Default class constructor.
      For internal use: do not call it in your code!
      
      :param `owner`: the control parent (an instance of :class:`CustomTreeCtrl`);
      :param `item`: an instance of :class:`GenericTreeItem`.
      
      :raise: `Exception` when the item has an associated image but the parent
       :class:`CustomTreeCtrl` does not have a :class:`ImageList` assigned.


   .. method:: AcceptChanges(self)

      Accepts/rejects the changes made by the user.
      
      :return: ``True`` if the changes to the item text have been accepted, ``False``
       if they have been rejected (i.e., vetoed by the user).


   .. method:: Finish(self)

      Finish editing. 


   .. method:: item(self)

      Returns the item currently edited.
      
      :return: An instance of :class:`GenericTreeItem`.


   .. method:: OnChar(self, event)

      Handles the ``EVT_CHAR``    event for :class:`TreeTextCtrl`.
      
      :param `event`: a :class:`KeyEvent` event to be processed.


   .. method:: OnKeyUp(self, event)

      Handles the ``EVT_KEY_UP``    event for :class:`TreeTextCtrl`.
      
      :param `event`: a :class:`KeyEvent` event to be processed.


   .. method:: OnKillFocus(self, event)

      Handles the ``EVT_KILL_FOCUS``    event for :class:`TreeTextCtrl`.
      
      :param `event`: a :class:`FocusEvent` event to be processed.


   .. method:: StopEditing(self)

      Suddenly stops the editing.