1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/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"
29 #include "wx/combobox.h"
32 #include "wx/settings.h"
34 // for wxEVT_COMMAND_TEXT_ENTER
35 #include "wx/textctrl.h"
40 #include "wx/clipbrd.h"
41 #include "wx/msw/private.h"
44 #if !defined(__GNUWIN32_OLD__) || defined(__CYGWIN10__)
47 #include "wx/tooltip.h"
48 #endif // wxUSE_TOOLTIPS
50 // ----------------------------------------------------------------------------
52 // ----------------------------------------------------------------------------
54 #if wxUSE_EXTENDED_RTTI
55 WX_DEFINE_FLAGS( wxComboBoxStyle
)
57 wxBEGIN_FLAGS( wxComboBoxStyle
)
58 // new style border flags, we put them first to
59 // use them for streaming out
60 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
61 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
62 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
63 wxFLAGS_MEMBER(wxBORDER_RAISED
)
64 wxFLAGS_MEMBER(wxBORDER_STATIC
)
65 wxFLAGS_MEMBER(wxBORDER_NONE
)
67 // old style border flags
68 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
69 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
70 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
71 wxFLAGS_MEMBER(wxRAISED_BORDER
)
72 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
73 wxFLAGS_MEMBER(wxBORDER
)
75 // standard window styles
76 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
77 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
78 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
79 wxFLAGS_MEMBER(wxWANTS_CHARS
)
80 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
81 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
82 wxFLAGS_MEMBER(wxVSCROLL
)
83 wxFLAGS_MEMBER(wxHSCROLL
)
85 wxFLAGS_MEMBER(wxCB_SIMPLE
)
86 wxFLAGS_MEMBER(wxCB_SORT
)
87 wxFLAGS_MEMBER(wxCB_READONLY
)
88 wxFLAGS_MEMBER(wxCB_DROPDOWN
)
90 wxEND_FLAGS( wxComboBoxStyle
)
92 IMPLEMENT_DYNAMIC_CLASS_XTI(wxComboBox
, wxControl
,"wx/combobox.h")
94 wxBEGIN_PROPERTIES_TABLE(wxComboBox
)
95 wxEVENT_PROPERTY( Select
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
)
96 wxEVENT_PROPERTY( TextEnter
, wxEVT_COMMAND_TEXT_ENTER
, wxCommandEvent
)
99 wxPROPERTY( Font
, wxFont
, SetFont
, GetFont
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
100 wxPROPERTY_COLLECTION( Choices
, wxArrayString
, wxString
, AppendString
, GetStrings
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
101 wxPROPERTY( Value
,wxString
, SetValue
, GetValue
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
102 wxPROPERTY( Selection
,int, SetSelection
, GetSelection
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
103 wxPROPERTY_FLAGS( WindowStyle
, wxComboBoxStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
104 wxEND_PROPERTIES_TABLE()
106 wxBEGIN_HANDLERS_TABLE(wxComboBox
)
107 wxEND_HANDLERS_TABLE()
109 wxCONSTRUCTOR_5( wxComboBox
, wxWindow
* , Parent
, wxWindowID
, Id
, wxString
, Value
, wxPoint
, Position
, wxSize
, Size
)
113 IMPLEMENT_DYNAMIC_CLASS(wxComboBox
, wxControl
)
117 BEGIN_EVENT_TABLE(wxComboBox
, wxControl
)
118 EVT_MENU(wxID_CUT
, wxComboBox::OnCut
)
119 EVT_MENU(wxID_COPY
, wxComboBox::OnCopy
)
120 EVT_MENU(wxID_PASTE
, wxComboBox::OnPaste
)
121 EVT_MENU(wxID_UNDO
, wxComboBox::OnUndo
)
122 EVT_MENU(wxID_REDO
, wxComboBox::OnRedo
)
123 EVT_MENU(wxID_CLEAR
, wxComboBox::OnDelete
)
124 EVT_MENU(wxID_SELECTALL
, wxComboBox::OnSelectAll
)
126 EVT_UPDATE_UI(wxID_CUT
, wxComboBox::OnUpdateCut
)
127 EVT_UPDATE_UI(wxID_COPY
, wxComboBox::OnUpdateCopy
)
128 EVT_UPDATE_UI(wxID_PASTE
, wxComboBox::OnUpdatePaste
)
129 EVT_UPDATE_UI(wxID_UNDO
, wxComboBox::OnUpdateUndo
)
130 EVT_UPDATE_UI(wxID_REDO
, wxComboBox::OnUpdateRedo
)
131 EVT_UPDATE_UI(wxID_CLEAR
, wxComboBox::OnUpdateDelete
)
132 EVT_UPDATE_UI(wxID_SELECTALL
, wxComboBox::OnUpdateSelectAll
)
135 // ----------------------------------------------------------------------------
136 // function prototypes
137 // ----------------------------------------------------------------------------
139 LRESULT APIENTRY _EXPORT
wxComboEditWndProc(HWND hWnd
,
144 // ---------------------------------------------------------------------------
146 // ---------------------------------------------------------------------------
148 // the pointer to standard radio button wnd proc
149 static WNDPROC gs_wndprocEdit
= (WNDPROC
)NULL
;
151 // ============================================================================
153 // ============================================================================
155 // ----------------------------------------------------------------------------
156 // wnd proc for subclassed edit control
157 // ----------------------------------------------------------------------------
159 LRESULT APIENTRY _EXPORT
wxComboEditWndProc(HWND hWnd
,
164 HWND hwndCombo
= ::GetParent(hWnd
);
165 wxWindow
*win
= wxFindWinFromHandle((WXHWND
)hwndCombo
);
169 // forward some messages to the combobox to generate the appropriate
170 // 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() & wxTE_PROCESS_ENTER
)
205 // need to return a custom dlg code or we'll never get it
206 return DLGC_WANTMESSAGE
;
214 if( win
->HandleClipboardEvent( message
) )
219 return ::CallWindowProc(CASTWNDPROC gs_wndprocEdit
, hWnd
, message
, wParam
, lParam
);
222 // ----------------------------------------------------------------------------
223 // wxComboBox callbacks
224 // ----------------------------------------------------------------------------
226 WXLRESULT
wxComboBox::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
228 // TODO: handle WM_CTLCOLOR messages from our EDIT control to be able to
229 // set its colour correctly (to be the same as our own one)
234 // wxStaticBox can generate this message, when modifying the control's style.
235 // This causes the content of the combobox to be selected, for some reason.
236 case WM_STYLECHANGED
:
238 // combobox selection sometimes spontaneously changes when its
239 // size changes, restore it to the old value if necessary
241 GetSelection(&fromOld
, &toOld
);
242 WXLRESULT result
= wxChoice::MSWWindowProc(nMsg
, wParam
, lParam
);
245 GetSelection(&fromNew
, &toNew
);
247 if ( fromOld
!= fromNew
|| toOld
!= toNew
)
249 SetSelection(fromOld
, toOld
);
256 return wxChoice::MSWWindowProc(nMsg
, wParam
, lParam
);
259 bool wxComboBox::MSWProcessEditMsg(WXUINT msg
, WXWPARAM wParam
, WXLPARAM lParam
)
264 // for compatibility with wxTextCtrl, generate a special message
265 // when Enter is pressed
266 if ( wParam
== VK_RETURN
)
268 wxCommandEvent
event(wxEVT_COMMAND_TEXT_ENTER
, m_windowId
);
270 const int sel
= GetSelection();
272 event
.SetString(GetValue());
273 InitCommandEventWithItems(event
, sel
);
275 if ( ProcessCommand(event
) )
277 // don't let the event through to the native control
278 // because it doesn't need it and may generate an annoying
279 // beep if it gets it
286 return HandleChar(wParam
, lParam
, true /* isASCII */);
290 return HandleKeyDown(wParam
, lParam
);
294 return HandleKeyUp(wParam
, lParam
);
297 return HandleSetFocus((WXHWND
)wParam
);
300 return HandleKillFocus((WXHWND
)wParam
);
306 bool wxComboBox::MSWCommand(WXUINT param
, WXWORD id
)
314 #ifndef __SMARTPHONE__
315 // we need to reset this to prevent the selection from being undone
316 // by wxChoice, see wxChoice::MSWCommand() and comments there
317 m_lastAcceptedSelection
= wxID_NONE
;
320 // set these variables so that they could be also fixed in
321 // CBN_EDITCHANGE below
322 sel
= GetSelection();
323 value
= GetStringSelection();
325 wxCommandEvent
event(wxEVT_COMMAND_COMBOBOX_SELECTED
, GetId());
327 event
.SetString(value
);
328 InitCommandEventWithItems(event
, sel
);
330 ProcessCommand(event
);
333 // fall through: for compability with wxGTK, also send the text
334 // update event when the selection changes (this also seems more
335 // logical as the text does change)
339 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, GetId());
341 // if sel != -1, value was already initialized above
344 value
= wxGetWindowText(GetHwnd());
347 event
.SetString(value
);
348 InitCommandEventWithItems(event
, sel
);
350 ProcessCommand(event
);
355 return wxChoice::MSWCommand(param
, id
);
358 // skip wxChoice version as it would generate its own events for
360 return wxControl::MSWCommand(param
, id
);
363 WXHWND
wxComboBox::GetEditHWND() const
365 // this function should not be called for wxCB_READONLY controls, it is
366 // the callers responsability to check this
367 wxASSERT_MSG( !(GetWindowStyle() & wxCB_READONLY
),
368 _T("read-only combobox doesn't have any edit control") );
372 HWND hwndEdit
= ::ChildWindowFromPoint(GetHwnd(), pt
);
373 if ( !hwndEdit
|| hwndEdit
== GetHwnd() )
375 wxFAIL_MSG(_T("not read only combobox without edit control?"));
378 return (WXHWND
)hwndEdit
;
381 // ----------------------------------------------------------------------------
382 // wxComboBox creation
383 // ----------------------------------------------------------------------------
385 bool wxComboBox::Create(wxWindow
*parent
, wxWindowID id
,
386 const wxString
& value
,
389 int n
, const wxString choices
[],
391 const wxValidator
& validator
,
392 const wxString
& name
)
394 // pretend that wxComboBox is hidden while it is positioned and resized and
395 // show it only right before leaving this method because otherwise there is
396 // some noticeable flicker while the control rearranges itself
399 if ( !CreateAndInit(parent
, id
, pos
, size
, n
, choices
, style
,
403 // we shouldn't call SetValue() for an empty string because this would
404 // (correctly) result in an assert with a read only combobox and is useless
405 // for the other ones anyhow
406 if ( !value
.empty() )
409 // a (not read only) combobox is, in fact, 2 controls: the combobox itself
410 // and an edit control inside it and if we want to catch events from this
411 // edit control, we must subclass it as well
412 if ( !(style
& wxCB_READONLY
) )
414 gs_wndprocEdit
= wxSetWindowProc((HWND
)GetEditHWND(),
418 // and finally, show the control
424 bool wxComboBox::Create(wxWindow
*parent
, wxWindowID id
,
425 const wxString
& value
,
428 const wxArrayString
& choices
,
430 const wxValidator
& validator
,
431 const wxString
& name
)
433 wxCArrayString
chs(choices
);
434 return Create(parent
, id
, value
, pos
, size
, chs
.GetCount(),
435 chs
.GetStrings(), style
, validator
, name
);
438 WXDWORD
wxComboBox::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
440 // we never have an external border
441 WXDWORD msStyle
= wxChoice::MSWGetStyle
443 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
446 // usually WS_TABSTOP is added by wxControl::MSWGetStyle() but as we're
447 // created hidden (see Create() above), it is not done for us but we still
448 // want to have this style
449 msStyle
|= WS_TABSTOP
;
451 // remove the style always added by wxChoice
452 msStyle
&= ~CBS_DROPDOWNLIST
;
454 if ( style
& wxCB_READONLY
)
455 msStyle
|= CBS_DROPDOWNLIST
;
457 else if ( style
& wxCB_SIMPLE
)
458 msStyle
|= CBS_SIMPLE
; // A list (shown always) and edit control
461 msStyle
|= CBS_DROPDOWN
;
463 // there is no reason to not always use CBS_AUTOHSCROLL, so do use it
464 msStyle
|= CBS_AUTOHSCROLL
;
466 // NB: we used to also add CBS_NOINTEGRALHEIGHT here but why?
471 // ----------------------------------------------------------------------------
472 // wxComboBox text control-like methods
473 // ----------------------------------------------------------------------------
475 wxString
wxComboBox::GetValue() const
477 return wxGetWindowText(m_hWnd
);
480 void wxComboBox::SetValue(const wxString
& value
)
482 if ( HasFlag(wxCB_READONLY
) )
483 SetStringSelection(value
);
485 SetWindowText(GetHwnd(), value
.c_str());
488 // Clipboard operations
489 void wxComboBox::Copy()
491 SendMessage(GetHwnd(), WM_COPY
, 0, 0L);
494 void wxComboBox::Cut()
496 SendMessage(GetHwnd(), WM_CUT
, 0, 0L);
499 void wxComboBox::Paste()
501 SendMessage(GetHwnd(), WM_PASTE
, 0, 0L);
504 void wxComboBox::Undo()
508 HWND hEditWnd
= (HWND
) GetEditHWND();
510 ::SendMessage(hEditWnd
, EM_UNDO
, 0, 0);
514 void wxComboBox::Redo()
518 // Same as Undo, since Undo undoes the undo, i.e. a redo.
519 HWND hEditWnd
= (HWND
) GetEditHWND();
521 ::SendMessage(hEditWnd
, EM_UNDO
, 0, 0);
525 void wxComboBox::SelectAll()
527 SetSelection(0, GetLastPosition());
530 bool wxComboBox::CanUndo() const
535 HWND hEditWnd
= (HWND
) GetEditHWND();
537 return ::SendMessage(hEditWnd
, EM_CANUNDO
, 0, 0) != 0;
542 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 IsEditable() && CanCopy();
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 wxTextPos pos
= GetLastPosition();
624 SetInsertionPoint(pos
);
628 long wxComboBox::GetInsertionPoint() const
630 // CB_GETEDITSEL returns the index of the first character of the selection in
631 // its low-order word
632 DWORD pos
= (DWORD
)::SendMessage(GetHwnd(), CB_GETEDITSEL
, 0, 0L);
636 wxTextPos
wxComboBox::GetLastPosition() const
638 HWND hEditWnd
= (HWND
) GetEditHWND();
640 // Get number of characters in the last (only) line. We'll add this to the character
641 // index for the last line, 1st position.
642 wxTextPos lineLength
= (wxTextPos
)SendMessage(hEditWnd
, EM_LINELENGTH
, (WPARAM
) 0, (LPARAM
)0L);
647 void wxComboBox::Replace(long from
, long to
, const wxString
& value
)
652 // Now replace with 'value', by pasting.
653 wxSetClipboardData(wxDF_TEXT
, (wxObject
*)(const wxChar
*)value
, 0, 0);
655 // Paste into edit control
656 SendMessage(GetHwnd(), WM_PASTE
, (WPARAM
)0, (LPARAM
)0L);
664 void wxComboBox::Remove(long from
, long to
)
666 // Set selection and remove it
667 SetSelection(from
, to
);
668 SendMessage(GetHwnd(), WM_CUT
, (WPARAM
)0, (LPARAM
)0);
671 void wxComboBox::SetSelection(long from
, long to
)
673 // if from and to are both -1, it means (in wxWidgets) that all text should
674 // be selected, translate this into Windows convention
675 if ( (from
== -1) && (to
== -1) )
680 if ( SendMessage(GetHwnd(), CB_SETEDITSEL
,
681 0, (LPARAM
)MAKELONG(from
, to
)) == CB_ERR
)
683 wxLogDebug(_T("CB_SETEDITSEL failed"));
687 void wxComboBox::GetSelection(long* from
, long* to
) const
689 DWORD dwStart
, dwEnd
;
690 if ( ::SendMessage(GetHwnd(), CB_GETEDITSEL
,
691 (WPARAM
)&dwStart
, (LPARAM
)&dwEnd
) == CB_ERR
)
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