1 /////////////////////////////////////////////////////////////////////////////
2 // Name: msw/combobox.cpp
3 // Purpose: wxComboBox class
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "combobox.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
34 #include "wx/settings.h"
36 // for wxEVT_COMMAND_TEXT_ENTER
37 #include "wx/textctrl.h"
41 #include "wx/combobox.h"
43 #include "wx/clipbrd.h"
44 #include "wx/msw/private.h"
47 #if !defined(__GNUWIN32_OLD__) || defined(__CYGWIN10__)
50 #include "wx/tooltip.h"
51 #endif // wxUSE_TOOLTIPS
53 // ----------------------------------------------------------------------------
55 // ----------------------------------------------------------------------------
57 #if wxUSE_EXTENDED_RTTI
58 WX_DEFINE_FLAGS( wxComboBoxStyle
)
60 wxBEGIN_FLAGS( wxComboBoxStyle
)
61 // new style border flags, we put them first to
62 // use them for streaming out
63 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
64 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
65 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
66 wxFLAGS_MEMBER(wxBORDER_RAISED
)
67 wxFLAGS_MEMBER(wxBORDER_STATIC
)
68 wxFLAGS_MEMBER(wxBORDER_NONE
)
70 // old style border flags
71 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
72 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
73 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
74 wxFLAGS_MEMBER(wxRAISED_BORDER
)
75 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
76 wxFLAGS_MEMBER(wxBORDER
)
78 // standard window styles
79 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
80 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
81 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
82 wxFLAGS_MEMBER(wxWANTS_CHARS
)
83 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
84 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
85 wxFLAGS_MEMBER(wxVSCROLL
)
86 wxFLAGS_MEMBER(wxHSCROLL
)
88 wxFLAGS_MEMBER(wxCB_SIMPLE
)
89 wxFLAGS_MEMBER(wxCB_SORT
)
90 wxFLAGS_MEMBER(wxCB_READONLY
)
91 wxFLAGS_MEMBER(wxCB_DROPDOWN
)
93 wxEND_FLAGS( wxComboBoxStyle
)
95 IMPLEMENT_DYNAMIC_CLASS_XTI(wxComboBox
, wxControl
,"wx/combobox.h")
97 wxBEGIN_PROPERTIES_TABLE(wxComboBox
)
98 wxEVENT_PROPERTY( Select
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
)
99 wxEVENT_PROPERTY( TextEnter
, wxEVT_COMMAND_TEXT_ENTER
, wxCommandEvent
)
102 wxPROPERTY( Font
, wxFont
, SetFont
, GetFont
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
103 wxPROPERTY_COLLECTION( Choices
, wxArrayString
, wxString
, AppendString
, GetStrings
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
104 wxPROPERTY( Value
,wxString
, SetValue
, GetValue
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
105 wxPROPERTY( Selection
,int, SetSelection
, GetSelection
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
106 wxPROPERTY_FLAGS( WindowStyle
, wxComboBoxStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
107 wxEND_PROPERTIES_TABLE()
109 wxBEGIN_HANDLERS_TABLE(wxComboBox
)
110 wxEND_HANDLERS_TABLE()
112 wxCONSTRUCTOR_5( wxComboBox
, wxWindow
* , Parent
, wxWindowID
, Id
, wxString
, Value
, wxPoint
, Position
, wxSize
, Size
)
116 IMPLEMENT_DYNAMIC_CLASS(wxComboBox
, wxControl
)
120 BEGIN_EVENT_TABLE(wxComboBox
, wxControl
)
121 EVT_MENU(wxID_CUT
, wxComboBox::OnCut
)
122 EVT_MENU(wxID_COPY
, wxComboBox::OnCopy
)
123 EVT_MENU(wxID_PASTE
, wxComboBox::OnPaste
)
124 EVT_MENU(wxID_UNDO
, wxComboBox::OnUndo
)
125 EVT_MENU(wxID_REDO
, wxComboBox::OnRedo
)
126 EVT_MENU(wxID_CLEAR
, wxComboBox::OnDelete
)
127 EVT_MENU(wxID_SELECTALL
, wxComboBox::OnSelectAll
)
129 EVT_UPDATE_UI(wxID_CUT
, wxComboBox::OnUpdateCut
)
130 EVT_UPDATE_UI(wxID_COPY
, wxComboBox::OnUpdateCopy
)
131 EVT_UPDATE_UI(wxID_PASTE
, wxComboBox::OnUpdatePaste
)
132 EVT_UPDATE_UI(wxID_UNDO
, wxComboBox::OnUpdateUndo
)
133 EVT_UPDATE_UI(wxID_REDO
, wxComboBox::OnUpdateRedo
)
134 EVT_UPDATE_UI(wxID_CLEAR
, wxComboBox::OnUpdateDelete
)
135 EVT_UPDATE_UI(wxID_SELECTALL
, wxComboBox::OnUpdateSelectAll
)
138 // ----------------------------------------------------------------------------
139 // function prototypes
140 // ----------------------------------------------------------------------------
142 LRESULT APIENTRY _EXPORT
wxComboEditWndProc(HWND hWnd
,
147 // ---------------------------------------------------------------------------
149 // ---------------------------------------------------------------------------
151 // the pointer to standard radio button wnd proc
152 static WNDPROC gs_wndprocEdit
= (WNDPROC
)NULL
;
154 // ============================================================================
156 // ============================================================================
158 // ----------------------------------------------------------------------------
159 // wnd proc for subclassed edit control
160 // ----------------------------------------------------------------------------
162 LRESULT APIENTRY _EXPORT
wxComboEditWndProc(HWND hWnd
,
167 HWND hwndCombo
= ::GetParent(hWnd
);
168 wxWindow
*win
= wxFindWinFromHandle((WXHWND
)hwndCombo
);
172 // forward some messages to the combobox to generate the appropriate
173 // wxEvents from them
180 wxComboBox
*combo
= wxDynamicCast(win
, wxComboBox
);
183 // we can get WM_KILLFOCUS while our parent is already half
184 // destroyed and hence doesn't look like a combobx any
185 // longer, check for it to avoid bogus assert failures
186 if ( !win
->IsBeingDeleted() )
188 wxFAIL_MSG( _T("should have combo as parent") );
191 else if ( combo
->MSWProcessEditMsg(message
, wParam
, lParam
) )
201 wxCHECK_MSG( win
, 0, _T("should have a parent") );
203 if ( win
->GetWindowStyle() & wxPROCESS_ENTER
)
205 // need to return a custom dlg code or we'll never get it
206 return DLGC_WANTMESSAGE
;
211 // deal with tooltips here
212 #if wxUSE_TOOLTIPS && defined(TTN_NEEDTEXT)
215 wxCHECK_MSG( win
, 0, _T("should have a parent") );
217 NMHDR
* hdr
= (NMHDR
*)lParam
;
218 if ( hdr
->code
== TTN_NEEDTEXT
)
220 wxToolTip
*tooltip
= win
->GetToolTip();
223 TOOLTIPTEXT
*ttt
= (TOOLTIPTEXT
*)lParam
;
224 ttt
->lpszText
= (wxChar
*)tooltip
->GetTip().c_str();
232 #endif // wxUSE_TOOLTIPS
235 return ::CallWindowProc(CASTWNDPROC gs_wndprocEdit
, hWnd
, message
, wParam
, lParam
);
238 // ----------------------------------------------------------------------------
239 // wxComboBox callbacks
240 // ----------------------------------------------------------------------------
242 WXLRESULT
wxComboBox::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
244 // handle WM_CTLCOLOR messages from our EDIT control to be able to set its
245 // colour correctly (to be the same as our own one)
249 // Selection was set with SetSelection. Update the value too.
250 if ((int)wParam
> GetCount())
251 m_value
= wxEmptyString
;
253 m_value
= GetString(wParam
);
258 return wxChoice::MSWWindowProc(nMsg
, wParam
, lParam
);
261 bool wxComboBox::MSWProcessEditMsg(WXUINT msg
, WXWPARAM wParam
, WXLPARAM lParam
)
266 // for compatibility with wxTextCtrl, generate a special message
267 // when Enter is pressed
268 if ( wParam
== VK_RETURN
)
270 wxCommandEvent
event(wxEVT_COMMAND_TEXT_ENTER
, m_windowId
);
271 InitCommandEvent(event
);
272 event
.SetString(GetValue());
273 event
.SetInt(GetSelection());
274 if ( ProcessCommand(event
) )
276 // don't let the event through to the native control
277 // because it doesn't need it and may generate an annoying
278 // beep if it gets it
283 return HandleChar(wParam
, lParam
, true /* isASCII */);
286 return HandleKeyDown(wParam
, lParam
);
289 return HandleKeyUp(wParam
, lParam
);
292 return HandleSetFocus((WXHWND
)wParam
);
295 return HandleKillFocus((WXHWND
)wParam
);
301 bool wxComboBox::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
308 sel
= GetSelection();
310 // somehow we get 2 CBN_SELCHANGE events with the same index when
311 // the user selects an item in the combobox -- ignore duplicates
312 if ( sel
> -1 && sel
!= m_selectionOld
)
314 m_selectionOld
= sel
;
316 // GetValue() would still return the old value from here but
317 // according to the docs we should return the new value if the
318 // user calls it in his event handler, so update internal
320 m_value
= GetString(sel
);
322 wxCommandEvent
event(wxEVT_COMMAND_COMBOBOX_SELECTED
, GetId());
324 event
.SetEventObject(this);
325 event
.SetString(m_value
);
326 ProcessCommand(event
);
328 else // no valid selection
330 m_selectionOld
= sel
;
332 // hence no EVT_TEXT neither
336 // fall through: for compability with wxGTK, also send the text
337 // update event when the selection changes (this also seems more
338 // logical as the text does change)
342 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, GetId());
344 // if sel != -1, value was initialized above (and we can't use
345 // GetValue() here as it would return the old selection and we
349 m_value
= wxGetWindowText(GetHwnd());
352 else // we're synthesizing text updated event from sel change
354 // We need to retrieve the current selection because the
355 // user may have changed it in the previous handler (for
356 // CBN_SELCHANGE above).
357 sel
= GetSelection();
360 m_value
= GetString(sel
);
364 event
.SetString(m_value
);
365 event
.SetEventObject(this);
366 ProcessCommand(event
);
371 // there is no return value for the CBN_ notifications, so always return
372 // false from here to pass the message to DefWindowProc()
376 WXHWND
wxComboBox::GetEditHWND() const
378 // this function should not be called for wxCB_READONLY controls, it is
379 // the callers responsability to check this
380 wxASSERT_MSG( !(GetWindowStyle() & wxCB_READONLY
),
381 _T("read-only combobox doesn't have any edit control") );
385 HWND hwndEdit
= ::ChildWindowFromPoint(GetHwnd(), pt
);
386 if ( !hwndEdit
|| hwndEdit
== GetHwnd() )
388 wxFAIL_MSG(_T("not read only combobox without edit control?"));
391 return (WXHWND
)hwndEdit
;
394 // ----------------------------------------------------------------------------
395 // wxComboBox creation
396 // ----------------------------------------------------------------------------
398 bool wxComboBox::Create(wxWindow
*parent
, wxWindowID id
,
399 const wxString
& value
,
402 int n
, const wxString choices
[],
404 const wxValidator
& validator
,
405 const wxString
& name
)
407 // pretend that wxComboBox is hidden while it is positioned and resized and
408 // show it only right before leaving this method because otherwise there is
409 // some noticeable flicker while the control rearranges itself
412 if ( !CreateAndInit(parent
, id
, pos
, size
, n
, choices
, style
,
416 // we shouldn't call SetValue() for an empty string because this would
417 // (correctly) result in an assert with a read only combobox and is useless
418 // for the other ones anyhow
419 if ( !value
.empty() )
422 // a (not read only) combobox is, in fact, 2 controls: the combobox itself
423 // and an edit control inside it and if we want to catch events from this
424 // edit control, we must subclass it as well
425 if ( !(style
& wxCB_READONLY
) )
427 gs_wndprocEdit
= wxSetWindowProc((HWND
)GetEditHWND(),
431 // and finally, show the control
437 bool wxComboBox::Create(wxWindow
*parent
, wxWindowID id
,
438 const wxString
& value
,
441 const wxArrayString
& choices
,
443 const wxValidator
& validator
,
444 const wxString
& name
)
446 wxCArrayString
chs(choices
);
447 return Create(parent
, id
, value
, pos
, size
, chs
.GetCount(),
448 chs
.GetStrings(), style
, validator
, name
);
451 WXDWORD
wxComboBox::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
453 // we never have an external border
454 WXDWORD msStyle
= wxChoice::MSWGetStyle
456 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
459 // remove the style always added by wxChoice
460 msStyle
&= ~CBS_DROPDOWNLIST
;
462 if ( style
& wxCB_READONLY
)
463 msStyle
|= CBS_DROPDOWNLIST
;
465 else if ( style
& wxCB_SIMPLE
)
466 msStyle
|= CBS_SIMPLE
; // A list (shown always) and edit control
469 msStyle
|= CBS_DROPDOWN
;
471 // there is no reason to not always use CBS_AUTOHSCROLL, so do use it
472 msStyle
|= CBS_AUTOHSCROLL
;
474 // NB: we used to also add CBS_NOINTEGRALHEIGHT here but why?
479 // ----------------------------------------------------------------------------
480 // wxComboBox text control-like methods
481 // ----------------------------------------------------------------------------
483 void wxComboBox::SetValue(const wxString
& value
)
485 if ( HasFlag(wxCB_READONLY
) )
486 SetStringSelection(value
);
488 SetWindowText(GetHwnd(), value
.c_str());
491 m_selectionOld
= GetSelection();
494 // Clipboard operations
495 void wxComboBox::Copy()
497 SendMessage(GetHwnd(), WM_COPY
, 0, 0L);
500 void wxComboBox::Cut()
502 SendMessage(GetHwnd(), WM_CUT
, 0, 0L);
505 void wxComboBox::Paste()
507 SendMessage(GetHwnd(), WM_PASTE
, 0, 0L);
510 void wxComboBox::Undo()
514 HWND hEditWnd
= (HWND
) GetEditHWND() ;
516 ::SendMessage(hEditWnd
, EM_UNDO
, 0, 0);
520 void wxComboBox::Redo()
524 // Same as Undo, since Undo undoes the undo, i.e. a redo.
525 HWND hEditWnd
= (HWND
) GetEditHWND() ;
527 ::SendMessage(hEditWnd
, EM_UNDO
, 0, 0);
531 void wxComboBox::SelectAll()
533 SetSelection(0, GetLastPosition());
536 bool wxComboBox::CanUndo() const
538 HWND hEditWnd
= (HWND
) GetEditHWND() ;
540 return ::SendMessage(hEditWnd
, EM_CANUNDO
, 0, 0) != 0;
545 bool wxComboBox::CanRedo() const
547 HWND hEditWnd
= (HWND
) GetEditHWND() ;
549 return ::SendMessage(hEditWnd
, EM_CANUNDO
, 0, 0) != 0;
554 bool wxComboBox::HasSelection() const
557 GetSelection(&from
, &to
);
561 bool wxComboBox::CanCopy() const
563 // Can copy if there's a selection
564 return HasSelection();
567 bool wxComboBox::CanCut() const
569 return CanCopy() && IsEditable();
572 bool wxComboBox::CanPaste() const
577 // Standard edit control: check for straight text on clipboard
578 if ( !::OpenClipboard(GetHwndOf(wxTheApp
->GetTopWindow())) )
581 bool isTextAvailable
= ::IsClipboardFormatAvailable(CF_TEXT
) != 0;
584 return isTextAvailable
;
587 bool wxComboBox::IsEditable() const
589 return !HasFlag(wxCB_READONLY
);
592 void wxComboBox::SetEditable(bool WXUNUSED(editable
))
594 // Can't implement in MSW?
595 // HWND hWnd = GetHwnd();
596 // SendMessage(hWnd, EM_SETREADONLY, (WPARAM)!editable, (LPARAM)0L);
599 void wxComboBox::SetInsertionPoint(long pos
)
601 if ( GetWindowStyle() & wxCB_READONLY
)
605 HWND hWnd
= GetHwnd();
606 ::SendMessage(hWnd
, CB_SETEDITSEL
, 0, MAKELPARAM(pos
, pos
));
607 HWND hEditWnd
= (HWND
) GetEditHWND() ;
610 // Scroll insertion point into view
611 SendMessage(hEditWnd
, EM_SCROLLCARET
, (WPARAM
)0, (LPARAM
)0);
612 // Why is this necessary? (Copied from wxTextCtrl::SetInsertionPoint)
613 SendMessage(hEditWnd
, EM_REPLACESEL
, 0, (LPARAM
) wxEmptyString
);
618 void wxComboBox::SetInsertionPointEnd()
620 // setting insertion point doesn't make sense for read only comboboxes
621 if ( !(GetWindowStyle() & wxCB_READONLY
) )
623 long pos
= GetLastPosition();
624 SetInsertionPoint(pos
);
628 long wxComboBox::GetInsertionPoint() const
631 DWORD Pos
=(DWORD
)SendMessage(GetHwnd(), CB_GETEDITSEL
, 0, 0L);
638 long wxComboBox::GetLastPosition() const
640 HWND hEditWnd
= (HWND
) GetEditHWND();
642 // Get number of characters in the last (only) line. We'll add this to the character
643 // index for the last line, 1st position.
644 int lineLength
= (int)SendMessage(hEditWnd
, EM_LINELENGTH
, (WPARAM
) 0, (LPARAM
)0L);
646 return (long)(lineLength
);
649 void wxComboBox::Replace(long from
, long to
, const wxString
& value
)
654 // Now replace with 'value', by pasting.
655 wxSetClipboardData(wxDF_TEXT
, (wxObject
*)(const wxChar
*)value
, 0, 0);
657 // Paste into edit control
658 SendMessage(GetHwnd(), WM_PASTE
, (WPARAM
)0, (LPARAM
)0L);
662 void wxComboBox::Remove(long from
, long to
)
664 // Set selection and remove it
665 SetSelection(from
, to
);
666 SendMessage(GetHwnd(), WM_CUT
, (WPARAM
)0, (LPARAM
)0);
669 void wxComboBox::SetSelection(long from
, long to
)
671 HWND hWnd
= GetHwnd();
672 long fromChar
= from
;
674 // if from and to are both -1, it means
675 // (in wxWidgets) that all text should be selected.
676 // This translates into Windows convention
677 if ((from
== -1) && (to
== -1))
683 if ( SendMessage(hWnd
, CB_SETEDITSEL
, (WPARAM
)0, (LPARAM
)MAKELONG(fromChar
, toChar
)) == CB_ERR
)
685 wxLogDebug(_T("CB_SETEDITSEL failed"));
689 void wxComboBox::GetSelection(long* from
, long* to
) const
691 DWORD dwStart
, dwEnd
;
692 ::SendMessage(GetHwnd(), CB_GETEDITSEL
, (WPARAM
)&dwStart
, (LPARAM
)&dwEnd
);
698 int wxComboBox::GetSelection() const
700 return wxChoice::GetSelection();
703 // ----------------------------------------------------------------------------
704 // standard event handling
705 // ----------------------------------------------------------------------------
707 void wxComboBox::OnCut(wxCommandEvent
& WXUNUSED(event
))
712 void wxComboBox::OnCopy(wxCommandEvent
& WXUNUSED(event
))
717 void wxComboBox::OnPaste(wxCommandEvent
& WXUNUSED(event
))
722 void wxComboBox::OnUndo(wxCommandEvent
& WXUNUSED(event
))
727 void wxComboBox::OnRedo(wxCommandEvent
& WXUNUSED(event
))
732 void wxComboBox::OnDelete(wxCommandEvent
& WXUNUSED(event
))
735 GetSelection(& from
, & to
);
736 if (from
!= -1 && to
!= -1)
740 void wxComboBox::OnSelectAll(wxCommandEvent
& WXUNUSED(event
))
742 SetSelection(-1, -1);
745 void wxComboBox::OnUpdateCut(wxUpdateUIEvent
& event
)
747 event
.Enable( CanCut() );
750 void wxComboBox::OnUpdateCopy(wxUpdateUIEvent
& event
)
752 event
.Enable( CanCopy() );
755 void wxComboBox::OnUpdatePaste(wxUpdateUIEvent
& event
)
757 event
.Enable( CanPaste() );
760 void wxComboBox::OnUpdateUndo(wxUpdateUIEvent
& event
)
762 event
.Enable( CanUndo() );
765 void wxComboBox::OnUpdateRedo(wxUpdateUIEvent
& event
)
767 event
.Enable( CanRedo() );
770 void wxComboBox::OnUpdateDelete(wxUpdateUIEvent
& event
)
772 event
.Enable(HasSelection() && IsEditable()) ;
775 void wxComboBox::OnUpdateSelectAll(wxUpdateUIEvent
& event
)
777 event
.Enable(GetLastPosition() > 0);
780 #endif // wxUSE_COMBOBOX