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

.. highlight:: python



.. _wx.lib.agw.floatspin.FloatTextCtrl:

==========================================================================================================================================
|phoenix_title|  **wx.lib.agw.floatspin.FloatTextCtrl**
==========================================================================================================================================

A class which holds a :class:`TextCtrl`, one of the two building blocks
of :class:`FloatSpin`.



|

|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>FloatTextCtrl</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.floatspin.FloatTextCtrl_inheritance.svg" alt="Inheritance diagram of FloatTextCtrl" 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.floatspin.FloatTextCtrl.html" title="A class which holds a TextCtrl, one of the two building blocks" alt="" coords="59,466,320,495"/> <area shape="rect" id="node2" href="wx.TextCtrl.html" title="A text control allows text to be displayed and edited." alt="" coords="136,389,243,418"/> <area shape="rect" id="node3" href="wx.Control.html" title="This is the base class for a control or 'widget'." alt="" coords="69,313,174,341"/> <area shape="rect" id="node4" href="wx.TextEntry.html" title="Common base class for single line text entry fields." alt="" coords="198,313,317,341"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="66,236,177,265"/> <area shape="rect" id="node6" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="48,159,195,188"/> <area shape="rect" id="node7" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="55,82,188,111"/> <area shape="rect" id="node8" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,104,34"/> <area shape="rect" id="node9" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="128,5,251,34"/> </map> 
   </p>
   </div>

|


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

:class:`wx.TextCtrl`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.agw.floatspin.FloatTextCtrl.__init__`                             Default class constructor.
:meth:`~wx.lib.agw.floatspin.FloatTextCtrl.OnChar`                               Handles the ``wx.EVT_CHAR`` event for :class:`FloatTextCtrl`.
:meth:`~wx.lib.agw.floatspin.FloatTextCtrl.OnDestroy`                            Handles the ``wx.EVT_WINDOW_DESTROY`` event for :class:`FloatTextCtrl`.
:meth:`~wx.lib.agw.floatspin.FloatTextCtrl.OnKillFocus`                          Handles the ``wx.EVT_KILL_FOCUS`` event for :class:`FloatTextCtrl`.
================================================================================ ================================================================================


|


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


.. class:: FloatTextCtrl(wx.TextCtrl)

   A class which holds a :class:`TextCtrl`, one of the two building blocks
   of :class:`FloatSpin`.

   .. method:: __init__(self, parent, id=wx.ID_ANY, value="", pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.TE_NOHIDESEL | wx.TE_PROCESS_ENTER, validator=wx.DefaultValidator, name=wx.TextCtrlNameStr)

      Default class constructor.
      Used internally. Do not call directly this class in your code!
      
      :param `parent`: the :class:`FloatTextCtrl` parent;
      :param `id`: an identifier for the control: a value of -1 is taken to mean a default;
      :param `value`: default text value;
      :param `pos`: the control position. A value of (-1, -1) indicates a default position,
       chosen by either the windowing system or wxPython, depending on platform;
      :param `size`: the control size. A value of (-1, -1) indicates a default size,
       chosen by either the windowing system or wxPython, depending on platform;
      :param `style`: the window style;
      :param `validator`: the window validator;
      :param `name`: the window name.


   .. method:: OnChar(self, event)

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


   .. method:: OnDestroy(self, event)

      Handles the ``wx.EVT_WINDOW_DESTROY`` event for :class:`FloatTextCtrl`.
      
      :param `event`: a :class:`wx.WindowDestroyEvent` event to be processed.
      
      .. note:: This method tries to correctly handle the control destruction under MSW.


   .. method:: OnKillFocus(self, event)

      Handles the ``wx.EVT_KILL_FOCUS`` event for :class:`FloatTextCtrl`.
      
      :param `event`: a :class:`FocusEvent` event to be processed.
      
      .. note:: This method synchronizes the :class:`SpinButton` and the :class:`TextCtrl`
       when focus is lost.