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