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"
33 #include "wx/textctrl.h"
36 #include "wx/msw/private.h"
37 #include "wx/msw/wrapcctl.h"
40 #include "wx/tooltip.h"
41 #endif // wxUSE_TOOLTIPS
43 #include <limits.h> // for INT_MIN
45 // ----------------------------------------------------------------------------
47 // ----------------------------------------------------------------------------
49 #if wxUSE_EXTENDED_RTTI
50 WX_DEFINE_FLAGS( wxSpinCtrlStyle
)
52 wxBEGIN_FLAGS( wxSpinCtrlStyle
)
53 // new style border flags, we put them first to
54 // use them for streaming out
55 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
56 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
57 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
58 wxFLAGS_MEMBER(wxBORDER_RAISED
)
59 wxFLAGS_MEMBER(wxBORDER_STATIC
)
60 wxFLAGS_MEMBER(wxBORDER_NONE
)
62 // old style border flags
63 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
64 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
65 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
66 wxFLAGS_MEMBER(wxRAISED_BORDER
)
67 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
68 wxFLAGS_MEMBER(wxBORDER
)
70 // standard window styles
71 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
72 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
73 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
74 wxFLAGS_MEMBER(wxWANTS_CHARS
)
75 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
76 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
77 wxFLAGS_MEMBER(wxVSCROLL
)
78 wxFLAGS_MEMBER(wxHSCROLL
)
80 wxFLAGS_MEMBER(wxSP_HORIZONTAL
)
81 wxFLAGS_MEMBER(wxSP_VERTICAL
)
82 wxFLAGS_MEMBER(wxSP_ARROW_KEYS
)
83 wxFLAGS_MEMBER(wxSP_WRAP
)
85 wxEND_FLAGS( wxSpinCtrlStyle
)
87 IMPLEMENT_DYNAMIC_CLASS_XTI(wxSpinCtrl
, wxControl
,"wx/spinbut.h")
89 wxBEGIN_PROPERTIES_TABLE(wxSpinCtrl
)
90 wxEVENT_RANGE_PROPERTY( Spin
, wxEVT_SCROLL_TOP
, wxEVT_SCROLL_ENDSCROLL
, wxSpinEvent
)
91 wxEVENT_PROPERTY( Updated
, wxEVT_COMMAND_SPINCTRL_UPDATED
, wxCommandEvent
)
92 wxEVENT_PROPERTY( TextUpdated
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
)
93 wxEVENT_PROPERTY( TextEnter
, wxEVT_COMMAND_TEXT_ENTER
, wxCommandEvent
)
95 wxPROPERTY( ValueString
, wxString
, SetValue
, GetValue
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) ;
96 wxPROPERTY( Value
, int , SetValue
, GetValue
, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
97 wxPROPERTY( Min
, int , SetMin
, GetMin
, 0, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
98 wxPROPERTY( Max
, int , SetMax
, GetMax
, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
99 wxPROPERTY_FLAGS( WindowStyle
, wxSpinCtrlStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
102 style wxSP_ARROW_KEYS
104 wxEND_PROPERTIES_TABLE()
106 wxBEGIN_HANDLERS_TABLE(wxSpinCtrl
)
107 wxEND_HANDLERS_TABLE()
109 wxCONSTRUCTOR_6( wxSpinCtrl
, wxWindow
* , Parent
, wxWindowID
, Id
, wxString
, ValueString
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
111 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 (the key and focus ones only so far) to
156 // if the focus comes from the spin control itself, don't set it
157 // back to it -- we don't want to go into an infinite loop
158 if ( (WXHWND
)wParam
== spin
->GetHWND() )
167 spin
->MSWWindowProc(message
, wParam
, lParam
);
169 // The control may have been deleted at this point, so check.
170 if ( !::IsWindow(hwnd
) || wxGetWindowUserData(hwnd
) != spin
)
175 // we want to get WXK_RETURN in order to generate the event for it
176 return DLGC_WANTCHARS
;
179 return ::CallWindowProc(CASTWNDPROC spin
->GetBuddyWndProc(),
180 hwnd
, message
, wParam
, lParam
);
184 wxSpinCtrl
*wxSpinCtrl::GetSpinForTextCtrl(WXHWND hwndBuddy
)
186 wxSpinCtrl
*spin
= (wxSpinCtrl
*)wxGetWindowUserData((HWND
)hwndBuddy
);
188 int i
= ms_allSpins
.Index(spin
);
190 if ( i
== wxNOT_FOUND
)
194 wxASSERT_MSG( spin
->m_hwndBuddy
== hwndBuddy
,
195 _T("wxSpinCtrl has incorrect buddy HWND!") );
200 // process a WM_COMMAND generated by the buddy text control
201 bool wxSpinCtrl::ProcessTextCommand(WXWORD cmd
, WXWORD
WXUNUSED(id
))
203 if ( cmd
== EN_CHANGE
)
205 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, GetId());
206 event
.SetEventObject(this);
207 wxString val
= wxGetWindowText(m_hwndBuddy
);
208 event
.SetString(val
);
209 event
.SetInt(GetValue());
210 return GetEventHandler()->ProcessEvent(event
);
217 void wxSpinCtrl::OnChar(wxKeyEvent
& event
)
219 switch ( event
.GetKeyCode() )
223 wxCommandEvent
event(wxEVT_COMMAND_TEXT_ENTER
, m_windowId
);
224 InitCommandEvent(event
);
225 wxString val
= wxGetWindowText(m_hwndBuddy
);
226 event
.SetString(val
);
227 event
.SetInt(GetValue());
228 if ( GetEventHandler()->ProcessEvent(event
) )
234 // always produce navigation event - even if we process TAB
235 // ourselves the fact that we got here means that the user code
236 // decided to skip processing of this TAB - probably to let it
237 // do its default job.
239 wxNavigationKeyEvent eventNav
;
240 eventNav
.SetDirection(!event
.ShiftDown());
241 eventNav
.SetWindowChange(event
.ControlDown());
242 eventNav
.SetEventObject(this);
244 if ( GetParent()->GetEventHandler()->ProcessEvent(eventNav
) )
250 // no, we didn't process it
254 void wxSpinCtrl::OnKillFocus(wxFocusEvent
& event
)
256 // ensure that a correct value is shown by the control
261 void wxSpinCtrl::OnSetFocus(wxFocusEvent
& event
)
263 // when we get focus, give it to our buddy window as it needs it more than
265 ::SetFocus((HWND
)m_hwndBuddy
);
270 // ----------------------------------------------------------------------------
272 // ----------------------------------------------------------------------------
274 bool wxSpinCtrl::Create(wxWindow
*parent
,
276 const wxString
& value
,
280 int min
, int max
, int initial
,
281 const wxString
& name
)
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
286 style
|= wxSP_VERTICAL
;
288 if ( (style
& wxBORDER_MASK
) == wxBORDER_DEFAULT
)
290 style
|= wxBORDER_SIMPLE
;
292 style
|= wxBORDER_SUNKEN
;
295 SetWindowStyle(style
);
298 WXDWORD msStyle
= MSWGetStyle(GetWindowStyle(), & exStyle
) ;
300 // calculate the sizes: the size given is the toal size for both controls
301 // and we need to fit them both in the given width (height is the same)
302 wxSize
sizeText(size
), sizeBtn(size
);
303 sizeBtn
.x
= wxSpinButton::DoGetBestSize().x
;
304 if ( sizeText
.x
<= 0 )
306 // DEFAULT_ITEM_WIDTH is the default width for the text control
307 sizeText
.x
= DEFAULT_ITEM_WIDTH
+ MARGIN_BETWEEN
+ sizeBtn
.x
;
310 sizeText
.x
-= sizeBtn
.x
+ MARGIN_BETWEEN
;
311 if ( sizeText
.x
<= 0 )
313 wxLogDebug(_T("not enough space for wxSpinCtrl!"));
317 posBtn
.x
+= sizeText
.x
+ MARGIN_BETWEEN
;
319 // we must create the text control before the spin button for the purpose
320 // of the dialog navigation: if there is a static text just before the spin
321 // control, activating it by Alt-letter should give focus to the text
322 // control, not the spin and the dialog navigation code will give focus to
323 // the next control (at Windows level), not the one after it
325 // create the text window
327 m_hwndBuddy
= (WXHWND
)::CreateWindowEx
329 exStyle
, // sunken border
330 _T("EDIT"), // window class
331 NULL
, // no window title
332 msStyle
, // style (will be shown later)
333 pos
.x
, pos
.y
, // position
334 0, 0, // size (will be set later)
335 GetHwndOf(parent
), // parent
336 (HMENU
)-1, // control id
337 wxGetInstance(), // app instance
338 NULL
// unused client data
343 wxLogLastError(wxT("CreateWindow(buddy text window)"));
349 // create the spin button
350 if ( !wxSpinButton::Create(parent
, id
, posBtn
, sizeBtn
, style
, name
) )
358 // subclass the text ctrl to be able to intercept some events
359 wxSetWindowUserData(GetBuddyHwnd(), this);
360 m_wndProcBuddy
= (WXFARPROC
)wxSetWindowProc(GetBuddyHwnd(),
363 // set up fonts and colours (This is nomally done in MSWCreateControl)
366 SetFont(GetDefaultAttributes().font
);
368 // set the size of the text window - can do it only now, because we
369 // couldn't call DoGetBestSize() before as font wasn't set
370 if ( sizeText
.y
<= 0 )
373 wxGetCharSize(GetHWND(), &cx
, &cy
, GetFont());
375 sizeText
.y
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy
);
380 (void)::ShowWindow(GetBuddyHwnd(), SW_SHOW
);
382 // associate the text window with the spin button
383 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY
, (WPARAM
)m_hwndBuddy
, 0);
385 if ( !value
.empty() )
390 // do it after finishing with m_hwndBuddy creation to avoid generating
391 // initial wxEVT_COMMAND_TEXT_UPDATED message
392 ms_allSpins
.Add(this);
397 wxSpinCtrl::~wxSpinCtrl()
399 ms_allSpins
.Remove(this);
401 // This removes spurious memory leak reporting
402 if (ms_allSpins
.GetCount() == 0)
405 // destroy the buddy window because this pointer which wxBuddyTextWndProc
406 // uses will not soon be valid any more
407 ::DestroyWindow(GetBuddyHwnd());
410 // ----------------------------------------------------------------------------
411 // wxTextCtrl-like methods
412 // ----------------------------------------------------------------------------
414 void wxSpinCtrl::SetValue(const wxString
& text
)
416 if ( !::SetWindowText(GetBuddyHwnd(), text
.c_str()) )
418 wxLogLastError(wxT("SetWindowText(buddy)"));
422 void wxSpinCtrl::SetValue(int val
)
424 wxSpinButton::SetValue(val
);
426 // normally setting the value of the spin button is enough as it updates
427 // its buddy control automatically ...
428 if ( wxGetWindowText(m_hwndBuddy
).empty() )
430 // ... but sometimes it doesn't, notably when the value is 0 and the
431 // text control is currently empty, the spin button seems to be happy
432 // to leave it like this, while we really want to always show the
433 // current value in the control, so do it manually
434 ::SetWindowText(GetBuddyHwnd(), wxString::Format(_T("%d"), val
));
438 int wxSpinCtrl::GetValue() const
440 wxString val
= wxGetWindowText(m_hwndBuddy
);
443 if ( (wxSscanf(val
, wxT("%ld"), &n
) != 1) )
454 void wxSpinCtrl::SetSelection(long from
, long to
)
456 // if from and to are both -1, it means (in wxWidgets) that all text should
457 // be selected - translate into Windows convention
458 if ( (from
== -1) && (to
== -1) )
463 ::SendMessage(GetBuddyHwnd(), EM_SETSEL
, (WPARAM
)from
, (LPARAM
)to
);
466 // ----------------------------------------------------------------------------
467 // forward some methods to subcontrols
468 // ----------------------------------------------------------------------------
470 bool wxSpinCtrl::SetFont(const wxFont
& font
)
472 if ( !wxWindowBase::SetFont(font
) )
478 WXHANDLE hFont
= GetFont().GetResourceHandle();
479 (void)::SendMessage(GetBuddyHwnd(), WM_SETFONT
, (WPARAM
)hFont
, TRUE
);
484 bool wxSpinCtrl::Show(bool show
)
486 if ( !wxControl::Show(show
) )
491 ::ShowWindow(GetBuddyHwnd(), show
? SW_SHOW
: SW_HIDE
);
496 bool wxSpinCtrl::Enable(bool enable
)
498 if ( !wxControl::Enable(enable
) )
503 ::EnableWindow(GetBuddyHwnd(), enable
);
508 void wxSpinCtrl::SetFocus()
510 ::SetFocus(GetBuddyHwnd());
515 void wxSpinCtrl::DoSetToolTip(wxToolTip
*tip
)
517 wxSpinButton::DoSetToolTip(tip
);
520 tip
->Add(m_hwndBuddy
);
523 #endif // wxUSE_TOOLTIPS
525 // ----------------------------------------------------------------------------
527 // ----------------------------------------------------------------------------
529 void wxSpinCtrl::OnSpinChange(wxSpinEvent
& eventSpin
)
531 wxCommandEvent
event(wxEVT_COMMAND_SPINCTRL_UPDATED
, GetId());
532 event
.SetEventObject(this);
533 event
.SetInt(eventSpin
.GetPosition());
535 (void)GetEventHandler()->ProcessEvent(event
);
537 if ( eventSpin
.GetSkipped() )
543 // ----------------------------------------------------------------------------
545 // ----------------------------------------------------------------------------
547 wxSize
wxSpinCtrl::DoGetBestSize() const
549 wxSize sizeBtn
= wxSpinButton::DoGetBestSize();
550 sizeBtn
.x
+= DEFAULT_ITEM_WIDTH
+ MARGIN_BETWEEN
;
553 wxGetCharSize(GetHWND(), NULL
, &y
, GetFont());
554 y
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(y
);
556 // JACS: we should always use the height calculated
557 // from above, because otherwise we'll get a spin control
558 // that's too big. So never use the height calculated
559 // from wxSpinButton::DoGetBestSize().
561 // if ( sizeBtn.y < y )
563 // make the text tall enough
570 void wxSpinCtrl::DoMoveWindow(int x
, int y
, int width
, int height
)
572 int widthBtn
= wxSpinButton::DoGetBestSize().x
;
573 int widthText
= width
- widthBtn
- MARGIN_BETWEEN
;
574 if ( widthText
<= 0 )
576 wxLogDebug(_T("not enough space for wxSpinCtrl!"));
579 // 1) The buddy window
580 DoMoveSibling(m_hwndBuddy
, x
, y
, widthText
, height
);
582 // 2) The button window
583 x
+= widthText
+ MARGIN_BETWEEN
;
584 wxSpinButton::DoMoveWindow(x
, y
, widthBtn
, height
);
587 // get total size of the control
588 void wxSpinCtrl::DoGetSize(int *x
, int *y
) const
590 RECT spinrect
, textrect
, ctrlrect
;
591 GetWindowRect(GetHwnd(), &spinrect
);
592 GetWindowRect(GetBuddyHwnd(), &textrect
);
593 UnionRect(&ctrlrect
,&textrect
, &spinrect
);
596 *x
= ctrlrect
.right
- ctrlrect
.left
;
598 *y
= ctrlrect
.bottom
- ctrlrect
.top
;
601 void wxSpinCtrl::DoGetPosition(int *x
, int *y
) const
603 // hack: pretend that our HWND is the text control just for a moment
604 WXHWND hWnd
= GetHWND();
605 wxConstCast(this, wxSpinCtrl
)->m_hWnd
= m_hwndBuddy
;
607 wxSpinButton::DoGetPosition(x
, y
);
609 wxConstCast(this, wxSpinCtrl
)->m_hWnd
= hWnd
;
612 #endif // wxUSE_SPINCTRL