Removed unnecessary assignment
[wxWidgets.git] / src / msw / spinctrl.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/spinctrl.cpp
3 // Purpose: wxSpinCtrl class implementation for Win32
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 22.07.99
7 // RCS-ID: $Id$
8 // Copyright: (c) 1999-2005 Vadim Zeitlin
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // for compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #if wxUSE_SPINCTRL
28
29 #include "wx/spinctrl.h"
30
31 #ifndef WX_PRECOMP
32 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
33 #include "wx/event.h"
34 #include "wx/textctrl.h"
35 #endif
36
37 #include "wx/msw/private.h"
38
39 #if wxUSE_TOOLTIPS
40 #include "wx/tooltip.h"
41 #endif // wxUSE_TOOLTIPS
42
43 #include <limits.h> // for INT_MIN
44
45 // ----------------------------------------------------------------------------
46 // macros
47 // ----------------------------------------------------------------------------
48
49 #if wxUSE_EXTENDED_RTTI
50 WX_DEFINE_FLAGS( wxSpinCtrlStyle )
51
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)
61
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)
69
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)
79
80 wxFLAGS_MEMBER(wxSP_HORIZONTAL)
81 wxFLAGS_MEMBER(wxSP_VERTICAL)
82 wxFLAGS_MEMBER(wxSP_ARROW_KEYS)
83 wxFLAGS_MEMBER(wxSP_WRAP)
84
85 wxEND_FLAGS( wxSpinCtrlStyle )
86
87 IMPLEMENT_DYNAMIC_CLASS_XTI(wxSpinCtrl, wxControl,"wx/spinbut.h")
88
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 )
94
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
100 /*
101 TODO PROPERTIES
102 style wxSP_ARROW_KEYS
103 */
104 wxEND_PROPERTIES_TABLE()
105
106 wxBEGIN_HANDLERS_TABLE(wxSpinCtrl)
107 wxEND_HANDLERS_TABLE()
108
109 wxCONSTRUCTOR_6( wxSpinCtrl , wxWindow* , Parent , wxWindowID , Id , wxString , ValueString , wxPoint , Position , wxSize , Size , long , WindowStyle )
110 #else
111 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl, wxControl)
112 #endif
113
114 BEGIN_EVENT_TABLE(wxSpinCtrl, wxSpinButton)
115 EVT_CHAR(wxSpinCtrl::OnChar)
116
117 EVT_SET_FOCUS(wxSpinCtrl::OnSetFocus)
118 EVT_KILL_FOCUS(wxSpinCtrl::OnKillFocus)
119 EVT_SPIN(wxID_ANY, wxSpinCtrl::OnSpinChange)
120 END_EVENT_TABLE()
121
122 #define GetBuddyHwnd() (HWND)(m_hwndBuddy)
123
124 // ----------------------------------------------------------------------------
125 // constants
126 // ----------------------------------------------------------------------------
127
128 // the margin between the up-down control and its buddy (can be arbitrary,
129 // choose what you like - or may be decide during run-time depending on the
130 // font size?)
131 static const int MARGIN_BETWEEN = 1;
132
133 // ============================================================================
134 // implementation
135 // ============================================================================
136
137 wxArraySpins wxSpinCtrl::ms_allSpins;
138
139 // ----------------------------------------------------------------------------
140 // wnd proc for the buddy text ctrl
141 // ----------------------------------------------------------------------------
142
143 LRESULT APIENTRY _EXPORT wxBuddyTextWndProc(HWND hwnd,
144 UINT message,
145 WPARAM wParam,
146 LPARAM lParam)
147 {
148 wxSpinCtrl *spin = (wxSpinCtrl *)wxGetWindowUserData(hwnd);
149
150 // forward some messages (the key and focus ones only so far) to
151 // the spin ctrl
152 switch ( message )
153 {
154 case WM_SETFOCUS:
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() )
158 break;
159 //else: fall through
160
161 case WM_KILLFOCUS:
162 case WM_CHAR:
163 case WM_DEADCHAR:
164 case WM_KEYUP:
165 case WM_KEYDOWN:
166 spin->MSWWindowProc(message, wParam, lParam);
167
168 // The control may have been deleted at this point, so check.
169 if ( !::IsWindow(hwnd) || wxGetWindowUserData(hwnd) != spin )
170 return 0;
171 break;
172
173 case WM_GETDLGCODE:
174 // we want to get WXK_RETURN in order to generate the event for it
175 return DLGC_WANTCHARS;
176 }
177
178 return ::CallWindowProc(CASTWNDPROC spin->GetBuddyWndProc(),
179 hwnd, message, wParam, lParam);
180 }
181
182 /* static */
183 wxSpinCtrl *wxSpinCtrl::GetSpinForTextCtrl(WXHWND hwndBuddy)
184 {
185 wxSpinCtrl *spin = (wxSpinCtrl *)wxGetWindowUserData((HWND)hwndBuddy);
186
187 int i = ms_allSpins.Index(spin);
188
189 if ( i == wxNOT_FOUND )
190 return NULL;
191
192 // sanity check
193 wxASSERT_MSG( spin->m_hwndBuddy == hwndBuddy,
194 _T("wxSpinCtrl has incorrect buddy HWND!") );
195
196 return spin;
197 }
198
199 // process a WM_COMMAND generated by the buddy text control
200 bool wxSpinCtrl::ProcessTextCommand(WXWORD cmd, WXWORD WXUNUSED(id))
201 {
202 if ( cmd == EN_CHANGE )
203 {
204 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
205 event.SetEventObject(this);
206 wxString val = wxGetWindowText(m_hwndBuddy);
207 event.SetString(val);
208 event.SetInt(GetValue());
209 return GetEventHandler()->ProcessEvent(event);
210 }
211
212 // not processed
213 return false;
214 }
215
216 void wxSpinCtrl::OnChar(wxKeyEvent& event)
217 {
218 switch ( event.GetKeyCode() )
219 {
220 case WXK_RETURN:
221 {
222 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_windowId);
223 InitCommandEvent(event);
224 wxString val = wxGetWindowText(m_hwndBuddy);
225 event.SetString(val);
226 event.SetInt(GetValue());
227 if ( GetEventHandler()->ProcessEvent(event) )
228 return;
229 break;
230 }
231
232 case WXK_TAB:
233 // always produce navigation event - even if we process TAB
234 // ourselves the fact that we got here means that the user code
235 // decided to skip processing of this TAB - probably to let it
236 // do its default job.
237 {
238 wxNavigationKeyEvent eventNav;
239 eventNav.SetDirection(!event.ShiftDown());
240 eventNav.SetWindowChange(event.ControlDown());
241 eventNav.SetEventObject(this);
242
243 if ( GetParent()->GetEventHandler()->ProcessEvent(eventNav) )
244 return;
245 }
246 break;
247 }
248
249 // no, we didn't process it
250 event.Skip();
251 }
252
253 void wxSpinCtrl::OnKillFocus(wxFocusEvent& event)
254 {
255 // ensure that a correct value is shown by the control
256 NormalizeValue();
257 event.Skip();
258 }
259
260 void wxSpinCtrl::OnSetFocus(wxFocusEvent& event)
261 {
262 // when we get focus, give it to our buddy window as it needs it more than
263 // we do
264 ::SetFocus((HWND)m_hwndBuddy);
265
266 event.Skip();
267 }
268
269 void wxSpinCtrl::NormalizeValue()
270 {
271 const int value = GetValue();
272 const bool changed = value != m_oldValue;
273
274 // notice that we have to call SetValue() even if the value didn't change
275 // because otherwise we could be left with empty buddy control when value
276 // is 0, see comment in SetValue()
277 SetValue(value);
278
279 if ( changed )
280 {
281 SendSpinUpdate(value);
282 }
283 }
284
285 // ----------------------------------------------------------------------------
286 // construction
287 // ----------------------------------------------------------------------------
288
289 bool wxSpinCtrl::Create(wxWindow *parent,
290 wxWindowID id,
291 const wxString& value,
292 const wxPoint& pos,
293 const wxSize& size,
294 long style,
295 int min, int max, int initial,
296 const wxString& name)
297 {
298 // this should be in ctor/init function but I don't want to add one to 2.8
299 // to avoid problems with default ctor which can be inlined in the user
300 // code and so might not get this fix without recompilation
301 m_oldValue = INT_MIN;
302
303 // before using DoGetBestSize(), have to set style to let the base class
304 // know whether this is a horizontal or vertical control (we're always
305 // vertical)
306 style |= wxSP_VERTICAL;
307
308 if ( (style & wxBORDER_MASK) == wxBORDER_DEFAULT )
309 #ifdef __WXWINCE__
310 style |= wxBORDER_SIMPLE;
311 #else
312 style |= wxBORDER_SUNKEN;
313 #endif
314
315 SetWindowStyle(style);
316
317 WXDWORD exStyle = 0;
318 WXDWORD msStyle = MSWGetStyle(GetWindowStyle(), & exStyle) ;
319
320 // calculate the sizes: the size given is the toal size for both controls
321 // and we need to fit them both in the given width (height is the same)
322 wxSize sizeText(size), sizeBtn(size);
323 sizeBtn.x = wxSpinButton::DoGetBestSize().x;
324 if ( sizeText.x <= 0 )
325 {
326 // DEFAULT_ITEM_WIDTH is the default width for the text control
327 sizeText.x = DEFAULT_ITEM_WIDTH + MARGIN_BETWEEN + sizeBtn.x;
328 }
329
330 sizeText.x -= sizeBtn.x + MARGIN_BETWEEN;
331 if ( sizeText.x <= 0 )
332 {
333 wxLogDebug(_T("not enough space for wxSpinCtrl!"));
334 }
335
336 wxPoint posBtn(pos);
337 posBtn.x += sizeText.x + MARGIN_BETWEEN;
338
339 // we must create the text control before the spin button for the purpose
340 // of the dialog navigation: if there is a static text just before the spin
341 // control, activating it by Alt-letter should give focus to the text
342 // control, not the spin and the dialog navigation code will give focus to
343 // the next control (at Windows level), not the one after it
344
345 // create the text window
346
347 m_hwndBuddy = (WXHWND)::CreateWindowEx
348 (
349 exStyle, // sunken border
350 _T("EDIT"), // window class
351 NULL, // no window title
352 msStyle, // style (will be shown later)
353 pos.x, pos.y, // position
354 0, 0, // size (will be set later)
355 GetHwndOf(parent), // parent
356 (HMENU)-1, // control id
357 wxGetInstance(), // app instance
358 NULL // unused client data
359 );
360
361 if ( !m_hwndBuddy )
362 {
363 wxLogLastError(wxT("CreateWindow(buddy text window)"));
364
365 return false;
366 }
367
368
369 // create the spin button
370 if ( !wxSpinButton::Create(parent, id, posBtn, sizeBtn, style, name) )
371 {
372 return false;
373 }
374
375 wxSpinButtonBase::SetRange(min, max);
376
377 // subclass the text ctrl to be able to intercept some events
378 wxSetWindowUserData(GetBuddyHwnd(), this);
379 m_wndProcBuddy = (WXFARPROC)wxSetWindowProc(GetBuddyHwnd(),
380 wxBuddyTextWndProc);
381
382 // set up fonts and colours (This is nomally done in MSWCreateControl)
383 InheritAttributes();
384 if (!m_hasFont)
385 SetFont(GetDefaultAttributes().font);
386
387 // set the size of the text window - can do it only now, because we
388 // couldn't call DoGetBestSize() before as font wasn't set
389 if ( sizeText.y <= 0 )
390 {
391 int cx, cy;
392 wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
393
394 sizeText.y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
395 }
396
397 SetInitialSize(size);
398
399 (void)::ShowWindow(GetBuddyHwnd(), SW_SHOW);
400
401 // associate the text window with the spin button
402 (void)::SendMessage(GetHwnd(), UDM_SETBUDDY, (WPARAM)m_hwndBuddy, 0);
403
404 SetValue(initial);
405
406 // Set the range in the native control
407 SetRange(min, max);
408
409 // Send the initial event
410 SendSpinUpdate(initial);
411
412 if ( !value.empty() )
413 {
414 SetValue(value);
415 }
416
417 // do it after finishing with m_hwndBuddy creation to avoid generating
418 // initial wxEVT_COMMAND_TEXT_UPDATED message
419 ms_allSpins.Add(this);
420
421 return true;
422 }
423
424 wxSpinCtrl::~wxSpinCtrl()
425 {
426 ms_allSpins.Remove(this);
427
428 // This removes spurious memory leak reporting
429 if (ms_allSpins.GetCount() == 0)
430 ms_allSpins.Clear();
431
432 // destroy the buddy window because this pointer which wxBuddyTextWndProc
433 // uses will not soon be valid any more
434 ::DestroyWindow(GetBuddyHwnd());
435 }
436
437 // ----------------------------------------------------------------------------
438 // wxTextCtrl-like methods
439 // ----------------------------------------------------------------------------
440
441 void wxSpinCtrl::SetValue(const wxString& text)
442 {
443 if ( !::SetWindowText(GetBuddyHwnd(), text.c_str()) )
444 {
445 wxLogLastError(wxT("SetWindowText(buddy)"));
446 }
447 }
448
449 void wxSpinCtrl::SetValue(int val)
450 {
451 wxSpinButton::SetValue(val);
452
453 // normally setting the value of the spin button is enough as it updates
454 // its buddy control automatically ...
455 if ( wxGetWindowText(m_hwndBuddy).empty() )
456 {
457 // ... but sometimes it doesn't, notably when the value is 0 and the
458 // text control is currently empty, the spin button seems to be happy
459 // to leave it like this, while we really want to always show the
460 // current value in the control, so do it manually
461 ::SetWindowText(GetBuddyHwnd(), wxString::Format(_T("%d"), val));
462 }
463
464 m_oldValue = GetValue();
465 }
466
467 int wxSpinCtrl::GetValue() const
468 {
469 wxString val = wxGetWindowText(m_hwndBuddy);
470
471 long n;
472 if ( (wxSscanf(val, wxT("%ld"), &n) != 1) )
473 n = INT_MIN;
474
475 if ( n < m_min )
476 n = m_min;
477 if ( n > m_max )
478 n = m_max;
479
480 return n;
481 }
482
483 void wxSpinCtrl::SetSelection(long from, long to)
484 {
485 // if from and to are both -1, it means (in wxWidgets) that all text should
486 // be selected - translate into Windows convention
487 if ( (from == -1) && (to == -1) )
488 {
489 from = 0;
490 }
491
492 ::SendMessage(GetBuddyHwnd(), EM_SETSEL, (WPARAM)from, (LPARAM)to);
493 }
494
495 // ----------------------------------------------------------------------------
496 // forward some methods to subcontrols
497 // ----------------------------------------------------------------------------
498
499 bool wxSpinCtrl::SetFont(const wxFont& font)
500 {
501 if ( !wxWindowBase::SetFont(font) )
502 {
503 // nothing to do
504 return false;
505 }
506
507 WXHANDLE hFont = GetFont().GetResourceHandle();
508 (void)::SendMessage(GetBuddyHwnd(), WM_SETFONT, (WPARAM)hFont, TRUE);
509
510 return true;
511 }
512
513 bool wxSpinCtrl::Show(bool show)
514 {
515 if ( !wxControl::Show(show) )
516 {
517 return false;
518 }
519
520 ::ShowWindow(GetBuddyHwnd(), show ? SW_SHOW : SW_HIDE);
521
522 return true;
523 }
524
525 bool wxSpinCtrl::Enable(bool enable)
526 {
527 if ( !wxControl::Enable(enable) )
528 {
529 return false;
530 }
531
532 ::EnableWindow(GetBuddyHwnd(), enable);
533
534 return true;
535 }
536
537 void wxSpinCtrl::SetFocus()
538 {
539 ::SetFocus(GetBuddyHwnd());
540 }
541
542 #if wxUSE_TOOLTIPS
543
544 void wxSpinCtrl::DoSetToolTip(wxToolTip *tip)
545 {
546 wxSpinButton::DoSetToolTip(tip);
547
548 if ( tip )
549 tip->Add(m_hwndBuddy);
550 }
551
552 #endif // wxUSE_TOOLTIPS
553
554 // ----------------------------------------------------------------------------
555 // events processing and generation
556 // ----------------------------------------------------------------------------
557
558 void wxSpinCtrl::SendSpinUpdate(int value)
559 {
560 wxCommandEvent event(wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());
561 event.SetEventObject(this);
562 event.SetInt(value);
563
564 (void)GetEventHandler()->ProcessEvent(event);
565
566 m_oldValue = value;
567 }
568
569 void wxSpinCtrl::OnSpinChange(wxSpinEvent& eventSpin)
570 {
571 const int value = eventSpin.GetPosition();
572 if ( value != m_oldValue )
573 {
574 SendSpinUpdate(value);
575 }
576 }
577
578 // ----------------------------------------------------------------------------
579 // size calculations
580 // ----------------------------------------------------------------------------
581
582 wxSize wxSpinCtrl::DoGetBestSize() const
583 {
584 wxSize sizeBtn = wxSpinButton::DoGetBestSize();
585 sizeBtn.x += DEFAULT_ITEM_WIDTH + MARGIN_BETWEEN;
586
587 int y;
588 wxGetCharSize(GetHWND(), NULL, &y, GetFont());
589 y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(y);
590
591 // JACS: we should always use the height calculated
592 // from above, because otherwise we'll get a spin control
593 // that's too big. So never use the height calculated
594 // from wxSpinButton::DoGetBestSize().
595
596 // if ( sizeBtn.y < y )
597 {
598 // make the text tall enough
599 sizeBtn.y = y;
600 }
601
602 return sizeBtn;
603 }
604
605 void wxSpinCtrl::DoMoveWindow(int x, int y, int width, int height)
606 {
607 int widthBtn = wxSpinButton::DoGetBestSize().x;
608 int widthText = width - widthBtn - MARGIN_BETWEEN;
609 if ( widthText <= 0 )
610 {
611 wxLogDebug(_T("not enough space for wxSpinCtrl!"));
612 }
613
614 // 1) The buddy window
615 DoMoveSibling(m_hwndBuddy, x, y, widthText, height);
616
617 // 2) The button window
618 x += widthText + MARGIN_BETWEEN;
619 wxSpinButton::DoMoveWindow(x, y, widthBtn, height);
620 }
621
622 // get total size of the control
623 void wxSpinCtrl::DoGetSize(int *x, int *y) const
624 {
625 RECT spinrect, textrect, ctrlrect;
626 GetWindowRect(GetHwnd(), &spinrect);
627 GetWindowRect(GetBuddyHwnd(), &textrect);
628 UnionRect(&ctrlrect,&textrect, &spinrect);
629
630 if ( x )
631 *x = ctrlrect.right - ctrlrect.left;
632 if ( y )
633 *y = ctrlrect.bottom - ctrlrect.top;
634 }
635
636 void wxSpinCtrl::DoGetPosition(int *x, int *y) const
637 {
638 // hack: pretend that our HWND is the text control just for a moment
639 WXHWND hWnd = GetHWND();
640 wxConstCast(this, wxSpinCtrl)->m_hWnd = m_hwndBuddy;
641
642 wxSpinButton::DoGetPosition(x, y);
643
644 wxConstCast(this, wxSpinCtrl)->m_hWnd = hWnd;
645 }
646
647 #endif // wxUSE_SPINCTRL