1 /////////////////////////////////////////////////////////////////////////////
2 // Name: univ/combobox.cpp
3 // Purpose: wxComboControl and wxComboBox implementation
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "univcombobox.h"
24 #include "wx/wxprec.h"
35 #include "wx/button.h"
36 #include "wx/combobox.h"
37 #include "wx/listbox.h"
38 #include "wx/textctrl.h"
39 #include "wx/bmpbuttn.h"
41 #include "wx/validate.h"
44 #include "wx/tooltip.h"
45 #include "wx/popupwin.h"
47 #include "wx/univ/renderer.h"
48 #include "wx/univ/inphand.h"
49 #include "wx/univ/theme.h"
52 The keyboard event flow:
54 1. they always come to the text ctrl
55 2. it forwards the ones it doesn't process to the wxComboControl
56 3. which passes them to the popup window if it is popped up
60 // ----------------------------------------------------------------------------
62 // the margin between the text control and the combo button
63 static const wxCoord g_comboMargin
= 2;
65 // ----------------------------------------------------------------------------
66 // wxComboButton is just a normal button except that it sends commands to the
67 // combobox and not its parent
68 // ----------------------------------------------------------------------------
70 class wxComboButton
: public wxBitmapButton
73 wxComboButton(wxComboControl
*combo
)
74 : wxBitmapButton(combo
->GetParent(), -1, wxNullBitmap
,
75 wxDefaultPosition
, wxDefaultSize
,
76 wxBORDER_NONE
| wxBU_EXACTFIT
)
80 wxBitmap bmpNormal
, bmpFocus
, bmpPressed
, bmpDisabled
;
82 GetRenderer()->GetComboBitmaps(&bmpNormal
,
87 SetBitmapLabel(bmpNormal
);
88 SetBitmapFocus(bmpFocus
.Ok() ? bmpFocus
: bmpNormal
);
89 SetBitmapSelected(bmpPressed
.Ok() ? bmpPressed
: bmpNormal
);
90 SetBitmapDisabled(bmpDisabled
.Ok() ? bmpDisabled
: bmpNormal
);
92 SetBestSize(wxDefaultSize
);
96 void OnButton(wxCommandEvent
& WXUNUSED(event
)) { m_combo
->ShowPopup(); }
98 virtual wxSize
DoGetBestClientSize() const
100 const wxBitmap
& bmp
= GetBitmapLabel();
102 return wxSize(bmp
.GetWidth(), bmp
.GetHeight());
107 wxComboControl
*m_combo
;
109 DECLARE_EVENT_TABLE()
112 // ----------------------------------------------------------------------------
113 // wxComboListBox is a listbox modified to be used as a popup window in a
115 // ----------------------------------------------------------------------------
117 class wxComboListBox
: public wxListBox
, public wxComboPopup
121 wxComboListBox(wxComboControl
*combo
, int style
= 0);
122 virtual ~wxComboListBox();
124 // implement wxComboPopup methods
125 virtual bool SetSelection(const wxString
& value
);
126 virtual wxControl
*GetControl() { return this; }
127 virtual void OnShow();
128 virtual wxCoord
GetBestWidth() const;
131 // we shouldn't return height too big from here
132 virtual wxSize
DoGetBestClientSize() const;
134 // filter mouse move events happening outside the list box
135 void OnMouseMove(wxMouseEvent
& event
);
137 // set m_clicked value from here
138 void OnLeftUp(wxMouseEvent
& event
);
140 // called whenever the user selects or activates a listbox item
141 void OnSelect(wxCommandEvent
& event
);
143 // used to process wxUniv actions
144 bool PerformAction(const wxControlAction
& action
,
146 const wxString
& strArg
);
149 // has the mouse been released on this control?
152 DECLARE_EVENT_TABLE()
155 // ----------------------------------------------------------------------------
156 // wxComboTextCtrl is a simple text ctrl which forwards
157 // wxEVT_COMMAND_TEXT_UPDATED events and all key events to the combobox
158 // ----------------------------------------------------------------------------
160 class wxComboTextCtrl
: public wxTextCtrl
163 wxComboTextCtrl(wxComboControl
*combo
,
164 const wxString
& value
,
166 const wxValidator
& validator
);
169 void OnKey(wxKeyEvent
& event
);
170 void OnText(wxCommandEvent
& event
);
173 wxComboControl
*m_combo
;
175 DECLARE_EVENT_TABLE()
178 // ----------------------------------------------------------------------------
179 // event tables and such
180 // ----------------------------------------------------------------------------
182 BEGIN_EVENT_TABLE(wxComboButton
, wxButton
)
183 EVT_BUTTON(-1, wxComboButton::OnButton
)
186 BEGIN_EVENT_TABLE(wxComboListBox
, wxListBox
)
187 EVT_LISTBOX(-1, wxComboListBox::OnSelect
)
188 EVT_LISTBOX_DCLICK(-1, wxComboListBox::OnSelect
)
189 EVT_MOTION(wxComboListBox::OnMouseMove
)
190 EVT_LEFT_UP(wxComboListBox::OnLeftUp
)
193 BEGIN_EVENT_TABLE(wxComboControl
, wxControl
)
194 EVT_KEY_DOWN(wxComboControl::OnKey
)
195 EVT_KEY_UP(wxComboControl::OnKey
)
198 BEGIN_EVENT_TABLE(wxComboTextCtrl
, wxTextCtrl
)
199 EVT_KEY_DOWN(wxComboTextCtrl::OnKey
)
200 EVT_KEY_UP(wxComboTextCtrl::OnKey
)
201 EVT_TEXT(-1, wxComboTextCtrl::OnText
)
204 IMPLEMENT_DYNAMIC_CLASS(wxComboBox
, wxControl
)
206 // ============================================================================
208 // ============================================================================
210 // ----------------------------------------------------------------------------
211 // wxComboControl creation
212 // ----------------------------------------------------------------------------
214 void wxComboControl::Init()
216 m_popup
= (wxComboPopup
*)NULL
;
217 m_winPopup
= (wxPopupComboWindow
*)NULL
;
218 m_isPopupShown
= FALSE
;
223 bool wxComboControl::Create(wxWindow
*parent
,
225 const wxString
& value
,
229 const wxValidator
& validator
,
230 const wxString
& name
)
232 // first create our own window, i.e. the one which will contain all
234 style
&= ~wxBORDER_NONE
;
235 style
|= wxBORDER_SUNKEN
;
236 if ( !wxControl::Create(parent
, id
, pos
, size
, style
, validator
, name
) )
239 // create the text control and the button as our siblings (*not* children),
240 // don't care about size/position here - they will be set in DoMoveWindow()
241 m_btn
= new wxComboButton(this);
242 m_text
= new wxComboTextCtrl(this,
244 style
& wxCB_READONLY
? wxTE_READONLY
: 0,
247 // for compatibility with the other ports, the height specified is the
248 // combined height of the combobox itself and the popup
251 // ok, use default height for popup too
256 m_heightPopup
= size
.y
- DoGetBestSize().y
;
262 // create the popup window immediately here to allow creating the controls
263 // with parent == GetPopupWindow() from the derived class ctor
264 m_winPopup
= new wxPopupComboWindow(this);
266 // have to disable this window to avoid interfering it with message
267 // processing to the text and the button... but pretend it is enabled to
268 // make IsEnabled() return TRUE
269 wxControl::Enable(FALSE
); // don't use non virtual Disable() here!
272 CreateInputHandler(wxINP_HANDLER_COMBOBOX
);
277 wxComboControl::~wxComboControl()
279 // as the button and the text control are the parent's children and not
280 // ours, we have to delete them manually - they are not deleted
281 // automatically by wxWindows when we're deleted
288 // ----------------------------------------------------------------------------
290 // ----------------------------------------------------------------------------
292 void wxComboControl::DoSetSize(int x
, int y
,
293 int width
, int WXUNUSED(height
),
296 // combo height is always fixed
297 wxControl::DoSetSize(x
, y
, width
, DoGetBestSize().y
, sizeFlags
);
300 wxSize
wxComboControl::DoGetBestClientSize() const
302 wxSize sizeBtn
= m_btn
->GetBestSize(),
303 sizeText
= m_text
->GetBestSize();
304 wxCoord widthPopup
= 0;
308 widthPopup
= m_popup
->GetBestWidth();
311 return wxSize(wxMax(sizeText
.x
+ g_comboMargin
+ sizeBtn
.x
, widthPopup
),
312 wxMax(sizeBtn
.y
, sizeText
.y
));
315 void wxComboControl::DoMoveWindow(int x
, int y
, int width
, int height
)
317 wxControl::DoMoveWindow(x
, y
, width
, height
);
319 // position the subcontrols inside the client area
320 wxRect rectBorders
= GetRenderer()->GetBorderDimensions(GetBorder());
323 width
-= rectBorders
.x
+ rectBorders
.width
;
324 height
-= rectBorders
.y
+ rectBorders
.height
;
326 wxSize sizeBtn
= m_btn
->GetBestSize();
328 wxCoord wText
= width
- sizeBtn
.x
;
329 wxPoint p
= GetParent() ? GetParent()->GetClientAreaOrigin() : wxPoint(0,0);
330 m_text
->SetSize(x
- p
.x
, y
- p
.y
, wText
, height
);
331 m_btn
->SetSize(x
- p
.x
+ wText
, y
- p
.y
, sizeBtn
.x
, height
);
334 // ----------------------------------------------------------------------------
336 // ----------------------------------------------------------------------------
338 bool wxComboControl::Enable(bool enable
)
340 if ( !wxControl::Enable(enable
) )
343 m_btn
->Enable(enable
);
344 m_text
->Enable(enable
);
349 bool wxComboControl::Show(bool show
)
351 if ( !wxControl::Show(show
) )
364 void wxComboControl::DoSetToolTip(wxToolTip
*tooltip
)
366 wxControl::DoSetToolTip(tooltip
);
368 // Set tool tip for button and text box
373 const wxString
&tip
= tooltip
->GetTip();
374 m_text
->SetToolTip(tip
);
375 m_btn
->SetToolTip(tip
);
379 m_text
->SetToolTip(NULL
);
380 m_btn
->SetToolTip(NULL
);
384 #endif // wxUSE_TOOLTIPS
386 // ----------------------------------------------------------------------------
387 // popup window handling
388 // ----------------------------------------------------------------------------
390 void wxComboControl::SetPopupControl(wxComboPopup
*popup
)
395 void wxComboControl::ShowPopup()
397 wxCHECK_RET( m_popup
, _T("no popup to show in wxComboControl") );
398 wxCHECK_RET( !IsPopupShown(), _T("popup window already shown") );
400 wxControl
*control
= m_popup
->GetControl();
402 // size and position the popup window correctly
403 m_winPopup
->SetSize(GetSize().x
,
404 m_heightPopup
== -1 ? control
->GetBestSize().y
406 wxSize sizePopup
= m_winPopup
->GetClientSize();
407 control
->SetSize(0, 0, sizePopup
.x
, sizePopup
.y
);
409 // some controls don't accept the size we give then: e.g. a listbox may
410 // require more space to show its last row
411 wxSize sizeReal
= control
->GetSize();
412 if ( sizeReal
!= sizePopup
)
414 m_winPopup
->SetClientSize(sizeReal
);
417 m_winPopup
->PositionNearCombo();
421 m_winPopup
->Popup(m_text
);
423 m_popup
->SetSelection(m_text
->GetValue());
425 m_isPopupShown
= TRUE
;
428 void wxComboControl::HidePopup()
430 wxCHECK_RET( m_popup
, _T("no popup to hide in wxComboControl") );
431 wxCHECK_RET( IsPopupShown(), _T("popup window not shown") );
433 m_winPopup
->Dismiss();
435 m_isPopupShown
= FALSE
;
438 void wxComboControl::OnSelect(const wxString
& value
)
440 m_text
->SetValue(value
);
446 void wxComboControl::OnDismiss()
452 // ----------------------------------------------------------------------------
454 // ----------------------------------------------------------------------------
456 wxComboTextCtrl::wxComboTextCtrl(wxComboControl
*combo
,
457 const wxString
& value
,
459 const wxValidator
& validator
)
460 : wxTextCtrl(combo
->GetParent(), -1, value
,
461 wxDefaultPosition
, wxDefaultSize
,
462 wxBORDER_NONE
| style
,
468 void wxComboTextCtrl::OnText(wxCommandEvent
& event
)
470 if ( m_combo
->IsPopupShown() )
472 m_combo
->GetPopupControl()->SetSelection(GetValue());
475 // we need to make a copy of the event to have the correct originating
477 wxCommandEvent event2
= event
;
478 event2
.SetEventObject(m_combo
);
479 event2
.SetId(m_combo
->GetId());
481 // there is a small incompatibility with wxMSW here: the combobox gets the
482 // event before the text control in our case which corresponds to SMW
483 // CBN_EDITUPDATE notification and not CBN_EDITCHANGE one wxMSW currently
486 // if this is really a problem, we can play games with the event handlers
487 // to circumvent this
488 (void)m_combo
->ProcessEvent(event2
);
493 // pass the keys we don't process to the combo first
494 void wxComboTextCtrl::OnKey(wxKeyEvent
& event
)
496 switch ( event
.GetKeyCode() )
499 // the popup control gets it first but only if it is shown
500 if ( !m_combo
->IsPopupShown() )
511 (void)m_combo
->ProcessEvent(event
);
518 // ----------------------------------------------------------------------------
520 // ----------------------------------------------------------------------------
522 wxComboListBox::wxComboListBox(wxComboControl
*combo
, int style
)
523 : wxListBox(combo
->GetPopupWindow(), -1,
524 wxDefaultPosition
, wxDefaultSize
,
526 wxBORDER_SIMPLE
| wxLB_INT_HEIGHT
| style
),
529 // we don't react to the mouse events outside the window at all
533 wxComboListBox::~wxComboListBox()
537 bool wxComboListBox::SetSelection(const wxString
& value
)
539 // FindItem() would just find the current item for an empty string (it
540 // always matches), but we want to show the first one in such case
545 wxListBox::SetSelection(0);
547 //else: empty listbox - nothing to do
549 else if ( !FindItem(value
) )
558 void wxComboListBox::OnSelect(wxCommandEvent
& event
)
562 // first update the combo and close the listbox
563 m_combo
->OnSelect(event
.GetString());
565 // next let the user code have the event
567 // all fields are already filled by the listbox, just change the event
568 // type and send it to the combo
569 wxCommandEvent event2
= event
;
570 event2
.SetEventType(wxEVT_COMMAND_COMBOBOX_SELECTED
);
571 event2
.SetEventObject(m_combo
);
572 event2
.SetId(m_combo
->GetId());
573 m_combo
->ProcessEvent(event2
);
575 //else: ignore the events resultign from just moving the mouse initially
578 void wxComboListBox::OnShow()
580 // nobody clicked us yet
584 bool wxComboListBox::PerformAction(const wxControlAction
& action
,
586 const wxString
& strArg
)
589 if ( action
== wxACTION_LISTBOX_FIND
)
591 // we don't let the listbox handle this as instead of just using the
592 // single key presses, as usual, we use the text ctrl value as prefix
593 // and this is done by wxComboControl itself
597 return wxListBox::PerformAction(action
, numArg
, strArg
);
600 void wxComboListBox::OnLeftUp(wxMouseEvent
& event
)
602 // we should dismiss the combo now
608 void wxComboListBox::OnMouseMove(wxMouseEvent
& event
)
610 // while a wxComboListBox is shown, it always has capture, so if it doesn't
611 // we're about to go away anyhow (normally this shouldn't happen at all,
612 // but I don't put assert here as it just might do on other platforms and
613 // it doesn't break anythign anyhow)
614 if ( this == wxWindow::GetCapture() )
616 if ( HitTest(event
.GetPosition()) == wxHT_WINDOW_INSIDE
)
620 //else: popup shouldn't react to the mouse motions outside it, it only
621 // captures the mouse to be able to detect when it must be
622 // dismissed, so don't call Skip()
626 wxCoord
wxComboListBox::GetBestWidth() const
628 wxSize size
= wxListBox::GetBestSize();
632 wxSize
wxComboListBox::DoGetBestClientSize() const
634 // don't return size too big or we risk to not fit on the screen
635 wxSize size
= wxListBox::DoGetBestClientSize();
636 wxCoord hChar
= GetCharHeight();
638 int nLines
= size
.y
/ hChar
;
640 // 10 is the same limit as used by wxMSW
649 // ----------------------------------------------------------------------------
651 // ----------------------------------------------------------------------------
653 void wxComboBox::Init()
655 m_lbox
= (wxListBox
*)NULL
;
658 bool wxComboBox::Create(wxWindow
*parent
,
660 const wxString
& value
,
664 const wxString
*choices
,
666 const wxValidator
& validator
,
667 const wxString
& name
)
669 if ( !wxComboControl::Create(parent
, id
, value
, pos
, size
, style
,
675 wxComboListBox
*combolbox
=
676 new wxComboListBox(this, style
& wxCB_SORT
? wxLB_SORT
: 0);
678 m_lbox
->Set(n
, choices
);
680 SetPopupControl(combolbox
);
685 wxComboBox::~wxComboBox()
689 // ----------------------------------------------------------------------------
690 // wxComboBox methods forwarded to wxTextCtrl
691 // ----------------------------------------------------------------------------
693 wxString
wxComboBox::GetValue() const
695 return GetText()->GetValue();
698 void wxComboBox::SetValue(const wxString
& value
)
700 GetText()->SetValue(value
);
703 void wxComboBox::Copy()
708 void wxComboBox::Cut()
713 void wxComboBox::Paste()
718 void wxComboBox::SetInsertionPoint(long pos
)
720 GetText()->SetInsertionPoint(pos
);
723 void wxComboBox::SetInsertionPointEnd()
725 GetText()->SetInsertionPointEnd();
728 long wxComboBox::GetInsertionPoint() const
730 return GetText()->GetInsertionPoint();
733 long wxComboBox::GetLastPosition() const
735 return GetText()->GetLastPosition();
738 void wxComboBox::Replace(long from
, long to
, const wxString
& value
)
740 GetText()->Replace(from
, to
, value
);
743 void wxComboBox::Remove(long from
, long to
)
745 GetText()->Remove(from
, to
);
748 void wxComboBox::SetSelection(long from
, long to
)
750 GetText()->SetSelection(from
, to
);
753 void wxComboBox::SetEditable(bool editable
)
755 GetText()->SetEditable(editable
);
758 // ----------------------------------------------------------------------------
759 // wxComboBox methods forwarded to wxListBox
760 // ----------------------------------------------------------------------------
762 void wxComboBox::Clear()
765 GetText()->SetValue(wxEmptyString
);
768 void wxComboBox::Delete(int n
)
770 wxCHECK_RET( (n
>= 0) && (n
< GetCount()), _T("invalid index in wxComboBox::Delete") );
772 if (GetSelection() == n
)
773 GetText()->SetValue(wxEmptyString
);
775 GetLBox()->Delete(n
);
778 int wxComboBox::GetCount() const
780 return GetLBox()->GetCount();
783 wxString
wxComboBox::GetString(int n
) const
785 wxCHECK_MSG( (n
>= 0) && (n
< GetCount()), wxEmptyString
, _T("invalid index in wxComboBox::GetString") );
787 return GetLBox()->GetString(n
);
790 void wxComboBox::SetString(int n
, const wxString
& s
)
792 wxCHECK_RET( (n
>= 0) && (n
< GetCount()), _T("invalid index in wxComboBox::SetString") );
794 GetLBox()->SetString(n
, s
);
797 int wxComboBox::FindString(const wxString
& s
) const
799 return GetLBox()->FindString(s
);
802 void wxComboBox::Select(int n
)
804 wxCHECK_RET( (n
>= 0) && (n
< GetCount()), _T("invalid index in wxComboBox::Select") );
806 GetLBox()->SetSelection(n
);
807 GetText()->SetValue(GetLBox()->GetString(n
));
810 int wxComboBox::GetSelection() const
812 #if 1 // FIXME:: What is the correct behavior?
813 // if the current value isn't one of the listbox strings, return -1
814 return GetLBox()->GetSelection();
816 // Why oh why is this done this way?
817 // It is not because the value displayed in the text can be found
818 // in the list that it is the item that is selected!
819 return FindString(GetText()->GetValue());
823 int wxComboBox::DoAppend(const wxString
& item
)
825 return GetLBox()->Append(item
);
828 int wxComboBox::DoInsert(const wxString
& item
, int pos
)
830 wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT
), -1, wxT("can't insert into sorted list"));
831 wxCHECK_MSG((pos
>=0) && (pos
<=GetCount()), -1, wxT("invalid index"));
833 if (pos
== GetCount())
834 return DoAppend(item
);
836 GetLBox()->Insert(item
, pos
);
840 void wxComboBox::DoSetItemClientData(int n
, void* clientData
)
842 GetLBox()->SetClientData(n
, clientData
);
845 void *wxComboBox::DoGetItemClientData(int n
) const
847 return GetLBox()->GetClientData(n
);
850 void wxComboBox::DoSetItemClientObject(int n
, wxClientData
* clientData
)
852 GetLBox()->SetClientObject(n
, clientData
);
855 wxClientData
* wxComboBox::DoGetItemClientObject(int n
) const
857 return GetLBox()->GetClientObject(n
);
860 // ----------------------------------------------------------------------------
862 // ----------------------------------------------------------------------------
864 void wxComboControl::OnKey(wxKeyEvent
& event
)
866 if ( m_isPopupShown
)
868 // pass it to the popped up control
869 (void)m_popup
->GetControl()->ProcessEvent(event
);
877 bool wxComboControl::PerformAction(const wxControlAction
& action
,
879 const wxString
& strArg
)
881 bool processed
= FALSE
;
882 if ( action
== wxACTION_COMBOBOX_POPUP
)
884 if ( !m_isPopupShown
)
891 else if ( action
== wxACTION_COMBOBOX_DISMISS
)
893 if ( m_isPopupShown
)
904 return wxControl::PerformAction(action
, numArg
, strArg
);
910 // ----------------------------------------------------------------------------
911 // wxStdComboBoxInputHandler
912 // ----------------------------------------------------------------------------
914 wxStdComboBoxInputHandler::wxStdComboBoxInputHandler(wxInputHandler
*inphand
)
915 : wxStdInputHandler(inphand
)
919 bool wxStdComboBoxInputHandler::HandleKey(wxInputConsumer
*consumer
,
920 const wxKeyEvent
& event
,
925 wxControlAction action
;
926 switch ( event
.GetKeyCode() )
929 action
= wxACTION_COMBOBOX_POPUP
;
933 action
= wxACTION_COMBOBOX_DISMISS
;
939 consumer
->PerformAction(action
);
945 return wxStdInputHandler::HandleKey(consumer
, event
, pressed
);
948 #endif // wxUSE_COMBOBOX