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 // ----------------------------------------------------------------------------
 359 // wxComboBox creation
 360 // ----------------------------------------------------------------------------
 361
 362 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 363                         const wxString& value,
 364                         const wxPoint& pos,
 365                         const wxSize& size,
 366                         int n, const wxString choices[],
 367                         long style,
 368                         const wxValidator& validator,
 369                         const wxString& name)
 370 {
 371     // pretend that wxComboBox is hidden while it is positioned and resized and
 372     // show it only right before leaving this method because otherwise there is
 373     // some noticeable flicker while the control rearranges itself
 374     m_isShown = FALSE;
 375
 376     if ( !CreateAndInit(parent, id, pos, size, n, choices, style,
 377                         validator, name) )
 378         return FALSE;
 379
 380     SetValue(value);
 381
 382     // a (not read only) combobox is, in fact, 2 controls: the combobox itself
 383     // and an edit control inside it and if we want to catch events from this
 384     // edit control, we must subclass it as well
 385     if ( !(style & wxCB_READONLY) )
 386     {
 387         gs_wndprocEdit = (WXFARPROC)::SetWindowLong
 388                                       (
 389                                         (HWND)GetEditHWND(),
 390                                         GWL_WNDPROC,
 391                                         (LPARAM)wxComboEditWndProc
 392                                       );
 393     }
 394
 395     // and finally, show the control
 396     Show(TRUE);
 397
 398     return TRUE;
 399 }
 400
 401 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 402                         const wxString& value,
 403                         const wxPoint& pos,
 404                         const wxSize& size,
 405                         const wxArrayString& choices,
 406                         long style,
 407                         const wxValidator& validator,
 408                         const wxString& name)
 409 {
 410     wxCArrayString chs(choices);
 411     return Create(parent, id, value, pos, size, chs.GetCount(),
 412                   chs.GetStrings(), style, validator, name);
 413 }
 414
 415 WXDWORD wxComboBox::MSWGetStyle(long style, WXDWORD *exstyle) const
 416 {
 417     // we never have an external border
 418     WXDWORD msStyle = wxChoice::MSWGetStyle
 419                       (
 420                         (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
 421                       );
 422
 423     // remove the style always added by wxChoice
 424     msStyle &= ~CBS_DROPDOWNLIST;
 425
 426     if ( style & wxCB_READONLY )
 427         msStyle |= CBS_DROPDOWNLIST;
 428 #ifndef __WXWINCE__
 429     else if ( style & wxCB_SIMPLE )
 430         msStyle |= CBS_SIMPLE; // A list (shown always) and edit control
 431 #endif
 432     else
 433         msStyle |= CBS_DROPDOWN;
 434
 435     // there is no reason to not always use CBS_AUTOHSCROLL, so do use it
 436     msStyle |= CBS_AUTOHSCROLL;
 437
 438     // NB: we used to also add CBS_NOINTEGRALHEIGHT here but why?
 439
 440     return msStyle;
 441 }
 442
 443 // ----------------------------------------------------------------------------
 444 // wxComboBox text control-like methods
 445 // ----------------------------------------------------------------------------
 446
 447 void wxComboBox::SetValue(const wxString& value)
 448 {
 449     if ( HasFlag(wxCB_READONLY) )
 450         SetStringSelection(value);
 451     else
 452         SetWindowText(GetHwnd(), value.c_str());
 453 }
 454
 455 // Clipboard operations
 456 void wxComboBox::Copy()
 457 {
 458   SendMessage(GetHwnd(), WM_COPY, 0, 0L);
 459 }
 460
 461 void wxComboBox::Cut()
 462 {
 463   SendMessage(GetHwnd(), WM_CUT, 0, 0L);
 464 }
 465
 466 void wxComboBox::Paste()
 467 {
 468   SendMessage(GetHwnd(), WM_PASTE, 0, 0L);
 469 }
 470
 471 void wxComboBox::SetEditable(bool WXUNUSED(editable))
 472 {
 473   // Can't implement in MSW?
 474 //  HWND hWnd = GetHwnd();
 475 //  SendMessage(hWnd, EM_SETREADONLY, (WPARAM)!editable, (LPARAM)0L);
 476 }
 477
 478 void wxComboBox::SetInsertionPoint(long pos)
 479 {
 480     if ( GetWindowStyle() & wxCB_READONLY )
 481         return;
 482
 483 #ifdef __WIN32__
 484     HWND hWnd = GetHwnd();
 485     ::SendMessage(hWnd, CB_SETEDITSEL, 0, MAKELPARAM(pos, pos));
 486     HWND hEditWnd = (HWND) GetEditHWND() ;
 487     if ( hEditWnd )
 488     {
 489         // Scroll insertion point into view
 490         SendMessage(hEditWnd, EM_SCROLLCARET, (WPARAM)0, (LPARAM)0);
 491         // Why is this necessary? (Copied from wxTextCtrl::SetInsertionPoint)
 492         SendMessage(hEditWnd, EM_REPLACESEL, 0, (LPARAM) wxEmptyString);
 493     }
 494 #endif // __WIN32__
 495 }
 496
 497 void wxComboBox::SetInsertionPointEnd()
 498 {
 499     // setting insertion point doesn't make sense for read only comboboxes
 500     if ( !(GetWindowStyle() & wxCB_READONLY) )
 501     {
 502         long pos = GetLastPosition();
 503         SetInsertionPoint(pos);
 504     }
 505 }
 506
 507 long wxComboBox::GetInsertionPoint() const
 508 {
 509 #ifdef __WIN32__
 510     DWORD Pos=(DWORD)SendMessage(GetHwnd(), CB_GETEDITSEL, 0, 0L);
 511     return Pos&0xFFFF;
 512 #else
 513     return 0;
 514 #endif
 515 }
 516
 517 long wxComboBox::GetLastPosition() const
 518 {
 519     HWND hEditWnd = (HWND) GetEditHWND();
 520
 521     // Get number of characters in the last (only) line. We'll add this to the character
 522     // index for the last line, 1st position.
 523     int lineLength = (int)SendMessage(hEditWnd, EM_LINELENGTH, (WPARAM) 0, (LPARAM)0L);
 524
 525     return (long)(lineLength);
 526 }
 527
 528 void wxComboBox::Replace(long from, long to, const wxString& value)
 529 {
 530 #if wxUSE_CLIPBOARD
 531     Remove(from, to);
 532
 533     // Now replace with 'value', by pasting.
 534     wxSetClipboardData(wxDF_TEXT, (wxObject *)(const wxChar *)value, 0, 0);
 535
 536     // Paste into edit control
 537     SendMessage(GetHwnd(), WM_PASTE, (WPARAM)0, (LPARAM)0L);
 538 #endif
 539 }
 540
 541 void wxComboBox::Remove(long from, long to)
 542 {
 543     // Set selection and remove it
 544     SetSelection(from, to);
 545     SendMessage(GetHwnd(), WM_CUT, (WPARAM)0, (LPARAM)0);
 546 }
 547
 548 void wxComboBox::SetSelection(long from, long to)
 549 {
 550     HWND hWnd = GetHwnd();
 551     long fromChar = from;
 552     long toChar = to;
 553     // if from and to are both -1, it means
 554     // (in wxWindows) that all text should be selected.
 555     // This translates into Windows convention
 556     if ((from == -1) && (to == -1))
 557     {
 558       fromChar = 0;
 559       toChar = -1;
 560     }
 561
 562     if (
 563 #ifdef __WIN32__
 564     SendMessage(hWnd, CB_SETEDITSEL, (WPARAM)0, (LPARAM)MAKELONG(fromChar, toChar))
 565 #else // Win16
 566     SendMessage(hWnd, CB_SETEDITSEL, (WPARAM)fromChar, (LPARAM)toChar)
 567 #endif
 568         == CB_ERR )
 569     {
 570         wxLogDebug(_T("CB_SETEDITSEL failed"));
 571     }
 572 }
 573
 574 #endif // wxUSE_COMBOBOX
 575