]> git.saurik.com Git - wxWidgets.git/blob - src/msw/spinctrl.cpp
Return non-const pointer from wxDataViewRendererBase::GetView().
[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 bool wxSpinCtrl::Create(wxWindow *parent,
268 wxWindowID id,
269 const wxString& value,
270 const wxPoint& pos,
271 const wxSize& size,
272 long style,
273 int min, int max, int initial,
274 const wxString& name)
275 {
276 m_blockEvent = false;
277
278 // this should be in ctor/init function but I don't want to add one to 2.8
279 // to avoid problems with default ctor which can be inlined in the user
280 // code and so might not get this fix without recompilation
281 m_oldValue = INT_MIN;
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 // propagate text alignment style to text ctrl
301 if ( style & wxALIGN_RIGHT )
302 msStyle |= ES_RIGHT;
303 else if ( style & wxALIGN_CENTER )
304 msStyle |= ES_CENTER;
305
306 // calculate the sizes: the size given is the total size for both controls
307 // and we need to fit them both in the given width (height is the same)
308 wxSize sizeText(size), sizeBtn(size);
309 sizeBtn.x = wxSpinButton::DoGetBestSize().x;
310 if ( sizeText.x <= 0 )
311 {
312 // DEFAULT_ITEM_WIDTH is the default width for the text control
313 sizeText.x = DEFAULT_ITEM_WIDTH + MARGIN_BETWEEN + sizeBtn.x;
314 }
315
316 sizeText.x -= sizeBtn.x + MARGIN_BETWEEN;
317 if ( sizeText.x <= 0 )
318 {
319 wxLogDebug(wxT("not enough space for wxSpinCtrl!"));
320 }
321
322 wxPoint posBtn(pos);
323 posBtn.x += sizeText.x + MARGIN_BETWEEN;
324
325 // we must create the text control before the spin button for the purpose
326 // of the dialog navigation: if there is a static text just before the spin
327 // control, activating it by Alt-letter should give focus to the text
328 // control, not the spin and the dialog navigation code will give focus to
329 // the next control (at Windows level), not the one after it
330
331 // create the text window
332
333 m_hwndBuddy = (WXHWND)::CreateWindowEx
334 (
335 exStyle, // sunken border
336 wxT("EDIT"), // window class
337 NULL, // no window title
338 msStyle, // style (will be shown later)
339 pos.x, pos.y, // position
340 0, 0, // size (will be set later)
341 GetHwndOf(parent), // parent
342 (HMENU)-1, // control id
343 wxGetInstance(), // app instance
344 NULL // unused client data
345 );
346
347 if ( !m_hwndBuddy )
348 {
349 wxLogLastError(wxT("CreateWindow(buddy text window)"));
350
351 return false;
352 }
353
354
355 // create the spin button
356 if ( !wxSpinButton::Create(parent, id, posBtn, sizeBtn, style, name) )
357 {
358 return false;
359 }
360
361 wxSpinButtonBase::SetRange(min, max);
362
363 // subclass the text ctrl to be able to intercept some events
364 gs_spinForTextCtrl[GetBuddyHwnd()] = this;
365
366 m_wndProcBuddy = (WXFARPROC)wxSetWindowProc(GetBuddyHwnd(),
367 wxBuddyTextWndProc);
368
369 // set up fonts and colours (This is nomally done in MSWCreateControl)
370 InheritAttributes();
371 if (!m_hasFont)
372 SetFont(GetDefaultAttributes().font);
373
374 // set the size of the text window - can do it only now, because we
375 // couldn't call DoGetBestSize() before as font wasn't set
376 if ( sizeText.y <= 0 )
377 {
378 int cx, cy;
379 wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
380
381 sizeText.y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
382 }
383
384 SetInitialSize(size);
385
386 (void)::ShowWindow(GetBuddyHwnd(), SW_SHOW);
387
388 // associate the text window with the spin button
389 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY, (WPARAM)m_hwndBuddy, 0);
390
391 SetValue(initial);
392
393 // Set the range in the native control
394 SetRange(min, max);
395
396 if ( !value.empty() )
397 {
398 SetValue(value);
399 m_oldValue = (int) wxAtol(value);
400 }
401 else
402 {
403 SetValue(wxString::Format(wxT("%d"), initial));
404 m_oldValue = initial;
405 }
406
407 return true;
408 }
409
410 wxSpinCtrl::~wxSpinCtrl()
411 {
412 // destroy the buddy window because this pointer which wxBuddyTextWndProc
413 // uses will not soon be valid any more
414 ::DestroyWindow( GetBuddyHwnd() );
415
416 gs_spinForTextCtrl.erase(GetBuddyHwnd());
417 }
418
419 // ----------------------------------------------------------------------------
420 // wxTextCtrl-like methods
421 // ----------------------------------------------------------------------------
422
423 void wxSpinCtrl::SetValue(const wxString& text)
424 {
425 if ( !::SetWindowText(GetBuddyHwnd(), text.c_str()) )
426 {
427 wxLogLastError(wxT("SetWindowText(buddy)"));
428 }
429 }
430
431 void wxSpinCtrl::SetValue(int val)
432 {
433 m_blockEvent = true;
434
435 wxSpinButton::SetValue(val);
436
437 // normally setting the value of the spin button is enough as it updates
438 // its buddy control automatically ...
439 if ( wxGetWindowText(m_hwndBuddy).empty() )
440 {
441 // ... but sometimes it doesn't, notably when the value is 0 and the
442 // text control is currently empty, the spin button seems to be happy
443 // to leave it like this, while we really want to always show the
444 // current value in the control, so do it manually
445 ::SetWindowText(GetBuddyHwnd(),
446 wxString::Format(wxT("%d"), val).wx_str());
447 }
448
449 m_oldValue = GetValue();
450
451 m_blockEvent = false;
452 }
453
454 int wxSpinCtrl::GetValue() const
455 {
456 wxString val = wxGetWindowText(m_hwndBuddy);
457
458 long n;
459 if ( (wxSscanf(val, wxT("%ld"), &n) != 1) )
460 n = INT_MIN;
461
462 if ( n < m_min )
463 n = m_min;
464 if ( n > m_max )
465 n = m_max;
466
467 return n;
468 }
469
470 void wxSpinCtrl::SetSelection(long from, long to)
471 {
472 // if from and to are both -1, it means (in wxWidgets) that all text should
473 // be selected - translate into Windows convention
474 if ( (from == -1) && (to == -1) )
475 {
476 from = 0;
477 }
478
479 ::SendMessage(GetBuddyHwnd(), EM_SETSEL, (WPARAM)from, (LPARAM)to);
480 }
481
482 // ----------------------------------------------------------------------------
483 // wxSpinButton methods
484 // ----------------------------------------------------------------------------
485
486 void wxSpinCtrl::SetRange(int minVal, int maxVal)
487 {
488 wxSpinButton::SetRange(minVal, maxVal);
489
490 // this control is used for numeric entry so restrict the input to numeric
491 // keys only -- but only if we don't need to be able to enter "-" in it as
492 // otherwise this would become impossible
493 const DWORD styleOld = ::GetWindowLong(GetBuddyHwnd(), GWL_STYLE);
494 DWORD styleNew;
495 if ( minVal < 0 )
496 styleNew = styleOld & ~ES_NUMBER;
497 else
498 styleNew = styleOld | ES_NUMBER;
499
500 if ( styleNew != styleOld )
501 ::SetWindowLong(GetBuddyHwnd(), GWL_STYLE, styleNew);
502 }
503
504 // ----------------------------------------------------------------------------
505 // forward some methods to subcontrols
506 // ----------------------------------------------------------------------------
507
508 bool wxSpinCtrl::SetFont(const wxFont& font)
509 {
510 if ( !wxWindowBase::SetFont(font) )
511 {
512 // nothing to do
513 return false;
514 }
515
516 WXHANDLE hFont = GetFont().GetResourceHandle();
517 (void)::SendMessage(GetBuddyHwnd(), WM_SETFONT, (WPARAM)hFont, TRUE);
518
519 return true;
520 }
521
522 bool wxSpinCtrl::Show(bool show)
523 {
524 if ( !wxControl::Show(show) )
525 {
526 return false;
527 }
528
529 ::ShowWindow(GetBuddyHwnd(), show ? SW_SHOW : SW_HIDE);
530
531 return true;
532 }
533
534 bool wxSpinCtrl::Reparent(wxWindowBase *newParent)
535 {
536 // Reparenting both the updown control and its buddy does not seem to work:
537 // they continue to be connected somehow, but visually there is no feedback
538 // on the buddy edit control. To avoid this problem, we reparent the buddy
539 // window normally, but we recreate the updown control and reassign its
540 // buddy.
541
542 // Get the position before changing the parent as it would be offset after
543 // changing it.
544 const wxRect rect = GetRect();
545
546 if ( !wxWindowBase::Reparent(newParent) )
547 return false;
548
549 newParent->GetChildren().DeleteObject(this);
550
551 // destroy the old spin button after detaching it from this wxWindow object
552 // (notice that m_hWnd will be reset by UnsubclassWin() so save it first)
553 const HWND hwndOld = GetHwnd();
554 UnsubclassWin();
555 if ( !::DestroyWindow(hwndOld) )
556 {
557 wxLogLastError(wxT("DestroyWindow"));
558 }
559
560 // create and initialize the new one
561 if ( !wxSpinButton::Create(GetParent(), GetId(),
562 rect.GetPosition(), rect.GetSize(),
563 GetWindowStyle(), GetName()) )
564 return false;
565
566 // reapply our values to wxSpinButton
567 wxSpinButton::SetValue(GetValue());
568 SetRange(m_min, m_max);
569
570 // also set the size again with wxSIZE_ALLOW_MINUS_ONE flag: this is
571 // necessary if our original position used -1 for either x or y
572 SetSize(rect, wxSIZE_ALLOW_MINUS_ONE);
573
574 // associate it with the buddy control again
575 ::SetParent(GetBuddyHwnd(), GetHwndOf(GetParent()));
576 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY, (WPARAM)GetBuddyHwnd(), 0);
577
578 return true;
579 }
580
581 bool wxSpinCtrl::Enable(bool enable)
582 {
583 if ( !wxControl::Enable(enable) )
584 {
585 return false;
586 }
587
588 MSWEnableHWND(GetBuddyHwnd(), enable);
589
590 return true;
591 }
592
593 void wxSpinCtrl::SetFocus()
594 {
595 ::SetFocus(GetBuddyHwnd());
596 }
597
598 #if wxUSE_TOOLTIPS
599
600 void wxSpinCtrl::DoSetToolTip(wxToolTip *tip)
601 {
602 wxSpinButton::DoSetToolTip(tip);
603
604 if ( tip )
605 tip->Add(m_hwndBuddy);
606 }
607
608 #endif // wxUSE_TOOLTIPS
609
610 // ----------------------------------------------------------------------------
611 // events processing and generation
612 // ----------------------------------------------------------------------------
613
614 void wxSpinCtrl::SendSpinUpdate(int value)
615 {
616 wxCommandEvent event(wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());
617 event.SetEventObject(this);
618 event.SetInt(value);
619
620 (void)HandleWindowEvent(event);
621
622 m_oldValue = value;
623 }
624
625 bool wxSpinCtrl::MSWOnScroll(int WXUNUSED(orientation), WXWORD wParam,
626 WXWORD pos, WXHWND control)
627 {
628 wxCHECK_MSG( control, false, wxT("scrolling what?") );
629
630 if ( wParam != SB_THUMBPOSITION )
631 {
632 // probable SB_ENDSCROLL - we don't react to it
633 return false;
634 }
635
636 int new_value = (short) pos;
637 if (m_oldValue != new_value)
638 SendSpinUpdate( new_value );
639
640 return TRUE;
641 }
642
643 bool wxSpinCtrl::MSWOnNotify(int WXUNUSED(idCtrl), WXLPARAM lParam, WXLPARAM *result)
644 {
645 NM_UPDOWN *lpnmud = (NM_UPDOWN *)lParam;
646
647 if (lpnmud->hdr.hwndFrom != GetHwnd()) // make sure it is the right control
648 return false;
649
650 *result = 0; // never reject UP and DOWN events
651
652 return TRUE;
653 }
654
655
656 // ----------------------------------------------------------------------------
657 // size calculations
658 // ----------------------------------------------------------------------------
659
660 wxSize wxSpinCtrl::DoGetBestSize() const
661 {
662 wxSize sizeBtn = wxSpinButton::DoGetBestSize();
663 sizeBtn.x += DEFAULT_ITEM_WIDTH + MARGIN_BETWEEN;
664
665 int y;
666 wxGetCharSize(GetHWND(), NULL, &y, GetFont());
667 y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(y);
668
669 // JACS: we should always use the height calculated
670 // from above, because otherwise we'll get a spin control
671 // that's too big. So never use the height calculated
672 // from wxSpinButton::DoGetBestSize().
673
674 // if ( sizeBtn.y < y )
675 {
676 // make the text tall enough
677 sizeBtn.y = y;
678 }
679
680 return sizeBtn;
681 }
682
683 void wxSpinCtrl::DoMoveWindow(int x, int y, int width, int height)
684 {
685 int widthBtn = wxSpinButton::DoGetBestSize().x;
686 int widthText = width - widthBtn - MARGIN_BETWEEN;
687 if ( widthText <= 0 )
688 {
689 wxLogDebug(wxT("not enough space for wxSpinCtrl!"));
690 }
691
692 // 1) The buddy window
693 DoMoveSibling(m_hwndBuddy, x, y, widthText, height);
694
695 // 2) The button window
696 x += widthText + MARGIN_BETWEEN;
697 wxSpinButton::DoMoveWindow(x, y, widthBtn, height);
698 }
699
700 // get total size of the control
701 void wxSpinCtrl::DoGetSize(int *x, int *y) const
702 {
703 RECT spinrect, textrect, ctrlrect;
704 GetWindowRect(GetHwnd(), &spinrect);
705 GetWindowRect(GetBuddyHwnd(), &textrect);
706 UnionRect(&ctrlrect,&textrect, &spinrect);
707
708 if ( x )
709 *x = ctrlrect.right - ctrlrect.left;
710 if ( y )
711 *y = ctrlrect.bottom - ctrlrect.top;
712 }
713
714 void wxSpinCtrl::DoGetClientSize(int *x, int *y) const
715 {
716 RECT spinrect = wxGetClientRect(GetHwnd());
717 RECT textrect = wxGetClientRect(GetBuddyHwnd());
718 RECT ctrlrect;
719 UnionRect(&ctrlrect,&textrect, &spinrect);
720
721 if ( x )
722 *x = ctrlrect.right - ctrlrect.left;
723 if ( y )
724 *y = ctrlrect.bottom - ctrlrect.top;
725 }
726
727 void wxSpinCtrl::DoGetPosition(int *x, int *y) const
728 {
729 // hack: pretend that our HWND is the text control just for a moment
730 WXHWND hWnd = GetHWND();
731 wxConstCast(this, wxSpinCtrl)->m_hWnd = m_hwndBuddy;
732
733 wxSpinButton::DoGetPosition(x, y);
734
735 wxConstCast(this, wxSpinCtrl)->m_hWnd = hWnd;
736 }
737
738 #endif // wxUSE_SPINCTRL