Correct the initial value setting in wxMSW wxSpinCtrl.
[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/hashmap.h"
33 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
34 #include "wx/event.h"
35 #include "wx/textctrl.h"
36 #include "wx/wxcrtvararg.h"
37 #endif
38
39 #include "wx/msw/private.h"
40
41 #if wxUSE_TOOLTIPS
42 #include "wx/tooltip.h"
43 #endif // wxUSE_TOOLTIPS
44
45 #include <limits.h> // for INT_MIN
46
47 // ----------------------------------------------------------------------------
48 // macros
49 // ----------------------------------------------------------------------------
50
51 BEGIN_EVENT_TABLE(wxSpinCtrl, wxSpinButton)
52 EVT_CHAR(wxSpinCtrl::OnChar)
53 EVT_SET_FOCUS(wxSpinCtrl::OnSetFocus)
54 EVT_KILL_FOCUS(wxSpinCtrl::OnKillFocus)
55 END_EVENT_TABLE()
56
57 #define GetBuddyHwnd() (HWND)(m_hwndBuddy)
58
59 // ----------------------------------------------------------------------------
60 // constants
61 // ----------------------------------------------------------------------------
62
63 // the margin between the up-down control and its buddy (can be arbitrary,
64 // choose what you like - or may be decide during run-time depending on the
65 // font size?)
66 static const int MARGIN_BETWEEN = 1;
67
68
69 // ---------------------------------------------------------------------------
70 // global vars
71 // ---------------------------------------------------------------------------
72
73 namespace
74 {
75
76 // Global hash used to find the spin control corresponding to the given buddy
77 // text control HWND.
78 WX_DECLARE_HASH_MAP(HWND, wxSpinCtrl *,
79 wxPointerHash, wxPointerEqual,
80 SpinForTextCtrl);
81
82 SpinForTextCtrl gs_spinForTextCtrl;
83
84 } // anonymous namespace
85
86 // ============================================================================
87 // implementation
88 // ============================================================================
89
90 // ----------------------------------------------------------------------------
91 // wnd proc for the buddy text ctrl
92 // ----------------------------------------------------------------------------
93
94 LRESULT APIENTRY _EXPORT wxBuddyTextWndProc(HWND hwnd,
95 UINT message,
96 WPARAM wParam,
97 LPARAM lParam)
98 {
99 wxSpinCtrl * const spin = wxSpinCtrl::GetSpinForTextCtrl(hwnd);
100
101 // forward some messages (mostly the key and focus ones) to the spin ctrl
102 switch ( message )
103 {
104 case WM_SETFOCUS:
105 // if the focus comes from the spin control itself, don't set it
106 // back to it -- we don't want to go into an infinite loop
107 if ( (WXHWND)wParam == spin->GetHWND() )
108 break;
109 //else: fall through
110
111 case WM_KILLFOCUS:
112 case WM_CHAR:
113 case WM_DEADCHAR:
114 case WM_KEYUP:
115 case WM_KEYDOWN:
116 #ifdef WM_HELP
117 // we need to forward WM_HELP too to ensure that the context help
118 // associated with wxSpinCtrl is shown when the text control part of it
119 // is clicked with the "?" cursor
120 case WM_HELP:
121 #endif
122 {
123 WXLRESULT result;
124 if ( spin->MSWHandleMessage(&result, message, wParam, lParam) )
125 {
126 // Do not let the message be processed by the window proc
127 // of the text control if it had been already handled at wx
128 // level, this is consistent with what happens for normal,
129 // non-composite controls.
130 return 0;
131 }
132
133 // The control may have been deleted at this point, so check.
134 if ( !::IsWindow(hwnd) )
135 return 0;
136 }
137 break;
138
139 case WM_GETDLGCODE:
140 if ( spin->HasFlag(wxTE_PROCESS_ENTER) )
141 {
142 long dlgCode = ::CallWindowProc
143 (
144 CASTWNDPROC spin->GetBuddyWndProc(),
145 hwnd,
146 message,
147 wParam,
148 lParam
149 );
150 dlgCode |= DLGC_WANTMESSAGE;
151 return dlgCode;
152 }
153 break;
154 }
155
156 return ::CallWindowProc(CASTWNDPROC spin->GetBuddyWndProc(),
157 hwnd, message, wParam, lParam);
158 }
159
160 /* static */
161 wxSpinCtrl *wxSpinCtrl::GetSpinForTextCtrl(WXHWND hwndBuddy)
162 {
163 const SpinForTextCtrl::const_iterator
164 it = gs_spinForTextCtrl.find(hwndBuddy);
165 if ( it == gs_spinForTextCtrl.end() )
166 return NULL;
167
168 wxSpinCtrl * const spin = it->second;
169
170 // sanity check
171 wxASSERT_MSG( spin->m_hwndBuddy == hwndBuddy,
172 wxT("wxSpinCtrl has incorrect buddy HWND!") );
173
174 return spin;
175 }
176
177 // process a WM_COMMAND generated by the buddy text control
178 bool wxSpinCtrl::ProcessTextCommand(WXWORD cmd, WXWORD WXUNUSED(id))
179 {
180 if ( (cmd == EN_CHANGE) && (!m_blockEvent ))
181 {
182 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
183 event.SetEventObject(this);
184 wxString val = wxGetWindowText(m_hwndBuddy);
185 event.SetString(val);
186 event.SetInt(GetValue());
187 return HandleWindowEvent(event);
188 }
189
190 // not processed
191 return false;
192 }
193
194 void wxSpinCtrl::OnChar(wxKeyEvent& event)
195 {
196 switch ( event.GetKeyCode() )
197 {
198 case WXK_RETURN:
199 {
200 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_windowId);
201 InitCommandEvent(event);
202 wxString val = wxGetWindowText(m_hwndBuddy);
203 event.SetString(val);
204 event.SetInt(GetValue());
205 if ( HandleWindowEvent(event) )
206 return;
207 break;
208 }
209
210 case WXK_TAB:
211 // always produce navigation event - even if we process TAB
212 // ourselves the fact that we got here means that the user code
213 // decided to skip processing of this TAB - probably to let it
214 // do its default job.
215 {
216 wxNavigationKeyEvent eventNav;
217 eventNav.SetDirection(!event.ShiftDown());
218 eventNav.SetWindowChange(event.ControlDown());
219 eventNav.SetEventObject(this);
220
221 if ( GetParent()->HandleWindowEvent(eventNav) )
222 return;
223 }
224 break;
225 }
226
227 // no, we didn't process it
228 event.Skip();
229 }
230
231 void wxSpinCtrl::OnKillFocus(wxFocusEvent& event)
232 {
233 // ensure that a correct value is shown by the control
234 NormalizeValue();
235 event.Skip();
236 }
237
238 void wxSpinCtrl::OnSetFocus(wxFocusEvent& event)
239 {
240 // when we get focus, give it to our buddy window as it needs it more than
241 // we do
242 ::SetFocus((HWND)m_hwndBuddy);
243
244 event.Skip();
245 }
246
247 void wxSpinCtrl::NormalizeValue()
248 {
249 const int value = GetValue();
250 const bool changed = value != m_oldValue;
251
252 // notice that we have to call SetValue() even if the value didn't change
253 // because otherwise we could be left with empty buddy control when value
254 // is 0, see comment in SetValue()
255 SetValue(value);
256
257 if ( changed )
258 {
259 SendSpinUpdate(value);
260 }
261 }
262
263 // ----------------------------------------------------------------------------
264 // construction
265 // ----------------------------------------------------------------------------
266
267 void wxSpinCtrl::Init()
268 {
269 m_blockEvent = false;
270 m_hwndBuddy = NULL;
271 m_wndProcBuddy = NULL;
272 m_oldValue = INT_MIN;
273 }
274
275 bool wxSpinCtrl::Create(wxWindow *parent,
276 wxWindowID id,
277 const wxString& value,
278 const wxPoint& pos,
279 const wxSize& size,
280 long style,
281 int min, int max, int initial,
282 const wxString& name)
283 {
284 // before using DoGetBestSize(), have to set style to let the base class
285 // know whether this is a horizontal or vertical control (we're always
286 // vertical)
287 style |= wxSP_VERTICAL;
288
289 if ( (style & wxBORDER_MASK) == wxBORDER_DEFAULT )
290 #ifdef __WXWINCE__
291 style |= wxBORDER_SIMPLE;
292 #else
293 style |= wxBORDER_SUNKEN;
294 #endif
295
296 SetWindowStyle(style);
297
298 WXDWORD exStyle = 0;
299 WXDWORD msStyle = MSWGetStyle(GetWindowStyle(), & exStyle) ;
300
301 // propagate text alignment style to text ctrl
302 if ( style & wxALIGN_RIGHT )
303 msStyle |= ES_RIGHT;
304 else if ( style & wxALIGN_CENTER )
305 msStyle |= ES_CENTER;
306
307 // calculate the sizes: the size given is the total size for both controls
308 // and we need to fit them both in the given width (height is the same)
309 wxSize sizeText(size), sizeBtn(size);
310 sizeBtn.x = wxSpinButton::DoGetBestSize().x;
311 if ( sizeText.x <= 0 )
312 {
313 // DEFAULT_ITEM_WIDTH is the default width for the text control
314 sizeText.x = DEFAULT_ITEM_WIDTH + MARGIN_BETWEEN + sizeBtn.x;
315 }
316
317 sizeText.x -= sizeBtn.x + MARGIN_BETWEEN;
318 if ( sizeText.x <= 0 )
319 {
320 wxLogDebug(wxT("not enough space for wxSpinCtrl!"));
321 }
322
323 wxPoint posBtn(pos);
324 posBtn.x += sizeText.x + MARGIN_BETWEEN;
325
326 // we must create the text control before the spin button for the purpose
327 // of the dialog navigation: if there is a static text just before the spin
328 // control, activating it by Alt-letter should give focus to the text
329 // control, not the spin and the dialog navigation code will give focus to
330 // the next control (at Windows level), not the one after it
331
332 // create the text window
333
334 m_hwndBuddy = (WXHWND)::CreateWindowEx
335 (
336 exStyle, // sunken border
337 wxT("EDIT"), // window class
338 NULL, // no window title
339 msStyle, // style (will be shown later)
340 pos.x, pos.y, // position
341 0, 0, // size (will be set later)
342 GetHwndOf(parent), // parent
343 (HMENU)-1, // control id
344 wxGetInstance(), // app instance
345 NULL // unused client data
346 );
347
348 if ( !m_hwndBuddy )
349 {
350 wxLogLastError(wxT("CreateWindow(buddy text window)"));
351
352 return false;
353 }
354
355
356 // create the spin button
357 if ( !wxSpinButton::Create(parent, id, posBtn, sizeBtn, style, name) )
358 {
359 return false;
360 }
361
362 wxSpinButtonBase::SetRange(min, max);
363
364 // subclass the text ctrl to be able to intercept some events
365 gs_spinForTextCtrl[GetBuddyHwnd()] = this;
366
367 m_wndProcBuddy = (WXFARPROC)wxSetWindowProc(GetBuddyHwnd(),
368 wxBuddyTextWndProc);
369
370 // set up fonts and colours (This is nomally done in MSWCreateControl)
371 InheritAttributes();
372 if (!m_hasFont)
373 SetFont(GetDefaultAttributes().font);
374
375 // set the size of the text window - can do it only now, because we
376 // couldn't call DoGetBestSize() before as font wasn't set
377 if ( sizeText.y <= 0 )
378 {
379 int cx, cy;
380 wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
381
382 sizeText.y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
383 }
384
385 SetInitialSize(size);
386
387 (void)::ShowWindow(GetBuddyHwnd(), SW_SHOW);
388
389 // associate the text window with the spin button
390 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY, (WPARAM)m_hwndBuddy, 0);
391
392 // If the initial text value is actually a number, it overrides the
393 // "initial" argument specified later.
394 long initialFromText;
395 if ( value.ToLong(&initialFromText) )
396 initial = initialFromText;
397
398 SetValue(initial);
399
400 m_oldValue = initial;
401
402 // Set the range in the native control
403 SetRange(min, max);
404
405 // Also set the text part of the control if it was specified independently
406 // but don't generate an event for this, it would be unexpected.
407 m_blockEvent = true;
408 if ( !value.empty() )
409 SetValue(value);
410 m_blockEvent = false;
411
412 return true;
413 }
414
415 wxSpinCtrl::~wxSpinCtrl()
416 {
417 // destroy the buddy window because this pointer which wxBuddyTextWndProc
418 // uses will not soon be valid any more
419 ::DestroyWindow( GetBuddyHwnd() );
420
421 gs_spinForTextCtrl.erase(GetBuddyHwnd());
422 }
423
424 // ----------------------------------------------------------------------------
425 // wxTextCtrl-like methods
426 // ----------------------------------------------------------------------------
427
428 void wxSpinCtrl::SetValue(const wxString& text)
429 {
430 if ( !::SetWindowText(GetBuddyHwnd(), text.c_str()) )
431 {
432 wxLogLastError(wxT("SetWindowText(buddy)"));
433 }
434 }
435
436 void wxSpinCtrl::SetValue(int val)
437 {
438 m_blockEvent = true;
439
440 wxSpinButton::SetValue(val);
441
442 // normally setting the value of the spin button is enough as it updates
443 // its buddy control automatically ...
444 if ( wxGetWindowText(m_hwndBuddy).empty() )
445 {
446 // ... but sometimes it doesn't, notably when the value is 0 and the
447 // text control is currently empty, the spin button seems to be happy
448 // to leave it like this, while we really want to always show the
449 // current value in the control, so do it manually
450 ::SetWindowText(GetBuddyHwnd(),
451 wxString::Format(wxT("%d"), val).wx_str());
452 }
453
454 m_oldValue = GetValue();
455
456 m_blockEvent = false;
457 }
458
459 int wxSpinCtrl::GetValue() const
460 {
461 wxString val = wxGetWindowText(m_hwndBuddy);
462
463 long n;
464 if ( (wxSscanf(val, wxT("%ld"), &n) != 1) )
465 n = INT_MIN;
466
467 if ( n < m_min )
468 n = m_min;
469 if ( n > m_max )
470 n = m_max;
471
472 return n;
473 }
474
475 void wxSpinCtrl::SetSelection(long from, long to)
476 {
477 // if from and to are both -1, it means (in wxWidgets) that all text should
478 // be selected - translate into Windows convention
479 if ( (from == -1) && (to == -1) )
480 {
481 from = 0;
482 }
483
484 ::SendMessage(GetBuddyHwnd(), EM_SETSEL, (WPARAM)from, (LPARAM)to);
485 }
486
487 // ----------------------------------------------------------------------------
488 // wxSpinButton methods
489 // ----------------------------------------------------------------------------
490
491 void wxSpinCtrl::SetRange(int minVal, int maxVal)
492 {
493 wxSpinButton::SetRange(minVal, maxVal);
494
495 // this control is used for numeric entry so restrict the input to numeric
496 // keys only -- but only if we don't need to be able to enter "-" in it as
497 // otherwise this would become impossible
498 const DWORD styleOld = ::GetWindowLong(GetBuddyHwnd(), GWL_STYLE);
499 DWORD styleNew;
500 if ( minVal < 0 )
501 styleNew = styleOld & ~ES_NUMBER;
502 else
503 styleNew = styleOld | ES_NUMBER;
504
505 if ( styleNew != styleOld )
506 ::SetWindowLong(GetBuddyHwnd(), GWL_STYLE, styleNew);
507 }
508
509 // ----------------------------------------------------------------------------
510 // forward some methods to subcontrols
511 // ----------------------------------------------------------------------------
512
513 bool wxSpinCtrl::SetFont(const wxFont& font)
514 {
515 if ( !wxWindowBase::SetFont(font) )
516 {
517 // nothing to do
518 return false;
519 }
520
521 WXHANDLE hFont = GetFont().GetResourceHandle();
522 (void)::SendMessage(GetBuddyHwnd(), WM_SETFONT, (WPARAM)hFont, TRUE);
523
524 return true;
525 }
526
527 bool wxSpinCtrl::Show(bool show)
528 {
529 if ( !wxControl::Show(show) )
530 {
531 return false;
532 }
533
534 ::ShowWindow(GetBuddyHwnd(), show ? SW_SHOW : SW_HIDE);
535
536 return true;
537 }
538
539 bool wxSpinCtrl::Reparent(wxWindowBase *newParent)
540 {
541 // Reparenting both the updown control and its buddy does not seem to work:
542 // they continue to be connected somehow, but visually there is no feedback
543 // on the buddy edit control. To avoid this problem, we reparent the buddy
544 // window normally, but we recreate the updown control and reassign its
545 // buddy.
546
547 // Get the position before changing the parent as it would be offset after
548 // changing it.
549 const wxRect rect = GetRect();
550
551 if ( !wxWindowBase::Reparent(newParent) )
552 return false;
553
554 newParent->GetChildren().DeleteObject(this);
555
556 // destroy the old spin button after detaching it from this wxWindow object
557 // (notice that m_hWnd will be reset by UnsubclassWin() so save it first)
558 const HWND hwndOld = GetHwnd();
559 UnsubclassWin();
560 if ( !::DestroyWindow(hwndOld) )
561 {
562 wxLogLastError(wxT("DestroyWindow"));
563 }
564
565 // create and initialize the new one
566 if ( !wxSpinButton::Create(GetParent(), GetId(),
567 rect.GetPosition(), rect.GetSize(),
568 GetWindowStyle(), GetName()) )
569 return false;
570
571 // reapply our values to wxSpinButton
572 wxSpinButton::SetValue(GetValue());
573 SetRange(m_min, m_max);
574
575 // also set the size again with wxSIZE_ALLOW_MINUS_ONE flag: this is
576 // necessary if our original position used -1 for either x or y
577 SetSize(rect, wxSIZE_ALLOW_MINUS_ONE);
578
579 // associate it with the buddy control again
580 ::SetParent(GetBuddyHwnd(), GetHwndOf(GetParent()));
581 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY, (WPARAM)GetBuddyHwnd(), 0);
582
583 return true;
584 }
585
586 bool wxSpinCtrl::Enable(bool enable)
587 {
588 if ( !wxControl::Enable(enable) )
589 {
590 return false;
591 }
592
593 MSWEnableHWND(GetBuddyHwnd(), enable);
594
595 return true;
596 }
597
598 void wxSpinCtrl::SetFocus()
599 {
600 ::SetFocus(GetBuddyHwnd());
601 }
602
603 #if wxUSE_TOOLTIPS
604
605 void wxSpinCtrl::DoSetToolTip(wxToolTip *tip)
606 {
607 wxSpinButton::DoSetToolTip(tip);
608
609 if ( tip )
610 tip->AddOtherWindow(m_hwndBuddy);
611 }
612
613 #endif // wxUSE_TOOLTIPS
614
615 // ----------------------------------------------------------------------------
616 // events processing and generation
617 // ----------------------------------------------------------------------------
618
619 void wxSpinCtrl::SendSpinUpdate(int value)
620 {
621 wxCommandEvent event(wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());
622 event.SetEventObject(this);
623 event.SetInt(value);
624
625 (void)HandleWindowEvent(event);
626
627 m_oldValue = value;
628 }
629
630 bool wxSpinCtrl::MSWOnScroll(int WXUNUSED(orientation), WXWORD wParam,
631 WXWORD pos, WXHWND control)
632 {
633 wxCHECK_MSG( control, false, wxT("scrolling what?") );
634
635 if ( wParam != SB_THUMBPOSITION )
636 {
637 // probable SB_ENDSCROLL - we don't react to it
638 return false;
639 }
640
641 int new_value = (short) pos;
642 if (m_oldValue != new_value)
643 SendSpinUpdate( new_value );
644
645 return TRUE;
646 }
647
648 bool wxSpinCtrl::MSWOnNotify(int WXUNUSED(idCtrl), WXLPARAM lParam, WXLPARAM *result)
649 {
650 NM_UPDOWN *lpnmud = (NM_UPDOWN *)lParam;
651
652 if (lpnmud->hdr.hwndFrom != GetHwnd()) // make sure it is the right control
653 return false;
654
655 *result = 0; // never reject UP and DOWN events
656
657 return TRUE;
658 }
659
660
661 // ----------------------------------------------------------------------------
662 // size calculations
663 // ----------------------------------------------------------------------------
664
665 wxSize wxSpinCtrl::DoGetBestSize() const
666 {
667 wxSize sizeBtn = wxSpinButton::DoGetBestSize();
668 sizeBtn.x += DEFAULT_ITEM_WIDTH + MARGIN_BETWEEN;
669
670 int y;
671 wxGetCharSize(GetHWND(), NULL, &y, GetFont());
672 y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(y);
673
674 // JACS: we should always use the height calculated
675 // from above, because otherwise we'll get a spin control
676 // that's too big. So never use the height calculated
677 // from wxSpinButton::DoGetBestSize().
678
679 // if ( sizeBtn.y < y )
680 {
681 // make the text tall enough
682 sizeBtn.y = y;
683 }
684
685 return sizeBtn;
686 }
687
688 void wxSpinCtrl::DoMoveWindow(int x, int y, int width, int height)
689 {
690 int widthBtn = wxSpinButton::DoGetBestSize().x;
691 int widthText = width - widthBtn - MARGIN_BETWEEN;
692 if ( widthText <= 0 )
693 {
694 wxLogDebug(wxT("not enough space for wxSpinCtrl!"));
695 }
696
697 // 1) The buddy window
698 DoMoveSibling(m_hwndBuddy, x, y, widthText, height);
699
700 // 2) The button window
701 x += widthText + MARGIN_BETWEEN;
702 wxSpinButton::DoMoveWindow(x, y, widthBtn, height);
703 }
704
705 // get total size of the control
706 void wxSpinCtrl::DoGetSize(int *x, int *y) const
707 {
708 RECT spinrect, textrect, ctrlrect;
709 GetWindowRect(GetHwnd(), &spinrect);
710 GetWindowRect(GetBuddyHwnd(), &textrect);
711 UnionRect(&ctrlrect,&textrect, &spinrect);
712
713 if ( x )
714 *x = ctrlrect.right - ctrlrect.left;
715 if ( y )
716 *y = ctrlrect.bottom - ctrlrect.top;
717 }
718
719 void wxSpinCtrl::DoGetClientSize(int *x, int *y) const
720 {
721 RECT spinrect = wxGetClientRect(GetHwnd());
722 RECT textrect = wxGetClientRect(GetBuddyHwnd());
723 RECT ctrlrect;
724 UnionRect(&ctrlrect,&textrect, &spinrect);
725
726 if ( x )
727 *x = ctrlrect.right - ctrlrect.left;
728 if ( y )
729 *y = ctrlrect.bottom - ctrlrect.top;
730 }
731
732 void wxSpinCtrl::DoGetPosition(int *x, int *y) const
733 {
734 // hack: pretend that our HWND is the text control just for a moment
735 WXHWND hWnd = GetHWND();
736 wxConstCast(this, wxSpinCtrl)->m_hWnd = m_hwndBuddy;
737
738 wxSpinButton::DoGetPosition(x, y);
739
740 wxConstCast(this, wxSpinCtrl)->m_hWnd = hWnd;
741 }
742
743 #endif // wxUSE_SPINCTRL