src/msw/spinctrl.cpp

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