1 /////////////////////////////////////////////////////////////////////////////
4 // Author: Robert Roebling
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
11 #pragma implementation "combobox.h"
14 // For compilers that support precompilation, includes "wx.h".
15 #include "wx/wxprec.h"
17 #include "wx/combobox.h"
21 #include "wx/settings.h"
24 #include "wx/textctrl.h" // for wxEVT_COMMAND_TEXT_UPDATED
26 #include "wx/gtk/private.h"
28 //-----------------------------------------------------------------------------
30 //-----------------------------------------------------------------------------
32 extern void wxapp_install_idle_handler();
35 //-----------------------------------------------------------------------------
37 //-----------------------------------------------------------------------------
39 extern bool g_blockEventsOnDrag;
41 //-----------------------------------------------------------------------------
42 // "select-child" - click/cursor get select-child, changed, select-child
43 //-----------------------------------------------------------------------------
46 gtk_combo_select_child_callback( GtkList *WXUNUSED(list), GtkWidget *WXUNUSED(widget), wxComboBox *combo )
48 if (g_isIdle) wxapp_install_idle_handler();
50 if (!combo->m_hasVMT) return;
52 if (g_blockEventsOnDrag) return;
54 int curSelection = combo->GetSelection();
56 if (combo->m_prevSelection != curSelection)
58 GtkWidget *list = GTK_COMBO(combo->m_widget)->list;
59 gtk_list_unselect_item( GTK_LIST(list), combo->m_prevSelection );
61 combo->m_prevSelection = curSelection;
63 wxCommandEvent event( wxEVT_COMMAND_COMBOBOX_SELECTED, combo->GetId() );
64 event.SetInt( curSelection );
65 event.SetString( combo->GetStringSelection() );
66 event.SetEventObject( combo );
68 combo->GetEventHandler()->ProcessEvent( event );
71 //-----------------------------------------------------------------------------
72 // "changed" - typing and list item matches get changed, select-child
73 // if it doesn't match an item then just get a single changed
74 //-----------------------------------------------------------------------------
77 gtk_text_changed_callback( GtkWidget *WXUNUSED(widget), wxComboBox *combo )
79 if (g_isIdle) wxapp_install_idle_handler();
81 if (!combo->m_hasVMT) return;
83 wxCommandEvent event( wxEVT_COMMAND_TEXT_UPDATED, combo->GetId() );
84 event.SetString( combo->GetValue() );
85 event.SetEventObject( combo );
86 combo->GetEventHandler()->ProcessEvent( event );
90 gtk_dummy_callback(GtkEntry *WXUNUSED(entry), GtkCombo *WXUNUSED(combo))
94 //-----------------------------------------------------------------------------
96 //-----------------------------------------------------------------------------
98 IMPLEMENT_DYNAMIC_CLASS(wxComboBox,wxControl)
100 BEGIN_EVENT_TABLE(wxComboBox, wxControl)
101 EVT_SIZE(wxComboBox::OnSize)
102 EVT_CHAR(wxComboBox::OnChar)
105 bool wxComboBox::Create( wxWindow *parent, wxWindowID id, const wxString& value,
106 const wxPoint& pos, const wxSize& size,
107 int n, const wxString choices[],
108 long style, const wxValidator& validator,
109 const wxString& name )
111 m_alreadySent = FALSE;
113 m_acceptsFocus = TRUE;
116 if (!PreCreation( parent, pos, size ) ||
117 !CreateBase( parent, id, pos, size, style, validator, name ))
119 wxFAIL_MSG( wxT("wxComboBox creation failed") );
123 m_widget = gtk_combo_new();
124 GtkCombo *combo = GTK_COMBO(m_widget);
126 // Disable GTK's broken events ...
127 gtk_signal_disconnect( GTK_OBJECT(combo->entry), combo->entry_change_id );
128 // ... and add surogate handler.
129 combo->entry_change_id = gtk_signal_connect (GTK_OBJECT (combo->entry), "changed",
130 (GtkSignalFunc) gtk_dummy_callback, combo);
132 // make it more useable
133 gtk_combo_set_use_arrows_always( GTK_COMBO(m_widget), TRUE );
135 // and case-sensitive
136 gtk_combo_set_case_sensitive( GTK_COMBO(m_widget), TRUE );
138 GtkWidget *list = GTK_COMBO(m_widget)->list;
141 // gtk_list_set_selection_mode( GTK_LIST(list), GTK_SELECTION_MULTIPLE );
144 for (int i = 0; i < n; i++)
146 GtkWidget *list_item = gtk_list_item_new_with_label( wxGTK_CONV( choices[i] ) );
148 m_clientDataList.Append( (wxObject*)NULL );
149 m_clientObjectList.Append( (wxObject*)NULL );
151 gtk_container_add( GTK_CONTAINER(list), list_item );
153 gtk_widget_show( list_item );
156 m_parent->DoAddChild( this );
158 m_focusWidget = combo->entry;
162 ConnectWidget( combo->button );
164 // MSW's combo box shows the value and the selection is -1
165 gtk_entry_set_text( GTK_ENTRY(combo->entry), wxGTK_CONV(value) );
166 gtk_list_unselect_all( GTK_LIST(combo->list) );
168 if (style & wxCB_READONLY)
169 gtk_entry_set_editable( GTK_ENTRY( combo->entry ), FALSE );
171 gtk_signal_connect( GTK_OBJECT(combo->entry), "changed",
172 GTK_SIGNAL_FUNC(gtk_text_changed_callback), (gpointer)this );
174 gtk_signal_connect( GTK_OBJECT(combo->list), "select-child",
175 GTK_SIGNAL_FUNC(gtk_combo_select_child_callback), (gpointer)this );
177 wxSize size_best( DoGetBestSize() );
178 wxSize new_size( size );
179 if (new_size.x == -1)
180 new_size.x = size_best.x;
181 if (new_size.y == -1)
182 new_size.y = size_best.y;
183 if (new_size.y > size_best.y)
184 new_size.y = size_best.y;
185 if ((new_size.x != size.x) || (new_size.y != size.y))
187 SetSize( new_size.x, new_size.y );
189 // This is required for tool bar support
190 gtk_widget_set_usize( m_widget, new_size.x, new_size.y );
193 SetBackgroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW ) );
194 SetForegroundColour( parent->GetForegroundColour() );
201 wxComboBox::~wxComboBox()
203 wxList::compatibility_iterator node = m_clientObjectList.GetFirst();
206 wxClientData *cd = (wxClientData*)node->GetData();
208 node = node->GetNext();
210 m_clientObjectList.Clear();
212 m_clientDataList.Clear();
215 void wxComboBox::SetFocus()
219 // don't do anything if we already have focus
223 gtk_widget_grab_focus( m_focusWidget );
226 int wxComboBox::AppendCommon( const wxString &item )
228 wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid combobox") );
232 GtkWidget *list = GTK_COMBO(m_widget)->list;
234 GtkWidget *list_item = gtk_list_item_new_with_label( wxGTK_CONV( item ) );
236 gtk_container_add( GTK_CONTAINER(list), list_item );
238 if (GTK_WIDGET_REALIZED(m_widget))
240 gtk_widget_realize( list_item );
241 gtk_widget_realize( GTK_BIN(list_item)->child );
243 if (m_widgetStyle) ApplyWidgetStyle();
246 gtk_widget_show( list_item );
250 return GetCount() - 1;
253 int wxComboBox::Append( const wxString &item )
255 m_clientDataList.Append( (wxObject*) NULL );
256 m_clientObjectList.Append( (wxObject*) NULL );
258 return AppendCommon( item );
261 int wxComboBox::Append( const wxString &item, void *clientData )
263 m_clientDataList.Append( (wxObject*) clientData );
264 m_clientObjectList.Append( (wxObject*)NULL );
266 return AppendCommon( item );
269 int wxComboBox::Append( const wxString &item, wxClientData *clientData )
271 m_clientDataList.Append( (wxObject*) NULL );
272 m_clientObjectList.Append( (wxObject*) clientData );
274 return AppendCommon( item );
277 int wxComboBox::InsertCommon( const wxString &item, int pos )
279 wxCHECK_MSG( !(GetWindowStyle() & wxCB_SORT), -1,
280 wxT("can't insert into sorted list"));
282 wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid combobox") );
284 int count = GetCount();
287 return AppendCommon(item);
292 GtkWidget *list = GTK_COMBO(m_widget)->list;
294 GtkWidget *list_item = gtk_list_item_new_with_label( wxGTK_CONV( item ) );
296 GList *gitem_list = g_list_alloc ();
297 gitem_list->data = list_item;
298 gtk_list_insert_items( GTK_LIST (list), gitem_list, pos );
300 if (GTK_WIDGET_REALIZED(m_widget))
302 gtk_widget_realize( list_item );
303 gtk_widget_realize( GTK_BIN(list_item)->child );
309 gtk_widget_show( list_item );
316 int wxComboBox::Insert( const wxString &item, int pos )
318 const int count = GetCount();
319 wxCHECK_MSG( (pos >= 0) && (pos <= count), -1, wxT("invalid index") );
326 m_clientDataList.Insert( pos, (wxObject*) NULL );
327 m_clientObjectList.Insert( pos, (wxObject*) NULL );
329 return InsertCommon( item, pos );
332 int wxComboBox::Insert( const wxString &item, int pos, void *clientData )
334 int count = GetCount();
335 wxCHECK_MSG( (pos >= 0) && (pos <= count), -1, wxT("invalid index") );
339 return Append(item, clientData);
342 m_clientDataList.Insert( pos, (wxObject*) clientData );
343 m_clientObjectList.Insert( pos, (wxObject*)NULL );
345 return InsertCommon( item, pos );
348 int wxComboBox::Insert( const wxString &item, int pos, wxClientData *clientData )
350 int count = GetCount();
351 wxCHECK_MSG( (pos >= 0) && (pos <= count), -1, wxT("invalid index") );
355 return Append(item, clientData);
358 m_clientDataList.Insert( pos, (wxObject*) NULL );
359 m_clientObjectList.Insert( pos, (wxObject*) clientData );
361 return InsertCommon( item, pos );
364 void wxComboBox::SetClientData( int n, void* clientData )
366 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
368 wxList::compatibility_iterator node = m_clientDataList.Item( n );
371 node->SetData( (wxObject*) clientData );
374 void* wxComboBox::GetClientData( int n ) const
376 wxCHECK_MSG( m_widget != NULL, NULL, wxT("invalid combobox") );
378 wxList::compatibility_iterator node = m_clientDataList.Item( n );
380 return node ? node->GetData() : NULL;
383 void wxComboBox::SetClientObject( int n, wxClientData* clientData )
385 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
387 wxList::compatibility_iterator node = m_clientObjectList.Item( n );
390 wxClientData *cd = (wxClientData*) node->GetData();
393 node->SetData( (wxObject*) clientData );
396 wxClientData* wxComboBox::GetClientObject( int n ) const
398 wxCHECK_MSG( m_widget != NULL, (wxClientData*)NULL, wxT("invalid combobox") );
400 wxList::compatibility_iterator node = m_clientObjectList.Item( n );
402 return node ? (wxClientData*) node->GetData() : NULL;
405 void wxComboBox::Clear()
407 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
411 GtkWidget *list = GTK_COMBO(m_widget)->list;
412 gtk_list_clear_items( GTK_LIST(list), 0, Number() );
414 wxList::compatibility_iterator node = m_clientObjectList.GetFirst();
417 wxClientData *cd = (wxClientData*)node->GetData();
419 node = node->GetNext();
421 m_clientObjectList.Clear();
423 m_clientDataList.Clear();
428 void wxComboBox::Delete( int n )
430 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
432 GtkList *listbox = GTK_LIST( GTK_COMBO(m_widget)->list );
434 GList *child = g_list_nth( listbox->children, n );
438 wxFAIL_MSG(wxT("wrong index"));
444 GList *list = g_list_append( (GList*) NULL, child->data );
445 gtk_list_remove_items( listbox, list );
448 wxList::compatibility_iterator node = m_clientObjectList.Item( n );
451 wxClientData *cd = (wxClientData*)node->GetData();
453 m_clientObjectList.Erase( node );
456 node = m_clientDataList.Item( n );
458 m_clientDataList.Erase( node );
463 void wxComboBox::SetString(int n, const wxString &text)
465 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
467 GtkWidget *list = GTK_COMBO(m_widget)->list;
469 GList *child = g_list_nth( GTK_LIST(list)->children, n );
472 GtkBin *bin = GTK_BIN( child->data );
473 GtkLabel *label = GTK_LABEL( bin->child );
474 gtk_label_set_text(label, wxGTK_CONV(text));
478 wxFAIL_MSG( wxT("wxComboBox: wrong index") );
482 int wxComboBox::FindString( const wxString &item )
484 wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid combobox") );
486 GtkWidget *list = GTK_COMBO(m_widget)->list;
488 GList *child = GTK_LIST(list)->children;
492 GtkBin *bin = GTK_BIN( child->data );
493 GtkLabel *label = GTK_LABEL( bin->child );
495 wxString str( wxGTK_CONV_BACK( gtk_label_get_text(label) ) );
497 wxString str( label->label );
509 int wxComboBox::GetSelection() const
511 wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid combobox") );
513 GtkWidget *list = GTK_COMBO(m_widget)->list;
515 GList *selection = GTK_LIST(list)->selection;
518 GList *child = GTK_LIST(list)->children;
522 if (child->data == selection->data) return count;
531 wxString wxComboBox::GetString( int n ) const
533 wxCHECK_MSG( m_widget != NULL, wxT(""), wxT("invalid combobox") );
535 GtkWidget *list = GTK_COMBO(m_widget)->list;
538 GList *child = g_list_nth( GTK_LIST(list)->children, n );
541 GtkBin *bin = GTK_BIN( child->data );
542 GtkLabel *label = GTK_LABEL( bin->child );
544 str = wxGTK_CONV_BACK( gtk_label_get_text(label) );
546 str = wxString( label->label );
551 wxFAIL_MSG( wxT("wxComboBox: wrong index") );
557 wxString wxComboBox::GetStringSelection() const
559 wxCHECK_MSG( m_widget != NULL, wxT(""), wxT("invalid combobox") );
561 GtkWidget *list = GTK_COMBO(m_widget)->list;
563 GList *selection = GTK_LIST(list)->selection;
566 GtkBin *bin = GTK_BIN( selection->data );
567 GtkLabel *label = GTK_LABEL( bin->child );
569 wxString tmp( wxGTK_CONV_BACK( gtk_label_get_text(label) ) );
571 wxString tmp( label->label );
576 wxFAIL_MSG( wxT("wxComboBox: no selection") );
581 int wxComboBox::Number() const
583 wxCHECK_MSG( m_widget != NULL, 0, wxT("invalid combobox") );
585 GtkWidget *list = GTK_COMBO(m_widget)->list;
587 GList *child = GTK_LIST(list)->children;
589 while (child) { count++; child = child->next; }
593 void wxComboBox::SetSelection( int n )
595 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
599 GtkWidget *list = GTK_COMBO(m_widget)->list;
600 gtk_list_unselect_item( GTK_LIST(list), m_prevSelection );
601 gtk_list_select_item( GTK_LIST(list), n );
607 void wxComboBox::SetStringSelection( const wxString &string )
609 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
611 int res = FindString( string );
612 if (res == -1) return;
616 wxString wxComboBox::GetValue() const
618 GtkEntry *entry = GTK_ENTRY( GTK_COMBO(m_widget)->entry );
619 wxString tmp( wxGTK_CONV_BACK( gtk_entry_get_text( entry ) ) );
622 for (int i = 0; i < wxStrlen(tmp.c_str()) +1; i++)
625 printf( "%d ", (int) (c) );
633 void wxComboBox::SetValue( const wxString& value )
635 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
637 GtkWidget *entry = GTK_COMBO(m_widget)->entry;
638 wxString tmp = wxT("");
639 if (!value.IsNull()) tmp = value;
640 gtk_entry_set_text( GTK_ENTRY(entry), wxGTK_CONV( tmp ) );
643 void wxComboBox::Copy()
645 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
647 GtkWidget *entry = GTK_COMBO(m_widget)->entry;
648 gtk_editable_copy_clipboard( GTK_EDITABLE(entry) DUMMY_CLIPBOARD_ARG );
651 void wxComboBox::Cut()
653 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
655 GtkWidget *entry = GTK_COMBO(m_widget)->entry;
656 gtk_editable_cut_clipboard( GTK_EDITABLE(entry) DUMMY_CLIPBOARD_ARG );
659 void wxComboBox::Paste()
661 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
663 GtkWidget *entry = GTK_COMBO(m_widget)->entry;
664 gtk_editable_paste_clipboard( GTK_EDITABLE(entry) DUMMY_CLIPBOARD_ARG);
667 void wxComboBox::SetInsertionPoint( long pos )
669 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
671 GtkWidget *entry = GTK_COMBO(m_widget)->entry;
672 gtk_entry_set_position( GTK_ENTRY(entry), (int)pos );
675 void wxComboBox::SetInsertionPointEnd()
677 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
679 SetInsertionPoint( -1 );
682 long wxComboBox::GetInsertionPoint() const
684 return (long) GET_EDITABLE_POS( GTK_COMBO(m_widget)->entry );
687 long wxComboBox::GetLastPosition() const
689 GtkWidget *entry = GTK_COMBO(m_widget)->entry;
690 int pos = GTK_ENTRY(entry)->text_length;
694 void wxComboBox::Replace( long from, long to, const wxString& value )
696 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
698 GtkWidget *entry = GTK_COMBO(m_widget)->entry;
699 gtk_editable_delete_text( GTK_EDITABLE(entry), (gint)from, (gint)to );
700 if (value.IsNull()) return;
704 wxCharBuffer buffer = wxConvUTF8.cWX2MB( value );
705 gtk_editable_insert_text( GTK_EDITABLE(entry), (const char*) buffer, strlen( (const char*) buffer ), &pos );
707 gtk_editable_insert_text( GTK_EDITABLE(entry), value.c_str(), value.Length(), &pos );
711 void wxComboBox::Remove(long from, long to)
713 wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
715 GtkWidget *entry = GTK_COMBO(m_widget)->entry;
716 gtk_editable_delete_text( GTK_EDITABLE(entry), (gint)from, (gint)to );
719 void wxComboBox::SetSelection( long from, long to )
721 GtkWidget *entry = GTK_COMBO(m_widget)->entry;
722 gtk_editable_select_region( GTK_EDITABLE(entry), (gint)from, (gint)to );
725 void wxComboBox::SetEditable( bool editable )
727 GtkWidget *entry = GTK_COMBO(m_widget)->entry;
728 gtk_entry_set_editable( GTK_ENTRY(entry), editable );
731 void wxComboBox::OnChar( wxKeyEvent &event )
733 if ( event.GetKeyCode() == WXK_RETURN )
735 // GTK automatically selects an item if its in the list
736 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, GetId());
737 event.SetString( GetValue() );
738 event.SetInt( GetSelection() );
739 event.SetEventObject( this );
741 if (!GetEventHandler()->ProcessEvent( event ))
743 // This will invoke the dialog default action, such
744 // as the clicking the default button.
746 wxWindow *top_frame = m_parent;
747 while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
748 top_frame = top_frame->GetParent();
750 if (top_frame && GTK_IS_WINDOW(top_frame->m_widget))
752 GtkWindow *window = GTK_WINDOW(top_frame->m_widget);
754 if (window->default_widget)
755 gtk_widget_activate (window->default_widget);
759 // Catch GTK event so that GTK doesn't open the drop
760 // down list upon RETURN.
767 void wxComboBox::DisableEvents()
769 gtk_signal_disconnect_by_func( GTK_OBJECT(GTK_COMBO(m_widget)->list),
770 GTK_SIGNAL_FUNC(gtk_combo_select_child_callback), (gpointer)this );
771 gtk_signal_disconnect_by_func( GTK_OBJECT(GTK_COMBO(m_widget)->entry),
772 GTK_SIGNAL_FUNC(gtk_text_changed_callback), (gpointer)this );
775 void wxComboBox::EnableEvents()
777 gtk_signal_connect( GTK_OBJECT(GTK_COMBO(m_widget)->list), "select-child",
778 GTK_SIGNAL_FUNC(gtk_combo_select_child_callback), (gpointer)this );
779 gtk_signal_connect( GTK_OBJECT(GTK_COMBO(m_widget)->entry), "changed",
780 GTK_SIGNAL_FUNC(gtk_text_changed_callback), (gpointer)this );
783 void wxComboBox::OnSize( wxSizeEvent &event )
789 gtk_widget_set_usize( GTK_COMBO(m_widget)->entry, m_width-w-1, m_height );
791 gtk_widget_set_uposition( GTK_COMBO(m_widget)->button, m_x+m_width-w, m_y );
792 gtk_widget_set_usize( GTK_COMBO(m_widget)->button, w, m_height );
796 void wxComboBox::ApplyWidgetStyle()
800 // gtk_widget_set_style( GTK_COMBO(m_widget)->button, m_widgetStyle );
801 gtk_widget_set_style( GTK_COMBO(m_widget)->entry, m_widgetStyle );
802 gtk_widget_set_style( GTK_COMBO(m_widget)->list, m_widgetStyle );
804 GtkList *list = GTK_LIST( GTK_COMBO(m_widget)->list );
805 GList *child = list->children;
808 gtk_widget_set_style( GTK_WIDGET(child->data), m_widgetStyle );
810 GtkBin *bin = GTK_BIN(child->data);
811 gtk_widget_set_style( bin->child, m_widgetStyle );
817 GtkWidget* wxComboBox::GetConnectWidget()
819 return GTK_COMBO(m_widget)->entry;
822 bool wxComboBox::IsOwnGtkWindow( GdkWindow *window )
824 return ( (window == GTK_ENTRY( GTK_COMBO(m_widget)->entry )->text_area) ||
825 (window == GTK_COMBO(m_widget)->button->window ) );
828 wxSize wxComboBox::DoGetBestSize() const
830 wxSize ret( wxControl::DoGetBestSize() );
832 // we know better our horizontal extent: it depends on the longest string
838 size_t count = GetCount();
839 for ( size_t n = 0; n < count; n++ )
841 GetTextExtent( GetString(n), &width, NULL, NULL, NULL, &m_font );
847 // empty combobox should have some reasonable default size too