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