2008-03-08 13:52:38 +00:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
2008-03-08 14:43:31 +00:00
|
|
|
// Name: numdlg.h
|
2008-03-10 15:24:38 +00:00
|
|
|
// Purpose: interface of global functions
|
2008-03-08 14:43:31 +00:00
|
|
|
// Author: wxWidgets team
|
2010-07-13 13:29:13 +00:00
|
|
|
// Licence: wxWindows licence
|
2008-03-08 14:43:31 +00:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
2009-01-05 20:48:06 +00:00
|
|
|
/** @addtogroup group_funcmacro_dialog */
|
2008-03-18 19:30:01 +00:00
|
|
|
//@{
|
|
|
|
|
2008-03-08 14:43:31 +00:00
|
|
|
/**
|
2008-03-18 19:30:01 +00:00
|
|
|
Shows a dialog asking the user for numeric input. The dialogs title is set
|
|
|
|
to @c caption, it contains a (possibly) multiline @c message above the
|
|
|
|
single line @c prompt and the zone for entering the number.
|
|
|
|
|
|
|
|
The number entered must be in the range @c min to @c max (both of which
|
|
|
|
should be positive) and @c value is the initial value of it. If the user
|
2008-07-30 19:25:10 +00:00
|
|
|
enters an invalid value, it is forced to fall into the specified range. If
|
|
|
|
the user cancels the dialog, the function returns -1.
|
2008-03-18 19:30:01 +00:00
|
|
|
|
|
|
|
Dialog is centered on its @c parent unless an explicit position is given
|
|
|
|
in @c pos.
|
|
|
|
|
|
|
|
@header{wx/numdlg.h}
|
2008-03-08 13:52:38 +00:00
|
|
|
*/
|
|
|
|
long wxGetNumberFromUser(const wxString& message,
|
|
|
|
const wxString& prompt,
|
|
|
|
const wxString& caption,
|
|
|
|
long value,
|
|
|
|
long min = 0,
|
|
|
|
long max = 100,
|
2008-03-09 12:33:59 +00:00
|
|
|
wxWindow* parent = NULL,
|
2008-03-08 13:52:38 +00:00
|
|
|
const wxPoint& pos = wxDefaultPosition);
|
|
|
|
|
2008-03-18 19:30:01 +00:00
|
|
|
//@}
|
2008-03-08 13:52:38 +00:00
|
|
|
|