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 #ifdef __GNUG__
  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(__TWIN32__))
  44     #include <commctrl.h>
  45 #endif
  46
  47 #include <limits.h>         // for INT_MIN
  48
  49 // ----------------------------------------------------------------------------
  50 // macros
  51 // ----------------------------------------------------------------------------
  52
  53 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl, wxControl)
  54
  55 BEGIN_EVENT_TABLE(wxSpinCtrl, wxSpinButton)
  56     EVT_CHAR(wxSpinCtrl::OnChar)
  57     EVT_SPIN(-1, wxSpinCtrl::OnSpinChange)
  58 END_EVENT_TABLE()
  59
  60 #define GetBuddyHwnd()      (HWND)(m_hwndBuddy)
  61
  62 // ----------------------------------------------------------------------------
  63 // constants
  64 // ----------------------------------------------------------------------------
  65
  66 // the margin between the up-down control and its buddy (can be arbitrary,
  67 // choose what you like - or may be decide during run-time depending on the
  68 // font size?)
  69 static const int MARGIN_BETWEEN = 1;
  70
  71 // ============================================================================
  72 // implementation
  73 // ============================================================================
  74
  75 wxArraySpins wxSpinCtrl::ms_allSpins;
  76
  77 // ----------------------------------------------------------------------------
  78 // wnd proc for the buddy text ctrl
  79 // ----------------------------------------------------------------------------
  80
  81 LRESULT APIENTRY _EXPORT wxBuddyTextWndProc(HWND hwnd,
  82                                             UINT message,
  83                                             WPARAM wParam,
  84                                             LPARAM lParam)
  85 {
  86     wxSpinCtrl *spin = (wxSpinCtrl *)::GetWindowLong(hwnd, GWL_USERDATA);
  87
  88     // forward some messages (the key ones only so far) to the spin ctrl
  89     switch ( message )
  90     {
  91         case WM_CHAR:
  92         case WM_DEADCHAR:
  93         case WM_KEYUP:
  94         case WM_KEYDOWN:
  95             spin->MSWWindowProc(message, wParam, lParam);
  96
  97             // The control may have been deleted at this point, so check.
  98             if (!(::IsWindow(hwnd) && ((wxSpinCtrl *)::GetWindowLong(hwnd, GWL_USERDATA)) == spin))
  99                 return 0;
 100             break;
 101     }
 102     return ::CallWindowProc(CASTWNDPROC spin->GetBuddyWndProc(),
 103                             hwnd, message, wParam, lParam);
 104 }
 105
 106 /* static */
 107 wxSpinCtrl *wxSpinCtrl::GetSpinForTextCtrl(WXHWND hwndBuddy)
 108 {
 109     wxSpinCtrl *spin = (wxSpinCtrl *)::GetWindowLong((HWND)hwndBuddy,
 110                                                      GWL_USERDATA);
 111
 112     int i = ms_allSpins.Index(spin);
 113
 114     if ( i == wxNOT_FOUND )
 115         return NULL;
 116
 117     // sanity check
 118     wxASSERT_MSG( spin->m_hwndBuddy == hwndBuddy,
 119                   _T("wxSpinCtrl has incorrect buddy HWND!") );
 120
 121     return spin;
 122 }
 123
 124 // process a WM_COMMAND generated by the buddy text control
 125 bool wxSpinCtrl::ProcessTextCommand(WXWORD cmd, WXWORD WXUNUSED(id))
 126 {
 127     switch (cmd)
 128     {
 129     case EN_CHANGE:
 130         {
 131             wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
 132             event.SetEventObject(this);
 133             wxString val = wxGetWindowText(m_hwndBuddy);
 134             event.SetString(val);
 135             event.SetInt(GetValue());
 136             return GetEventHandler()->ProcessEvent(event);
 137         }
 138     case EN_SETFOCUS:
 139     case EN_KILLFOCUS:
 140         {
 141             wxFocusEvent event(cmd == EN_KILLFOCUS ? wxEVT_KILL_FOCUS
 142                     : wxEVT_SET_FOCUS,
 143                     m_windowId);
 144             event.SetEventObject( this );
 145             return GetEventHandler()->ProcessEvent(event);
 146         }
 147      default:
 148         break;
 149     }
 150
 151     // not processed
 152     return FALSE;
 153 }
 154
 155 void wxSpinCtrl::OnChar(wxKeyEvent& event)
 156 {
 157     switch ( event.KeyCode() )
 158     {
 159         case WXK_RETURN:
 160             {
 161                 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_windowId);
 162                 InitCommandEvent(event);
 163                 wxString val = wxGetWindowText(m_hwndBuddy);
 164                 event.SetString(val);
 165                 event.SetInt(GetValue());
 166                 if ( GetEventHandler()->ProcessEvent(event) )
 167                     return;
 168                 break;
 169             }
 170
 171         case WXK_TAB:
 172             // always produce navigation event - even if we process TAB
 173             // ourselves the fact that we got here means that the user code
 174             // decided to skip processing of this TAB - probably to let it
 175             // do its default job.
 176             {
 177                 wxNavigationKeyEvent eventNav;
 178                 eventNav.SetDirection(!event.ShiftDown());
 179                 eventNav.SetWindowChange(event.ControlDown());
 180                 eventNav.SetEventObject(this);
 181
 182                 if ( GetParent()->GetEventHandler()->ProcessEvent(eventNav) )
 183                     return;
 184             }
 185             break;
 186     }
 187
 188     // no, we didn't process it
 189     event.Skip();
 190 }
 191
 192 // ----------------------------------------------------------------------------
 193 // construction
 194 // ----------------------------------------------------------------------------
 195
 196 bool wxSpinCtrl::Create(wxWindow *parent,
 197                         wxWindowID id,
 198                         const wxString& value,
 199                         const wxPoint& pos,
 200                         const wxSize& size,
 201                         long style,
 202                         int min, int max, int initial,
 203                         const wxString& name)
 204 {
 205     // before using DoGetBestSize(), have to set style to let the base class
 206     // know whether this is a horizontal or vertical control (we're always
 207     // vertical)
 208     style |= wxSP_VERTICAL;
 209     SetWindowStyle(style);
 210
 211     // calculate the sizes: the size given is the toal size for both controls
 212     // and we need to fit them both in the given width (height is the same)
 213     wxSize sizeText(size), sizeBtn(size);
 214     sizeBtn.x = wxSpinButton::DoGetBestSize().x;
 215     if ( sizeText.x <= 0 )
 216     {
 217         // DEFAULT_ITEM_WIDTH is the default width for the text control
 218         sizeText.x = DEFAULT_ITEM_WIDTH + MARGIN_BETWEEN + sizeBtn.x;
 219     }
 220
 221     sizeText.x -= sizeBtn.x + MARGIN_BETWEEN;
 222     if ( sizeText.x <= 0 )
 223     {
 224         wxLogDebug(_T("not enough space for wxSpinCtrl!"));
 225     }
 226
 227     wxPoint posBtn(pos);
 228     posBtn.x += sizeText.x + MARGIN_BETWEEN;
 229
 230     // create the spin button
 231     if ( !wxSpinButton::Create(parent, id, posBtn, sizeBtn, style, name) )
 232     {
 233         return FALSE;
 234     }
 235
 236     SetRange(min, max);
 237     SetValue(initial);
 238
 239     bool want3D;
 240     WXDWORD exStyle = Determine3DEffects(WS_EX_CLIENTEDGE, &want3D);
 241     int msStyle = WS_CHILD;
 242
 243     // Even with extended styles, need to combine with WS_BORDER for them to
 244     // look right.
 245     if ( want3D || wxStyleHasBorder(style) )
 246         msStyle |= WS_BORDER;
 247
 248     if ( style & wxCLIP_SIBLINGS )
 249         msStyle |= WS_CLIPSIBLINGS;
 250
 251
 252     // create the text window
 253     m_hwndBuddy = (WXHWND)::CreateWindowEx
 254                     (
 255                      exStyle,       // sunken border
 256                      _T("EDIT"),             // window class
 257                      NULL,                   // no window title
 258                      msStyle /* | WS_CLIPSIBLINGS */,   // style (will be shown later)
 259                      pos.x, pos.y,           // position
 260                      0, 0,                   // size (will be set later)
 261                      GetHwndOf(parent),      // parent
 262                      (HMENU)-1,              // control id
 263                      wxGetInstance(),        // app instance
 264                      NULL                    // unused client data
 265                     );
 266
 267     if ( !m_hwndBuddy )
 268     {
 269         wxLogLastError(wxT("CreateWindow(buddy text window)"));
 270
 271         return FALSE;
 272     }
 273
 274     // subclass the text ctrl to be able to intercept some events
 275     m_wndProcBuddy = (WXFARPROC)::GetWindowLong(GetBuddyHwnd(), GWL_WNDPROC);
 276     ::SetWindowLong(GetBuddyHwnd(), GWL_USERDATA, (LONG)this);
 277     ::SetWindowLong(GetBuddyHwnd(), GWL_WNDPROC, (LONG)wxBuddyTextWndProc);
 278
 279     // should have the same font as the other controls
 280     SetFont(GetParent()->GetFont());
 281
 282     // set the size of the text window - can do it only now, because we
 283     // couldn't call DoGetBestSize() before as font wasn't set
 284     if ( sizeText.y <= 0 )
 285     {
 286         int cx, cy;
 287         wxGetCharSize(GetHWND(), &cx, &cy, &GetFont());
 288
 289         sizeText.y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
 290     }
 291
 292     DoMoveWindow(pos.x, pos.y,
 293                  sizeText.x + sizeBtn.x + MARGIN_BETWEEN, sizeText.y);
 294
 295     (void)::ShowWindow(GetBuddyHwnd(), SW_SHOW);
 296
 297     // associate the text window with the spin button
 298     (void)::SendMessage(GetHwnd(), UDM_SETBUDDY, (WPARAM)m_hwndBuddy, 0);
 299
 300     if ( !value.IsEmpty() )
 301     {
 302         SetValue(value);
 303     }
 304
 305     // do it after finishing with m_hwndBuddy creation to avoid generating
 306     // initial wxEVT_COMMAND_TEXT_UPDATED message
 307     ms_allSpins.Add(this);
 308
 309     return TRUE;
 310 }
 311
 312 wxSpinCtrl::~wxSpinCtrl()
 313 {
 314     ms_allSpins.Remove(this);
 315
 316     // destroy the buddy window because this pointer which wxBuddyTextWndProc
 317     // uses will not soon be valid any more
 318     ::DestroyWindow(GetBuddyHwnd());
 319 }
 320
 321 // ----------------------------------------------------------------------------
 322 // wxTextCtrl-like methods
 323 // ----------------------------------------------------------------------------
 324
 325 void wxSpinCtrl::SetValue(const wxString& text)
 326 {
 327     if ( !::SetWindowText(GetBuddyHwnd(), text.c_str()) )
 328     {
 329         wxLogLastError(wxT("SetWindowText(buddy)"));
 330     }
 331 }
 332
 333 int wxSpinCtrl::GetValue() const
 334 {
 335     wxString val = wxGetWindowText(m_hwndBuddy);
 336
 337     long n;
 338     if ( (wxSscanf(val, wxT("%lu"), &n) != 1) )
 339         n = INT_MIN;
 340
 341     return n;
 342 }
 343
 344 // ----------------------------------------------------------------------------
 345 // forward some methods to subcontrols
 346 // ----------------------------------------------------------------------------
 347
 348 bool wxSpinCtrl::SetFont(const wxFont& font)
 349 {
 350     if ( !wxWindowBase::SetFont(font) )
 351     {
 352         // nothing to do
 353         return FALSE;
 354     }
 355
 356     WXHANDLE hFont = GetFont().GetResourceHandle();
 357     (void)::SendMessage(GetBuddyHwnd(), WM_SETFONT, (WPARAM)hFont, TRUE);
 358
 359     return TRUE;
 360 }
 361
 362 bool wxSpinCtrl::Show(bool show)
 363 {
 364     if ( !wxControl::Show(show) )
 365     {
 366         return FALSE;
 367     }
 368
 369     ::ShowWindow(GetBuddyHwnd(), show ? SW_SHOW : SW_HIDE);
 370
 371     return TRUE;
 372 }
 373
 374 bool wxSpinCtrl::Enable(bool enable)
 375 {
 376     if ( !wxControl::Enable(enable) )
 377     {
 378         return FALSE;
 379     }
 380
 381     ::EnableWindow(GetBuddyHwnd(), enable);
 382
 383     return TRUE;
 384 }
 385
 386 void wxSpinCtrl::SetFocus()
 387 {
 388     ::SetFocus(GetBuddyHwnd());
 389 }
 390
 391 // ----------------------------------------------------------------------------
 392 // event processing
 393 // ----------------------------------------------------------------------------
 394
 395 void wxSpinCtrl::OnSpinChange(wxSpinEvent& eventSpin)
 396 {
 397     wxCommandEvent event(wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());
 398     event.SetEventObject(this);
 399     event.SetInt(eventSpin.GetPosition());
 400
 401     (void)GetEventHandler()->ProcessEvent(event);
 402
 403     if ( eventSpin.GetSkipped() )
 404     {
 405         event.Skip();
 406     }
 407 }
 408
 409 // ----------------------------------------------------------------------------
 410 // size calculations
 411 // ----------------------------------------------------------------------------
 412
 413 wxSize wxSpinCtrl::DoGetBestSize() const
 414 {
 415     wxSize sizeBtn = wxSpinButton::DoGetBestSize();
 416     sizeBtn.x += DEFAULT_ITEM_WIDTH + MARGIN_BETWEEN;
 417
 418     int y;
 419     wxGetCharSize(GetHWND(), NULL, &y, &GetFont());
 420     y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(y);
 421
 422     if ( sizeBtn.y < y )
 423     {
 424         // make the text tall enough
 425         sizeBtn.y = y;
 426     }
 427
 428     return sizeBtn;
 429 }
 430
 431 void wxSpinCtrl::DoMoveWindow(int x, int y, int width, int height)
 432 {
 433     int widthBtn = wxSpinButton::DoGetBestSize().x;
 434     int widthText = width - widthBtn - MARGIN_BETWEEN;
 435     if ( widthText <= 0 )
 436     {
 437         wxLogDebug(_T("not enough space for wxSpinCtrl!"));
 438     }
 439
 440     if ( !::MoveWindow(GetBuddyHwnd(), x, y, widthText, height, TRUE) )
 441     {
 442         wxLogLastError(wxT("MoveWindow(buddy)"));
 443     }
 444
 445     x += widthText + MARGIN_BETWEEN;
 446     if ( !::MoveWindow(GetHwnd(), x, y, widthBtn, height, TRUE) )
 447     {
 448         wxLogLastError(wxT("MoveWindow"));
 449     }
 450 }
 451
 452 // get total size of the control
 453 void wxSpinCtrl::DoGetSize(int *x, int *y) const
 454 {
 455     RECT spinrect, textrect, ctrlrect;
 456     GetWindowRect(GetHwnd(), &spinrect);
 457     GetWindowRect(GetBuddyHwnd(), &textrect);
 458     UnionRect(&ctrlrect,&textrect, &spinrect);
 459
 460     if ( x )
 461         *x = ctrlrect.right - ctrlrect.left;
 462     if ( y )
 463         *y = ctrlrect.bottom - ctrlrect.top;
 464 }
 465
 466 void wxSpinCtrl::DoGetPosition(int *x, int *y) const
 467 {
 468     // hack: pretend that our HWND is the text control just for a moment
 469     WXHWND hWnd = GetHWND();
 470     wxConstCast(this, wxSpinCtrl)->m_hWnd = m_hwndBuddy;
 471
 472     wxSpinButton::DoGetPosition(x, y);
 473
 474     wxConstCast(this, wxSpinCtrl)->m_hWnd = hWnd;
 475 }
 476
 477 #endif // __WIN95__
 478
 479 #endif
 480        // wxUSE_SPINCTRL
 481