File: wx.NumberEntryDialog.txt

package info (click to toggle)
wxpython4.0 4.2.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 232,540 kB
  • sloc: cpp: 958,937; python: 233,059; ansic: 150,441; makefile: 51,662; sh: 8,687; perl: 1,563; javascript: 584; php: 326; xml: 200
file content (256 lines) | stat: -rw-r--r-- 6,921 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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
.. 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



.. _wx.NumberEntryDialog:

==========================================================================================================================================
|phoenix_title|  **wx.NumberEntryDialog**
==========================================================================================================================================

This class represents a dialog that requests a numeric input from the user.          

Currently it is implemented as a generic wxWidgets dialog under all platforms. 

You can use a convenience :ref:`wx.GetNumberFromUser`  function instead of using this dialog. 





         



.. seealso:: :ref:`NumberEntryDialog Overview <numberentrydialog overview>`    







|

|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>NumberEntryDialog</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.NumberEntryDialog_inheritance.png" alt="Inheritance diagram of NumberEntryDialog" 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.NumberEntryDialog.html" title="wx.NumberEntryDialog" alt="" coords="22,469,195,499"/> <area shape="rect" id="node2" href="wx.Dialog.html" title="wx.Dialog" alt="" coords="65,392,152,421"/> <area shape="rect" id="node3" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="31,315,186,344"/> <area shape="rect" id="node4" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="25,237,193,267"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="60,160,157,189"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="50,83,167,112"/> <area shape="rect" id="node7" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,92,35"/> <area shape="rect" id="node8" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="117,5,223,35"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.NumberEntryDialog.__init__`                                           Default constructor.
:meth:`~wx.NumberEntryDialog.Create`                                             
:meth:`~wx.NumberEntryDialog.GetClassDefaultAttributes`                          
:meth:`~wx.NumberEntryDialog.GetValue`                                           Returns the value that the user has entered if the user has pressed ``wx.OK``, or the original value if the user has pressed Cancel.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.NumberEntryDialog.Value`                                              See :meth:`~wx.NumberEntryDialog.GetValue`
================================================================================ ================================================================================


|


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


.. class:: wx.NumberEntryDialog(Dialog)

   **Possible constructors**::

       NumberEntryDialog()
       
       NumberEntryDialog(parent, message, prompt, caption, value, min, max,
                         pos=DefaultPosition)
       
   
   This class represents a dialog that requests a numeric input from the
   user.



   .. method:: __init__(self, *args, **kw)



      |overload| Overloaded Implementations:

      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self)`
      
      Default constructor.                  
      
      Call :meth:`Create`   to really create the dialog later.                   
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, parent, message, prompt, caption, value, min, max, pos=DefaultPosition)`
      
      Constructor.                  
      
      Use :meth:`ShowModal`   to show the dialog. 
      
      See :meth:`Create`   method for parameter description.                  
      
      
      :param `parent`: 
      :type `parent`: wx.Window
      :param `message`: 
      :type `message`: string
      :param `prompt`: 
      :type `prompt`: string
      :param `caption`: 
      :type `caption`: string
      :param `value`: 
      :type `value`: long
      :param `min`: 
      :type `min`: long
      :param `max`: 
      :type `max`: long
      :param `pos`: 
      :type `pos`: wx.Point
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`






   .. method:: Create(self, parent, message, prompt, caption, value, min, max, pos=DefaultPosition)






      :param `parent`: Parent window.   
      :type `parent`: wx.Window
      :param `message`: Message to show on the dialog.   
      :type `message`: string
      :param `prompt`: The prompt of the dialog.   
      :type `prompt`: string
      :param `caption`: The caption of the dialog.   
      :type `caption`: string
      :param `value`: The default value.   
      :type `value`: long
      :param `min`: The minimal value.   
      :type `min`: long
      :param `max`: The maximal value.   
      :type `max`: long
      :param `pos`: Dialog position.   
      :type `pos`: wx.Point




















      :rtype: `bool`



                  





   .. staticmethod:: GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)




      :param `variant`: 
      :type `variant`: wx.WindowVariant




      :rtype: :ref:`wx.VisualAttributes`








   .. method:: GetValue(self)

      Returns the value that the user has entered if the user has pressed ``wx.OK``, or the original value if the user has pressed Cancel.                  

      :rtype: `long`








   .. attribute:: Value

      See :meth:`~wx.NumberEntryDialog.GetValue`