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