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 wxBorder wxControl::GetDefaultBorder() const
 230 {
 231     // we want to automatically give controls a sunken style (confusingly,
 232     // it may not really mean sunken at all as we map it to WS_EX_CLIENTEDGE
 233     // which is not sunken at all under Windows XP -- rather, just the default)
 234 #if defined(__POCKETPC__) || defined(__SMARTPHONE__)
 235     return wxBORDER_SIMPLE;
 236 #else
 237     return wxBORDER_SUNKEN;
 238 #endif
 239 }
 240
 241 WXDWORD wxControl::MSWGetStyle(long style, WXDWORD *exstyle) const
 242 {
 243     long msStyle = wxWindow::MSWGetStyle(style, exstyle);
 244
 245     if ( AcceptsFocusFromKeyboard() )
 246     {
 247         msStyle |= WS_TABSTOP;
 248     }
 249
 250     return msStyle;
 251 }
 252
 253 wxSize wxControl::DoGetBestSize() const
 254 {
 255     return wxSize(DEFAULT_ITEM_WIDTH, DEFAULT_ITEM_HEIGHT);
 256 }
 257
 258 // This is a helper for all wxControls made with UPDOWN native control.
 259 // In wxMSW it was only wxSpinCtrl derived from wxSpinButton but in
 260 // WinCE of Smartphones this happens also for native wxTextCtrl,
 261 // wxChoice and others.
 262 wxSize wxControl::GetBestSpinnerSize(const bool is_vertical) const
 263 {
 264     // take size according to layout
 265     wxSize bestSize(
 266 #if defined(__SMARTPHONE__) && defined(__WXWINCE__)
 267                     0,GetCharHeight()
 268 #else
 269                     ::GetSystemMetrics(is_vertical ? SM_CXVSCROLL : SM_CXHSCROLL),
 270                     ::GetSystemMetrics(is_vertical ? SM_CYVSCROLL : SM_CYHSCROLL)
 271 #endif
 272     );
 273
 274     // correct size as for undocumented MSW variants cases (WinCE and perhaps others)
 275     if (bestSize.x==0)
 276         bestSize.x = bestSize.y;
 277     if (bestSize.y==0)
 278         bestSize.y = bestSize.x;
 279
 280     // double size according to layout
 281     if (is_vertical)
 282         bestSize.y *= 2;
 283     else
 284         bestSize.x *= 2;
 285
 286     return bestSize;
 287 }
 288
 289 /* static */ wxVisualAttributes
 290 wxControl::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 291 {
 292     wxVisualAttributes attrs;
 293
 294     // old school (i.e. not "common") controls use the standard dialog font
 295     // by default
 296     attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
 297
 298     // most, or at least many, of the controls use the same colours as the
 299     // buttons -- others will have to override this (and possibly simply call
 300     // GetCompositeControlsDefaultAttributes() from their versions)
 301     attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNTEXT);
 302     attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE);
 303
 304     return attrs;
 305 }
 306
 307 // another version for the "composite", i.e. non simple controls
 308 /* static */ wxVisualAttributes
 309 wxControl::GetCompositeControlsDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 310 {
 311     wxVisualAttributes attrs;
 312     attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
 313     attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
 314     attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
 315
 316     return attrs;
 317 }
 318
 319 // ----------------------------------------------------------------------------
 320 // message handling
 321 // ----------------------------------------------------------------------------
 322
 323 bool wxControl::ProcessCommand(wxCommandEvent& event)
 324 {
 325     return GetEventHandler()->ProcessEvent(event);
 326 }
 327
 328 bool wxControl::MSWOnNotify(int idCtrl,
 329                             WXLPARAM lParam,
 330                             WXLPARAM* result)
 331 {
 332     wxEventType eventType wxDUMMY_INITIALIZE(wxEVT_NULL);
 333
 334     NMHDR *hdr = (NMHDR*) lParam;
 335     switch ( hdr->code )
 336     {
 337         case NM_CLICK:
 338             eventType = wxEVT_COMMAND_LEFT_CLICK;
 339             break;
 340
 341         case NM_DBLCLK:
 342             eventType = wxEVT_COMMAND_LEFT_DCLICK;
 343             break;
 344
 345         case NM_RCLICK:
 346             eventType = wxEVT_COMMAND_RIGHT_CLICK;
 347             break;
 348
 349         case NM_RDBLCLK:
 350             eventType = wxEVT_COMMAND_RIGHT_DCLICK;
 351             break;
 352
 353         case NM_SETFOCUS:
 354             eventType = wxEVT_COMMAND_SET_FOCUS;
 355             break;
 356
 357         case NM_KILLFOCUS:
 358             eventType = wxEVT_COMMAND_KILL_FOCUS;
 359             break;
 360
 361         case NM_RETURN:
 362             eventType = wxEVT_COMMAND_ENTER;
 363             break;
 364
 365         default:
 366             return wxWindow::MSWOnNotify(idCtrl, lParam, result);
 367     }
 368
 369     wxCommandEvent event(wxEVT_NULL, m_windowId);
 370     event.SetEventType(eventType);
 371     event.SetEventObject(this);
 372
 373     return GetEventHandler()->ProcessEvent(event);
 374 }
 375
 376 WXHBRUSH wxControl::DoMSWControlColor(WXHDC pDC, wxColour colBg, WXHWND hWnd)
 377 {
 378     HDC hdc = (HDC)pDC;
 379     if ( m_hasFgCol )
 380     {
 381         ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
 382     }
 383
 384     WXHBRUSH hbr = 0;
 385     if ( !colBg.Ok() )
 386     {
 387         hbr = MSWGetBgBrush(pDC, hWnd);
 388
 389         // if the control doesn't have any bg colour, foreground colour will be
 390         // ignored as the return value would be 0 -- so forcefully give it a
 391         // non default background brush in this case
 392         if ( !hbr && m_hasFgCol )
 393             colBg = GetBackgroundColour();
 394     }
 395
 396     // use the background colour override if a valid colour is given
 397     if ( colBg.Ok() )
 398     {
 399         ::SetBkColor(hdc, wxColourToRGB(colBg));
 400
 401         // draw children with the same colour as the parent
 402         wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBg, wxSOLID);
 403
 404         hbr = (WXHBRUSH)brush->GetResourceHandle();
 405
 406     }
 407
 408     // if we use custom background, we should set foreground ourselves too
 409     if ( hbr && !m_hasFgCol )
 410     {
 411         ::SetTextColor(hdc, ::GetSysColor(COLOR_WINDOWTEXT));
 412     }
 413     //else: already set above
 414
 415     return hbr;
 416 }
 417
 418 WXHBRUSH wxControl::MSWControlColor(WXHDC pDC, WXHWND hWnd)
 419 {
 420     wxColour colBg;
 421
 422     if ( HasTransparentBackground() )
 423         ::SetBkMode((HDC)pDC, TRANSPARENT);
 424     else // if the control is opaque it shouldn't use the parents background
 425         colBg = GetBackgroundColour();
 426
 427     return DoMSWControlColor(pDC, colBg, hWnd);
 428 }
 429
 430 WXHBRUSH wxControl::MSWControlColorDisabled(WXHDC pDC)
 431 {
 432     return DoMSWControlColor(pDC,
 433                              wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE),
 434                              GetHWND());
 435 }
 436
 437 // ----------------------------------------------------------------------------
 438 // wxControlWithItems
 439 // ----------------------------------------------------------------------------
 440
 441 void wxControlWithItems::MSWAllocStorage(const wxArrayStringsAdapter& items,
 442                                          unsigned wm)
 443 {
 444     const unsigned numItems = items.GetCount();
 445     unsigned long totalTextLength = numItems; // for trailing '\0' characters
 446     for ( unsigned i = 0; i < numItems; ++i )
 447     {
 448         totalTextLength += items[i].length();
 449     }
 450
 451     if ( SendMessage((HWND)MSWGetItemsHWND(), wm, numItems,
 452                      (LPARAM)totalTextLength*sizeof(wxChar)) == LB_ERRSPACE )
 453     {
 454         wxLogLastError(wxT("SendMessage(XX_INITSTORAGE)"));
 455     }
 456 }
 457
 458 int wxControlWithItems::MSWInsertOrAppendItem(unsigned pos,
 459                                               const wxString& item,
 460                                               unsigned wm)
 461 {
 462     LRESULT n = SendMessage((HWND)MSWGetItemsHWND(), wm, pos,
 463                             (LPARAM)item.wx_str());
 464     if ( n == CB_ERR || n == CB_ERRSPACE )
 465     {
 466         wxLogLastError(wxT("SendMessage(XX_ADD/INSERTSTRING)"));
 467         return wxNOT_FOUND;
 468     }
 469
 470     return n;
 471 }
 472
 473 // ---------------------------------------------------------------------------
 474 // global functions
 475 // ---------------------------------------------------------------------------
 476
 477 // this is used in radiobox.cpp and slider95.cpp and should be removed as soon
 478 // as it is not needed there any more!
 479 //
 480 // Call this repeatedly for several wnds to find the overall size
 481 // of the widget.
 482 // Call it initially with wxDefaultCoord for all values in rect.
 483 // Keep calling for other widgets, and rect will be modified
 484 // to calculate largest bounding rectangle.
 485 void wxFindMaxSize(WXHWND wnd, RECT *rect)
 486 {
 487     int left = rect->left;
 488     int right = rect->right;
 489     int top = rect->top;
 490     int bottom = rect->bottom;
 491
 492     GetWindowRect((HWND) wnd, rect);
 493
 494     if (left < 0)
 495         return;
 496
 497     if (left < rect->left)
 498         rect->left = left;
 499
 500     if (right > rect->right)
 501         rect->right = right;
 502
 503     if (top < rect->top)
 504         rect->top = top;
 505
 506     if (bottom > rect->bottom)
 507         rect->bottom = bottom;
 508 }
 509
 510 #endif // wxUSE_CONTROLS