As per the docs, the value returned is -1 if the value entered is out of range [patch...
[wxWidgets.git] / src / generic / numdlgg.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: numdlgg.cpp
3 // Purpose: wxGetNumberFromUser implementation
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 23.07.99
7 // RCS-ID: $Id$
8 // Copyright: (c) Vadim Zeitlin
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "numdlgg.cpp"
22 #endif
23
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
26
27 #ifdef __BORLANDC__
28 #pragma hdrstop
29 #endif
30
31 #if wxUSE_NUMBERDLG
32
33 #ifndef WX_PRECOMP
34 #include <stdio.h>
35
36 #include "wx/utils.h"
37 #include "wx/dialog.h"
38 #include "wx/button.h"
39 #include "wx/stattext.h"
40 #include "wx/textctrl.h"
41 #include "wx/intl.h"
42 #include "wx/sizer.h"
43 #endif
44
45 #if wxUSE_STATLINE
46 #include "wx/statline.h"
47 #endif
48
49 #if wxUSE_SPINCTRL
50 #include "wx/spinctrl.h"
51 #endif
52
53 // this is where wxGetNumberFromUser() is declared
54 #include "wx/numdlg.h"
55
56 #if !wxUSE_SPINCTRL
57 // wxTextCtrl will do instead of wxSpinCtrl if we don't have it
58 #define wxSpinCtrl wxTextCtrl
59 #endif
60
61 // ---------------------------------------------------------------------------
62 // macros
63 // ---------------------------------------------------------------------------
64
65 /* Macro for avoiding #ifdefs when value have to be different depending on size of
66 device we display on - take it from something like wxDesktopPolicy in the future
67 */
68
69 #if defined(__SMARTPHONE__)
70 #define wxLARGESMALL(large,small) small
71 #else
72 #define wxLARGESMALL(large,small) large
73 #endif
74
75 // ============================================================================
76 // implementation
77 // ============================================================================
78
79 // ----------------------------------------------------------------------------
80 // wxNumberEntryDialog
81 // ----------------------------------------------------------------------------
82
83 BEGIN_EVENT_TABLE(wxNumberEntryDialog, wxDialog)
84 EVT_BUTTON(wxID_OK, wxNumberEntryDialog::OnOK)
85 EVT_BUTTON(wxID_CANCEL, wxNumberEntryDialog::OnCancel)
86 END_EVENT_TABLE()
87
88 IMPLEMENT_CLASS(wxNumberEntryDialog, wxDialog)
89
90 wxNumberEntryDialog::wxNumberEntryDialog(wxWindow *parent,
91 const wxString& message,
92 const wxString& prompt,
93 const wxString& caption,
94 long value,
95 long min,
96 long max,
97 const wxPoint& pos)
98 : wxDialog(parent, wxID_ANY, caption,
99 pos, wxDefaultSize)
100 {
101 m_value = value;
102 m_max = max;
103 m_min = min;
104
105 wxBeginBusyCursor();
106
107 wxBoxSizer *topsizer = new wxBoxSizer( wxVERTICAL );
108
109 // 1) text message
110 topsizer->Add( CreateTextSizer( message ), 0, wxALL, 10 );
111
112 // 2) prompt and text ctrl
113 wxBoxSizer *inputsizer = new wxBoxSizer( wxHORIZONTAL );
114 // prompt if any
115 if (!prompt.IsEmpty())
116 inputsizer->Add( new wxStaticText( this, wxID_ANY, prompt ), 0, wxCENTER | wxLEFT, 10 );
117 // spin ctrl
118 wxString valStr;
119 valStr.Printf(wxT("%ld"), m_value);
120 m_spinctrl = new wxSpinCtrl(this, wxID_ANY, valStr, wxDefaultPosition, wxSize( 140, wxDefaultCoord ) );
121 #if wxUSE_SPINCTRL
122 m_spinctrl->SetRange((int)m_min, (int)m_max);
123 #endif
124 inputsizer->Add( m_spinctrl, 1, wxCENTER | wxLEFT | wxRIGHT, 10 );
125 // add both
126 topsizer->Add( inputsizer, 1, wxEXPAND | wxLEFT|wxRIGHT, 5 );
127
128 // smart phones does not support or do not waste space for wxButtons
129 #ifdef __SMARTPHONE__
130
131 SetRightMenu(wxID_CANCEL, _("Cancel"));
132
133 #else // __SMARTPHONE__/!__SMARTPHONE__
134
135 #if wxUSE_STATLINE
136 // 3) static line
137 topsizer->Add( new wxStaticLine( this, wxID_ANY ), 0, wxEXPAND | wxLEFT|wxRIGHT|wxTOP, 10 );
138 #endif
139
140 // 4) buttons
141 topsizer->Add( CreateButtonSizer( wxOK|wxCANCEL ), 0, wxEXPAND | wxALL, 10 );
142
143 #endif // !__SMARTPHONE__
144
145 SetSizer( topsizer );
146 SetAutoLayout( true );
147
148 topsizer->SetSizeHints( this );
149 topsizer->Fit( this );
150
151 Centre( wxBOTH );
152
153 m_spinctrl->SetSelection(-1, -1);
154 m_spinctrl->SetFocus();
155
156 wxEndBusyCursor();
157 }
158
159 void wxNumberEntryDialog::OnOK(wxCommandEvent& WXUNUSED(event))
160 {
161 #if !wxUSE_SPINCTRL
162 wxString tmp = m_spinctrl->GetValue();
163 if ( wxSscanf(tmp, _T("%ld"), &m_value) != 1 )
164 EndModal(wxID_CANCEL);
165 else
166 #else
167 m_value = m_spinctrl->GetValue();
168 #endif
169 if ( m_value < m_min || m_value > m_max )
170 {
171 // not a number or out of range
172 m_value = -1;
173 EndModal(wxID_CANCEL);
174 }
175
176 EndModal(wxID_OK);
177 }
178
179 void wxNumberEntryDialog::OnCancel(wxCommandEvent& WXUNUSED(event))
180 {
181 EndModal(wxID_CANCEL);
182 }
183
184 // ----------------------------------------------------------------------------
185 // global functions
186 // ----------------------------------------------------------------------------
187
188 // wxGetTextFromUser is in utilscmn.cpp
189
190 long wxGetNumberFromUser(const wxString& msg,
191 const wxString& prompt,
192 const wxString& title,
193 long value,
194 long min,
195 long max,
196 wxWindow *parent,
197 const wxPoint& pos)
198 {
199 wxNumberEntryDialog dialog(parent, msg, prompt, title,
200 value, min, max, pos);
201 if (dialog.ShowModal() == wxID_OK)
202 return dialog.GetValue();
203
204 return -1;
205 }
206
207 #endif // wxUSE_NUMBERDLG