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 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
30 #include "wx/settings.h"
32 // for wxEVT_COMMAND_TEXT_ENTER
33 #include "wx/textctrl.h"
37 #include "wx/combobox.h"
39 #include "wx/clipbrd.h"
40 #include "wx/msw/private.h"
43 #if !defined(__GNUWIN32_OLD__) || defined(__CYGWIN10__)
46 #include "wx/tooltip.h"
47 #endif // wxUSE_TOOLTIPS
49 // ----------------------------------------------------------------------------
51 // ----------------------------------------------------------------------------
53 #if wxUSE_EXTENDED_RTTI
54 WX_DEFINE_FLAGS( wxComboBoxStyle
)
56 wxBEGIN_FLAGS( wxComboBoxStyle
)
57 // new style border flags, we put them first to
58 // use them for streaming out
59 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
60 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
61 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
62 wxFLAGS_MEMBER(wxBORDER_RAISED
)
63 wxFLAGS_MEMBER(wxBORDER_STATIC
)
64 wxFLAGS_MEMBER(wxBORDER_NONE
)
66 // old style border flags
67 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
68 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
69 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
70 wxFLAGS_MEMBER(wxRAISED_BORDER
)
71 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
72 wxFLAGS_MEMBER(wxBORDER
)
74 // standard window styles
75 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
76 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
77 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
78 wxFLAGS_MEMBER(wxWANTS_CHARS
)
79 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
80 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
81 wxFLAGS_MEMBER(wxVSCROLL
)
82 wxFLAGS_MEMBER(wxHSCROLL
)
84 wxFLAGS_MEMBER(wxCB_SIMPLE
)
85 wxFLAGS_MEMBER(wxCB_SORT
)
86 wxFLAGS_MEMBER(wxCB_READONLY
)
87 wxFLAGS_MEMBER(wxCB_DROPDOWN
)
89 wxEND_FLAGS( wxComboBoxStyle
)
91 IMPLEMENT_DYNAMIC_CLASS_XTI(wxComboBox
, wxControl
,"wx/combobox.h")
93 wxBEGIN_PROPERTIES_TABLE(wxComboBox
)
94 wxEVENT_PROPERTY( Select
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
)
95 wxEVENT_PROPERTY( TextEnter
, wxEVT_COMMAND_TEXT_ENTER
, wxCommandEvent
)
98 wxPROPERTY( Font
, wxFont
, SetFont
, GetFont
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
99 wxPROPERTY_COLLECTION( Choices
, wxArrayString
, wxString
, AppendString
, GetStrings
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
100 wxPROPERTY( Value
,wxString
, SetValue
, GetValue
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
101 wxPROPERTY( Selection
,int, SetSelection
, GetSelection
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
102 wxPROPERTY_FLAGS( WindowStyle
, wxComboBoxStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
103 wxEND_PROPERTIES_TABLE()
105 wxBEGIN_HANDLERS_TABLE(wxComboBox
)
106 wxEND_HANDLERS_TABLE()
108 wxCONSTRUCTOR_5( wxComboBox
, wxWindow
* , Parent
, wxWindowID
, Id
, wxString
, Value
, wxPoint
, Position
, wxSize
, Size
)
112 IMPLEMENT_DYNAMIC_CLASS(wxComboBox
, wxControl
)
116 BEGIN_EVENT_TABLE(wxComboBox
, wxControl
)
117 EVT_MENU(wxID_CUT
, wxComboBox::OnCut
)
118 EVT_MENU(wxID_COPY
, wxComboBox::OnCopy
)
119 EVT_MENU(wxID_PASTE
, wxComboBox::OnPaste
)
120 EVT_MENU(wxID_UNDO
, wxComboBox::OnUndo
)
121 EVT_MENU(wxID_REDO
, wxComboBox::OnRedo
)
122 EVT_MENU(wxID_CLEAR
, wxComboBox::OnDelete
)
123 EVT_MENU(wxID_SELECTALL
, wxComboBox::OnSelectAll
)
125 EVT_UPDATE_UI(wxID_CUT
, wxComboBox::OnUpdateCut
)
126 EVT_UPDATE_UI(wxID_COPY
, wxComboBox::OnUpdateCopy
)
127 EVT_UPDATE_UI(wxID_PASTE
, wxComboBox::OnUpdatePaste
)
128 EVT_UPDATE_UI(wxID_UNDO
, wxComboBox::OnUpdateUndo
)
129 EVT_UPDATE_UI(wxID_REDO
, wxComboBox::OnUpdateRedo
)
130 EVT_UPDATE_UI(wxID_CLEAR
, wxComboBox::OnUpdateDelete
)
131 EVT_UPDATE_UI(wxID_SELECTALL
, wxComboBox::OnUpdateSelectAll
)
134 // ----------------------------------------------------------------------------
135 // function prototypes
136 // ----------------------------------------------------------------------------
138 LRESULT APIENTRY _EXPORT
wxComboEditWndProc(HWND hWnd
,
143 // ---------------------------------------------------------------------------
145 // ---------------------------------------------------------------------------
147 // the pointer to standard radio button wnd proc
148 static WNDPROC gs_wndprocEdit
= (WNDPROC
)NULL
;
150 // ============================================================================
152 // ============================================================================
154 // ----------------------------------------------------------------------------
155 // wnd proc for subclassed edit control
156 // ----------------------------------------------------------------------------
158 LRESULT APIENTRY _EXPORT
wxComboEditWndProc(HWND hWnd
,
163 HWND hwndCombo
= ::GetParent(hWnd
);
164 wxWindow
*win
= wxFindWinFromHandle((WXHWND
)hwndCombo
);
168 // forward some messages to the combobox to generate the appropriate
169 // wxEvents from them
179 wxComboBox
*combo
= wxDynamicCast(win
, wxComboBox
);
182 // we can get WM_KILLFOCUS while our parent is already half
183 // destroyed and hence doesn't look like a combobx any
184 // longer, check for it to avoid bogus assert failures
185 if ( !win
->IsBeingDeleted() )
187 wxFAIL_MSG( _T("should have combo as parent") );
190 else if ( combo
->MSWProcessEditMsg(message
, wParam
, lParam
) )
200 wxCHECK_MSG( win
, 0, _T("should have a parent") );
202 if ( win
->GetWindowStyle() & wxPROCESS_ENTER
)
204 // need to return a custom dlg code or we'll never get it
205 return DLGC_WANTMESSAGE
;
210 // deal with tooltips here
211 #if wxUSE_TOOLTIPS && defined(TTN_NEEDTEXT)
214 wxCHECK_MSG( win
, 0, _T("should have a parent") );
216 NMHDR
* hdr
= (NMHDR
*)lParam
;
217 if ( hdr
->code
== TTN_NEEDTEXT
)
219 wxToolTip
*tooltip
= win
->GetToolTip();
222 TOOLTIPTEXT
*ttt
= (TOOLTIPTEXT
*)lParam
;
223 ttt
->lpszText
= (wxChar
*)tooltip
->GetTip().c_str();
231 #endif // wxUSE_TOOLTIPS
234 return ::CallWindowProc(CASTWNDPROC gs_wndprocEdit
, hWnd
, message
, wParam
, lParam
);
237 // ----------------------------------------------------------------------------
238 // wxComboBox callbacks
239 // ----------------------------------------------------------------------------
241 WXLRESULT
wxComboBox::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
243 // TODO: handle WM_CTLCOLOR messages from our EDIT control to be able to
244 // set its 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())
253 m_value
= GetString(wParam
);
258 // wxStaticBox can generate this message, when modifying the control's style.
259 // This causes the content of the combobox to be selected, for some reason.
260 case WM_STYLECHANGED
:
262 // combobox selection sometimes spontaneously changes when its
263 // size changes, restore it to the old value if necessary
265 GetSelection(&fromOld
, &toOld
);
266 WXLRESULT result
= wxChoice::MSWWindowProc(nMsg
, wParam
, lParam
);
269 GetSelection(&fromNew
, &toNew
);
271 if ( fromOld
!= fromNew
|| toOld
!= toNew
)
273 SetSelection(fromOld
, toOld
);
280 return wxChoice::MSWWindowProc(nMsg
, wParam
, lParam
);
283 bool wxComboBox::MSWProcessEditMsg(WXUINT msg
, WXWPARAM wParam
, WXLPARAM lParam
)
288 // for compatibility with wxTextCtrl, generate a special message
289 // when Enter is pressed
290 if ( wParam
== VK_RETURN
)
292 wxCommandEvent
event(wxEVT_COMMAND_TEXT_ENTER
, m_windowId
);
293 InitCommandEvent(event
);
294 event
.SetString(GetValue());
295 event
.SetInt(GetSelection());
296 if ( ProcessCommand(event
) )
298 // don't let the event through to the native control
299 // because it doesn't need it and may generate an annoying
300 // beep if it gets it
307 return HandleChar(wParam
, lParam
, true /* isASCII */);
311 return HandleKeyDown(wParam
, lParam
);
315 return HandleKeyUp(wParam
, lParam
);
318 return HandleSetFocus((WXHWND
)wParam
);
321 return HandleKillFocus((WXHWND
)wParam
);
327 bool wxComboBox::MSWCommand(WXUINT param
, WXWORD id
)
335 sel
= GetSelection();
337 // we may sometimes get 2 CBN_SELCHANGE events or a CBN_SELENDOK
338 // before CBN_SELCHANGE with the same index when the user selects
339 // an item in the combobox -- ignore duplicates
340 if ( sel
> -1 && sel
!= m_selectionOld
)
342 m_selectionOld
= sel
;
344 // GetValue() would still return the old value from here but
345 // according to the docs we should return the new value if the
346 // user calls it in his event handler, so update internal
348 m_value
= GetString(sel
);
350 wxCommandEvent
event(wxEVT_COMMAND_COMBOBOX_SELECTED
, GetId());
352 event
.SetEventObject(this);
353 event
.SetString(m_value
);
354 ProcessCommand(event
);
356 else // no valid selection
358 m_selectionOld
= sel
;
360 // hence no EVT_TEXT neither
364 // fall through: for compability with wxGTK, also send the text
365 // update event when the selection changes (this also seems more
366 // logical as the text does change)
370 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, GetId());
372 // if sel != -1, value was initialized above (and we can't use
373 // GetValue() here as it would return the old selection and we
377 m_value
= wxGetWindowText(GetHwnd());
380 else // we're synthesizing text updated event from sel change
382 // We need to retrieve the current selection because the
383 // user may have changed it in the previous handler (for
384 // CBN_SELCHANGE above).
385 sel
= GetSelection();
388 m_value
= GetString(sel
);
392 event
.SetString(m_value
);
393 event
.SetEventObject(this);
394 ProcessCommand(event
);
399 return wxChoice::MSWCommand(param
, id
);
402 // let the def window proc have it by returning false, but do not pass the
403 // message we've already handled here (notably CBN_SELCHANGE) to the base
404 // class as it would generate another event for them
408 WXHWND
wxComboBox::GetEditHWND() const
410 // this function should not be called for wxCB_READONLY controls, it is
411 // the callers responsability to check this
412 wxASSERT_MSG( !(GetWindowStyle() & wxCB_READONLY
),
413 _T("read-only combobox doesn't have any edit control") );
417 HWND hwndEdit
= ::ChildWindowFromPoint(GetHwnd(), pt
);
418 if ( !hwndEdit
|| hwndEdit
== GetHwnd() )
420 wxFAIL_MSG(_T("not read only combobox without edit control?"));
423 return (WXHWND
)hwndEdit
;
426 // ----------------------------------------------------------------------------
427 // wxComboBox creation
428 // ----------------------------------------------------------------------------
430 bool wxComboBox::Create(wxWindow
*parent
, wxWindowID id
,
431 const wxString
& value
,
434 int n
, const wxString choices
[],
436 const wxValidator
& validator
,
437 const wxString
& name
)
439 // pretend that wxComboBox is hidden while it is positioned and resized and
440 // show it only right before leaving this method because otherwise there is
441 // some noticeable flicker while the control rearranges itself
444 if ( !CreateAndInit(parent
, id
, pos
, size
, n
, choices
, style
,
448 // we shouldn't call SetValue() for an empty string because this would
449 // (correctly) result in an assert with a read only combobox and is useless
450 // for the other ones anyhow
451 if ( !value
.empty() )
454 // a (not read only) combobox is, in fact, 2 controls: the combobox itself
455 // and an edit control inside it and if we want to catch events from this
456 // edit control, we must subclass it as well
457 if ( !(style
& wxCB_READONLY
) )
459 gs_wndprocEdit
= wxSetWindowProc((HWND
)GetEditHWND(),
463 // and finally, show the control
469 bool wxComboBox::Create(wxWindow
*parent
, wxWindowID id
,
470 const wxString
& value
,
473 const wxArrayString
& choices
,
475 const wxValidator
& validator
,
476 const wxString
& name
)
478 wxCArrayString
chs(choices
);
479 return Create(parent
, id
, value
, pos
, size
, chs
.GetCount(),
480 chs
.GetStrings(), style
, validator
, name
);
483 WXDWORD
wxComboBox::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
485 // we never have an external border
486 WXDWORD msStyle
= wxChoice::MSWGetStyle
488 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
491 // usually WS_TABSTOP is added by wxControl::MSWGetStyle() but as we're
492 // created hidden (see Create() above), it is not done for us but we still
493 // want to have this style
494 msStyle
|= WS_TABSTOP
;
496 // remove the style always added by wxChoice
497 msStyle
&= ~CBS_DROPDOWNLIST
;
499 if ( style
& wxCB_READONLY
)
500 msStyle
|= CBS_DROPDOWNLIST
;
502 else if ( style
& wxCB_SIMPLE
)
503 msStyle
|= CBS_SIMPLE
; // A list (shown always) and edit control
506 msStyle
|= CBS_DROPDOWN
;
508 // there is no reason to not always use CBS_AUTOHSCROLL, so do use it
509 msStyle
|= CBS_AUTOHSCROLL
;
511 // NB: we used to also add CBS_NOINTEGRALHEIGHT here but why?
516 // ----------------------------------------------------------------------------
517 // wxComboBox text control-like methods
518 // ----------------------------------------------------------------------------
520 void wxComboBox::SetValue(const wxString
& value
)
522 if ( HasFlag(wxCB_READONLY
) )
523 SetStringSelection(value
);
525 SetWindowText(GetHwnd(), value
.c_str());
528 m_selectionOld
= GetSelection();
531 // Clipboard operations
532 void wxComboBox::Copy()
534 SendMessage(GetHwnd(), WM_COPY
, 0, 0L);
537 void wxComboBox::Cut()
539 SendMessage(GetHwnd(), WM_CUT
, 0, 0L);
542 void wxComboBox::Paste()
544 SendMessage(GetHwnd(), WM_PASTE
, 0, 0L);
547 void wxComboBox::Undo()
551 HWND hEditWnd
= (HWND
) GetEditHWND() ;
553 ::SendMessage(hEditWnd
, EM_UNDO
, 0, 0);
557 void wxComboBox::Redo()
561 // Same as Undo, since Undo undoes the undo, i.e. a redo.
562 HWND hEditWnd
= (HWND
) GetEditHWND() ;
564 ::SendMessage(hEditWnd
, EM_UNDO
, 0, 0);
568 void wxComboBox::SelectAll()
570 SetSelection(0, GetLastPosition());
573 bool wxComboBox::CanUndo() const
578 HWND hEditWnd
= (HWND
) GetEditHWND() ;
580 return ::SendMessage(hEditWnd
, EM_CANUNDO
, 0, 0) != 0;
585 bool wxComboBox::CanRedo() const
590 HWND hEditWnd
= (HWND
) GetEditHWND() ;
592 return ::SendMessage(hEditWnd
, EM_CANUNDO
, 0, 0) != 0;
597 bool wxComboBox::HasSelection() const
600 GetSelection(&from
, &to
);
604 bool wxComboBox::CanCopy() const
606 // Can copy if there's a selection
607 return HasSelection();
610 bool wxComboBox::CanCut() const
612 return IsEditable() && CanCopy() ;
615 bool wxComboBox::CanPaste() const
620 // Standard edit control: check for straight text on clipboard
621 if ( !::OpenClipboard(GetHwndOf(wxTheApp
->GetTopWindow())) )
624 bool isTextAvailable
= ::IsClipboardFormatAvailable(CF_TEXT
) != 0;
627 return isTextAvailable
;
630 bool wxComboBox::IsEditable() const
632 return !HasFlag(wxCB_READONLY
);
635 void wxComboBox::SetEditable(bool WXUNUSED(editable
))
637 // Can't implement in MSW?
638 // HWND hWnd = GetHwnd();
639 // SendMessage(hWnd, EM_SETREADONLY, (WPARAM)!editable, (LPARAM)0L);
642 void wxComboBox::SetInsertionPoint(long pos
)
644 if ( GetWindowStyle() & wxCB_READONLY
)
648 HWND hWnd
= GetHwnd();
649 ::SendMessage(hWnd
, CB_SETEDITSEL
, 0, MAKELPARAM(pos
, pos
));
650 HWND hEditWnd
= (HWND
) GetEditHWND() ;
653 // Scroll insertion point into view
654 SendMessage(hEditWnd
, EM_SCROLLCARET
, (WPARAM
)0, (LPARAM
)0);
655 // Why is this necessary? (Copied from wxTextCtrl::SetInsertionPoint)
656 SendMessage(hEditWnd
, EM_REPLACESEL
, 0, (LPARAM
) wxEmptyString
);
661 void wxComboBox::SetInsertionPointEnd()
663 // setting insertion point doesn't make sense for read only comboboxes
664 if ( !(GetWindowStyle() & wxCB_READONLY
) )
666 wxTextPos pos
= GetLastPosition();
667 SetInsertionPoint(pos
);
671 long wxComboBox::GetInsertionPoint() const
673 // CB_GETEDITSEL returns the index of the first character of the selection in
674 // its low-order word
675 DWORD pos
= (DWORD
)::SendMessage(GetHwnd(), CB_GETEDITSEL
, 0, 0L);
679 wxTextPos
wxComboBox::GetLastPosition() const
681 HWND hEditWnd
= (HWND
) GetEditHWND();
683 // Get number of characters in the last (only) line. We'll add this to the character
684 // index for the last line, 1st position.
685 wxTextPos lineLength
= (wxTextPos
)SendMessage(hEditWnd
, EM_LINELENGTH
, (WPARAM
) 0, (LPARAM
)0L);
690 void wxComboBox::Replace(long from
, long to
, const wxString
& value
)
695 // Now replace with 'value', by pasting.
696 wxSetClipboardData(wxDF_TEXT
, (wxObject
*)(const wxChar
*)value
, 0, 0);
698 // Paste into edit control
699 SendMessage(GetHwnd(), WM_PASTE
, (WPARAM
)0, (LPARAM
)0L);
707 void wxComboBox::Remove(long from
, long to
)
709 // Set selection and remove it
710 SetSelection(from
, to
);
711 SendMessage(GetHwnd(), WM_CUT
, (WPARAM
)0, (LPARAM
)0);
714 void wxComboBox::SetSelection(long from
, long to
)
716 // if from and to are both -1, it means (in wxWidgets) that all text should
717 // be selected, translate this into Windows convention
718 if ( (from
== -1) && (to
== -1) )
723 if ( SendMessage(GetHwnd(), CB_SETEDITSEL
,
724 0, (LPARAM
)MAKELONG(from
, to
)) == CB_ERR
)
726 wxLogDebug(_T("CB_SETEDITSEL failed"));
730 void wxComboBox::GetSelection(long* from
, long* to
) const
732 DWORD dwStart
, dwEnd
;
733 if ( ::SendMessage(GetHwnd(), CB_GETEDITSEL
,
734 (WPARAM
)&dwStart
, (LPARAM
)&dwEnd
) == CB_ERR
)
746 int wxComboBox::GetSelection() const
748 return wxChoice::GetSelection();
751 // ----------------------------------------------------------------------------
752 // standard event handling
753 // ----------------------------------------------------------------------------
755 void wxComboBox::OnCut(wxCommandEvent
& WXUNUSED(event
))
760 void wxComboBox::OnCopy(wxCommandEvent
& WXUNUSED(event
))
765 void wxComboBox::OnPaste(wxCommandEvent
& WXUNUSED(event
))
770 void wxComboBox::OnUndo(wxCommandEvent
& WXUNUSED(event
))
775 void wxComboBox::OnRedo(wxCommandEvent
& WXUNUSED(event
))
780 void wxComboBox::OnDelete(wxCommandEvent
& WXUNUSED(event
))
783 GetSelection(& from
, & to
);
784 if (from
!= -1 && to
!= -1)
788 void wxComboBox::OnSelectAll(wxCommandEvent
& WXUNUSED(event
))
790 SetSelection(-1, -1);
793 void wxComboBox::OnUpdateCut(wxUpdateUIEvent
& event
)
795 event
.Enable( CanCut() );
798 void wxComboBox::OnUpdateCopy(wxUpdateUIEvent
& event
)
800 event
.Enable( CanCopy() );
803 void wxComboBox::OnUpdatePaste(wxUpdateUIEvent
& event
)
805 event
.Enable( CanPaste() );
808 void wxComboBox::OnUpdateUndo(wxUpdateUIEvent
& event
)
810 event
.Enable( CanUndo() );
813 void wxComboBox::OnUpdateRedo(wxUpdateUIEvent
& event
)
815 event
.Enable( CanRedo() );
818 void wxComboBox::OnUpdateDelete(wxUpdateUIEvent
& event
)
820 event
.Enable(HasSelection() && IsEditable()) ;
823 void wxComboBox::OnUpdateSelectAll(wxUpdateUIEvent
& event
)
825 event
.Enable(GetLastPosition() > 0);
828 #endif // wxUSE_COMBOBOX