File: wx.lib.agw.floatspin.FloatTextCtrl.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (125 lines) | stat: -rw-r--r-- 5,631 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
.. 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.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.png" alt="Inheritance diagram of FloatTextCtrl" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.TextCtrl.html" title="wx.TextCtrl" alt="" coords="127,392,216,421"/> <area shape="rect" id="node4" href="wx.lib.agw.floatspin.FloatTextCtrl.html" title="wx.lib.agw.floatspin.FloatTextCtrl" alt="" coords="60,469,283,499"/> <area shape="rect" id="node2" href="wx.Control.html" title="wx.Control" alt="" coords="69,315,157,344"/> <area shape="rect" id="node3" href="wx.TextEntry.html" title="wx.TextEntry" alt="" coords="182,315,281,344"/> <area shape="rect" id="node5" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="5,5,107,35"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="57,83,168,112"/> <area shape="rect" id="node8" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="53,160,173,189"/> <area shape="rect" id="node7" href="wx.Object.html" title="wx.Object" alt="" coords="131,5,212,35"/> <area shape="rect" id="node9" href="wx.Window.html" title="wx.Window" alt="" coords="69,237,157,267"/> </map> 
   </p>

|


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