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



.. _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 `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>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,5,108,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="59,83,171,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="133,5,215,35"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="71,160,160,189"/> <area shape="rect" id="node6" href="wx.NonOwnedWindow.html" title="Common base class for all non-child windows." alt="" coords="36,237,195,267"/> <area shape="rect" id="node5" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow  is a common base class for wx.Dialog  and wx.Frame." alt="" coords="43,315,188,344"/> <area shape="rect" id="node8" href="wx.Dialog.html" title="A dialog box is a window with a title bar and sometimes a system menu, which can be moved around the screen." alt="" coords="74,392,157,421"/> <area shape="rect" id="node7" href="wx.NumberEntryDialog.html" title="This class represents a dialog that requests a numeric input from the user." alt="" coords="32,469,199,499"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~wx.NumberEntryDialog.__init__`                                           Constructor.
: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(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, parent, message, prompt, caption, value, min, max, pos=DefaultPosition)

      Constructor.                  

      Use :meth:`~wx.Dialog.ShowModal`   to show the dialog. 




      :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


















                  





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