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)wxUIntToPtr(GetId()),    // child id
 149                         wxGetInstance(),    // app instance
 150                         NULL                // creation parameters
 151                        );
 152
 153     if ( !m_hWnd )
 154     {
 155 #ifdef __WXDEBUG__
 156         wxLogLastError(wxString::Format
 157                        (
 158                         _T("CreateWindowEx(\"%s\", flags=%08lx, ex=%08lx)"),
 159                         classname, style, exstyle
 160                        ));
 161 #endif // __WXDEBUG__
 162
 163         return false;
 164     }
 165
 166 #if !wxUSE_UNICODE
 167     // Text labels starting with the character 0xff (which is a valid character
 168     // in many code pages) don't appear correctly as CreateWindowEx() has some
 169     // special treatment for this case, apparently the strings starting with -1
 170     // are not really strings but something called "ordinals". There is no
 171     // documentation about it but the fact is that the label gets mangled or
 172     // not displayed at all if we don't do this, see #9572.
 173     //
 174     // Notice that 0xffff is not a valid Unicode character so the problem
 175     // doesn't arise in Unicode build.
 176     if ( !label.empty() && label[0] == -1 )
 177         ::SetWindowText(GetHwnd(), label.wx_str());
 178 #endif // !wxUSE_UNICODE
 179
 180     // saving the label in m_labelOrig to return it verbatim
 181     // later in GetLabel()
 182     m_labelOrig = label;
 183
 184     // install wxWidgets window proc for this window
 185     SubclassWin(m_hWnd);
 186
 187     // set up fonts and colours
 188     InheritAttributes();
 189     if ( !m_hasFont )
 190     {
 191         bool setFont = true;
 192
 193         wxFont font = GetDefaultAttributes().font;
 194
 195         // if we set a font for {list,tree}ctrls and the font size is changed in
 196         // the display properties then the font size for these controls doesn't
 197         // automatically adjust when they receive WM_SETTINGCHANGE
 198
 199         // FIXME: replace the dynamic casts with virtual function calls!!
 200 #if wxUSE_LISTCTRL || wxUSE_TREECTRL
 201         bool testFont = false;
 202 #if wxUSE_LISTCTRL
 203         if ( wxDynamicCastThis(wxListCtrl) )
 204             testFont = true;
 205 #endif // wxUSE_LISTCTRL
 206 #if wxUSE_TREECTRL
 207         if ( wxDynamicCastThis(wxTreeCtrl) )
 208             testFont = true;
 209 #endif // wxUSE_TREECTRL
 210
 211         if ( testFont )
 212         {
 213             // not sure if we need to explicitly set the font here for Win95/NT4
 214             // but we definitely can't do it for any newer version
 215             // see wxGetCCDefaultFont() in src/msw/settings.cpp for explanation
 216             // of why this test works
 217
 218             // TODO: test Win95/NT4 to see if this is needed or breaks the
 219             // font resizing as it does on newer versions
 220             if ( font != wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT) )
 221             {
 222                 setFont = false;
 223             }
 224         }
 225 #endif // wxUSE_LISTCTRL || wxUSE_TREECTRL
 226
 227         if ( setFont )
 228         {
 229             SetFont(GetDefaultAttributes().font);
 230         }
 231     }
 232
 233     // set the size now if no initial size specified
 234     SetInitialSize(size);
 235
 236     return true;
 237 }
 238
 239 // ----------------------------------------------------------------------------
 240 // various accessors
 241 // ----------------------------------------------------------------------------
 242
 243 WXDWORD wxControl::MSWGetStyle(long style, WXDWORD *exstyle) const
 244 {
 245     long msStyle = wxWindow::MSWGetStyle(style, exstyle);
 246
 247     if ( AcceptsFocusFromKeyboard() )
 248     {
 249         msStyle |= WS_TABSTOP;
 250     }
 251
 252     return msStyle;
 253 }
 254
 255 wxSize wxControl::DoGetBestSize() const
 256 {
 257     return wxSize(DEFAULT_ITEM_WIDTH, DEFAULT_ITEM_HEIGHT);
 258 }
 259
 260 wxBorder wxControl::GetDefaultBorder() const
 261 {
 262     return wxControlBase::GetDefaultBorder();
 263 }
 264
 265 // This is a helper for all wxControls made with UPDOWN native control.
 266 // In wxMSW it was only wxSpinCtrl derived from wxSpinButton but in
 267 // WinCE of Smartphones this happens also for native wxTextCtrl,
 268 // wxChoice and others.
 269 wxSize wxControl::GetBestSpinnerSize(const bool is_vertical) const
 270 {
 271     // take size according to layout
 272     wxSize bestSize(
 273 #if defined(__SMARTPHONE__) && defined(__WXWINCE__)
 274                     0,GetCharHeight()
 275 #else
 276                     ::GetSystemMetrics(is_vertical ? SM_CXVSCROLL : SM_CXHSCROLL),
 277                     ::GetSystemMetrics(is_vertical ? SM_CYVSCROLL : SM_CYHSCROLL)
 278 #endif
 279     );
 280
 281     // correct size as for undocumented MSW variants cases (WinCE and perhaps others)
 282     if (bestSize.x==0)
 283         bestSize.x = bestSize.y;
 284     if (bestSize.y==0)
 285         bestSize.y = bestSize.x;
 286
 287     // double size according to layout
 288     if (is_vertical)
 289         bestSize.y *= 2;
 290     else
 291         bestSize.x *= 2;
 292
 293     return bestSize;
 294 }
 295
 296 /* static */ wxVisualAttributes
 297 wxControl::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 298 {
 299     wxVisualAttributes attrs;
 300
 301     // old school (i.e. not "common") controls use the standard dialog font
 302     // by default
 303     attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
 304
 305     // most, or at least many, of the controls use the same colours as the
 306     // buttons -- others will have to override this (and possibly simply call
 307     // GetCompositeControlsDefaultAttributes() from their versions)
 308     attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNTEXT);
 309     attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE);
 310
 311     return attrs;
 312 }
 313
 314 // another version for the "composite", i.e. non simple controls
 315 /* static */ wxVisualAttributes
 316 wxControl::GetCompositeControlsDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 317 {
 318     wxVisualAttributes attrs;
 319     attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
 320     attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
 321     attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
 322
 323     return attrs;
 324 }
 325
 326 // ----------------------------------------------------------------------------
 327 // message handling
 328 // ----------------------------------------------------------------------------
 329
 330 bool wxControl::ProcessCommand(wxCommandEvent& event)
 331 {
 332     return HandleWindowEvent(event);
 333 }
 334
 335 bool wxControl::MSWOnNotify(int idCtrl,
 336                             WXLPARAM lParam,
 337                             WXLPARAM* result)
 338 {
 339     wxEventType eventType wxDUMMY_INITIALIZE(wxEVT_NULL);
 340
 341     NMHDR *hdr = (NMHDR*) lParam;
 342     switch ( hdr->code )
 343     {
 344         case NM_CLICK:
 345             eventType = wxEVT_COMMAND_LEFT_CLICK;
 346             break;
 347
 348         case NM_DBLCLK:
 349             eventType = wxEVT_COMMAND_LEFT_DCLICK;
 350             break;
 351
 352         case NM_RCLICK:
 353             eventType = wxEVT_COMMAND_RIGHT_CLICK;
 354             break;
 355
 356         case NM_RDBLCLK:
 357             eventType = wxEVT_COMMAND_RIGHT_DCLICK;
 358             break;
 359
 360         case NM_SETFOCUS:
 361             eventType = wxEVT_COMMAND_SET_FOCUS;
 362             break;
 363
 364         case NM_KILLFOCUS:
 365             eventType = wxEVT_COMMAND_KILL_FOCUS;
 366             break;
 367
 368         case NM_RETURN:
 369             eventType = wxEVT_COMMAND_ENTER;
 370             break;
 371
 372         default:
 373             return wxWindow::MSWOnNotify(idCtrl, lParam, result);
 374     }
 375
 376     wxCommandEvent event(wxEVT_NULL, m_windowId);
 377     event.SetEventType(eventType);
 378     event.SetEventObject(this);
 379
 380     return HandleWindowEvent(event);
 381 }
 382
 383 WXHBRUSH wxControl::DoMSWControlColor(WXHDC pDC, wxColour colBg, WXHWND hWnd)
 384 {
 385     HDC hdc = (HDC)pDC;
 386     if ( m_hasFgCol )
 387     {
 388         ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
 389     }
 390
 391     WXHBRUSH hbr = 0;
 392     if ( !colBg.Ok() )
 393     {
 394         hbr = MSWGetBgBrush(pDC, hWnd);
 395
 396         // if the control doesn't have any bg colour, foreground colour will be
 397         // ignored as the return value would be 0 -- so forcefully give it a
 398         // non default background brush in this case
 399         if ( !hbr && m_hasFgCol )
 400             colBg = GetBackgroundColour();
 401     }
 402
 403     // use the background colour override if a valid colour is given
 404     if ( colBg.Ok() )
 405     {
 406         ::SetBkColor(hdc, wxColourToRGB(colBg));
 407
 408         // draw children with the same colour as the parent
 409         wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBg,
 410                                                            wxBRUSHSTYLE_SOLID);
 411         hbr = (WXHBRUSH)brush->GetResourceHandle();
 412     }
 413
 414     // if we use custom background, we should set foreground ourselves too
 415     if ( hbr && !m_hasFgCol )
 416     {
 417         ::SetTextColor(hdc, ::GetSysColor(COLOR_WINDOWTEXT));
 418     }
 419     //else: already set above
 420
 421     return hbr;
 422 }
 423
 424 WXHBRUSH wxControl::MSWControlColor(WXHDC pDC, WXHWND hWnd)
 425 {
 426     wxColour colBg;
 427
 428     if ( HasTransparentBackground() )
 429         ::SetBkMode((HDC)pDC, TRANSPARENT);
 430     else // if the control is opaque it shouldn't use the parents background
 431         colBg = GetBackgroundColour();
 432
 433     return DoMSWControlColor(pDC, colBg, hWnd);
 434 }
 435
 436 WXHBRUSH wxControl::MSWControlColorDisabled(WXHDC pDC)
 437 {
 438     return DoMSWControlColor(pDC,
 439                              wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE),
 440                              GetHWND());
 441 }
 442
 443 // ----------------------------------------------------------------------------
 444 // wxControlWithItems
 445 // ----------------------------------------------------------------------------
 446
 447 void wxControlWithItems::MSWAllocStorage(const wxArrayStringsAdapter& items,
 448                                          unsigned wm)
 449 {
 450     const unsigned numItems = items.GetCount();
 451     unsigned long totalTextLength = numItems; // for trailing '\0' characters
 452     for ( unsigned i = 0; i < numItems; ++i )
 453     {
 454         totalTextLength += items[i].length();
 455     }
 456
 457     if ( SendMessage((HWND)MSWGetItemsHWND(), wm, numItems,
 458                      (LPARAM)totalTextLength*sizeof(wxChar)) == LB_ERRSPACE )
 459     {
 460         wxLogLastError(wxT("SendMessage(XX_INITSTORAGE)"));
 461     }
 462 }
 463
 464 int wxControlWithItems::MSWInsertOrAppendItem(unsigned pos,
 465                                               const wxString& item,
 466                                               unsigned wm)
 467 {
 468     LRESULT n = SendMessage((HWND)MSWGetItemsHWND(), wm, pos,
 469                             (LPARAM)item.wx_str());
 470     if ( n == CB_ERR || n == CB_ERRSPACE )
 471     {
 472         wxLogLastError(wxT("SendMessage(XX_ADD/INSERTSTRING)"));
 473         return wxNOT_FOUND;
 474     }
 475
 476     return n;
 477 }
 478
 479 // ---------------------------------------------------------------------------
 480 // global functions
 481 // ---------------------------------------------------------------------------
 482
 483 // this is used in radiobox.cpp and slider95.cpp and should be removed as soon
 484 // as it is not needed there any more!
 485 //
 486 // Call this repeatedly for several wnds to find the overall size
 487 // of the widget.
 488 // Call it initially with wxDefaultCoord for all values in rect.
 489 // Keep calling for other widgets, and rect will be modified
 490 // to calculate largest bounding rectangle.
 491 void wxFindMaxSize(WXHWND wnd, RECT *rect)
 492 {
 493     int left = rect->left;
 494     int right = rect->right;
 495     int top = rect->top;
 496     int bottom = rect->bottom;
 497
 498     GetWindowRect((HWND) wnd, rect);
 499
 500     if (left < 0)
 501         return;
 502
 503     if (left < rect->left)
 504         rect->left = left;
 505
 506     if (right > rect->right)
 507         rect->right = right;
 508
 509     if (top < rect->top)
 510         rect->top = top;
 511
 512     if (bottom > rect->bottom)
 513         rect->bottom = bottom;
 514 }
 515
 516 #endif // wxUSE_CONTROLS