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
124 if ( spin
->MSWHandleMessage(&result
, message
, wParam
, lParam
) )
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.
133 // The control may have been deleted at this point, so check.
134 if ( !::IsWindow(hwnd
) )
140 if ( spin
->HasFlag(wxTE_PROCESS_ENTER
) )
142 long dlgCode
= ::CallWindowProc
144 CASTWNDPROC spin
->GetBuddyWndProc(),
150 dlgCode
|= DLGC_WANTMESSAGE
;
156 return ::CallWindowProc(CASTWNDPROC spin
->GetBuddyWndProc(),
157 hwnd
, message
, wParam
, lParam
);
161 wxSpinCtrl
*wxSpinCtrl
::GetSpinForTextCtrl(WXHWND hwndBuddy
)
163 const SpinForTextCtrl
::const_iterator
164 it
= gs_spinForTextCtrl
.find(hwndBuddy
);
165 if ( it
== gs_spinForTextCtrl
.end() )
168 wxSpinCtrl
* const spin
= it
->second
;
171 wxASSERT_MSG( spin
->m_hwndBuddy
== hwndBuddy
,
172 wxT("wxSpinCtrl has incorrect buddy HWND!") );
177 // process a WM_COMMAND generated by the buddy text control
178 bool wxSpinCtrl
::ProcessTextCommand(WXWORD cmd
, WXWORD
WXUNUSED(id
))
180 if ( (cmd
== EN_CHANGE
) && (!m_blockEvent
))
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
);
194 void wxSpinCtrl
::OnChar(wxKeyEvent
& event
)
196 switch ( event
.GetKeyCode() )
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
) )
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.
216 wxNavigationKeyEvent eventNav
;
217 eventNav
.SetDirection(!event
.ShiftDown());
218 eventNav
.SetWindowChange(event
.ControlDown());
219 eventNav
.SetEventObject(this);
221 if ( GetParent()->HandleWindowEvent(eventNav
) )
227 // no, we didn't process it
231 void wxSpinCtrl
::OnKillFocus(wxFocusEvent
& event
)
233 // ensure that a correct value is shown by the control
238 void wxSpinCtrl
::OnSetFocus(wxFocusEvent
& event
)
240 // when we get focus, give it to our buddy window as it needs it more than
242 ::SetFocus((HWND
)m_hwndBuddy
);
247 void wxSpinCtrl
::NormalizeValue()
249 const int value
= GetValue();
250 const bool changed
= value
!= m_oldValue
;
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()
259 SendSpinUpdate(value
);
263 // ----------------------------------------------------------------------------
265 // ----------------------------------------------------------------------------
267 void wxSpinCtrl
::Init()
269 m_blockEvent
= false;
271 m_wndProcBuddy
= NULL
;
272 m_oldValue
= INT_MIN
;
275 bool wxSpinCtrl
::Create(wxWindow
*parent
,
277 const wxString
& value
,
281 int min
, int max
, int initial
,
282 const wxString
& name
)
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
287 style
|= wxSP_VERTICAL
;
289 if ( (style
& wxBORDER_MASK
) == wxBORDER_DEFAULT
)
291 style
|= wxBORDER_SIMPLE
;
293 style
|= wxBORDER_SUNKEN
;
296 SetWindowStyle(style
);
299 WXDWORD msStyle
= MSWGetStyle(GetWindowStyle(), & exStyle
) ;
301 // propagate text alignment style to text ctrl
302 if ( style
& wxALIGN_RIGHT
)
304 else if ( style
& wxALIGN_CENTER
)
305 msStyle
|= ES_CENTER
;
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 )
313 // DEFAULT_ITEM_WIDTH is the default width for the text control
314 sizeText
.x
= DEFAULT_ITEM_WIDTH
+ MARGIN_BETWEEN
+ sizeBtn
.x
;
317 sizeText
.x
-= sizeBtn
.x
+ MARGIN_BETWEEN
;
318 if ( sizeText
.x
<= 0 )
320 wxLogDebug(wxT("not enough space for wxSpinCtrl!"));
324 posBtn
.x
+= sizeText
.x
+ MARGIN_BETWEEN
;
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
332 // create the text window
334 m_hwndBuddy
= (WXHWND
)::CreateWindowEx
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
350 wxLogLastError(wxT("CreateWindow(buddy text window)"));
356 // create the spin button
357 if ( !wxSpinButton
::Create(parent
, id
, posBtn
, sizeBtn
, style
, name
) )
362 wxSpinButtonBase
::SetRange(min
, max
);
364 // subclass the text ctrl to be able to intercept some events
365 gs_spinForTextCtrl
[GetBuddyHwnd()] = this;
367 m_wndProcBuddy
= (WXFARPROC
)wxSetWindowProc(GetBuddyHwnd(),
370 // set up fonts and colours (This is nomally done in MSWCreateControl)
373 SetFont(GetDefaultAttributes().font
);
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 )
380 wxGetCharSize(GetHWND(), &cx
, &cy
, GetFont());
382 sizeText
.y
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy
);
385 SetInitialSize(size
);
387 (void)::ShowWindow(GetBuddyHwnd(), SW_SHOW
);
389 // associate the text window with the spin button
390 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY
, (WPARAM
)m_hwndBuddy
, 0);
394 // Set the range in the native control
397 if ( !value
.empty() )
400 m_oldValue
= (int) wxAtol(value
);
404 SetValue(wxString
::Format(wxT("%d"), initial
));
405 m_oldValue
= initial
;
411 wxSpinCtrl
::~wxSpinCtrl()
413 // destroy the buddy window because this pointer which wxBuddyTextWndProc
414 // uses will not soon be valid any more
415 ::DestroyWindow( GetBuddyHwnd() );
417 gs_spinForTextCtrl
.erase(GetBuddyHwnd());
420 // ----------------------------------------------------------------------------
421 // wxTextCtrl-like methods
422 // ----------------------------------------------------------------------------
424 void wxSpinCtrl
::SetValue(const wxString
& text
)
426 if ( !::SetWindowText(GetBuddyHwnd(), text
.c_str()) )
428 wxLogLastError(wxT("SetWindowText(buddy)"));
432 void wxSpinCtrl
::SetValue(int val
)
436 wxSpinButton
::SetValue(val
);
438 // normally setting the value of the spin button is enough as it updates
439 // its buddy control automatically ...
440 if ( wxGetWindowText(m_hwndBuddy
).empty() )
442 // ... but sometimes it doesn't, notably when the value is 0 and the
443 // text control is currently empty, the spin button seems to be happy
444 // to leave it like this, while we really want to always show the
445 // current value in the control, so do it manually
446 ::SetWindowText(GetBuddyHwnd(),
447 wxString
::Format(wxT("%d"), val
).wx_str());
450 m_oldValue
= GetValue();
452 m_blockEvent
= false;
455 int wxSpinCtrl
::GetValue() const
457 wxString val
= wxGetWindowText(m_hwndBuddy
);
460 if ( (wxSscanf(val
, wxT("%ld"), &n
) != 1) )
471 void wxSpinCtrl
::SetSelection(long from
, long to
)
473 // if from and to are both -1, it means (in wxWidgets) that all text should
474 // be selected - translate into Windows convention
475 if ( (from
== -1) && (to
== -1) )
480 ::SendMessage(GetBuddyHwnd(), EM_SETSEL
, (WPARAM
)from
, (LPARAM
)to
);
483 // ----------------------------------------------------------------------------
484 // wxSpinButton methods
485 // ----------------------------------------------------------------------------
487 void wxSpinCtrl
::SetRange(int minVal
, int maxVal
)
489 wxSpinButton
::SetRange(minVal
, maxVal
);
491 // this control is used for numeric entry so restrict the input to numeric
492 // keys only -- but only if we don't need to be able to enter "-" in it as
493 // otherwise this would become impossible
494 const DWORD styleOld
= ::GetWindowLong(GetBuddyHwnd(), GWL_STYLE
);
497 styleNew
= styleOld
& ~ES_NUMBER
;
499 styleNew
= styleOld
| ES_NUMBER
;
501 if ( styleNew
!= styleOld
)
502 ::SetWindowLong(GetBuddyHwnd(), GWL_STYLE
, styleNew
);
505 // ----------------------------------------------------------------------------
506 // forward some methods to subcontrols
507 // ----------------------------------------------------------------------------
509 bool wxSpinCtrl
::SetFont(const wxFont
& font
)
511 if ( !wxWindowBase
::SetFont(font
) )
517 WXHANDLE hFont
= GetFont().GetResourceHandle();
518 (void)::SendMessage(GetBuddyHwnd(), WM_SETFONT
, (WPARAM
)hFont
, TRUE
);
523 bool wxSpinCtrl
::Show(bool show
)
525 if ( !wxControl
::Show(show
) )
530 ::ShowWindow(GetBuddyHwnd(), show ? SW_SHOW
: SW_HIDE
);
535 bool wxSpinCtrl
::Reparent(wxWindowBase
*newParent
)
537 // Reparenting both the updown control and its buddy does not seem to work:
538 // they continue to be connected somehow, but visually there is no feedback
539 // on the buddy edit control. To avoid this problem, we reparent the buddy
540 // window normally, but we recreate the updown control and reassign its
543 // Get the position before changing the parent as it would be offset after
545 const wxRect rect
= GetRect();
547 if ( !wxWindowBase
::Reparent(newParent
) )
550 newParent
->GetChildren().DeleteObject(this);
552 // destroy the old spin button after detaching it from this wxWindow object
553 // (notice that m_hWnd will be reset by UnsubclassWin() so save it first)
554 const HWND hwndOld
= GetHwnd();
556 if ( !::DestroyWindow(hwndOld
) )
558 wxLogLastError(wxT("DestroyWindow"));
561 // create and initialize the new one
562 if ( !wxSpinButton
::Create(GetParent(), GetId(),
563 rect
.GetPosition(), rect
.GetSize(),
564 GetWindowStyle(), GetName()) )
567 // reapply our values to wxSpinButton
568 wxSpinButton
::SetValue(GetValue());
569 SetRange(m_min
, m_max
);
571 // also set the size again with wxSIZE_ALLOW_MINUS_ONE flag: this is
572 // necessary if our original position used -1 for either x or y
573 SetSize(rect
, wxSIZE_ALLOW_MINUS_ONE
);
575 // associate it with the buddy control again
576 ::SetParent(GetBuddyHwnd(), GetHwndOf(GetParent()));
577 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY
, (WPARAM
)GetBuddyHwnd(), 0);
582 bool wxSpinCtrl
::Enable(bool enable
)
584 if ( !wxControl
::Enable(enable
) )
589 MSWEnableHWND(GetBuddyHwnd(), enable
);
594 void wxSpinCtrl
::SetFocus()
596 ::SetFocus(GetBuddyHwnd());
601 void wxSpinCtrl
::DoSetToolTip(wxToolTip
*tip
)
603 wxSpinButton
::DoSetToolTip(tip
);
606 tip
->Add(m_hwndBuddy
);
609 #endif // wxUSE_TOOLTIPS
611 // ----------------------------------------------------------------------------
612 // events processing and generation
613 // ----------------------------------------------------------------------------
615 void wxSpinCtrl
::SendSpinUpdate(int value
)
617 wxCommandEvent
event(wxEVT_COMMAND_SPINCTRL_UPDATED
, GetId());
618 event
.SetEventObject(this);
621 (void)HandleWindowEvent(event
);
626 bool wxSpinCtrl
::MSWOnScroll(int WXUNUSED(orientation
), WXWORD wParam
,
627 WXWORD pos
, WXHWND control
)
629 wxCHECK_MSG( control
, false, wxT("scrolling what?") );
631 if ( wParam
!= SB_THUMBPOSITION
)
633 // probable SB_ENDSCROLL - we don't react to it
637 int new_value
= (short) pos
;
638 if (m_oldValue
!= new_value
)
639 SendSpinUpdate( new_value
);
644 bool wxSpinCtrl
::MSWOnNotify(int WXUNUSED(idCtrl
), WXLPARAM lParam
, WXLPARAM
*result
)
646 NM_UPDOWN
*lpnmud
= (NM_UPDOWN
*)lParam
;
648 if (lpnmud
->hdr
.hwndFrom
!= GetHwnd()) // make sure it is the right control
651 *result
= 0; // never reject UP and DOWN events
657 // ----------------------------------------------------------------------------
659 // ----------------------------------------------------------------------------
661 wxSize wxSpinCtrl
::DoGetBestSize() const
663 wxSize sizeBtn
= wxSpinButton
::DoGetBestSize();
664 sizeBtn
.x
+= DEFAULT_ITEM_WIDTH
+ MARGIN_BETWEEN
;
667 wxGetCharSize(GetHWND(), NULL
, &y
, GetFont());
668 y
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(y
);
670 // JACS: we should always use the height calculated
671 // from above, because otherwise we'll get a spin control
672 // that's too big. So never use the height calculated
673 // from wxSpinButton::DoGetBestSize().
675 // if ( sizeBtn.y < y )
677 // make the text tall enough
684 void wxSpinCtrl
::DoMoveWindow(int x
, int y
, int width
, int height
)
686 int widthBtn
= wxSpinButton
::DoGetBestSize().x
;
687 int widthText
= width
- widthBtn
- MARGIN_BETWEEN
;
688 if ( widthText
<= 0 )
690 wxLogDebug(wxT("not enough space for wxSpinCtrl!"));
693 // 1) The buddy window
694 DoMoveSibling(m_hwndBuddy
, x
, y
, widthText
, height
);
696 // 2) The button window
697 x
+= widthText
+ MARGIN_BETWEEN
;
698 wxSpinButton
::DoMoveWindow(x
, y
, widthBtn
, height
);
701 // get total size of the control
702 void wxSpinCtrl
::DoGetSize(int *x
, int *y
) const
704 RECT spinrect
, textrect
, ctrlrect
;
705 GetWindowRect(GetHwnd(), &spinrect
);
706 GetWindowRect(GetBuddyHwnd(), &textrect
);
707 UnionRect(&ctrlrect
,&textrect
, &spinrect
);
710 *x
= ctrlrect
.right
- ctrlrect
.left
;
712 *y
= ctrlrect
.bottom
- ctrlrect
.top
;
715 void wxSpinCtrl
::DoGetClientSize(int *x
, int *y
) const
717 RECT spinrect
= wxGetClientRect(GetHwnd());
718 RECT textrect
= wxGetClientRect(GetBuddyHwnd());
720 UnionRect(&ctrlrect
,&textrect
, &spinrect
);
723 *x
= ctrlrect
.right
- ctrlrect
.left
;
725 *y
= ctrlrect
.bottom
- ctrlrect
.top
;
728 void wxSpinCtrl
::DoGetPosition(int *x
, int *y
) const
730 // hack: pretend that our HWND is the text control just for a moment
731 WXHWND hWnd
= GetHWND();
732 wxConstCast(this, wxSpinCtrl
)->m_hWnd
= m_hwndBuddy
;
734 wxSpinButton
::DoGetPosition(x
, y
);
736 wxConstCast(this, wxSpinCtrl
)->m_hWnd
= hWnd
;
739 #endif // wxUSE_SPINCTRL