wxWidgets/interface/numdlg.h

38 lines
1.3 KiB
C

/////////////////////////////////////////////////////////////////////////////
// Name: numdlg.h
// Purpose: interface of global functions
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/** @ingroup group_funcmacro_dialog */
//@{
/**
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
enters an invalid value or cancels the dialog, the function will return
-1.
Dialog is centered on its @c parent unless an explicit position is given
in @c pos.
@header{wx/numdlg.h}
*/
long wxGetNumberFromUser(const wxString& message,
const wxString& prompt,
const wxString& caption,
long value,
long min = 0,
long max = 100,
wxWindow* parent = NULL,
const wxPoint& pos = wxDefaultPosition);
//@}