src/msw/control.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/control.cpp
   3 // Purpose:     wxControl class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   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_CONTROLS
  28
  29 #include "wx/control.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
  33     #include "wx/event.h"
  34     #include "wx/app.h"
  35     #include "wx/dcclient.h"
  36     #include "wx/log.h"
  37     #include "wx/settings.h"
  38     #include "wx/ctrlsub.h"
  39 #endif
  40
  41 #if wxUSE_LISTCTRL
  42     #include "wx/listctrl.h"
  43 #endif // wxUSE_LISTCTRL
  44
  45 #if wxUSE_TREECTRL
  46     #include "wx/treectrl.h"
  47 #endif // wxUSE_TREECTRL
  48
  49 #include "wx/msw/private.h"
  50 #include "wx/msw/uxtheme.h"
  51
  52 // ----------------------------------------------------------------------------
  53 // wxWin macros
  54 // ----------------------------------------------------------------------------
  55
  56 IMPLEMENT_ABSTRACT_CLASS(wxControl, wxWindow)
  57
  58 // ============================================================================
  59 // wxControl implementation
  60 // ============================================================================
  61
  62 // ----------------------------------------------------------------------------
  63 // wxControl ctor/dtor
  64 // ----------------------------------------------------------------------------
  65
  66 wxControl::~wxControl()
  67 {
  68     m_isBeingDeleted = true;
  69 }
  70
  71 // ----------------------------------------------------------------------------
  72 // control window creation
  73 // ----------------------------------------------------------------------------
  74
  75 bool wxControl::Create(wxWindow *parent,
  76                        wxWindowID id,
  77                        const wxPoint& pos,
  78                        const wxSize& size,
  79                        long style,
  80                        const wxValidator& wxVALIDATOR_PARAM(validator),
  81                        const wxString& name)
  82 {
  83     if ( !wxWindow::Create(parent, id, pos, size, style, name) )
  84         return false;
  85
  86 #if wxUSE_VALIDATORS
  87     SetValidator(validator);
  88 #endif
  89
  90     return true;
  91 }
  92
  93 bool wxControl::MSWCreateControl(const wxChar *classname,
  94                                  const wxString& label,
  95                                  const wxPoint& pos,
  96                                  const wxSize& size)
  97 {
  98     WXDWORD exstyle;
  99     WXDWORD msStyle = MSWGetStyle(GetWindowStyle(), &exstyle);
 100
 101     return MSWCreateControl(classname, msStyle, pos, size, label, exstyle);
 102 }
 103
 104 bool wxControl::MSWCreateControl(const wxChar *classname,
 105                                  WXDWORD style,
 106                                  const wxPoint& pos,
 107                                  const wxSize& size,
 108                                  const wxString& label,
 109                                  WXDWORD exstyle)
 110 {
 111     // if no extended style given, determine it ourselves
 112     if ( exstyle == (WXDWORD)-1 )
 113     {
 114         exstyle = 0;
 115         (void) MSWGetStyle(GetWindowStyle(), &exstyle);
 116     }
 117
 118     // all controls should have this style
 119     style |= WS_CHILD;
 120
 121     // create the control visible if it's currently shown for wxWidgets
 122     if ( m_isShown )
 123     {
 124         style |= WS_VISIBLE;
 125     }
 126
 127     // choose the position for the control: we have a problem with default size
 128     // here as we can't calculate the best size before the control exists
 129     // (DoGetBestSize() may need to use m_hWnd), so just choose the minimal
 130     // possible but non 0 size because 0 window width/height result in problems
 131     // elsewhere
 132     int x = pos.x == wxDefaultCoord ? 0 : pos.x,
 133         y = pos.y == wxDefaultCoord ? 0 : pos.y,
 134         w = size.x == wxDefaultCoord ? 1 : size.x,
 135         h = size.y == wxDefaultCoord ? 1 : size.y;
 136
 137     // ... and adjust it to account for a possible parent frames toolbar
 138     AdjustForParentClientOrigin(x, y);
 139
 140     m_hWnd = (WXHWND)::CreateWindowEx
 141                        (
 142                         exstyle,            // extended style
 143                         classname,          // the kind of control to create
 144                         label.wx_str(),     // the window name
 145                         style,              // the window style
 146                         x, y, w, h,         // the window position and size
 147                         GetHwndOf(GetParent()),  // parent
 148                         (HMENU)GetId(),     // child id
 149                         wxGetInstance(),    // app instance
 150                         NULL                // creation parameters
 151                        );
 152
 153     if ( !m_hWnd )
 154     {
 155 #ifdef __WXDEBUG__
 156         wxFAIL_MSG(wxString::Format
 157                    (
 158                     _T("CreateWindowEx(\"%s\", flags=%08x, ex=%08x) failed"),
 159                     classname, (unsigned int)style, (unsigned int)exstyle
 160                    ));
 161 #endif // __WXDEBUG__
 162
 163         return false;
 164     }
 165
 166     // saving the label in m_labelOrig to return it verbatim
 167     // later in GetLabel()
 168     m_labelOrig = label;
 169
 170     // install wxWidgets window proc for this window
 171     SubclassWin(m_hWnd);
 172
 173     // set up fonts and colours
 174     InheritAttributes();
 175     if ( !m_hasFont )
 176     {
 177         bool setFont = true;
 178
 179         wxFont font = GetDefaultAttributes().font;
 180
 181         // if we set a font for {list,tree}ctrls and the font size is changed in
 182         // the display properties then the font size for these controls doesn't
 183         // automatically adjust when they receive WM_SETTINGCHANGE
 184
 185         // FIXME: replace the dynamic casts with virtual function calls!!
 186 #if wxUSE_LISTCTRL || wxUSE_TREECTRL
 187         bool testFont = false;
 188 #if wxUSE_LISTCTRL
 189         if ( wxDynamicCastThis(wxListCtrl) )
 190             testFont = true;
 191 #endif // wxUSE_LISTCTRL
 192 #if wxUSE_TREECTRL
 193         if ( wxDynamicCastThis(wxTreeCtrl) )
 194             testFont = true;
 195 #endif // wxUSE_TREECTRL
 196
 197         if ( testFont )
 198         {
 199             // not sure if we need to explicitly set the font here for Win95/NT4
 200             // but we definitely can't do it for any newer version
 201             // see wxGetCCDefaultFont() in src/msw/settings.cpp for explanation
 202             // of why this test works
 203
 204             // TODO: test Win95/NT4 to see if this is needed or breaks the
 205             // font resizing as it does on newer versions
 206             if ( font != wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT) )
 207             {
 208                 setFont = false;
 209             }
 210         }
 211 #endif // wxUSE_LISTCTRL || wxUSE_TREECTRL
 212
 213         if ( setFont )
 214         {
 215             SetFont(GetDefaultAttributes().font);
 216         }
 217     }
 218
 219     // set the size now if no initial size specified
 220     SetInitialSize(size);
 221
 222     return true;
 223 }
 224
 225 // ----------------------------------------------------------------------------
 226 // various accessors
 227 // ----------------------------------------------------------------------------
 228
 229 WXDWORD wxControl::MSWGetStyle(long style, WXDWORD *exstyle) const
 230 {
 231     long msStyle = wxWindow::MSWGetStyle(style, exstyle);
 232
 233     if ( AcceptsFocusFromKeyboard() )
 234     {
 235         msStyle |= WS_TABSTOP;
 236     }
 237
 238     return msStyle;
 239 }
 240
 241 wxSize wxControl::DoGetBestSize() const
 242 {
 243     return wxSize(DEFAULT_ITEM_WIDTH, DEFAULT_ITEM_HEIGHT);
 244 }
 245
 246 wxBorder wxControl::GetDefaultBorder() const
 247 {
 248     return wxControlBase::GetDefaultBorder();
 249
 250 //  return GetDefaultBorderForControl();
 251 }
 252
 253 // This is a helper for all wxControls made with UPDOWN native control.
 254 // In wxMSW it was only wxSpinCtrl derived from wxSpinButton but in
 255 // WinCE of Smartphones this happens also for native wxTextCtrl,
 256 // wxChoice and others.
 257 wxSize wxControl::GetBestSpinnerSize(const bool is_vertical) const
 258 {
 259     // take size according to layout
 260     wxSize bestSize(
 261 #if defined(__SMARTPHONE__) && defined(__WXWINCE__)
 262                     0,GetCharHeight()
 263 #else
 264                     ::GetSystemMetrics(is_vertical ? SM_CXVSCROLL : SM_CXHSCROLL),
 265                     ::GetSystemMetrics(is_vertical ? SM_CYVSCROLL : SM_CYHSCROLL)
 266 #endif
 267     );
 268
 269     // correct size as for undocumented MSW variants cases (WinCE and perhaps others)
 270     if (bestSize.x==0)
 271         bestSize.x = bestSize.y;
 272     if (bestSize.y==0)
 273         bestSize.y = bestSize.x;
 274
 275     // double size according to layout
 276     if (is_vertical)
 277         bestSize.y *= 2;
 278     else
 279         bestSize.x *= 2;
 280
 281     return bestSize;
 282 }
 283
 284 /* static */ wxVisualAttributes
 285 wxControl::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 286 {
 287     wxVisualAttributes attrs;
 288
 289     // old school (i.e. not "common") controls use the standard dialog font
 290     // by default
 291     attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
 292
 293     // most, or at least many, of the controls use the same colours as the
 294     // buttons -- others will have to override this (and possibly simply call
 295     // GetCompositeControlsDefaultAttributes() from their versions)
 296     attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNTEXT);
 297     attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE);
 298
 299     return attrs;
 300 }
 301
 302 // another version for the "composite", i.e. non simple controls
 303 /* static */ wxVisualAttributes
 304 wxControl::GetCompositeControlsDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 305 {
 306     wxVisualAttributes attrs;
 307     attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
 308     attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
 309     attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
 310
 311     return attrs;
 312 }
 313
 314 // ----------------------------------------------------------------------------
 315 // message handling
 316 // ----------------------------------------------------------------------------
 317
 318 bool wxControl::ProcessCommand(wxCommandEvent& event)
 319 {
 320     return GetEventHandler()->ProcessEvent(event);
 321 }
 322
 323 bool wxControl::MSWOnNotify(int idCtrl,
 324                             WXLPARAM lParam,
 325                             WXLPARAM* result)
 326 {
 327     wxEventType eventType wxDUMMY_INITIALIZE(wxEVT_NULL);
 328
 329     NMHDR *hdr = (NMHDR*) lParam;
 330     switch ( hdr->code )
 331     {
 332         case NM_CLICK:
 333             eventType = wxEVT_COMMAND_LEFT_CLICK;
 334             break;
 335
 336         case NM_DBLCLK:
 337             eventType = wxEVT_COMMAND_LEFT_DCLICK;
 338             break;
 339
 340         case NM_RCLICK:
 341             eventType = wxEVT_COMMAND_RIGHT_CLICK;
 342             break;
 343
 344         case NM_RDBLCLK:
 345             eventType = wxEVT_COMMAND_RIGHT_DCLICK;
 346             break;
 347
 348         case NM_SETFOCUS:
 349             eventType = wxEVT_COMMAND_SET_FOCUS;
 350             break;
 351
 352         case NM_KILLFOCUS:
 353             eventType = wxEVT_COMMAND_KILL_FOCUS;
 354             break;
 355
 356         case NM_RETURN:
 357             eventType = wxEVT_COMMAND_ENTER;
 358             break;
 359
 360         default:
 361             return wxWindow::MSWOnNotify(idCtrl, lParam, result);
 362     }
 363
 364     wxCommandEvent event(wxEVT_NULL, m_windowId);
 365     event.SetEventType(eventType);
 366     event.SetEventObject(this);
 367
 368     return GetEventHandler()->ProcessEvent(event);
 369 }
 370
 371 WXHBRUSH wxControl::DoMSWControlColor(WXHDC pDC, wxColour colBg, WXHWND hWnd)
 372 {
 373     HDC hdc = (HDC)pDC;
 374     if ( m_hasFgCol )
 375     {
 376         ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
 377     }
 378
 379     WXHBRUSH hbr = 0;
 380     if ( !colBg.Ok() )
 381     {
 382         hbr = MSWGetBgBrush(pDC, hWnd);
 383
 384         // if the control doesn't have any bg colour, foreground colour will be
 385         // ignored as the return value would be 0 -- so forcefully give it a
 386         // non default background brush in this case
 387         if ( !hbr && m_hasFgCol )
 388             colBg = GetBackgroundColour();
 389     }
 390
 391     // use the background colour override if a valid colour is given
 392     if ( colBg.Ok() )
 393     {
 394         ::SetBkColor(hdc, wxColourToRGB(colBg));
 395
 396         // draw children with the same colour as the parent
 397         wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBg, wxSOLID);
 398
 399         hbr = (WXHBRUSH)brush->GetResourceHandle();
 400
 401     }
 402
 403     // if we use custom background, we should set foreground ourselves too
 404     if ( hbr && !m_hasFgCol )
 405     {
 406         ::SetTextColor(hdc, ::GetSysColor(COLOR_WINDOWTEXT));
 407     }
 408     //else: already set above
 409
 410     return hbr;
 411 }
 412
 413 WXHBRUSH wxControl::MSWControlColor(WXHDC pDC, WXHWND hWnd)
 414 {
 415     wxColour colBg;
 416
 417     if ( HasTransparentBackground() )
 418         ::SetBkMode((HDC)pDC, TRANSPARENT);
 419     else // if the control is opaque it shouldn't use the parents background
 420         colBg = GetBackgroundColour();
 421
 422     return DoMSWControlColor(pDC, colBg, hWnd);
 423 }
 424
 425 WXHBRUSH wxControl::MSWControlColorDisabled(WXHDC pDC)
 426 {
 427     return DoMSWControlColor(pDC,
 428                              wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE),
 429                              GetHWND());
 430 }
 431
 432 // ----------------------------------------------------------------------------
 433 // wxControlWithItems
 434 // ----------------------------------------------------------------------------
 435
 436 void wxControlWithItems::MSWAllocStorage(const wxArrayStringsAdapter& items,
 437                                          unsigned wm)
 438 {
 439     const unsigned numItems = items.GetCount();
 440     unsigned long totalTextLength = numItems; // for trailing '\0' characters
 441     for ( unsigned i = 0; i < numItems; ++i )
 442     {
 443         totalTextLength += items[i].length();
 444     }
 445
 446     if ( SendMessage((HWND)MSWGetItemsHWND(), wm, numItems,
 447                      (LPARAM)totalTextLength*sizeof(wxChar)) == LB_ERRSPACE )
 448     {
 449         wxLogLastError(wxT("SendMessage(XX_INITSTORAGE)"));
 450     }
 451 }
 452
 453 int wxControlWithItems::MSWInsertOrAppendItem(unsigned pos,
 454                                               const wxString& item,
 455                                               unsigned wm)
 456 {
 457     LRESULT n = SendMessage((HWND)MSWGetItemsHWND(), wm, pos,
 458                             (LPARAM)item.wx_str());
 459     if ( n == CB_ERR || n == CB_ERRSPACE )
 460     {
 461         wxLogLastError(wxT("SendMessage(XX_ADD/INSERTSTRING)"));
 462         return wxNOT_FOUND;
 463     }
 464
 465     return n;
 466 }
 467
 468 // ---------------------------------------------------------------------------
 469 // global functions
 470 // ---------------------------------------------------------------------------
 471
 472 // this is used in radiobox.cpp and slider95.cpp and should be removed as soon
 473 // as it is not needed there any more!
 474 //
 475 // Call this repeatedly for several wnds to find the overall size
 476 // of the widget.
 477 // Call it initially with wxDefaultCoord for all values in rect.
 478 // Keep calling for other widgets, and rect will be modified
 479 // to calculate largest bounding rectangle.
 480 void wxFindMaxSize(WXHWND wnd, RECT *rect)
 481 {
 482     int left = rect->left;
 483     int right = rect->right;
 484     int top = rect->top;
 485     int bottom = rect->bottom;
 486
 487     GetWindowRect((HWND) wnd, rect);
 488
 489     if (left < 0)
 490         return;
 491
 492     if (left < rect->left)
 493         rect->left = left;
 494
 495     if (right > rect->right)
 496         rect->right = right;
 497
 498     if (top < rect->top)
 499         rect->top = top;
 500
 501     if (bottom > rect->bottom)
 502         rect->bottom = bottom;
 503 }
 504
 505 #endif // wxUSE_CONTROLS