interface/numdlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        numdlg.h
   3 // Purpose:     documentation for global functions
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10 Shows a dialog asking the user for numeric input. The dialogs title is set to
  11 @e caption, it contains a (possibly) multiline @e message above the
  12 single line @e prompt and the zone for entering the number.
  13
  14 The number entered must be in the range @e min..@e max (both of which
  15 should be positive) and @e value is the initial value of it. If the user
  16 enters an invalid value or cancels the dialog, the function will return -1.
  17
  18 Dialog is centered on its @e parent unless an explicit position is given in
  19 @e pos.
  20 */
  21 long wxGetNumberFromUser(const wxString& message,
  22                          const wxString& prompt,
  23                          const wxString& caption,
  24                          long value,
  25                          long min = 0,
  26                          long max = 100,
  27                          wxWindow * parent = @NULL,
  28                          const wxPoint& pos = wxDefaultPosition);
  29
  30