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 bool wxComboBox::MSWProcessEditMsg(WXUINT msg, WXWPARAM wParam, WXLPARAM lParam)
 241 {
 242     switch ( msg )
 243     {
 244         case WM_CHAR:
 245             // for compatibility with wxTextCtrl, generate a special message
 246             // when Enter is pressed
 247             if ( wParam == VK_RETURN )
 248             {
 249                 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_windowId);
 250                 InitCommandEvent(event);
 251                 event.SetString(GetValue());
 252                 event.SetInt(GetSelection());
 253                 ProcessCommand(event);
 254             }
 255
 256             return HandleChar(wParam, lParam, TRUE /* isASCII */);
 257
 258         case WM_KEYDOWN:
 259             return HandleKeyDown(wParam, lParam);
 260
 261         case WM_KEYUP:
 262             return HandleKeyUp(wParam, lParam);
 263
 264         case WM_SETFOCUS:
 265             return HandleSetFocus((WXHWND)wParam);
 266
 267         case WM_KILLFOCUS:
 268             return HandleKillFocus((WXHWND)wParam);
 269     }
 270
 271     return FALSE;
 272 }
 273
 274 bool wxComboBox::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 275 {
 276     wxString value;
 277     int sel = -1;
 278     switch ( param )
 279     {
 280         case CBN_SELCHANGE:
 281             sel = GetSelection();
 282             if ( sel > -1 )
 283             {
 284                 value = GetString(sel);
 285
 286                 wxCommandEvent event(wxEVT_COMMAND_COMBOBOX_SELECTED, GetId());
 287                 event.SetInt(sel);
 288                 event.SetEventObject(this);
 289                 event.SetString(value);
 290                 ProcessCommand(event);
 291             }
 292             else
 293             {
 294                 break;
 295             }
 296
 297             // fall through: for compability with wxGTK, also send the text
 298             // update event when the selection changes (this also seems more
 299             // logical as the text does change)
 300
 301         case CBN_EDITCHANGE:
 302             {
 303                 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
 304
 305                 // if sel != -1, value was initialized above (and we can't use
 306                 // GetValue() here as it would return the old selection and we
 307                 // want the new one)
 308                 if ( sel == -1 )
 309                 {
 310                     value = GetValue();
 311                 }
 312                 else // we're synthesizing text updated event from sel change
 313                 {
 314                     // We need to retrieve the current selection because the user
 315                     // may have changed it in the previous handler (for CBN_SELCHANGE
 316                     // above).
 317                     sel = GetSelection();
 318                     if ( sel > -1 )
 319                     {
 320                         value = GetString(sel);
 321                     }
 322                     // we need to do this because the user code expects
 323                     // wxComboBox::GetValue() to return the new value from
 324                     // "text updated" handler but it hadn't been updated yet
 325                     SetValue(value);
 326                 }
 327
 328                 event.SetString(value);
 329                 event.SetEventObject(this);
 330                 ProcessCommand(event);
 331             }
 332             break;
 333     }
 334
 335     // there is no return value for the CBN_ notifications, so always return
 336     // FALSE from here to pass the message to DefWindowProc()
 337     return FALSE;
 338 }
 339
 340 WXHWND wxComboBox::GetEditHWND() const
 341 {
 342     // this function should not be called for wxCB_READONLY controls, it is
 343     // the callers responsability to check this
 344     wxASSERT_MSG( !(GetWindowStyle() & wxCB_READONLY),
 345                   _T("read-only combobox doesn't have any edit control") );
 346
 347     POINT pt;
 348     pt.x = pt.y = 4;
 349     HWND hwndEdit = ::ChildWindowFromPoint(GetHwnd(), pt);
 350     if ( !hwndEdit || hwndEdit == GetHwnd() )
 351     {
 352         wxFAIL_MSG(_T("not read only combobox without edit control?"));
 353     }
 354
 355     return (WXHWND)hwndEdit;
 356 }
 357
 358 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 359                         const wxString& value,
 360                         const wxPoint& pos,
 361                         const wxSize& size,
 362                         int n, const wxString choices[],
 363                         long style,
 364                         const wxValidator& validator,
 365                         const wxString& name)
 366 {
 367     // pretend that wxComboBox is hidden while it is positioned and resized and
 368     // show it only right before leaving this method because otherwise there is
 369     // some noticeable flicker while the control rearranges itself
 370     m_isShown = FALSE;
 371
 372     // first create wxWin object
 373     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
 374         return FALSE;
 375
 376     // get the right style
 377     long msStyle = WS_TABSTOP | WS_VSCROLL | WS_HSCROLL |
 378                    CBS_AUTOHSCROLL | CBS_NOINTEGRALHEIGHT /* | WS_CLIPSIBLINGS */;
 379     if ( style & wxCB_READONLY )
 380         msStyle |= CBS_DROPDOWNLIST;
 381 #ifndef __WXWINCE__
 382     else if ( style & wxCB_SIMPLE )
 383         msStyle |= CBS_SIMPLE; // A list (shown always) and edit control
 384 #endif
 385     else
 386         msStyle |= CBS_DROPDOWN;
 387
 388     if ( style & wxCB_SORT )
 389         msStyle |= CBS_SORT;
 390
 391     if ( style & wxCLIP_SIBLINGS )
 392         msStyle |= WS_CLIPSIBLINGS;
 393
 394
 395     // and now create the MSW control
 396     if ( !MSWCreateControl(_T("COMBOBOX"), msStyle) )
 397         return FALSE;
 398
 399     // A choice/combobox normally has a white background (or other, depending
 400     // on global settings) rather than inheriting the parent's background colour.
 401     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
 402
 403     for ( int i = 0; i < n; i++ )
 404     {
 405         Append(choices[i]);
 406     }
 407
 408     if ( !value.IsEmpty() )
 409     {
 410         SetValue(value);
 411     }
 412
 413     // do this after appending the values to the combobox so that autosizing
 414     // works correctly
 415     SetSize(pos.x, pos.y, size.x, size.y);
 416
 417     // a (not read only) combobox is, in fact, 2 controls: the combobox itself
 418     // and an edit control inside it and if we want to catch events from this
 419     // edit control, we must subclass it as well
 420     if ( !(style & wxCB_READONLY) )
 421     {
 422         gs_wndprocEdit = (WXFARPROC)::SetWindowLong
 423                                       (
 424                                         (HWND)GetEditHWND(),
 425                                         GWL_WNDPROC,
 426                                         (LPARAM)wxComboEditWndProc
 427                                       );
 428     }
 429
 430     // and finally, show the control
 431     Show(TRUE);
 432
 433     return TRUE;
 434 }
 435
 436 void wxComboBox::SetValue(const wxString& value)
 437 {
 438     if ( HasFlag(wxCB_READONLY) )
 439         SetStringSelection(value);
 440     else
 441         SetWindowText(GetHwnd(), value.c_str());
 442 }
 443
 444 // Clipboard operations
 445 void wxComboBox::Copy()
 446 {
 447   SendMessage(GetHwnd(), WM_COPY, 0, 0L);
 448 }
 449
 450 void wxComboBox::Cut()
 451 {
 452   SendMessage(GetHwnd(), WM_CUT, 0, 0L);
 453 }
 454
 455 void wxComboBox::Paste()
 456 {
 457   SendMessage(GetHwnd(), WM_PASTE, 0, 0L);
 458 }
 459
 460 void wxComboBox::SetEditable(bool WXUNUSED(editable))
 461 {
 462   // Can't implement in MSW?
 463 //  HWND hWnd = GetHwnd();
 464 //  SendMessage(hWnd, EM_SETREADONLY, (WPARAM)!editable, (LPARAM)0L);
 465 }
 466
 467 void wxComboBox::SetInsertionPoint(long pos)
 468 {
 469     if ( GetWindowStyle() & wxCB_READONLY )
 470         return;
 471
 472 #ifdef __WIN32__
 473     HWND hWnd = GetHwnd();
 474     ::SendMessage(hWnd, CB_SETEDITSEL, 0, MAKELPARAM(pos, pos));
 475     HWND hEditWnd = (HWND) GetEditHWND() ;
 476     if ( hEditWnd )
 477     {
 478         // Scroll insertion point into view
 479         SendMessage(hEditWnd, EM_SCROLLCARET, (WPARAM)0, (LPARAM)0);
 480         // Why is this necessary? (Copied from wxTextCtrl::SetInsertionPoint)
 481         SendMessage(hEditWnd, EM_REPLACESEL, 0, (LPARAM) wxEmptyString);
 482     }
 483 #endif // __WIN32__
 484 }
 485
 486 void wxComboBox::SetInsertionPointEnd()
 487 {
 488     // setting insertion point doesn't make sense for read only comboboxes
 489     if ( !(GetWindowStyle() & wxCB_READONLY) )
 490     {
 491         long pos = GetLastPosition();
 492         SetInsertionPoint(pos);
 493     }
 494 }
 495
 496 long wxComboBox::GetInsertionPoint() const
 497 {
 498 #ifdef __WIN32__
 499     DWORD Pos=(DWORD)SendMessage(GetHwnd(), CB_GETEDITSEL, 0, 0L);
 500     return Pos&0xFFFF;
 501 #else
 502     return 0;
 503 #endif
 504 }
 505
 506 long wxComboBox::GetLastPosition() const
 507 {
 508     HWND hEditWnd = (HWND) GetEditHWND();
 509
 510     // Get number of characters in the last (only) line. We'll add this to the character
 511     // index for the last line, 1st position.
 512     int lineLength = (int)SendMessage(hEditWnd, EM_LINELENGTH, (WPARAM) 0, (LPARAM)0L);
 513
 514     return (long)(lineLength);
 515 }
 516
 517 void wxComboBox::Replace(long from, long to, const wxString& value)
 518 {
 519 #if wxUSE_CLIPBOARD
 520     Remove(from, to);
 521
 522     // Now replace with 'value', by pasting.
 523     wxSetClipboardData(wxDF_TEXT, (wxObject *)(const wxChar *)value, 0, 0);
 524
 525     // Paste into edit control
 526     SendMessage(GetHwnd(), WM_PASTE, (WPARAM)0, (LPARAM)0L);
 527 #endif
 528 }
 529
 530 void wxComboBox::Remove(long from, long to)
 531 {
 532     // Set selection and remove it
 533     SetSelection(from, to);
 534     SendMessage(GetHwnd(), WM_CUT, (WPARAM)0, (LPARAM)0);
 535 }
 536
 537 void wxComboBox::SetSelection(long from, long to)
 538 {
 539     HWND hWnd = GetHwnd();
 540     long fromChar = from;
 541     long toChar = to;
 542     // if from and to are both -1, it means
 543     // (in wxWindows) that all text should be selected.
 544     // This translates into Windows convention
 545     if ((from == -1) && (to == -1))
 546     {
 547       fromChar = 0;
 548       toChar = -1;
 549     }
 550
 551     if (
 552 #ifdef __WIN32__
 553     SendMessage(hWnd, CB_SETEDITSEL, (WPARAM)0, (LPARAM)MAKELONG(fromChar, toChar))
 554 #else // Win16
 555     SendMessage(hWnd, CB_SETEDITSEL, (WPARAM)fromChar, (LPARAM)toChar)
 556 #endif
 557         == CB_ERR )
 558     {
 559         wxLogDebug(_T("CB_SETEDITSEL failed"));
 560     }
 561 }
 562
 563 #endif
 564  // wxUSE_COMBOBOX
 565