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