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/msw/wrapcctl.h" // include <commctrl.h> "properly"
34 #include "wx/textctrl.h"
35 #include "wx/wxcrtvararg.h"
38 #include "wx/msw/private.h"
41 #include "wx/tooltip.h"
42 #endif // wxUSE_TOOLTIPS
44 #include <limits.h> // for INT_MIN
46 // ----------------------------------------------------------------------------
48 // ----------------------------------------------------------------------------
50 #if wxUSE_EXTENDED_RTTI
51 WX_DEFINE_FLAGS( wxSpinCtrlStyle
)
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
)
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
)
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
)
81 wxFLAGS_MEMBER(wxSP_HORIZONTAL
)
82 wxFLAGS_MEMBER(wxSP_VERTICAL
)
83 wxFLAGS_MEMBER(wxSP_ARROW_KEYS
)
84 wxFLAGS_MEMBER(wxSP_WRAP
)
86 wxEND_FLAGS( wxSpinCtrlStyle
)
88 IMPLEMENT_DYNAMIC_CLASS_XTI(wxSpinCtrl
, wxControl
,"wx/spinbut.h")
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
)
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
103 style wxSP_ARROW_KEYS
105 wxEND_PROPERTIES_TABLE()
107 wxBEGIN_HANDLERS_TABLE(wxSpinCtrl
)
108 wxEND_HANDLERS_TABLE()
110 wxCONSTRUCTOR_6( wxSpinCtrl
, wxWindow
* , Parent
, wxWindowID
, Id
, wxString
, ValueString
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
112 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl
, wxControl
)
115 BEGIN_EVENT_TABLE(wxSpinCtrl
, wxSpinButton
)
116 EVT_CHAR(wxSpinCtrl::OnChar
)
117 EVT_SET_FOCUS(wxSpinCtrl::OnSetFocus
)
118 EVT_KILL_FOCUS(wxSpinCtrl::OnKillFocus
)
121 #define GetBuddyHwnd() (HWND)(m_hwndBuddy)
123 // ----------------------------------------------------------------------------
125 // ----------------------------------------------------------------------------
127 // the margin between the up-down control and its buddy (can be arbitrary,
128 // choose what you like - or may be decide during run-time depending on the
130 static const int MARGIN_BETWEEN
= 1;
132 // ============================================================================
134 // ============================================================================
136 wxArraySpins
wxSpinCtrl::ms_allSpins
;
138 // ----------------------------------------------------------------------------
139 // wnd proc for the buddy text ctrl
140 // ----------------------------------------------------------------------------
142 LRESULT APIENTRY _EXPORT
wxBuddyTextWndProc(HWND hwnd
,
147 wxSpinCtrl
*spin
= (wxSpinCtrl
*)wxGetWindowUserData(hwnd
);
149 // forward some messages (mostly the key and focus ones) to the spin ctrl
153 // if the focus comes from the spin control itself, don't set it
154 // back to it -- we don't want to go into an infinite loop
155 if ( (WXHWND
)wParam
== spin
->GetHWND() )
165 // we need to forward WM_HELP too to ensure that the context help
166 // associated with wxSpinCtrl is shown when the text control part of it
167 // is clicked with the "?" cursor
170 spin
->MSWWindowProc(message
, wParam
, lParam
);
172 // The control may have been deleted at this point, so check.
173 if ( !::IsWindow(hwnd
) || wxGetWindowUserData(hwnd
) != spin
)
178 if ( spin
->HasFlag(wxTE_PROCESS_ENTER
) )
180 long dlgCode
= ::CallWindowProc
182 CASTWNDPROC spin
->GetBuddyWndProc(),
188 dlgCode
|= DLGC_WANTMESSAGE
;
194 return ::CallWindowProc(CASTWNDPROC spin
->GetBuddyWndProc(),
195 hwnd
, message
, wParam
, lParam
);
199 wxSpinCtrl
*wxSpinCtrl::GetSpinForTextCtrl(WXHWND hwndBuddy
)
201 wxSpinCtrl
*spin
= (wxSpinCtrl
*)wxGetWindowUserData((HWND
)hwndBuddy
);
203 int i
= ms_allSpins
.Index(spin
);
205 if ( i
== wxNOT_FOUND
)
209 wxASSERT_MSG( spin
->m_hwndBuddy
== hwndBuddy
,
210 wxT("wxSpinCtrl has incorrect buddy HWND!") );
215 // process a WM_COMMAND generated by the buddy text control
216 bool wxSpinCtrl::ProcessTextCommand(WXWORD cmd
, WXWORD
WXUNUSED(id
))
218 if ( (cmd
== EN_CHANGE
) && (!m_blockEvent
))
220 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, GetId());
221 event
.SetEventObject(this);
222 wxString val
= wxGetWindowText(m_hwndBuddy
);
223 event
.SetString(val
);
224 event
.SetInt(GetValue());
225 return HandleWindowEvent(event
);
232 void wxSpinCtrl::OnChar(wxKeyEvent
& event
)
234 switch ( event
.GetKeyCode() )
238 wxCommandEvent
event(wxEVT_COMMAND_TEXT_ENTER
, m_windowId
);
239 InitCommandEvent(event
);
240 wxString val
= wxGetWindowText(m_hwndBuddy
);
241 event
.SetString(val
);
242 event
.SetInt(GetValue());
243 if ( HandleWindowEvent(event
) )
249 // always produce navigation event - even if we process TAB
250 // ourselves the fact that we got here means that the user code
251 // decided to skip processing of this TAB - probably to let it
252 // do its default job.
254 wxNavigationKeyEvent eventNav
;
255 eventNav
.SetDirection(!event
.ShiftDown());
256 eventNav
.SetWindowChange(event
.ControlDown());
257 eventNav
.SetEventObject(this);
259 if ( GetParent()->HandleWindowEvent(eventNav
) )
265 // no, we didn't process it
269 void wxSpinCtrl::OnKillFocus(wxFocusEvent
& event
)
271 // ensure that a correct value is shown by the control
276 void wxSpinCtrl::OnSetFocus(wxFocusEvent
& event
)
278 // when we get focus, give it to our buddy window as it needs it more than
280 ::SetFocus((HWND
)m_hwndBuddy
);
285 void wxSpinCtrl::NormalizeValue()
287 const int value
= GetValue();
288 const bool changed
= value
!= m_oldValue
;
290 // notice that we have to call SetValue() even if the value didn't change
291 // because otherwise we could be left with empty buddy control when value
292 // is 0, see comment in SetValue()
297 SendSpinUpdate(value
);
301 // ----------------------------------------------------------------------------
303 // ----------------------------------------------------------------------------
305 bool wxSpinCtrl::Create(wxWindow
*parent
,
307 const wxString
& value
,
311 int min
, int max
, int initial
,
312 const wxString
& name
)
314 m_blockEvent
= false;
316 // this should be in ctor/init function but I don't want to add one to 2.8
317 // to avoid problems with default ctor which can be inlined in the user
318 // code and so might not get this fix without recompilation
319 m_oldValue
= INT_MIN
;
321 // before using DoGetBestSize(), have to set style to let the base class
322 // know whether this is a horizontal or vertical control (we're always
324 style
|= wxSP_VERTICAL
;
326 if ( (style
& wxBORDER_MASK
) == wxBORDER_DEFAULT
)
328 style
|= wxBORDER_SIMPLE
;
330 style
|= wxBORDER_SUNKEN
;
333 SetWindowStyle(style
);
336 WXDWORD msStyle
= MSWGetStyle(GetWindowStyle(), & exStyle
) ;
338 // propagate text alignment style to text ctrl
339 if ( style
& wxALIGN_RIGHT
)
341 else if ( style
& wxALIGN_CENTER
)
342 msStyle
|= ES_CENTER
;
344 // calculate the sizes: the size given is the total size for both controls
345 // and we need to fit them both in the given width (height is the same)
346 wxSize
sizeText(size
), sizeBtn(size
);
347 sizeBtn
.x
= wxSpinButton::DoGetBestSize().x
;
348 if ( sizeText
.x
<= 0 )
350 // DEFAULT_ITEM_WIDTH is the default width for the text control
351 sizeText
.x
= DEFAULT_ITEM_WIDTH
+ MARGIN_BETWEEN
+ sizeBtn
.x
;
354 sizeText
.x
-= sizeBtn
.x
+ MARGIN_BETWEEN
;
355 if ( sizeText
.x
<= 0 )
357 wxLogDebug(wxT("not enough space for wxSpinCtrl!"));
361 posBtn
.x
+= sizeText
.x
+ MARGIN_BETWEEN
;
363 // we must create the text control before the spin button for the purpose
364 // of the dialog navigation: if there is a static text just before the spin
365 // control, activating it by Alt-letter should give focus to the text
366 // control, not the spin and the dialog navigation code will give focus to
367 // the next control (at Windows level), not the one after it
369 // create the text window
371 m_hwndBuddy
= (WXHWND
)::CreateWindowEx
373 exStyle
, // sunken border
374 wxT("EDIT"), // window class
375 NULL
, // no window title
376 msStyle
, // style (will be shown later)
377 pos
.x
, pos
.y
, // position
378 0, 0, // size (will be set later)
379 GetHwndOf(parent
), // parent
380 (HMENU
)-1, // control id
381 wxGetInstance(), // app instance
382 NULL
// unused client data
387 wxLogLastError(wxT("CreateWindow(buddy text window)"));
393 // create the spin button
394 if ( !wxSpinButton::Create(parent
, id
, posBtn
, sizeBtn
, style
, name
) )
399 wxSpinButtonBase::SetRange(min
, max
);
401 // subclass the text ctrl to be able to intercept some events
402 wxSetWindowUserData(GetBuddyHwnd(), this);
403 m_wndProcBuddy
= (WXFARPROC
)wxSetWindowProc(GetBuddyHwnd(),
406 // set up fonts and colours (This is nomally done in MSWCreateControl)
409 SetFont(GetDefaultAttributes().font
);
411 // set the size of the text window - can do it only now, because we
412 // couldn't call DoGetBestSize() before as font wasn't set
413 if ( sizeText
.y
<= 0 )
416 wxGetCharSize(GetHWND(), &cx
, &cy
, GetFont());
418 sizeText
.y
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy
);
421 SetInitialSize(size
);
423 (void)::ShowWindow(GetBuddyHwnd(), SW_SHOW
);
425 // associate the text window with the spin button
426 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY
, (WPARAM
)m_hwndBuddy
, 0);
430 // Set the range in the native control
433 if ( !value
.empty() )
436 m_oldValue
= (int) wxAtol(value
);
440 SetValue(wxString::Format(wxT("%d"), initial
));
441 m_oldValue
= initial
;
444 // do it after finishing with m_hwndBuddy creation to avoid generating
445 // initial wxEVT_COMMAND_TEXT_UPDATED message
446 ms_allSpins
.Add(this);
451 wxSpinCtrl::~wxSpinCtrl()
453 ms_allSpins
.Remove(this);
455 // This removes spurious memory leak reporting
456 if (ms_allSpins
.GetCount() == 0)
459 // destroy the buddy window because this pointer which wxBuddyTextWndProc
460 // uses will not soon be valid any more
461 ::DestroyWindow(GetBuddyHwnd());
464 // ----------------------------------------------------------------------------
465 // wxTextCtrl-like methods
466 // ----------------------------------------------------------------------------
468 void wxSpinCtrl::SetValue(const wxString
& text
)
470 if ( !::SetWindowText(GetBuddyHwnd(), text
.c_str()) )
472 wxLogLastError(wxT("SetWindowText(buddy)"));
476 void wxSpinCtrl::SetValue(int val
)
480 wxSpinButton::SetValue(val
);
482 // normally setting the value of the spin button is enough as it updates
483 // its buddy control automatically ...
484 if ( wxGetWindowText(m_hwndBuddy
).empty() )
486 // ... but sometimes it doesn't, notably when the value is 0 and the
487 // text control is currently empty, the spin button seems to be happy
488 // to leave it like this, while we really want to always show the
489 // current value in the control, so do it manually
490 ::SetWindowText(GetBuddyHwnd(),
491 wxString::Format(wxT("%d"), val
).wx_str());
494 m_oldValue
= GetValue();
496 m_blockEvent
= false;
499 int wxSpinCtrl::GetValue() const
501 wxString val
= wxGetWindowText(m_hwndBuddy
);
504 if ( (wxSscanf(val
, wxT("%ld"), &n
) != 1) )
515 void wxSpinCtrl::SetSelection(long from
, long to
)
517 // if from and to are both -1, it means (in wxWidgets) that all text should
518 // be selected - translate into Windows convention
519 if ( (from
== -1) && (to
== -1) )
524 ::SendMessage(GetBuddyHwnd(), EM_SETSEL
, (WPARAM
)from
, (LPARAM
)to
);
527 // ----------------------------------------------------------------------------
528 // wxSpinButton methods
529 // ----------------------------------------------------------------------------
531 void wxSpinCtrl::SetRange(int minVal
, int maxVal
)
533 wxSpinButton::SetRange(minVal
, maxVal
);
535 // this control is used for numeric entry so restrict the input to numeric
536 // keys only -- but only if we don't need to be able to enter "-" in it as
537 // otherwise this would become impossible
538 const DWORD styleOld
= ::GetWindowLong(GetBuddyHwnd(), GWL_STYLE
);
541 styleNew
= styleOld
& ~ES_NUMBER
;
543 styleNew
= styleOld
| ES_NUMBER
;
545 if ( styleNew
!= styleOld
)
546 ::SetWindowLong(GetBuddyHwnd(), GWL_STYLE
, styleNew
);
549 // ----------------------------------------------------------------------------
550 // forward some methods to subcontrols
551 // ----------------------------------------------------------------------------
553 bool wxSpinCtrl::SetFont(const wxFont
& font
)
555 if ( !wxWindowBase::SetFont(font
) )
561 WXHANDLE hFont
= GetFont().GetResourceHandle();
562 (void)::SendMessage(GetBuddyHwnd(), WM_SETFONT
, (WPARAM
)hFont
, TRUE
);
567 bool wxSpinCtrl::Show(bool show
)
569 if ( !wxControl::Show(show
) )
574 ::ShowWindow(GetBuddyHwnd(), show
? SW_SHOW
: SW_HIDE
);
579 bool wxSpinCtrl::Reparent(wxWindowBase
*newParent
)
581 // Reparenting both the updown control and its buddy does not seem to work:
582 // they continue to be connected somehow, but visually there is no feedback
583 // on the buddy edit control. To avoid this problem, we reparent the buddy
584 // window normally, but we recreate the updown control and reassign its
587 if ( !wxWindowBase::Reparent(newParent
) )
590 newParent
->GetChildren().DeleteObject(this);
592 // preserve the old values
593 const wxSize size
= GetSize();
594 int value
= GetValue();
595 const wxRect btnRect
= wxRectFromRECT(wxGetWindowRect(GetHwnd()));
597 // destroy the old spin button
599 if ( !::DestroyWindow(GetHwnd()) )
601 wxLogLastError(wxT("DestroyWindow"));
604 // create and initialize the new one
605 if ( !wxSpinButton::Create(GetParent(), GetId(),
606 btnRect
.GetPosition(), btnRect
.GetSize(),
607 GetWindowStyle(), GetName()) )
611 SetRange(m_min
, m_max
);
612 SetInitialSize(size
);
614 // associate it with the buddy control again
615 ::SetParent(GetBuddyHwnd(), GetHwndOf(GetParent()));
616 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY
, (WPARAM
)GetBuddyHwnd(), 0);
621 bool wxSpinCtrl::Enable(bool enable
)
623 if ( !wxControl::Enable(enable
) )
628 MSWEnableHWND(GetBuddyHwnd(), enable
);
633 void wxSpinCtrl::SetFocus()
635 ::SetFocus(GetBuddyHwnd());
640 void wxSpinCtrl::DoSetToolTip(wxToolTip
*tip
)
642 wxSpinButton::DoSetToolTip(tip
);
645 tip
->Add(m_hwndBuddy
);
648 #endif // wxUSE_TOOLTIPS
650 // ----------------------------------------------------------------------------
651 // events processing and generation
652 // ----------------------------------------------------------------------------
654 void wxSpinCtrl::SendSpinUpdate(int value
)
656 wxCommandEvent
event(wxEVT_COMMAND_SPINCTRL_UPDATED
, GetId());
657 event
.SetEventObject(this);
660 (void)HandleWindowEvent(event
);
665 bool wxSpinCtrl::MSWOnScroll(int WXUNUSED(orientation
), WXWORD wParam
,
666 WXWORD pos
, WXHWND control
)
668 wxCHECK_MSG( control
, false, wxT("scrolling what?") );
670 if ( wParam
!= SB_THUMBPOSITION
)
672 // probable SB_ENDSCROLL - we don't react to it
676 int new_value
= (short) pos
;
677 if (m_oldValue
!= new_value
)
678 SendSpinUpdate( new_value
);
683 bool wxSpinCtrl::MSWOnNotify(int WXUNUSED(idCtrl
), WXLPARAM lParam
, WXLPARAM
*result
)
685 NM_UPDOWN
*lpnmud
= (NM_UPDOWN
*)lParam
;
687 if (lpnmud
->hdr
.hwndFrom
!= GetHwnd()) // make sure it is the right control
690 *result
= 0; // never reject UP and DOWN events
696 // ----------------------------------------------------------------------------
698 // ----------------------------------------------------------------------------
700 wxSize
wxSpinCtrl::DoGetBestSize() const
702 wxSize sizeBtn
= wxSpinButton::DoGetBestSize();
703 sizeBtn
.x
+= DEFAULT_ITEM_WIDTH
+ MARGIN_BETWEEN
;
706 wxGetCharSize(GetHWND(), NULL
, &y
, GetFont());
707 y
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(y
);
709 // JACS: we should always use the height calculated
710 // from above, because otherwise we'll get a spin control
711 // that's too big. So never use the height calculated
712 // from wxSpinButton::DoGetBestSize().
714 // if ( sizeBtn.y < y )
716 // make the text tall enough
723 void wxSpinCtrl::DoMoveWindow(int x
, int y
, int width
, int height
)
725 int widthBtn
= wxSpinButton::DoGetBestSize().x
;
726 int widthText
= width
- widthBtn
- MARGIN_BETWEEN
;
727 if ( widthText
<= 0 )
729 wxLogDebug(wxT("not enough space for wxSpinCtrl!"));
732 // 1) The buddy window
733 DoMoveSibling(m_hwndBuddy
, x
, y
, widthText
, height
);
735 // 2) The button window
736 x
+= widthText
+ MARGIN_BETWEEN
;
737 wxSpinButton::DoMoveWindow(x
, y
, widthBtn
, height
);
740 // get total size of the control
741 void wxSpinCtrl::DoGetSize(int *x
, int *y
) const
743 RECT spinrect
, textrect
, ctrlrect
;
744 GetWindowRect(GetHwnd(), &spinrect
);
745 GetWindowRect(GetBuddyHwnd(), &textrect
);
746 UnionRect(&ctrlrect
,&textrect
, &spinrect
);
749 *x
= ctrlrect
.right
- ctrlrect
.left
;
751 *y
= ctrlrect
.bottom
- ctrlrect
.top
;
754 void wxSpinCtrl::DoGetClientSize(int *x
, int *y
) const
756 RECT spinrect
= wxGetClientRect(GetHwnd());
757 RECT textrect
= wxGetClientRect(GetBuddyHwnd());
759 UnionRect(&ctrlrect
,&textrect
, &spinrect
);
762 *x
= ctrlrect
.right
- ctrlrect
.left
;
764 *y
= ctrlrect
.bottom
- ctrlrect
.top
;
767 void wxSpinCtrl::DoGetPosition(int *x
, int *y
) const
769 // hack: pretend that our HWND is the text control just for a moment
770 WXHWND hWnd
= GetHWND();
771 wxConstCast(this, wxSpinCtrl
)->m_hWnd
= m_hwndBuddy
;
773 wxSpinButton::DoGetPosition(x
, y
);
775 wxConstCast(this, wxSpinCtrl
)->m_hWnd
= hWnd
;
778 #endif // wxUSE_SPINCTRL