]>
Commit | Line | Data |
---|---|---|
23324ae1 | 1 | ///////////////////////////////////////////////////////////////////////////// |
7c913512 | 2 | // Name: numdlg.h |
e54c96f1 | 3 | // Purpose: interface of global functions |
7c913512 | 4 | // Author: wxWidgets team |
526954c5 | 5 | // Licence: wxWindows licence |
7c913512 FM |
6 | ///////////////////////////////////////////////////////////////////////////// |
7 | ||
b21126db | 8 | /** @addtogroup group_funcmacro_dialog */ |
ba2874ff BP |
9 | //@{ |
10 | ||
7c913512 | 11 | /** |
ba2874ff BP |
12 | Shows a dialog asking the user for numeric input. The dialogs title is set |
13 | to @c caption, it contains a (possibly) multiline @c message above the | |
14 | single line @c prompt and the zone for entering the number. | |
15 | ||
16 | The number entered must be in the range @c min to @c max (both of which | |
17 | should be positive) and @c value is the initial value of it. If the user | |
6a7e5ea2 VZ |
18 | enters an invalid value, it is forced to fall into the specified range. If |
19 | the user cancels the dialog, the function returns -1. | |
ba2874ff BP |
20 | |
21 | Dialog is centered on its @c parent unless an explicit position is given | |
22 | in @c pos. | |
23 | ||
24 | @header{wx/numdlg.h} | |
23324ae1 FM |
25 | */ |
26 | long wxGetNumberFromUser(const wxString& message, | |
27 | const wxString& prompt, | |
28 | const wxString& caption, | |
29 | long value, | |
30 | long min = 0, | |
31 | long max = 100, | |
4cc4bfaf | 32 | wxWindow* parent = NULL, |
23324ae1 FM |
33 | const wxPoint& pos = wxDefaultPosition); |
34 | ||
ba2874ff | 35 | //@} |
23324ae1 | 36 |