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"
40 #include "wx/combobox.h"
42 #include "wx/clipbrd.h"
43 #include "wx/msw/private.h"
46 #if !defined(__GNUWIN32_OLD__) || defined(__CYGWIN10__)
49 #include "wx/tooltip.h"
50 #endif // wxUSE_TOOLTIPS
52 // ----------------------------------------------------------------------------
54 // ----------------------------------------------------------------------------
56 #if wxUSE_EXTENDED_RTTI
57 WX_DEFINE_FLAGS( wxComboBoxStyle
)
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
)
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
)
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
)
87 wxFLAGS_MEMBER(wxCB_SIMPLE
)
88 wxFLAGS_MEMBER(wxCB_SORT
)
89 wxFLAGS_MEMBER(wxCB_READONLY
)
90 wxFLAGS_MEMBER(wxCB_DROPDOWN
)
92 wxEND_FLAGS( wxComboBoxStyle
)
94 IMPLEMENT_DYNAMIC_CLASS_XTI(wxComboBox
, wxControl
,"wx/combobox.h")
96 wxBEGIN_PROPERTIES_TABLE(wxComboBox
)
97 wxEVENT_PROPERTY( Select
, wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
)
98 wxEVENT_PROPERTY( TextEnter
, wxEVT_COMMAND_TEXT_ENTER
, wxCommandEvent
)
101 wxPROPERTY( Font
, wxFont
, SetFont
, GetFont
, EMPTY_MACROVALUE
, 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
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
104 wxPROPERTY( Selection
,int, SetSelection
, GetSelection
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
105 wxPROPERTY_FLAGS( WindowStyle
, wxComboBoxStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
106 wxEND_PROPERTIES_TABLE()
108 wxBEGIN_HANDLERS_TABLE(wxComboBox
)
109 wxEND_HANDLERS_TABLE()
111 wxCONSTRUCTOR_5( wxComboBox
, wxWindow
* , Parent
, wxWindowID
, Id
, wxString
, Value
, wxPoint
, Position
, wxSize
, Size
)
113 IMPLEMENT_DYNAMIC_CLASS(wxComboBox
, wxControl
)
115 BEGIN_EVENT_TABLE(wxComboBox
, wxControl
)
116 EVT_MENU(wxID_CUT
, wxComboBox::OnCut
)
117 EVT_MENU(wxID_COPY
, wxComboBox::OnCopy
)
118 EVT_MENU(wxID_PASTE
, wxComboBox::OnPaste
)
119 EVT_MENU(wxID_UNDO
, wxComboBox::OnUndo
)
120 EVT_MENU(wxID_REDO
, wxComboBox::OnRedo
)
121 EVT_MENU(wxID_CLEAR
, wxComboBox::OnDelete
)
122 EVT_MENU(wxID_SELECTALL
, wxComboBox::OnSelectAll
)
124 EVT_UPDATE_UI(wxID_CUT
, wxComboBox::OnUpdateCut
)
125 EVT_UPDATE_UI(wxID_COPY
, wxComboBox::OnUpdateCopy
)
126 EVT_UPDATE_UI(wxID_PASTE
, wxComboBox::OnUpdatePaste
)
127 EVT_UPDATE_UI(wxID_UNDO
, wxComboBox::OnUpdateUndo
)
128 EVT_UPDATE_UI(wxID_REDO
, wxComboBox::OnUpdateRedo
)
129 EVT_UPDATE_UI(wxID_CLEAR
, wxComboBox::OnUpdateDelete
)
130 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
177 wxComboBox
*combo
= wxDynamicCast(win
, wxComboBox
);
180 // we can get WM_KILLFOCUS while our parent is already half
181 // destroyed and hence doesn't look like a combobx any
182 // longer, check for it to avoid bogus assert failures
183 if ( !win
->IsBeingDeleted() )
185 wxFAIL_MSG( _T("should have combo as parent") );
188 else if ( combo
->MSWProcessEditMsg(message
, wParam
, lParam
) )
198 wxCHECK_MSG( win
, 0, _T("should have a parent") );
200 if ( win
->GetWindowStyle() & wxPROCESS_ENTER
)
202 // need to return a custom dlg code or we'll never get it
203 return DLGC_WANTMESSAGE
;
208 // deal with tooltips here
209 #if wxUSE_TOOLTIPS && defined(TTN_NEEDTEXT)
212 wxCHECK_MSG( win
, 0, _T("should have a parent") );
214 NMHDR
* hdr
= (NMHDR
*)lParam
;
215 if ( hdr
->code
== TTN_NEEDTEXT
)
217 wxToolTip
*tooltip
= win
->GetToolTip();
220 TOOLTIPTEXT
*ttt
= (TOOLTIPTEXT
*)lParam
;
221 ttt
->lpszText
= (wxChar
*)tooltip
->GetTip().c_str();
229 #endif // wxUSE_TOOLTIPS
232 return ::CallWindowProc(CASTWNDPROC gs_wndprocEdit
, hWnd
, message
, wParam
, lParam
);
235 // ----------------------------------------------------------------------------
236 // wxComboBox callbacks
237 // ----------------------------------------------------------------------------
239 WXLRESULT
wxComboBox::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
241 // handle WM_CTLCOLOR messages from our EDIT control to be able to set its
242 // colour correctly (to be the same as our own one)
246 // Selection was set with SetSelection. Update the value too.
247 if ((int)wParam
> GetCount())
248 m_value
= wxEmptyString
;
250 m_value
= GetString(wParam
);
254 return wxChoice::MSWWindowProc(nMsg
, wParam
, lParam
);
257 bool wxComboBox::MSWProcessEditMsg(WXUINT msg
, WXWPARAM wParam
, WXLPARAM lParam
)
262 // for compatibility with wxTextCtrl, generate a special message
263 // when Enter is pressed
264 if ( wParam
== VK_RETURN
)
266 wxCommandEvent
event(wxEVT_COMMAND_TEXT_ENTER
, m_windowId
);
267 InitCommandEvent(event
);
268 event
.SetString(GetValue());
269 event
.SetInt(GetSelection());
270 ProcessCommand(event
);
273 return HandleChar(wParam
, lParam
, true /* isASCII */);
276 return HandleKeyDown(wParam
, lParam
);
279 return HandleKeyUp(wParam
, lParam
);
282 return HandleSetFocus((WXHWND
)wParam
);
285 return HandleKillFocus((WXHWND
)wParam
);
291 bool wxComboBox::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
298 sel
= GetSelection();
300 // somehow we get 2 CBN_SELCHANGE events with the same index when
301 // the user selects an item in the combobox -- ignore duplicates
302 if ( sel
> -1 && sel
!= m_selectionOld
)
304 m_selectionOld
= sel
;
306 // GetValue() would still return the old value from here but
307 // according to the docs we should return the new value if the
308 // user calls it in his event handler, so update internal
310 m_value
= GetString(sel
);
312 wxCommandEvent
event(wxEVT_COMMAND_COMBOBOX_SELECTED
, GetId());
314 event
.SetEventObject(this);
315 event
.SetString(m_value
);
316 ProcessCommand(event
);
318 else // no valid selection
320 m_selectionOld
= sel
;
322 // hence no EVT_TEXT neither
326 // fall through: for compability with wxGTK, also send the text
327 // update event when the selection changes (this also seems more
328 // logical as the text does change)
332 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, GetId());
334 // if sel != -1, value was initialized above (and we can't use
335 // GetValue() here as it would return the old selection and we
339 m_value
= wxGetWindowText(GetHwnd());
341 else // we're synthesizing text updated event from sel change
343 // We need to retrieve the current selection because the
344 // user may have changed it in the previous handler (for
345 // CBN_SELCHANGE above).
346 sel
= GetSelection();
349 m_value
= GetString(sel
);
353 event
.SetString(m_value
);
354 event
.SetEventObject(this);
355 ProcessCommand(event
);
360 // there is no return value for the CBN_ notifications, so always return
361 // false from here to pass the message to DefWindowProc()
365 WXHWND
wxComboBox::GetEditHWND() const
367 // this function should not be called for wxCB_READONLY controls, it is
368 // the callers responsability to check this
369 wxASSERT_MSG( !(GetWindowStyle() & wxCB_READONLY
),
370 _T("read-only combobox doesn't have any edit control") );
374 HWND hwndEdit
= ::ChildWindowFromPoint(GetHwnd(), pt
);
375 if ( !hwndEdit
|| hwndEdit
== GetHwnd() )
377 wxFAIL_MSG(_T("not read only combobox without edit control?"));
380 return (WXHWND
)hwndEdit
;
383 // ----------------------------------------------------------------------------
384 // wxComboBox creation
385 // ----------------------------------------------------------------------------
387 bool wxComboBox::Create(wxWindow
*parent
, wxWindowID id
,
388 const wxString
& value
,
391 int n
, const wxString choices
[],
393 const wxValidator
& validator
,
394 const wxString
& name
)
396 // pretend that wxComboBox is hidden while it is positioned and resized and
397 // show it only right before leaving this method because otherwise there is
398 // some noticeable flicker while the control rearranges itself
401 if ( !CreateAndInit(parent
, id
, pos
, size
, n
, choices
, style
,
405 // we shouldn't call SetValue() for an empty string because this would
406 // (correctly) result in an assert with a read only combobox and is useless
407 // for the other ones anyhow
408 if ( !value
.empty() )
411 // a (not read only) combobox is, in fact, 2 controls: the combobox itself
412 // and an edit control inside it and if we want to catch events from this
413 // edit control, we must subclass it as well
414 if ( !(style
& wxCB_READONLY
) )
416 gs_wndprocEdit
= wxSetWindowProc((HWND
)GetEditHWND(),
420 // and finally, show the control
426 bool wxComboBox::Create(wxWindow
*parent
, wxWindowID id
,
427 const wxString
& value
,
430 const wxArrayString
& choices
,
432 const wxValidator
& validator
,
433 const wxString
& name
)
435 wxCArrayString
chs(choices
);
436 return Create(parent
, id
, value
, pos
, size
, chs
.GetCount(),
437 chs
.GetStrings(), style
, validator
, name
);
440 WXDWORD
wxComboBox::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
442 // we never have an external border
443 WXDWORD msStyle
= wxChoice::MSWGetStyle
445 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
448 // remove the style always added by wxChoice
449 msStyle
&= ~CBS_DROPDOWNLIST
;
451 if ( style
& wxCB_READONLY
)
452 msStyle
|= CBS_DROPDOWNLIST
;
454 else if ( style
& wxCB_SIMPLE
)
455 msStyle
|= CBS_SIMPLE
; // A list (shown always) and edit control
458 msStyle
|= CBS_DROPDOWN
;
460 // there is no reason to not always use CBS_AUTOHSCROLL, so do use it
461 msStyle
|= CBS_AUTOHSCROLL
;
463 // NB: we used to also add CBS_NOINTEGRALHEIGHT here but why?
468 // ----------------------------------------------------------------------------
469 // wxComboBox text control-like methods
470 // ----------------------------------------------------------------------------
472 void wxComboBox::SetValue(const wxString
& value
)
474 if ( HasFlag(wxCB_READONLY
) )
475 SetStringSelection(value
);
477 SetWindowText(GetHwnd(), value
.c_str());
480 m_selectionOld
= GetSelection();
483 // Clipboard operations
484 void wxComboBox::Copy()
486 SendMessage(GetHwnd(), WM_COPY
, 0, 0L);
489 void wxComboBox::Cut()
491 SendMessage(GetHwnd(), WM_CUT
, 0, 0L);
494 void wxComboBox::Paste()
496 SendMessage(GetHwnd(), WM_PASTE
, 0, 0L);
499 void wxComboBox::Undo()
503 HWND hEditWnd
= (HWND
) GetEditHWND() ;
505 ::SendMessage(hEditWnd
, EM_UNDO
, 0, 0);
509 void wxComboBox::Redo()
513 // Same as Undo, since Undo undoes the undo, i.e. a redo.
514 HWND hEditWnd
= (HWND
) GetEditHWND() ;
516 ::SendMessage(hEditWnd
, EM_UNDO
, 0, 0);
520 void wxComboBox::SelectAll()
522 SetSelection(0, GetLastPosition());
525 bool wxComboBox::CanUndo() const
527 HWND hEditWnd
= (HWND
) GetEditHWND() ;
529 return ::SendMessage(hEditWnd
, EM_CANUNDO
, 0, 0) != 0;
534 bool wxComboBox::CanRedo() const
536 HWND hEditWnd
= (HWND
) GetEditHWND() ;
538 return ::SendMessage(hEditWnd
, EM_CANUNDO
, 0, 0) != 0;
543 bool wxComboBox::HasSelection() const
546 GetSelection(&from
, &to
);
550 bool wxComboBox::CanCopy() const
552 // Can copy if there's a selection
553 return HasSelection();
556 bool wxComboBox::CanCut() const
558 return CanCopy() && IsEditable();
561 bool wxComboBox::CanPaste() const
566 // Standard edit control: check for straight text on clipboard
567 if ( !::OpenClipboard(GetHwndOf(wxTheApp
->GetTopWindow())) )
570 bool isTextAvailable
= ::IsClipboardFormatAvailable(CF_TEXT
) != 0;
573 return isTextAvailable
;
576 bool wxComboBox::IsEditable() const
578 return !HasFlag(wxCB_READONLY
);
581 void wxComboBox::SetEditable(bool WXUNUSED(editable
))
583 // Can't implement in MSW?
584 // HWND hWnd = GetHwnd();
585 // SendMessage(hWnd, EM_SETREADONLY, (WPARAM)!editable, (LPARAM)0L);
588 void wxComboBox::SetInsertionPoint(long pos
)
590 if ( GetWindowStyle() & wxCB_READONLY
)
594 HWND hWnd
= GetHwnd();
595 ::SendMessage(hWnd
, CB_SETEDITSEL
, 0, MAKELPARAM(pos
, pos
));
596 HWND hEditWnd
= (HWND
) GetEditHWND() ;
599 // Scroll insertion point into view
600 SendMessage(hEditWnd
, EM_SCROLLCARET
, (WPARAM
)0, (LPARAM
)0);
601 // Why is this necessary? (Copied from wxTextCtrl::SetInsertionPoint)
602 SendMessage(hEditWnd
, EM_REPLACESEL
, 0, (LPARAM
) wxEmptyString
);
607 void wxComboBox::SetInsertionPointEnd()
609 // setting insertion point doesn't make sense for read only comboboxes
610 if ( !(GetWindowStyle() & wxCB_READONLY
) )
612 long pos
= GetLastPosition();
613 SetInsertionPoint(pos
);
617 long wxComboBox::GetInsertionPoint() const
620 DWORD Pos
=(DWORD
)SendMessage(GetHwnd(), CB_GETEDITSEL
, 0, 0L);
627 long wxComboBox::GetLastPosition() const
629 HWND hEditWnd
= (HWND
) GetEditHWND();
631 // Get number of characters in the last (only) line. We'll add this to the character
632 // index for the last line, 1st position.
633 int lineLength
= (int)SendMessage(hEditWnd
, EM_LINELENGTH
, (WPARAM
) 0, (LPARAM
)0L);
635 return (long)(lineLength
);
638 void wxComboBox::Replace(long from
, long to
, const wxString
& value
)
643 // Now replace with 'value', by pasting.
644 wxSetClipboardData(wxDF_TEXT
, (wxObject
*)(const wxChar
*)value
, 0, 0);
646 // Paste into edit control
647 SendMessage(GetHwnd(), WM_PASTE
, (WPARAM
)0, (LPARAM
)0L);
651 void wxComboBox::Remove(long from
, long to
)
653 // Set selection and remove it
654 SetSelection(from
, to
);
655 SendMessage(GetHwnd(), WM_CUT
, (WPARAM
)0, (LPARAM
)0);
658 void wxComboBox::SetSelection(long from
, long to
)
660 HWND hWnd
= GetHwnd();
661 long fromChar
= from
;
663 // if from and to are both -1, it means
664 // (in wxWidgets) that all text should be selected.
665 // This translates into Windows convention
666 if ((from
== -1) && (to
== -1))
672 if ( SendMessage(hWnd
, CB_SETEDITSEL
, (WPARAM
)0, (LPARAM
)MAKELONG(fromChar
, toChar
)) == CB_ERR
)
674 wxLogDebug(_T("CB_SETEDITSEL failed"));
678 void wxComboBox::GetSelection(long* from
, long* to
) const
680 DWORD dwStart
, dwEnd
;
681 ::SendMessage(GetHwnd(), CB_GETEDITSEL
, (WPARAM
)&dwStart
, (LPARAM
)&dwEnd
);
687 int wxComboBox::GetSelection() const
689 return wxChoice::GetSelection();
692 // ----------------------------------------------------------------------------
693 // standard event handling
694 // ----------------------------------------------------------------------------
696 void wxComboBox::OnCut(wxCommandEvent
& WXUNUSED(event
))
701 void wxComboBox::OnCopy(wxCommandEvent
& WXUNUSED(event
))
706 void wxComboBox::OnPaste(wxCommandEvent
& WXUNUSED(event
))
711 void wxComboBox::OnUndo(wxCommandEvent
& WXUNUSED(event
))
716 void wxComboBox::OnRedo(wxCommandEvent
& WXUNUSED(event
))
721 void wxComboBox::OnDelete(wxCommandEvent
& WXUNUSED(event
))
724 GetSelection(& from
, & to
);
725 if (from
!= -1 && to
!= -1)
729 void wxComboBox::OnSelectAll(wxCommandEvent
& WXUNUSED(event
))
731 SetSelection(-1, -1);
734 void wxComboBox::OnUpdateCut(wxUpdateUIEvent
& event
)
736 event
.Enable( CanCut() );
739 void wxComboBox::OnUpdateCopy(wxUpdateUIEvent
& event
)
741 event
.Enable( CanCopy() );
744 void wxComboBox::OnUpdatePaste(wxUpdateUIEvent
& event
)
746 event
.Enable( CanPaste() );
749 void wxComboBox::OnUpdateUndo(wxUpdateUIEvent
& event
)
751 event
.Enable( CanUndo() );
754 void wxComboBox::OnUpdateRedo(wxUpdateUIEvent
& event
)
756 event
.Enable( CanRedo() );
759 void wxComboBox::OnUpdateDelete(wxUpdateUIEvent
& event
)
761 event
.Enable(HasSelection() && IsEditable()) ;
764 void wxComboBox::OnUpdateSelectAll(wxUpdateUIEvent
& event
)
766 event
.Enable(GetLastPosition() > 0);
769 #endif // wxUSE_COMBOBOX