.. include:: headings.inc

.. currentmodule:: lib.expando

.. highlight:: python



.. _lib.expando.ExpandoTextCtrl:

==========================================================================================================================================
|phoenix_title|  **ExpandoTextCtrl**
==========================================================================================================================================

The ExpandoTextCtrl is a multi-line wx.TextCtrl that will
adjust its height on the fly as needed to accomodate the number of
lines needed to display the current content of the control.  It is
assumed that the width of the control will be a fixed value and
that only the height will be adjusted automatically.  If the
control is used in a sizer then the width should be set as part of
the initial or min size of the control.

When the control resizes itself it will attempt to also make
necessary adjustments in the sizer hierarchy it is a member of (if
any) but if that is not suffiecient then the programmer can catch
the EVT_ETC_LAYOUT_NEEDED event in the container and make any
other layout adjustments that may be needed.



|

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

Inheritance diagram for class **ExpandoTextCtrl**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.expando.ExpandoTextCtrl_inheritance.png" alt="Inheritance diagram of ExpandoTextCtrl" 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.expando.ExpandoTextCtrl.html" title="The ExpandoTextCtrl is a multi-line wx.TextCtrl that will" alt="" coords="1048,58,1253,89"/> <area shape="rect" id="node9" href="TextCtrl.html" title="A text control allows text to be displayed and edited." alt="" coords="924,58,999,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"/> </map> 
   </p>

|


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

:class:`TextCtrl`

|


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

================================================================================ ================================================================================
:meth:`~lib.expando.ExpandoTextCtrl.__init__`                                    
:meth:`~lib.expando.ExpandoTextCtrl.AppendText`                                  
:meth:`~lib.expando.ExpandoTextCtrl.GetMaxHeight`                                Sets the max height that the control will expand to on its own
:meth:`~lib.expando.ExpandoTextCtrl.OnSize`                                      
:meth:`~lib.expando.ExpandoTextCtrl.OnTextChanged`                               
:meth:`~lib.expando.ExpandoTextCtrl.SetFont`                                     
:meth:`~lib.expando.ExpandoTextCtrl.SetMaxHeight`                                Sets the max height that the control will expand to on its
:meth:`~lib.expando.ExpandoTextCtrl.WriteText`                                   
================================================================================ ================================================================================


|


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

.. class:: ExpandoTextCtrl(TextCtrl)

   The ExpandoTextCtrl is a multi-line wx.TextCtrl that will
   adjust its height on the fly as needed to accomodate the number of
   lines needed to display the current content of the control.  It is
   assumed that the width of the control will be a fixed value and
   that only the height will be adjusted automatically.  If the
   control is used in a sizer then the width should be set as part of
   the initial or min size of the control.
   
   When the control resizes itself it will attempt to also make
   necessary adjustments in the sizer hierarchy it is a member of (if
   any) but if that is not suffiecient then the programmer can catch
   the EVT_ETC_LAYOUT_NEEDED event in the container and make any
   other layout adjustments that may be needed.

   .. method:: __init__(self, parent, id=-1, value="", pos=DefaultPosition,  size=DefaultSize, style=0, validator=DefaultValidator, name="expando")


   .. method:: AppendText(self, text)


   .. method:: GetMaxHeight(self)

      Sets the max height that the control will expand to on its own


   .. method:: OnSize(self, evt)


   .. method:: OnTextChanged(self, evt)


   .. method:: SetFont(self, font)


   .. method:: SetMaxHeight(self, h)

      Sets the max height that the control will expand to on its
      own, and adjusts it down if needed.


   .. method:: WriteText(self, text)