src/msw/combobox.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/combobox.cpp
   3 // Purpose:     wxComboBox 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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  21 #pragma implementation "combobox.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #if wxUSE_COMBOBOX
  32
  33 #ifndef WX_PRECOMP
  34     #include "wx/settings.h"
  35     #include "wx/log.h"
  36     // for wxEVT_COMMAND_TEXT_ENTER
  37     #include "wx/textctrl.h"
  38 #endif
  39
  40 #include "wx/combobox.h"
  41 #include "wx/brush.h"
  42 #include "wx/clipbrd.h"
  43 #include "wx/msw/private.h"
  44
  45 #if wxUSE_TOOLTIPS
  46     #if !defined(__GNUWIN32_OLD__) || defined(__CYGWIN10__)
  47         #include <commctrl.h>
  48     #endif
  49     #include "wx/tooltip.h"
  50 #endif // wxUSE_TOOLTIPS
  51
  52 // ----------------------------------------------------------------------------
  53 // wxWin macros
  54 // ----------------------------------------------------------------------------
  55
  56 #if wxUSE_EXTENDED_RTTI
  57 IMPLEMENT_DYNAMIC_CLASS_XTI(wxComboBox, wxControl,"wx/combobox.h")
  58
  59 WX_BEGIN_PROPERTIES_TABLE(wxComboBox)
  60     // TODO DELEGATES
  61         WX_PROPERTY( Font , wxFont , SetFont , GetFont  , )
  62     WX_PROPERTY_COLLECTION( Choices , wxArrayString , wxString , AppendString , GetStrings )
  63         WX_PROPERTY( Value ,wxString, SetValue, GetValue, )
  64         WX_PROPERTY( Selection ,int, SetSelectionLine, GetSelection, )
  65 WX_END_PROPERTIES_TABLE()
  66
  67 WX_BEGIN_HANDLERS_TABLE(wxComboBox)
  68 WX_END_HANDLERS_TABLE()
  69
  70 WX_CONSTRUCTOR_5( wxComboBox , wxWindow* , Parent , wxWindowID , Id , wxString , Value , wxPoint , Position , wxSize , Size )
  71 #else
  72 IMPLEMENT_DYNAMIC_CLASS(wxComboBox, wxControl)
  73 #endif
  74
  75 // ----------------------------------------------------------------------------
  76 // function prototypes
  77 // ----------------------------------------------------------------------------
  78
  79 LRESULT APIENTRY _EXPORT wxComboEditWndProc(HWND hWnd,
  80                                             UINT message,
  81                                             WPARAM wParam,
  82                                             LPARAM lParam);
  83
  84 // ---------------------------------------------------------------------------
  85 // global vars
  86 // ---------------------------------------------------------------------------
  87
  88 // the pointer to standard radio button wnd proc
  89 static WXFARPROC gs_wndprocEdit = (WXFARPROC)NULL;
  90
  91 // ============================================================================
  92 // implementation
  93 // ============================================================================
  94
  95 // ----------------------------------------------------------------------------
  96 // wnd proc for subclassed edit control
  97 // ----------------------------------------------------------------------------
  98
  99 LRESULT APIENTRY _EXPORT wxComboEditWndProc(HWND hWnd,
 100                                             UINT message,
 101                                             WPARAM wParam,
 102                                             LPARAM lParam)
 103 {
 104     HWND hwndCombo = ::GetParent(hWnd);
 105     wxWindow *win = wxFindWinFromHandle((WXHWND)hwndCombo);
 106
 107     switch ( message )
 108     {
 109         // forward some messages to the combobox to generate the appropriate
 110         // wxEvents from them
 111         case WM_KEYUP:
 112         case WM_KEYDOWN:
 113         case WM_CHAR:
 114         case WM_SETFOCUS:
 115         case WM_KILLFOCUS:
 116             {
 117                 wxComboBox *combo = wxDynamicCast(win, wxComboBox);
 118                 if ( !combo )
 119                 {
 120                     // we can get WM_KILLFOCUS while our parent is already half
 121                     // destroyed and hence doesn't look like a combobx any
 122                     // longer, check for it to avoid bogus assert failures
 123                     if ( !win->IsBeingDeleted() )
 124                     {
 125                         wxFAIL_MSG( _T("should have combo as parent") );
 126                     }
 127                 }
 128                 else if ( combo->MSWProcessEditMsg(message, wParam, lParam) )
 129                 {
 130                     // handled by parent
 131                     return 0;
 132                 }
 133             }
 134             break;
 135
 136         case WM_GETDLGCODE:
 137             {
 138                 wxCHECK_MSG( win, 0, _T("should have a parent") );
 139
 140                 if ( win->GetWindowStyle() & wxPROCESS_ENTER )
 141                 {
 142                     // need to return a custom dlg code or we'll never get it
 143                     return DLGC_WANTMESSAGE;
 144                 }
 145             }
 146             break;
 147
 148         // deal with tooltips here
 149 #if wxUSE_TOOLTIPS && defined(TTN_NEEDTEXT)
 150         case WM_NOTIFY:
 151             {
 152                 wxCHECK_MSG( win, 0, _T("should have a parent") );
 153
 154                 NMHDR* hdr = (NMHDR *)lParam;
 155                 if ( hdr->code == TTN_NEEDTEXT )
 156                 {
 157                     wxToolTip *tooltip = win->GetToolTip();
 158                     if ( tooltip )
 159                     {
 160                         TOOLTIPTEXT *ttt = (TOOLTIPTEXT *)lParam;
 161                         ttt->lpszText = (wxChar *)tooltip->GetTip().c_str();
 162                     }
 163
 164                     // processed
 165                     return 0;
 166                 }
 167             }
 168             break;
 169 #endif // wxUSE_TOOLTIPS
 170     }
 171
 172     return ::CallWindowProc(CASTWNDPROC gs_wndprocEdit, hWnd, message, wParam, lParam);
 173 }
 174
 175 WXHBRUSH wxComboBox::OnCtlColor(WXHDC pDC, WXHWND WXUNUSED(pWnd), WXUINT WXUNUSED(nCtlColor),
 176                                WXUINT WXUNUSED(message),
 177                                WXWPARAM WXUNUSED(wParam),
 178                                WXLPARAM WXUNUSED(lParam)
 179     )
 180 {
 181     HDC hdc = (HDC)pDC;
 182     wxColour colBack = GetBackgroundColour();
 183
 184     if (!IsEnabled())
 185         colBack = wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE);
 186
 187     ::SetBkColor(hdc, wxColourToRGB(colBack));
 188     ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
 189
 190     wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBack, wxSOLID);
 191
 192     return (WXHBRUSH)brush->GetResourceHandle();
 193 }
 194
 195 // ----------------------------------------------------------------------------
 196 // wxComboBox
 197 // ----------------------------------------------------------------------------
 198
 199 bool wxComboBox::MSWProcessEditMsg(WXUINT msg, WXWPARAM wParam, WXLPARAM lParam)
 200 {
 201     switch ( msg )
 202     {
 203         case WM_CHAR:
 204             // for compatibility with wxTextCtrl, generate a special message
 205             // when Enter is pressed
 206             if ( wParam == VK_RETURN )
 207             {
 208                 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_windowId);
 209                 InitCommandEvent(event);
 210                 event.SetString(GetValue());
 211                 event.SetInt(GetSelection());
 212                 ProcessCommand(event);
 213             }
 214
 215             return HandleChar(wParam, lParam, TRUE /* isASCII */);
 216
 217         case WM_KEYDOWN:
 218             return HandleKeyDown(wParam, lParam);
 219
 220         case WM_KEYUP:
 221             return HandleKeyUp(wParam, lParam);
 222
 223         case WM_SETFOCUS:
 224             return HandleSetFocus((WXHWND)wParam);
 225
 226         case WM_KILLFOCUS:
 227             return HandleKillFocus((WXHWND)wParam);
 228     }
 229
 230     return FALSE;
 231 }
 232
 233 bool wxComboBox::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 234 {
 235     wxString value;
 236     int sel = -1;
 237     switch ( param )
 238     {
 239         case CBN_SELCHANGE:
 240             sel = GetSelection();
 241             if ( sel > -1 )
 242             {
 243                 value = GetString(sel);
 244
 245                 wxCommandEvent event(wxEVT_COMMAND_COMBOBOX_SELECTED, GetId());
 246                 event.SetInt(sel);
 247                 event.SetEventObject(this);
 248                 event.SetString(value);
 249                 ProcessCommand(event);
 250             }
 251             else
 252             {
 253                 break;
 254             }
 255
 256             // fall through: for compability with wxGTK, also send the text
 257             // update event when the selection changes (this also seems more
 258             // logical as the text does change)
 259
 260         case CBN_EDITCHANGE:
 261             {
 262                 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
 263
 264                 // if sel != -1, value was initialized above (and we can't use
 265                 // GetValue() here as it would return the old selection and we
 266                 // want the new one)
 267                 if ( sel == -1 )
 268                 {
 269                     value = GetValue();
 270                 }
 271                 else // we're synthesizing text updated event from sel change
 272                 {
 273                     // we need to do this because the user code expects
 274                     // wxComboBox::GetValue() to return the new value from
 275                     // "text updated" handler but it hadn't been updated yet
 276                     SetValue(value);
 277                 }
 278
 279                 event.SetString(value);
 280                 event.SetEventObject(this);
 281                 ProcessCommand(event);
 282             }
 283             break;
 284     }
 285
 286     // there is no return value for the CBN_ notifications, so always return
 287     // FALSE from here to pass the message to DefWindowProc()
 288     return FALSE;
 289 }
 290
 291 WXHWND wxComboBox::GetEditHWND() const
 292 {
 293     // this function should not be called for wxCB_READONLY controls, it is
 294     // the callers responsability to check this
 295     wxASSERT_MSG( !(GetWindowStyle() & wxCB_READONLY),
 296                   _T("read-only combobox doesn't have any edit control") );
 297
 298     POINT pt;
 299     pt.x = pt.y = 4;
 300     HWND hwndEdit = ::ChildWindowFromPoint(GetHwnd(), pt);
 301     if ( !hwndEdit || hwndEdit == GetHwnd() )
 302     {
 303         wxFAIL_MSG(_T("not read only combobox without edit control?"));
 304     }
 305
 306     return (WXHWND)hwndEdit;
 307 }
 308
 309 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 310                         const wxString& value,
 311                         const wxPoint& pos,
 312                         const wxSize& size,
 313                         int n, const wxString choices[],
 314                         long style,
 315                         const wxValidator& validator,
 316                         const wxString& name)
 317 {
 318     // pretend that wxComboBox is hidden while it is positioned and resized and
 319     // show it only right before leaving this method because otherwise there is
 320     // some noticeable flicker while the control rearranges itself
 321     m_isShown = FALSE;
 322
 323     // first create wxWin object
 324     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
 325         return FALSE;
 326
 327     // get the right style
 328     long msStyle = WS_TABSTOP | WS_VSCROLL | WS_HSCROLL |
 329                    CBS_AUTOHSCROLL | CBS_NOINTEGRALHEIGHT /* | WS_CLIPSIBLINGS */;
 330     if ( style & wxCB_READONLY )
 331         msStyle |= CBS_DROPDOWNLIST;
 332 #ifndef __WXWINCE__
 333     else if ( style & wxCB_SIMPLE )
 334         msStyle |= CBS_SIMPLE; // A list (shown always) and edit control
 335 #endif
 336     else
 337         msStyle |= CBS_DROPDOWN;
 338
 339     if ( style & wxCB_SORT )
 340         msStyle |= CBS_SORT;
 341
 342     if ( style & wxCLIP_SIBLINGS )
 343         msStyle |= WS_CLIPSIBLINGS;
 344
 345
 346     // and now create the MSW control
 347     if ( !MSWCreateControl(_T("COMBOBOX"), msStyle) )
 348         return FALSE;
 349
 350     // A choice/combobox normally has a white background (or other, depending
 351     // on global settings) rather than inheriting the parent's background colour.
 352     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
 353
 354     for ( int i = 0; i < n; i++ )
 355     {
 356         Append(choices[i]);
 357     }
 358
 359     if ( !value.IsEmpty() )
 360     {
 361         SetValue(value);
 362     }
 363
 364     // do this after appending the values to the combobox so that autosizing
 365     // works correctly
 366     SetSize(pos.x, pos.y, size.x, size.y);
 367
 368     // a (not read only) combobox is, in fact, 2 controls: the combobox itself
 369     // and an edit control inside it and if we want to catch events from this
 370     // edit control, we must subclass it as well
 371     if ( !(style & wxCB_READONLY) )
 372     {
 373         gs_wndprocEdit = (WXFARPROC)::SetWindowLong
 374                                       (
 375                                         (HWND)GetEditHWND(),
 376                                         GWL_WNDPROC,
 377                                         (LPARAM)wxComboEditWndProc
 378                                       );
 379     }
 380
 381     // and finally, show the control
 382     Show(TRUE);
 383
 384     return TRUE;
 385 }
 386
 387 void wxComboBox::SetValue(const wxString& value)
 388 {
 389     if ( HasFlag(wxCB_READONLY) )
 390         SetStringSelection(value);
 391     else
 392         SetWindowText(GetHwnd(), value.c_str());
 393 }
 394
 395 // Clipboard operations
 396 void wxComboBox::Copy()
 397 {
 398   SendMessage(GetHwnd(), WM_COPY, 0, 0L);
 399 }
 400
 401 void wxComboBox::Cut()
 402 {
 403   SendMessage(GetHwnd(), WM_CUT, 0, 0L);
 404 }
 405
 406 void wxComboBox::Paste()
 407 {
 408   SendMessage(GetHwnd(), WM_PASTE, 0, 0L);
 409 }
 410
 411 void wxComboBox::SetEditable(bool WXUNUSED(editable))
 412 {
 413   // Can't implement in MSW?
 414 //  HWND hWnd = GetHwnd();
 415 //  SendMessage(hWnd, EM_SETREADONLY, (WPARAM)!editable, (LPARAM)0L);
 416 }
 417
 418 void wxComboBox::SetInsertionPoint(long pos)
 419 {
 420     if ( GetWindowStyle() & wxCB_READONLY )
 421         return;
 422
 423 #ifdef __WIN32__
 424     HWND hWnd = GetHwnd();
 425     ::SendMessage(hWnd, CB_SETEDITSEL, 0, MAKELPARAM(pos, pos));
 426     HWND hEditWnd = (HWND) GetEditHWND() ;
 427     if ( hEditWnd )
 428     {
 429         // Scroll insertion point into view
 430         SendMessage(hEditWnd, EM_SCROLLCARET, (WPARAM)0, (LPARAM)0);
 431         // Why is this necessary? (Copied from wxTextCtrl::SetInsertionPoint)
 432         SendMessage(hEditWnd, EM_REPLACESEL, 0, (LPARAM) wxEmptyString);
 433     }
 434 #endif // __WIN32__
 435 }
 436
 437 void wxComboBox::SetInsertionPointEnd()
 438 {
 439     // setting insertion point doesn't make sense for read only comboboxes
 440     if ( !(GetWindowStyle() & wxCB_READONLY) )
 441     {
 442         long pos = GetLastPosition();
 443         SetInsertionPoint(pos);
 444     }
 445 }
 446
 447 long wxComboBox::GetInsertionPoint() const
 448 {
 449 #ifdef __WIN32__
 450     DWORD Pos=(DWORD)SendMessage(GetHwnd(), CB_GETEDITSEL, 0, 0L);
 451     return Pos&0xFFFF;
 452 #else
 453     return 0;
 454 #endif
 455 }
 456
 457 long wxComboBox::GetLastPosition() const
 458 {
 459     HWND hEditWnd = (HWND) GetEditHWND();
 460
 461     // Get number of characters in the last (only) line. We'll add this to the character
 462     // index for the last line, 1st position.
 463     int lineLength = (int)SendMessage(hEditWnd, EM_LINELENGTH, (WPARAM) 0, (LPARAM)0L);
 464
 465     return (long)(lineLength);
 466 }
 467
 468 void wxComboBox::Replace(long from, long to, const wxString& value)
 469 {
 470 #if wxUSE_CLIPBOARD
 471     Remove(from, to);
 472
 473     // Now replace with 'value', by pasting.
 474     wxSetClipboardData(wxDF_TEXT, (wxObject *)(const wxChar *)value, 0, 0);
 475
 476     // Paste into edit control
 477     SendMessage(GetHwnd(), WM_PASTE, (WPARAM)0, (LPARAM)0L);
 478 #endif
 479 }
 480
 481 void wxComboBox::Remove(long from, long to)
 482 {
 483     // Set selection and remove it
 484     SetSelection(from, to);
 485     SendMessage(GetHwnd(), WM_CUT, (WPARAM)0, (LPARAM)0);
 486 }
 487
 488 void wxComboBox::SetSelection(long from, long to)
 489 {
 490     HWND hWnd = GetHwnd();
 491     long fromChar = from;
 492     long toChar = to;
 493     // if from and to are both -1, it means
 494     // (in wxWindows) that all text should be selected.
 495     // This translates into Windows convention
 496     if ((from == -1) && (to == -1))
 497     {
 498       fromChar = 0;
 499       toChar = -1;
 500     }
 501
 502     if (
 503 #ifdef __WIN32__
 504     SendMessage(hWnd, CB_SETEDITSEL, (WPARAM)0, (LPARAM)MAKELONG(fromChar, toChar))
 505 #else // Win16
 506     SendMessage(hWnd, CB_SETEDITSEL, (WPARAM)fromChar, (LPARAM)toChar)
 507 #endif
 508         == CB_ERR )
 509     {
 510         wxLogDebug(_T("CB_SETEDITSEL failed"));
 511     }
 512 }
 513
 514 #endif
 515  // wxUSE_COMBOBOX
 516