1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/spinctrl.cpp
3 // Purpose: wxSpinCtrl class implementation for Win32
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 1999-2005 Vadim Zeitlin
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // for compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
29 #include "wx/spinctrl.h"
32 #include "wx/hashmap.h"
33 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
35 #include "wx/textctrl.h"
36 #include "wx/wxcrtvararg.h"
39 #include "wx/msw/private.h"
42 #include "wx/tooltip.h"
43 #endif // wxUSE_TOOLTIPS
45 #include <limits.h> // for INT_MIN
47 // ----------------------------------------------------------------------------
49 // ----------------------------------------------------------------------------
51 BEGIN_EVENT_TABLE(wxSpinCtrl
, wxSpinButton
)
52 EVT_CHAR(wxSpinCtrl::OnChar
)
53 EVT_SET_FOCUS(wxSpinCtrl::OnSetFocus
)
54 EVT_KILL_FOCUS(wxSpinCtrl::OnKillFocus
)
57 #define GetBuddyHwnd() (HWND)(m_hwndBuddy)
59 // ----------------------------------------------------------------------------
61 // ----------------------------------------------------------------------------
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
66 static const int MARGIN_BETWEEN
= 1;
69 // ---------------------------------------------------------------------------
71 // ---------------------------------------------------------------------------
76 // Global hash used to find the spin control corresponding to the given buddy
78 WX_DECLARE_HASH_MAP(HWND
, wxSpinCtrl
*,
79 wxPointerHash
, wxPointerEqual
,
82 SpinForTextCtrl gs_spinForTextCtrl
;
84 } // anonymous namespace
86 // ============================================================================
88 // ============================================================================
90 // ----------------------------------------------------------------------------
91 // wnd proc for the buddy text ctrl
92 // ----------------------------------------------------------------------------
94 LRESULT APIENTRY _EXPORT
wxBuddyTextWndProc(HWND hwnd
,
99 wxSpinCtrl
* const spin
= wxSpinCtrl::GetSpinForTextCtrl(hwnd
);
101 // forward some messages (mostly the key and focus ones) to the spin ctrl
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() )
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
122 spin
->MSWWindowProc(message
, wParam
, lParam
);
124 // The control may have been deleted at this point, so check.
125 if ( !::IsWindow(hwnd
) )
130 if ( spin
->HasFlag(wxTE_PROCESS_ENTER
) )
132 long dlgCode
= ::CallWindowProc
134 CASTWNDPROC spin
->GetBuddyWndProc(),
140 dlgCode
|= DLGC_WANTMESSAGE
;
146 return ::CallWindowProc(CASTWNDPROC spin
->GetBuddyWndProc(),
147 hwnd
, message
, wParam
, lParam
);
151 wxSpinCtrl
*wxSpinCtrl::GetSpinForTextCtrl(WXHWND hwndBuddy
)
153 const SpinForTextCtrl::const_iterator
154 it
= gs_spinForTextCtrl
.find(hwndBuddy
);
155 if ( it
== gs_spinForTextCtrl
.end() )
158 wxSpinCtrl
* const spin
= it
->second
;
161 wxASSERT_MSG( spin
->m_hwndBuddy
== hwndBuddy
,
162 wxT("wxSpinCtrl has incorrect buddy HWND!") );
167 // process a WM_COMMAND generated by the buddy text control
168 bool wxSpinCtrl::ProcessTextCommand(WXWORD cmd
, WXWORD
WXUNUSED(id
))
170 if ( (cmd
== EN_CHANGE
) && (!m_blockEvent
))
172 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, GetId());
173 event
.SetEventObject(this);
174 wxString val
= wxGetWindowText(m_hwndBuddy
);
175 event
.SetString(val
);
176 event
.SetInt(GetValue());
177 return HandleWindowEvent(event
);
184 void wxSpinCtrl::OnChar(wxKeyEvent
& event
)
186 switch ( event
.GetKeyCode() )
190 wxCommandEvent
event(wxEVT_COMMAND_TEXT_ENTER
, m_windowId
);
191 InitCommandEvent(event
);
192 wxString val
= wxGetWindowText(m_hwndBuddy
);
193 event
.SetString(val
);
194 event
.SetInt(GetValue());
195 if ( HandleWindowEvent(event
) )
201 // always produce navigation event - even if we process TAB
202 // ourselves the fact that we got here means that the user code
203 // decided to skip processing of this TAB - probably to let it
204 // do its default job.
206 wxNavigationKeyEvent eventNav
;
207 eventNav
.SetDirection(!event
.ShiftDown());
208 eventNav
.SetWindowChange(event
.ControlDown());
209 eventNav
.SetEventObject(this);
211 if ( GetParent()->HandleWindowEvent(eventNav
) )
217 // no, we didn't process it
221 void wxSpinCtrl::OnKillFocus(wxFocusEvent
& event
)
223 // ensure that a correct value is shown by the control
228 void wxSpinCtrl::OnSetFocus(wxFocusEvent
& event
)
230 // when we get focus, give it to our buddy window as it needs it more than
232 ::SetFocus((HWND
)m_hwndBuddy
);
237 void wxSpinCtrl::NormalizeValue()
239 const int value
= GetValue();
240 const bool changed
= value
!= m_oldValue
;
242 // notice that we have to call SetValue() even if the value didn't change
243 // because otherwise we could be left with empty buddy control when value
244 // is 0, see comment in SetValue()
249 SendSpinUpdate(value
);
253 // ----------------------------------------------------------------------------
255 // ----------------------------------------------------------------------------
257 bool wxSpinCtrl::Create(wxWindow
*parent
,
259 const wxString
& value
,
263 int min
, int max
, int initial
,
264 const wxString
& name
)
266 m_blockEvent
= false;
268 // this should be in ctor/init function but I don't want to add one to 2.8
269 // to avoid problems with default ctor which can be inlined in the user
270 // code and so might not get this fix without recompilation
271 m_oldValue
= INT_MIN
;
273 // before using DoGetBestSize(), have to set style to let the base class
274 // know whether this is a horizontal or vertical control (we're always
276 style
|= wxSP_VERTICAL
;
278 if ( (style
& wxBORDER_MASK
) == wxBORDER_DEFAULT
)
280 style
|= wxBORDER_SIMPLE
;
282 style
|= wxBORDER_SUNKEN
;
285 SetWindowStyle(style
);
288 WXDWORD msStyle
= MSWGetStyle(GetWindowStyle(), & exStyle
) ;
290 // propagate text alignment style to text ctrl
291 if ( style
& wxALIGN_RIGHT
)
293 else if ( style
& wxALIGN_CENTER
)
294 msStyle
|= ES_CENTER
;
296 // calculate the sizes: the size given is the total size for both controls
297 // and we need to fit them both in the given width (height is the same)
298 wxSize
sizeText(size
), sizeBtn(size
);
299 sizeBtn
.x
= wxSpinButton::DoGetBestSize().x
;
300 if ( sizeText
.x
<= 0 )
302 // DEFAULT_ITEM_WIDTH is the default width for the text control
303 sizeText
.x
= DEFAULT_ITEM_WIDTH
+ MARGIN_BETWEEN
+ sizeBtn
.x
;
306 sizeText
.x
-= sizeBtn
.x
+ MARGIN_BETWEEN
;
307 if ( sizeText
.x
<= 0 )
309 wxLogDebug(wxT("not enough space for wxSpinCtrl!"));
313 posBtn
.x
+= sizeText
.x
+ MARGIN_BETWEEN
;
315 // we must create the text control before the spin button for the purpose
316 // of the dialog navigation: if there is a static text just before the spin
317 // control, activating it by Alt-letter should give focus to the text
318 // control, not the spin and the dialog navigation code will give focus to
319 // the next control (at Windows level), not the one after it
321 // create the text window
323 m_hwndBuddy
= (WXHWND
)::CreateWindowEx
325 exStyle
, // sunken border
326 wxT("EDIT"), // window class
327 NULL
, // no window title
328 msStyle
, // style (will be shown later)
329 pos
.x
, pos
.y
, // position
330 0, 0, // size (will be set later)
331 GetHwndOf(parent
), // parent
332 (HMENU
)-1, // control id
333 wxGetInstance(), // app instance
334 NULL
// unused client data
339 wxLogLastError(wxT("CreateWindow(buddy text window)"));
345 // create the spin button
346 if ( !wxSpinButton::Create(parent
, id
, posBtn
, sizeBtn
, style
, name
) )
351 wxSpinButtonBase::SetRange(min
, max
);
353 // subclass the text ctrl to be able to intercept some events
354 gs_spinForTextCtrl
[GetBuddyHwnd()] = this;
356 m_wndProcBuddy
= (WXFARPROC
)wxSetWindowProc(GetBuddyHwnd(),
359 // set up fonts and colours (This is nomally done in MSWCreateControl)
362 SetFont(GetDefaultAttributes().font
);
364 // set the size of the text window - can do it only now, because we
365 // couldn't call DoGetBestSize() before as font wasn't set
366 if ( sizeText
.y
<= 0 )
369 wxGetCharSize(GetHWND(), &cx
, &cy
, GetFont());
371 sizeText
.y
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy
);
374 SetInitialSize(size
);
376 (void)::ShowWindow(GetBuddyHwnd(), SW_SHOW
);
378 // associate the text window with the spin button
379 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY
, (WPARAM
)m_hwndBuddy
, 0);
383 // Set the range in the native control
386 if ( !value
.empty() )
389 m_oldValue
= (int) wxAtol(value
);
393 SetValue(wxString::Format(wxT("%d"), initial
));
394 m_oldValue
= initial
;
400 wxSpinCtrl::~wxSpinCtrl()
402 // destroy the buddy window because this pointer which wxBuddyTextWndProc
403 // uses will not soon be valid any more
404 ::DestroyWindow( GetBuddyHwnd() );
406 gs_spinForTextCtrl
.erase(GetBuddyHwnd());
409 // ----------------------------------------------------------------------------
410 // wxTextCtrl-like methods
411 // ----------------------------------------------------------------------------
413 void wxSpinCtrl::SetValue(const wxString
& text
)
415 if ( !::SetWindowText(GetBuddyHwnd(), text
.c_str()) )
417 wxLogLastError(wxT("SetWindowText(buddy)"));
421 void wxSpinCtrl::SetValue(int val
)
425 wxSpinButton::SetValue(val
);
427 // normally setting the value of the spin button is enough as it updates
428 // its buddy control automatically ...
429 if ( wxGetWindowText(m_hwndBuddy
).empty() )
431 // ... but sometimes it doesn't, notably when the value is 0 and the
432 // text control is currently empty, the spin button seems to be happy
433 // to leave it like this, while we really want to always show the
434 // current value in the control, so do it manually
435 ::SetWindowText(GetBuddyHwnd(),
436 wxString::Format(wxT("%d"), val
).wx_str());
439 m_oldValue
= GetValue();
441 m_blockEvent
= false;
444 int wxSpinCtrl::GetValue() const
446 wxString val
= wxGetWindowText(m_hwndBuddy
);
449 if ( (wxSscanf(val
, wxT("%ld"), &n
) != 1) )
460 void wxSpinCtrl::SetSelection(long from
, long to
)
462 // if from and to are both -1, it means (in wxWidgets) that all text should
463 // be selected - translate into Windows convention
464 if ( (from
== -1) && (to
== -1) )
469 ::SendMessage(GetBuddyHwnd(), EM_SETSEL
, (WPARAM
)from
, (LPARAM
)to
);
472 // ----------------------------------------------------------------------------
473 // wxSpinButton methods
474 // ----------------------------------------------------------------------------
476 void wxSpinCtrl::SetRange(int minVal
, int maxVal
)
478 wxSpinButton::SetRange(minVal
, maxVal
);
480 // this control is used for numeric entry so restrict the input to numeric
481 // keys only -- but only if we don't need to be able to enter "-" in it as
482 // otherwise this would become impossible
483 const DWORD styleOld
= ::GetWindowLong(GetBuddyHwnd(), GWL_STYLE
);
486 styleNew
= styleOld
& ~ES_NUMBER
;
488 styleNew
= styleOld
| ES_NUMBER
;
490 if ( styleNew
!= styleOld
)
491 ::SetWindowLong(GetBuddyHwnd(), GWL_STYLE
, styleNew
);
494 // ----------------------------------------------------------------------------
495 // forward some methods to subcontrols
496 // ----------------------------------------------------------------------------
498 bool wxSpinCtrl::SetFont(const wxFont
& font
)
500 if ( !wxWindowBase::SetFont(font
) )
506 WXHANDLE hFont
= GetFont().GetResourceHandle();
507 (void)::SendMessage(GetBuddyHwnd(), WM_SETFONT
, (WPARAM
)hFont
, TRUE
);
512 bool wxSpinCtrl::Show(bool show
)
514 if ( !wxControl::Show(show
) )
519 ::ShowWindow(GetBuddyHwnd(), show
? SW_SHOW
: SW_HIDE
);
524 bool wxSpinCtrl::Reparent(wxWindowBase
*newParent
)
526 // Reparenting both the updown control and its buddy does not seem to work:
527 // they continue to be connected somehow, but visually there is no feedback
528 // on the buddy edit control. To avoid this problem, we reparent the buddy
529 // window normally, but we recreate the updown control and reassign its
532 // Get the position before changing the parent as it would be offset after
534 const wxRect rect
= GetRect();
536 if ( !wxWindowBase::Reparent(newParent
) )
539 newParent
->GetChildren().DeleteObject(this);
541 // destroy the old spin button after detaching it from this wxWindow object
542 // (notice that m_hWnd will be reset by UnsubclassWin() so save it first)
543 const HWND hwndOld
= GetHwnd();
545 if ( !::DestroyWindow(hwndOld
) )
547 wxLogLastError(wxT("DestroyWindow"));
550 // create and initialize the new one
551 if ( !wxSpinButton::Create(GetParent(), GetId(),
552 rect
.GetPosition(), rect
.GetSize(),
553 GetWindowStyle(), GetName()) )
556 // reapply our values to wxSpinButton
557 wxSpinButton::SetValue(GetValue());
558 SetRange(m_min
, m_max
);
560 // also set the size again with wxSIZE_ALLOW_MINUS_ONE flag: this is
561 // necessary if our original position used -1 for either x or y
562 SetSize(rect
, wxSIZE_ALLOW_MINUS_ONE
);
564 // associate it with the buddy control again
565 ::SetParent(GetBuddyHwnd(), GetHwndOf(GetParent()));
566 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY
, (WPARAM
)GetBuddyHwnd(), 0);
571 bool wxSpinCtrl::Enable(bool enable
)
573 if ( !wxControl::Enable(enable
) )
578 MSWEnableHWND(GetBuddyHwnd(), enable
);
583 void wxSpinCtrl::SetFocus()
585 ::SetFocus(GetBuddyHwnd());
590 void wxSpinCtrl::DoSetToolTip(wxToolTip
*tip
)
592 wxSpinButton::DoSetToolTip(tip
);
595 tip
->Add(m_hwndBuddy
);
598 #endif // wxUSE_TOOLTIPS
600 // ----------------------------------------------------------------------------
601 // events processing and generation
602 // ----------------------------------------------------------------------------
604 void wxSpinCtrl::SendSpinUpdate(int value
)
606 wxCommandEvent
event(wxEVT_COMMAND_SPINCTRL_UPDATED
, GetId());
607 event
.SetEventObject(this);
610 (void)HandleWindowEvent(event
);
615 bool wxSpinCtrl::MSWOnScroll(int WXUNUSED(orientation
), WXWORD wParam
,
616 WXWORD pos
, WXHWND control
)
618 wxCHECK_MSG( control
, false, wxT("scrolling what?") );
620 if ( wParam
!= SB_THUMBPOSITION
)
622 // probable SB_ENDSCROLL - we don't react to it
626 int new_value
= (short) pos
;
627 if (m_oldValue
!= new_value
)
628 SendSpinUpdate( new_value
);
633 bool wxSpinCtrl::MSWOnNotify(int WXUNUSED(idCtrl
), WXLPARAM lParam
, WXLPARAM
*result
)
635 NM_UPDOWN
*lpnmud
= (NM_UPDOWN
*)lParam
;
637 if (lpnmud
->hdr
.hwndFrom
!= GetHwnd()) // make sure it is the right control
640 *result
= 0; // never reject UP and DOWN events
646 // ----------------------------------------------------------------------------
648 // ----------------------------------------------------------------------------
650 wxSize
wxSpinCtrl::DoGetBestSize() const
652 wxSize sizeBtn
= wxSpinButton::DoGetBestSize();
653 sizeBtn
.x
+= DEFAULT_ITEM_WIDTH
+ MARGIN_BETWEEN
;
656 wxGetCharSize(GetHWND(), NULL
, &y
, GetFont());
657 y
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(y
);
659 // JACS: we should always use the height calculated
660 // from above, because otherwise we'll get a spin control
661 // that's too big. So never use the height calculated
662 // from wxSpinButton::DoGetBestSize().
664 // if ( sizeBtn.y < y )
666 // make the text tall enough
673 void wxSpinCtrl::DoMoveWindow(int x
, int y
, int width
, int height
)
675 int widthBtn
= wxSpinButton::DoGetBestSize().x
;
676 int widthText
= width
- widthBtn
- MARGIN_BETWEEN
;
677 if ( widthText
<= 0 )
679 wxLogDebug(wxT("not enough space for wxSpinCtrl!"));
682 // 1) The buddy window
683 DoMoveSibling(m_hwndBuddy
, x
, y
, widthText
, height
);
685 // 2) The button window
686 x
+= widthText
+ MARGIN_BETWEEN
;
687 wxSpinButton::DoMoveWindow(x
, y
, widthBtn
, height
);
690 // get total size of the control
691 void wxSpinCtrl::DoGetSize(int *x
, int *y
) const
693 RECT spinrect
, textrect
, ctrlrect
;
694 GetWindowRect(GetHwnd(), &spinrect
);
695 GetWindowRect(GetBuddyHwnd(), &textrect
);
696 UnionRect(&ctrlrect
,&textrect
, &spinrect
);
699 *x
= ctrlrect
.right
- ctrlrect
.left
;
701 *y
= ctrlrect
.bottom
- ctrlrect
.top
;
704 void wxSpinCtrl::DoGetClientSize(int *x
, int *y
) const
706 RECT spinrect
= wxGetClientRect(GetHwnd());
707 RECT textrect
= wxGetClientRect(GetBuddyHwnd());
709 UnionRect(&ctrlrect
,&textrect
, &spinrect
);
712 *x
= ctrlrect
.right
- ctrlrect
.left
;
714 *y
= ctrlrect
.bottom
- ctrlrect
.top
;
717 void wxSpinCtrl::DoGetPosition(int *x
, int *y
) const
719 // hack: pretend that our HWND is the text control just for a moment
720 WXHWND hWnd
= GetHWND();
721 wxConstCast(this, wxSpinCtrl
)->m_hWnd
= m_hwndBuddy
;
723 wxSpinButton::DoGetPosition(x
, y
);
725 wxConstCast(this, wxSpinCtrl
)->m_hWnd
= hWnd
;
728 #endif // wxUSE_SPINCTRL