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
)
118 EVT_SET_FOCUS(wxSpinCtrl::OnSetFocus
)
119 EVT_KILL_FOCUS(wxSpinCtrl::OnKillFocus
)
120 EVT_SPIN(wxID_ANY
, wxSpinCtrl::OnSpinChange
)
123 #define GetBuddyHwnd() (HWND)(m_hwndBuddy)
125 // ----------------------------------------------------------------------------
127 // ----------------------------------------------------------------------------
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
132 static const int MARGIN_BETWEEN
= 1;
134 // ============================================================================
136 // ============================================================================
138 wxArraySpins
wxSpinCtrl::ms_allSpins
;
140 // ----------------------------------------------------------------------------
141 // wnd proc for the buddy text ctrl
142 // ----------------------------------------------------------------------------
144 LRESULT APIENTRY _EXPORT
wxBuddyTextWndProc(HWND hwnd
,
149 wxSpinCtrl
*spin
= (wxSpinCtrl
*)wxGetWindowUserData(hwnd
);
151 // forward some messages (mostly the key and focus ones) to the spin ctrl
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() )
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
172 spin
->MSWWindowProc(message
, wParam
, lParam
);
174 // The control may have been deleted at this point, so check.
175 if ( !::IsWindow(hwnd
) || wxGetWindowUserData(hwnd
) != spin
)
180 // we want to get WXK_RETURN in order to generate the event for it
181 return DLGC_WANTCHARS
;
184 return ::CallWindowProc(CASTWNDPROC spin
->GetBuddyWndProc(),
185 hwnd
, message
, wParam
, lParam
);
189 wxSpinCtrl
*wxSpinCtrl::GetSpinForTextCtrl(WXHWND hwndBuddy
)
191 wxSpinCtrl
*spin
= (wxSpinCtrl
*)wxGetWindowUserData((HWND
)hwndBuddy
);
193 int i
= ms_allSpins
.Index(spin
);
195 if ( i
== wxNOT_FOUND
)
199 wxASSERT_MSG( spin
->m_hwndBuddy
== hwndBuddy
,
200 _T("wxSpinCtrl has incorrect buddy HWND!") );
205 // process a WM_COMMAND generated by the buddy text control
206 bool wxSpinCtrl::ProcessTextCommand(WXWORD cmd
, WXWORD
WXUNUSED(id
))
208 if ( cmd
== EN_CHANGE
)
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
);
222 void wxSpinCtrl::OnChar(wxKeyEvent
& event
)
224 switch ( event
.GetKeyCode() )
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
) )
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.
244 wxNavigationKeyEvent eventNav
;
245 eventNav
.SetDirection(!event
.ShiftDown());
246 eventNav
.SetWindowChange(event
.ControlDown());
247 eventNav
.SetEventObject(this);
249 if ( GetParent()->HandleWindowEvent(eventNav
) )
255 // no, we didn't process it
259 void wxSpinCtrl::OnKillFocus(wxFocusEvent
& event
)
261 // ensure that a correct value is shown by the control
266 void wxSpinCtrl::OnSetFocus(wxFocusEvent
& event
)
268 // when we get focus, give it to our buddy window as it needs it more than
270 ::SetFocus((HWND
)m_hwndBuddy
);
275 void wxSpinCtrl::NormalizeValue()
277 const int value
= GetValue();
278 const bool changed
= value
!= m_oldValue
;
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()
287 SendSpinUpdate(value
);
291 // ----------------------------------------------------------------------------
293 // ----------------------------------------------------------------------------
295 bool wxSpinCtrl::Create(wxWindow
*parent
,
297 const wxString
& value
,
301 int min
, int max
, int initial
,
302 const wxString
& name
)
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
;
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
312 style
|= wxSP_VERTICAL
;
314 if ( (style
& wxBORDER_MASK
) == wxBORDER_DEFAULT
)
316 style
|= wxBORDER_SIMPLE
;
318 style
|= wxBORDER_SUNKEN
;
321 SetWindowStyle(style
);
324 WXDWORD msStyle
= MSWGetStyle(GetWindowStyle(), & exStyle
) ;
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
;
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 )
337 // DEFAULT_ITEM_WIDTH is the default width for the text control
338 sizeText
.x
= DEFAULT_ITEM_WIDTH
+ MARGIN_BETWEEN
+ sizeBtn
.x
;
341 sizeText
.x
-= sizeBtn
.x
+ MARGIN_BETWEEN
;
342 if ( sizeText
.x
<= 0 )
344 wxLogDebug(_T("not enough space for wxSpinCtrl!"));
348 posBtn
.x
+= sizeText
.x
+ MARGIN_BETWEEN
;
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
356 // create the text window
358 m_hwndBuddy
= (WXHWND
)::CreateWindowEx
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
374 wxLogLastError(wxT("CreateWindow(buddy text window)"));
380 // create the spin button
381 if ( !wxSpinButton::Create(parent
, id
, posBtn
, sizeBtn
, style
, name
) )
386 wxSpinButtonBase::SetRange(min
, max
);
388 // subclass the text ctrl to be able to intercept some events
389 wxSetWindowUserData(GetBuddyHwnd(), this);
390 m_wndProcBuddy
= (WXFARPROC
)wxSetWindowProc(GetBuddyHwnd(),
393 // set up fonts and colours (This is nomally done in MSWCreateControl)
396 SetFont(GetDefaultAttributes().font
);
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 )
403 wxGetCharSize(GetHWND(), &cx
, &cy
, GetFont());
405 sizeText
.y
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy
);
408 SetInitialSize(size
);
410 (void)::ShowWindow(GetBuddyHwnd(), SW_SHOW
);
412 // associate the text window with the spin button
413 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY
, (WPARAM
)m_hwndBuddy
, 0);
417 // Set the range in the native control
420 if ( !value
.empty() )
423 m_oldValue
= (int) wxAtol(value
);
427 SetValue(wxString::Format(wxT("%d"), initial
));
428 m_oldValue
= initial
;
431 // do it after finishing with m_hwndBuddy creation to avoid generating
432 // initial wxEVT_COMMAND_TEXT_UPDATED message
433 ms_allSpins
.Add(this);
438 wxSpinCtrl::~wxSpinCtrl()
440 ms_allSpins
.Remove(this);
442 // This removes spurious memory leak reporting
443 if (ms_allSpins
.GetCount() == 0)
446 // destroy the buddy window because this pointer which wxBuddyTextWndProc
447 // uses will not soon be valid any more
448 ::DestroyWindow(GetBuddyHwnd());
451 // ----------------------------------------------------------------------------
452 // wxTextCtrl-like methods
453 // ----------------------------------------------------------------------------
455 void wxSpinCtrl::SetValue(const wxString
& text
)
457 if ( !::SetWindowText(GetBuddyHwnd(), text
.c_str()) )
459 wxLogLastError(wxT("SetWindowText(buddy)"));
463 void wxSpinCtrl::SetValue(int val
)
465 wxSpinButton::SetValue(val
);
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() )
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());
479 m_oldValue
= GetValue();
482 int wxSpinCtrl::GetValue() const
484 wxString val
= wxGetWindowText(m_hwndBuddy
);
487 if ( (wxSscanf(val
, wxT("%ld"), &n
) != 1) )
498 void wxSpinCtrl::SetSelection(long from
, long to
)
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) )
507 ::SendMessage(GetBuddyHwnd(), EM_SETSEL
, (WPARAM
)from
, (LPARAM
)to
);
510 // ----------------------------------------------------------------------------
511 // forward some methods to subcontrols
512 // ----------------------------------------------------------------------------
514 bool wxSpinCtrl::SetFont(const wxFont
& font
)
516 if ( !wxWindowBase::SetFont(font
) )
522 WXHANDLE hFont
= GetFont().GetResourceHandle();
523 (void)::SendMessage(GetBuddyHwnd(), WM_SETFONT
, (WPARAM
)hFont
, TRUE
);
528 bool wxSpinCtrl::Show(bool show
)
530 if ( !wxControl::Show(show
) )
535 ::ShowWindow(GetBuddyHwnd(), show
? SW_SHOW
: SW_HIDE
);
540 bool wxSpinCtrl::Enable(bool enable
)
542 if ( !wxControl::Enable(enable
) )
547 ::EnableWindow(GetBuddyHwnd(), enable
);
552 void wxSpinCtrl::SetFocus()
554 ::SetFocus(GetBuddyHwnd());
559 void wxSpinCtrl::DoSetToolTip(wxToolTip
*tip
)
561 wxSpinButton::DoSetToolTip(tip
);
564 tip
->Add(m_hwndBuddy
);
567 #endif // wxUSE_TOOLTIPS
569 // ----------------------------------------------------------------------------
570 // events processing and generation
571 // ----------------------------------------------------------------------------
573 void wxSpinCtrl::SendSpinUpdate(int value
)
575 wxCommandEvent
event(wxEVT_COMMAND_SPINCTRL_UPDATED
, GetId());
576 event
.SetEventObject(this);
579 (void)HandleWindowEvent(event
);
584 void wxSpinCtrl::OnSpinChange(wxSpinEvent
& eventSpin
)
586 const int value
= eventSpin
.GetPosition();
587 if ( value
!= m_oldValue
)
589 SendSpinUpdate(value
);
593 // ----------------------------------------------------------------------------
595 // ----------------------------------------------------------------------------
597 wxSize
wxSpinCtrl::DoGetBestSize() const
599 wxSize sizeBtn
= wxSpinButton::DoGetBestSize();
600 sizeBtn
.x
+= DEFAULT_ITEM_WIDTH
+ MARGIN_BETWEEN
;
603 wxGetCharSize(GetHWND(), NULL
, &y
, GetFont());
604 y
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(y
);
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().
611 // if ( sizeBtn.y < y )
613 // make the text tall enough
620 void wxSpinCtrl::DoMoveWindow(int x
, int y
, int width
, int height
)
622 int widthBtn
= wxSpinButton::DoGetBestSize().x
;
623 int widthText
= width
- widthBtn
- MARGIN_BETWEEN
;
624 if ( widthText
<= 0 )
626 wxLogDebug(_T("not enough space for wxSpinCtrl!"));
629 // 1) The buddy window
630 DoMoveSibling(m_hwndBuddy
, x
, y
, widthText
, height
);
632 // 2) The button window
633 x
+= widthText
+ MARGIN_BETWEEN
;
634 wxSpinButton::DoMoveWindow(x
, y
, widthBtn
, height
);
637 // get total size of the control
638 void wxSpinCtrl::DoGetSize(int *x
, int *y
) const
640 RECT spinrect
, textrect
, ctrlrect
;
641 GetWindowRect(GetHwnd(), &spinrect
);
642 GetWindowRect(GetBuddyHwnd(), &textrect
);
643 UnionRect(&ctrlrect
,&textrect
, &spinrect
);
646 *x
= ctrlrect
.right
- ctrlrect
.left
;
648 *y
= ctrlrect
.bottom
- ctrlrect
.top
;
651 void wxSpinCtrl::DoGetClientSize(int *x
, int *y
) const
653 RECT spinrect
= wxGetClientRect(GetHwnd());
654 RECT textrect
= wxGetClientRect(GetBuddyHwnd());
656 UnionRect(&ctrlrect
,&textrect
, &spinrect
);
659 *x
= ctrlrect
.right
- ctrlrect
.left
;
661 *y
= ctrlrect
.bottom
- ctrlrect
.top
;
664 void wxSpinCtrl::DoGetPosition(int *x
, int *y
) const
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
;
670 wxSpinButton::DoGetPosition(x
, y
);
672 wxConstCast(this, wxSpinCtrl
)->m_hWnd
= hWnd
;
675 #endif // wxUSE_SPINCTRL