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