]> git.saurik.com Git - wxWidgets.git/blob - src/msw/spinctrl.cpp
don't reset the selection after event was vetoed if there is no old selection
[wxWidgets.git] / src / msw / spinctrl.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/spinctrl.cpp
3 // Purpose: wxSpinCtrl class implementation for Win32
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 22.07.99
7 // RCS-ID: $Id$
8 // Copyright: (c) 1999-2005 Vadim Zeitlin
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // for compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #if wxUSE_SPINCTRL
28
29 #include "wx/spinctrl.h"
30
31 #ifndef WX_PRECOMP
32 #include "wx/event.h"
33 #include "wx/textctrl.h"
34 #endif
35
36 #include "wx/msw/private.h"
37 #include "wx/msw/wrapcctl.h"
38
39 #if wxUSE_TOOLTIPS
40 #include "wx/tooltip.h"
41 #endif // wxUSE_TOOLTIPS
42
43 #include <limits.h> // for INT_MIN
44
45 // ----------------------------------------------------------------------------
46 // macros
47 // ----------------------------------------------------------------------------
48
49 #if wxUSE_EXTENDED_RTTI
50 WX_DEFINE_FLAGS( wxSpinCtrlStyle )
51
52 wxBEGIN_FLAGS( wxSpinCtrlStyle )
53 // new style border flags, we put them first to
54 // use them for streaming out
55 wxFLAGS_MEMBER(wxBORDER_SIMPLE)
56 wxFLAGS_MEMBER(wxBORDER_SUNKEN)
57 wxFLAGS_MEMBER(wxBORDER_DOUBLE)
58 wxFLAGS_MEMBER(wxBORDER_RAISED)
59 wxFLAGS_MEMBER(wxBORDER_STATIC)
60 wxFLAGS_MEMBER(wxBORDER_NONE)
61
62 // old style border flags
63 wxFLAGS_MEMBER(wxSIMPLE_BORDER)
64 wxFLAGS_MEMBER(wxSUNKEN_BORDER)
65 wxFLAGS_MEMBER(wxDOUBLE_BORDER)
66 wxFLAGS_MEMBER(wxRAISED_BORDER)
67 wxFLAGS_MEMBER(wxSTATIC_BORDER)
68 wxFLAGS_MEMBER(wxBORDER)
69
70 // standard window styles
71 wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
72 wxFLAGS_MEMBER(wxCLIP_CHILDREN)
73 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
74 wxFLAGS_MEMBER(wxWANTS_CHARS)
75 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
76 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
77 wxFLAGS_MEMBER(wxVSCROLL)
78 wxFLAGS_MEMBER(wxHSCROLL)
79
80 wxFLAGS_MEMBER(wxSP_HORIZONTAL)
81 wxFLAGS_MEMBER(wxSP_VERTICAL)
82 wxFLAGS_MEMBER(wxSP_ARROW_KEYS)
83 wxFLAGS_MEMBER(wxSP_WRAP)
84
85 wxEND_FLAGS( wxSpinCtrlStyle )
86
87 IMPLEMENT_DYNAMIC_CLASS_XTI(wxSpinCtrl, wxControl,"wx/spinbut.h")
88
89 wxBEGIN_PROPERTIES_TABLE(wxSpinCtrl)
90 wxEVENT_RANGE_PROPERTY( Spin , wxEVT_SCROLL_TOP , wxEVT_SCROLL_ENDSCROLL , wxSpinEvent )
91 wxEVENT_PROPERTY( Updated , wxEVT_COMMAND_SPINCTRL_UPDATED , wxCommandEvent )
92 wxEVENT_PROPERTY( TextUpdated , wxEVT_COMMAND_TEXT_UPDATED , wxCommandEvent )
93 wxEVENT_PROPERTY( TextEnter , wxEVT_COMMAND_TEXT_ENTER , wxCommandEvent )
94
95 wxPROPERTY( ValueString , wxString , SetValue , GetValue , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) ;
96 wxPROPERTY( Value , int , SetValue, GetValue, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
97 wxPROPERTY( Min , int , SetMin, GetMin, 0, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
98 wxPROPERTY( Max , int , SetMax, GetMax, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
99 wxPROPERTY_FLAGS( WindowStyle , wxSpinCtrlStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
100 /*
101 TODO PROPERTIES
102 style wxSP_ARROW_KEYS
103 */
104 wxEND_PROPERTIES_TABLE()
105
106 wxBEGIN_HANDLERS_TABLE(wxSpinCtrl)
107 wxEND_HANDLERS_TABLE()
108
109 wxCONSTRUCTOR_6( wxSpinCtrl , wxWindow* , Parent , wxWindowID , Id , wxString , ValueString , wxPoint , Position , wxSize , Size , long , WindowStyle )
110 #else
111 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl, wxControl)
112 #endif
113
114 //pmg EVT_KILL_FOCUS
115 BEGIN_EVENT_TABLE(wxSpinCtrl, wxSpinButton)
116 EVT_CHAR(wxSpinCtrl::OnChar)
117
118 EVT_SET_FOCUS(wxSpinCtrl::OnSetFocus)
119 EVT_KILL_FOCUS(wxSpinCtrl::OnKillFocus)
120 EVT_SPIN(wxID_ANY, wxSpinCtrl::OnSpinChange)
121 END_EVENT_TABLE()
122
123 #define GetBuddyHwnd() (HWND)(m_hwndBuddy)
124
125 // ----------------------------------------------------------------------------
126 // constants
127 // ----------------------------------------------------------------------------
128
129 // the margin between the up-down control and its buddy (can be arbitrary,
130 // choose what you like - or may be decide during run-time depending on the
131 // font size?)
132 static const int MARGIN_BETWEEN = 1;
133
134 // ============================================================================
135 // implementation
136 // ============================================================================
137
138 wxArraySpins wxSpinCtrl::ms_allSpins;
139
140 // ----------------------------------------------------------------------------
141 // wnd proc for the buddy text ctrl
142 // ----------------------------------------------------------------------------
143
144 LRESULT APIENTRY _EXPORT wxBuddyTextWndProc(HWND hwnd,
145 UINT message,
146 WPARAM wParam,
147 LPARAM lParam)
148 {
149 wxSpinCtrl *spin = (wxSpinCtrl *)wxGetWindowUserData(hwnd);
150
151 // forward some messages (the key and focus ones only so far) to
152 // the spin ctrl
153 switch ( message )
154 {
155 case WM_SETFOCUS:
156 // if the focus comes from the spin control itself, don't set it
157 // back to it -- we don't want to go into an infinite loop
158 if ( (WXHWND)wParam == spin->GetHWND() )
159 break;
160 //else: fall through
161
162 case WM_KILLFOCUS:
163 case WM_CHAR:
164 case WM_DEADCHAR:
165 case WM_KEYUP:
166 case WM_KEYDOWN:
167 spin->MSWWindowProc(message, wParam, lParam);
168
169 // The control may have been deleted at this point, so check.
170 if ( !::IsWindow(hwnd) || wxGetWindowUserData(hwnd) != spin )
171 return 0;
172 break;
173
174 case WM_GETDLGCODE:
175 // we want to get WXK_RETURN in order to generate the event for it
176 return DLGC_WANTCHARS;
177 }
178
179 return ::CallWindowProc(CASTWNDPROC spin->GetBuddyWndProc(),
180 hwnd, message, wParam, lParam);
181 }
182
183 /* static */
184 wxSpinCtrl *wxSpinCtrl::GetSpinForTextCtrl(WXHWND hwndBuddy)
185 {
186 wxSpinCtrl *spin = (wxSpinCtrl *)wxGetWindowUserData((HWND)hwndBuddy);
187
188 int i = ms_allSpins.Index(spin);
189
190 if ( i == wxNOT_FOUND )
191 return NULL;
192
193 // sanity check
194 wxASSERT_MSG( spin->m_hwndBuddy == hwndBuddy,
195 _T("wxSpinCtrl has incorrect buddy HWND!") );
196
197 return spin;
198 }
199
200 // process a WM_COMMAND generated by the buddy text control
201 bool wxSpinCtrl::ProcessTextCommand(WXWORD cmd, WXWORD WXUNUSED(id))
202 {
203 if ( cmd == EN_CHANGE )
204 {
205 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
206 event.SetEventObject(this);
207 wxString val = wxGetWindowText(m_hwndBuddy);
208 event.SetString(val);
209 event.SetInt(GetValue());
210 return GetEventHandler()->ProcessEvent(event);
211 }
212
213 // not processed
214 return false;
215 }
216
217 void wxSpinCtrl::OnChar(wxKeyEvent& event)
218 {
219 switch ( event.GetKeyCode() )
220 {
221 case WXK_RETURN:
222 {
223 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_windowId);
224 InitCommandEvent(event);
225 wxString val = wxGetWindowText(m_hwndBuddy);
226 event.SetString(val);
227 event.SetInt(GetValue());
228 if ( GetEventHandler()->ProcessEvent(event) )
229 return;
230 break;
231 }
232
233 case WXK_TAB:
234 // always produce navigation event - even if we process TAB
235 // ourselves the fact that we got here means that the user code
236 // decided to skip processing of this TAB - probably to let it
237 // do its default job.
238 {
239 wxNavigationKeyEvent eventNav;
240 eventNav.SetDirection(!event.ShiftDown());
241 eventNav.SetWindowChange(event.ControlDown());
242 eventNav.SetEventObject(this);
243
244 if ( GetParent()->GetEventHandler()->ProcessEvent(eventNav) )
245 return;
246 }
247 break;
248 }
249
250 // no, we didn't process it
251 event.Skip();
252 }
253
254 void wxSpinCtrl::OnKillFocus(wxFocusEvent& event)
255 {
256 // ensure that a correct value is shown by the control
257 NormalizeValue();
258 event.Skip();
259 }
260
261 void wxSpinCtrl::OnSetFocus(wxFocusEvent& event)
262 {
263 // when we get focus, give it to our buddy window as it needs it more than
264 // we do
265 ::SetFocus((HWND)m_hwndBuddy);
266
267 event.Skip();
268 }
269
270 // ----------------------------------------------------------------------------
271 // construction
272 // ----------------------------------------------------------------------------
273
274 bool wxSpinCtrl::Create(wxWindow *parent,
275 wxWindowID id,
276 const wxString& value,
277 const wxPoint& pos,
278 const wxSize& size,
279 long style,
280 int min, int max, int initial,
281 const wxString& name)
282 {
283 // before using DoGetBestSize(), have to set style to let the base class
284 // know whether this is a horizontal or vertical control (we're always
285 // vertical)
286 style |= wxSP_VERTICAL;
287
288 if ( (style & wxBORDER_MASK) == wxBORDER_DEFAULT )
289 #ifdef __WXWINCE__
290 style |= wxBORDER_SIMPLE;
291 #else
292 style |= wxBORDER_SUNKEN;
293 #endif
294
295 SetWindowStyle(style);
296
297 WXDWORD exStyle = 0;
298 WXDWORD msStyle = MSWGetStyle(GetWindowStyle(), & exStyle) ;
299
300 // calculate the sizes: the size given is the toal size for both controls
301 // and we need to fit them both in the given width (height is the same)
302 wxSize sizeText(size), sizeBtn(size);
303 sizeBtn.x = wxSpinButton::DoGetBestSize().x;
304 if ( sizeText.x <= 0 )
305 {
306 // DEFAULT_ITEM_WIDTH is the default width for the text control
307 sizeText.x = DEFAULT_ITEM_WIDTH + MARGIN_BETWEEN + sizeBtn.x;
308 }
309
310 sizeText.x -= sizeBtn.x + MARGIN_BETWEEN;
311 if ( sizeText.x <= 0 )
312 {
313 wxLogDebug(_T("not enough space for wxSpinCtrl!"));
314 }
315
316 wxPoint posBtn(pos);
317 posBtn.x += sizeText.x + MARGIN_BETWEEN;
318
319 // we must create the text control before the spin button for the purpose
320 // of the dialog navigation: if there is a static text just before the spin
321 // control, activating it by Alt-letter should give focus to the text
322 // control, not the spin and the dialog navigation code will give focus to
323 // the next control (at Windows level), not the one after it
324
325 // create the text window
326
327 m_hwndBuddy = (WXHWND)::CreateWindowEx
328 (
329 exStyle, // sunken border
330 _T("EDIT"), // window class
331 NULL, // no window title
332 msStyle, // style (will be shown later)
333 pos.x, pos.y, // position
334 0, 0, // size (will be set later)
335 GetHwndOf(parent), // parent
336 (HMENU)-1, // control id
337 wxGetInstance(), // app instance
338 NULL // unused client data
339 );
340
341 if ( !m_hwndBuddy )
342 {
343 wxLogLastError(wxT("CreateWindow(buddy text window)"));
344
345 return false;
346 }
347
348
349 // create the spin button
350 if ( !wxSpinButton::Create(parent, id, posBtn, sizeBtn, style, name) )
351 {
352 return false;
353 }
354
355 SetRange(min, max);
356 SetValue(initial);
357
358 // subclass the text ctrl to be able to intercept some events
359 wxSetWindowUserData(GetBuddyHwnd(), this);
360 m_wndProcBuddy = (WXFARPROC)wxSetWindowProc(GetBuddyHwnd(),
361 wxBuddyTextWndProc);
362
363 // set up fonts and colours (This is nomally done in MSWCreateControl)
364 InheritAttributes();
365 if (!m_hasFont)
366 SetFont(GetDefaultAttributes().font);
367
368 // set the size of the text window - can do it only now, because we
369 // couldn't call DoGetBestSize() before as font wasn't set
370 if ( sizeText.y <= 0 )
371 {
372 int cx, cy;
373 wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
374
375 sizeText.y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
376 }
377
378 SetBestSize(size);
379
380 (void)::ShowWindow(GetBuddyHwnd(), SW_SHOW);
381
382 // associate the text window with the spin button
383 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY, (WPARAM)m_hwndBuddy, 0);
384
385 if ( !value.empty() )
386 {
387 SetValue(value);
388 }
389
390 // do it after finishing with m_hwndBuddy creation to avoid generating
391 // initial wxEVT_COMMAND_TEXT_UPDATED message
392 ms_allSpins.Add(this);
393
394 return true;
395 }
396
397 wxSpinCtrl::~wxSpinCtrl()
398 {
399 ms_allSpins.Remove(this);
400
401 // This removes spurious memory leak reporting
402 if (ms_allSpins.GetCount() == 0)
403 ms_allSpins.Clear();
404
405 // destroy the buddy window because this pointer which wxBuddyTextWndProc
406 // uses will not soon be valid any more
407 ::DestroyWindow(GetBuddyHwnd());
408 }
409
410 // ----------------------------------------------------------------------------
411 // wxTextCtrl-like methods
412 // ----------------------------------------------------------------------------
413
414 void wxSpinCtrl::SetValue(const wxString& text)
415 {
416 if ( !::SetWindowText(GetBuddyHwnd(), text.c_str()) )
417 {
418 wxLogLastError(wxT("SetWindowText(buddy)"));
419 }
420 }
421
422 void wxSpinCtrl::SetValue(int val)
423 {
424 wxSpinButton::SetValue(val);
425
426 // normally setting the value of the spin button is enough as it updates
427 // its buddy control automatically ...
428 if ( wxGetWindowText(m_hwndBuddy).empty() )
429 {
430 // ... but sometimes it doesn't, notably when the value is 0 and the
431 // text control is currently empty, the spin button seems to be happy
432 // to leave it like this, while we really want to always show the
433 // current value in the control, so do it manually
434 ::SetWindowText(GetBuddyHwnd(), wxString::Format(_T("%d"), val));
435 }
436 }
437
438 int wxSpinCtrl::GetValue() const
439 {
440 wxString val = wxGetWindowText(m_hwndBuddy);
441
442 long n;
443 if ( (wxSscanf(val, wxT("%ld"), &n) != 1) )
444 n = INT_MIN;
445
446 if ( n < m_min )
447 n = m_min;
448 if ( n > m_max )
449 n = m_max;
450
451 return n;
452 }
453
454 void wxSpinCtrl::SetSelection(long from, long to)
455 {
456 // if from and to are both -1, it means (in wxWidgets) that all text should
457 // be selected - translate into Windows convention
458 if ( (from == -1) && (to == -1) )
459 {
460 from = 0;
461 }
462
463 ::SendMessage(GetBuddyHwnd(), EM_SETSEL, (WPARAM)from, (LPARAM)to);
464 }
465
466 // ----------------------------------------------------------------------------
467 // forward some methods to subcontrols
468 // ----------------------------------------------------------------------------
469
470 bool wxSpinCtrl::SetFont(const wxFont& font)
471 {
472 if ( !wxWindowBase::SetFont(font) )
473 {
474 // nothing to do
475 return false;
476 }
477
478 WXHANDLE hFont = GetFont().GetResourceHandle();
479 (void)::SendMessage(GetBuddyHwnd(), WM_SETFONT, (WPARAM)hFont, TRUE);
480
481 return true;
482 }
483
484 bool wxSpinCtrl::Show(bool show)
485 {
486 if ( !wxControl::Show(show) )
487 {
488 return false;
489 }
490
491 ::ShowWindow(GetBuddyHwnd(), show ? SW_SHOW : SW_HIDE);
492
493 return true;
494 }
495
496 bool wxSpinCtrl::Enable(bool enable)
497 {
498 if ( !wxControl::Enable(enable) )
499 {
500 return false;
501 }
502
503 ::EnableWindow(GetBuddyHwnd(), enable);
504
505 return true;
506 }
507
508 void wxSpinCtrl::SetFocus()
509 {
510 ::SetFocus(GetBuddyHwnd());
511 }
512
513 #if wxUSE_TOOLTIPS
514
515 void wxSpinCtrl::DoSetToolTip(wxToolTip *tip)
516 {
517 wxSpinButton::DoSetToolTip(tip);
518
519 if ( tip )
520 tip->Add(m_hwndBuddy);
521 }
522
523 #endif // wxUSE_TOOLTIPS
524
525 // ----------------------------------------------------------------------------
526 // event processing
527 // ----------------------------------------------------------------------------
528
529 void wxSpinCtrl::OnSpinChange(wxSpinEvent& eventSpin)
530 {
531 wxCommandEvent event(wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());
532 event.SetEventObject(this);
533 event.SetInt(eventSpin.GetPosition());
534
535 (void)GetEventHandler()->ProcessEvent(event);
536
537 if ( eventSpin.GetSkipped() )
538 {
539 event.Skip();
540 }
541 }
542
543 // ----------------------------------------------------------------------------
544 // size calculations
545 // ----------------------------------------------------------------------------
546
547 wxSize wxSpinCtrl::DoGetBestSize() const
548 {
549 wxSize sizeBtn = wxSpinButton::DoGetBestSize();
550 sizeBtn.x += DEFAULT_ITEM_WIDTH + MARGIN_BETWEEN;
551
552 int y;
553 wxGetCharSize(GetHWND(), NULL, &y, GetFont());
554 y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(y);
555
556 // JACS: we should always use the height calculated
557 // from above, because otherwise we'll get a spin control
558 // that's too big. So never use the height calculated
559 // from wxSpinButton::DoGetBestSize().
560
561 // if ( sizeBtn.y < y )
562 {
563 // make the text tall enough
564 sizeBtn.y = y;
565 }
566
567 return sizeBtn;
568 }
569
570 void wxSpinCtrl::DoMoveWindow(int x, int y, int width, int height)
571 {
572 int widthBtn = wxSpinButton::DoGetBestSize().x;
573 int widthText = width - widthBtn - MARGIN_BETWEEN;
574 if ( widthText <= 0 )
575 {
576 wxLogDebug(_T("not enough space for wxSpinCtrl!"));
577 }
578
579 // 1) The buddy window
580 DoMoveSibling(m_hwndBuddy, x, y, widthText, height);
581
582 // 2) The button window
583 x += widthText + MARGIN_BETWEEN;
584 wxSpinButton::DoMoveWindow(x, y, widthBtn, height);
585 }
586
587 // get total size of the control
588 void wxSpinCtrl::DoGetSize(int *x, int *y) const
589 {
590 RECT spinrect, textrect, ctrlrect;
591 GetWindowRect(GetHwnd(), &spinrect);
592 GetWindowRect(GetBuddyHwnd(), &textrect);
593 UnionRect(&ctrlrect,&textrect, &spinrect);
594
595 if ( x )
596 *x = ctrlrect.right - ctrlrect.left;
597 if ( y )
598 *y = ctrlrect.bottom - ctrlrect.top;
599 }
600
601 void wxSpinCtrl::DoGetPosition(int *x, int *y) const
602 {
603 // hack: pretend that our HWND is the text control just for a moment
604 WXHWND hWnd = GetHWND();
605 wxConstCast(this, wxSpinCtrl)->m_hWnd = m_hwndBuddy;
606
607 wxSpinButton::DoGetPosition(x, y);
608
609 wxConstCast(this, wxSpinCtrl)->m_hWnd = hWnd;
610 }
611
612 #endif // wxUSE_SPINCTRL