X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9ff9d30c0aab3b281ef9b380eac17435556c5088..c9ed413ab4f5673ffff00198dc6ce1397398bda4:/src/gtk/listbox.cpp?ds=sidebyside diff --git a/src/gtk/listbox.cpp b/src/gtk/listbox.cpp index d453bf384a..9a406184bd 100644 --- a/src/gtk/listbox.cpp +++ b/src/gtk/listbox.cpp @@ -26,6 +26,7 @@ #endif #include "wx/gtk/private.h" +#include "wx/gtk/private/object.h" #include "wx/gtk/treeentry_gtk.h" #if wxUSE_TOOLTIPS @@ -56,6 +57,31 @@ extern bool g_blockEventsOnScroll; #define WXLISTBOX_DATACOLUMN WXLISTBOX_DATACOLUMN_ARG(this) +// ---------------------------------------------------------------------------- +// helper functions +// ---------------------------------------------------------------------------- + +namespace +{ + +// Return the entry for the given listbox item. +// +// Return value must be released by caller if non-NULL. +GtkTreeEntry * +GetEntry(GtkListStore *store, GtkTreeIter *iter, const wxListBox *listbox) +{ + GtkTreeEntry* entry; + gtk_tree_model_get(GTK_TREE_MODEL(store), + iter, + WXLISTBOX_DATACOLUMN_ARG(listbox), + &entry, + -1); + + return entry; +} + +} // anonymous namespace + //----------------------------------------------------------------------------- // "row-activated" //----------------------------------------------------------------------------- @@ -74,37 +100,7 @@ gtk_listbox_row_activated_callback(GtkTreeView * WXUNUSED(treeview), int sel = gtk_tree_path_get_indices(path)[0]; - wxCommandEvent event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, listbox->GetId() ); - event.SetEventObject( listbox ); - - if (listbox->IsSelected(sel)) - { - GtkTreeEntry* entry = listbox->GtkGetEntry(sel); - - if (entry) - { - event.SetInt(sel); - event.SetString(wxConvUTF8.cMB2WX(gtk_tree_entry_get_label(entry))); - - if ( listbox->HasClientObjectData() ) - event.SetClientObject( (wxClientData*) gtk_tree_entry_get_userdata(entry) ); - else if ( listbox->HasClientUntypedData() ) - event.SetClientData( gtk_tree_entry_get_userdata(entry) ); - - g_object_unref (entry); - } - else - { - wxLogSysError(wxT("Internal error - could not get entry for double-click")); - event.SetInt(-1); - } - } - else - { - event.SetInt(-1); - } - - listbox->HandleWindowEvent( event ); + listbox->GTKOnActivated(sel); } } @@ -119,49 +115,9 @@ gtk_listitem_changed_callback(GtkTreeSelection * WXUNUSED(selection), { if (g_blockEventsOnDrag) return; - if (listbox->HasFlag(wxLB_MULTIPLE | wxLB_EXTENDED)) - { - listbox->CalcAndSendEvent(); - } - else // single selection - { - wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, listbox->GetId() ); - event.SetEventObject( listbox ); - - int index = listbox->GetSelection(); - if (index == wxNOT_FOUND) - { - // indicate that this is a deselection - event.SetExtraLong( 0 ); - event.SetInt( -1 ); - - listbox->HandleWindowEvent( event ); - - return; - } - else - { - GtkTreeEntry* entry = listbox->GtkGetEntry( index ); - - // indicate that this is a selection - event.SetExtraLong( 1 ); - - event.SetInt( index ); - event.SetString(wxConvUTF8.cMB2WX(gtk_tree_entry_get_label(entry))); - - if ( listbox->HasClientObjectData() ) - event.SetClientObject( - (wxClientData*) gtk_tree_entry_get_userdata(entry) - ); - else if ( listbox->HasClientUntypedData() ) - event.SetClientData( gtk_tree_entry_get_userdata(entry) ); - - listbox->HandleWindowEvent( event ); - - g_object_unref (entry); - } - } + listbox->GTKOnSelectionChanged(); } + } //----------------------------------------------------------------------------- @@ -174,7 +130,7 @@ gtk_listbox_key_press_callback( GtkWidget *WXUNUSED(widget), GdkEventKey *gdk_event, wxListBox *listbox ) { - if ((gdk_event->keyval == GDK_Return) || + if ((gdk_event->keyval == GDK_Return) || (gdk_event->keyval == GDK_ISO_Enter) || (gdk_event->keyval == GDK_KP_Enter)) { @@ -188,31 +144,11 @@ gtk_listbox_key_press_callback( GtkWidget *WXUNUSED(widget), return FALSE; index = sels[0]; } - + if (index != wxNOT_FOUND) { - wxCommandEvent event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, listbox->GetId() ); - event.SetEventObject( listbox ); - - GtkTreeEntry* entry = listbox->GtkGetEntry( index ); - - // indicate that this is a selection - event.SetExtraLong( 1 ); + listbox->GTKOnActivated(index); - event.SetInt( index ); - event.SetString(wxConvUTF8.cMB2WX(gtk_tree_entry_get_label(entry))); - - if ( listbox->HasClientObjectData() ) - event.SetClientObject( - (wxClientData*) gtk_tree_entry_get_userdata(entry) - ); - else if ( listbox->HasClientUntypedData() ) - event.SetClientData( gtk_tree_entry_get_userdata(entry) ); - - /* bool ret = */ listbox->HandleWindowEvent( event ); - - g_object_unref (entry); - // wxMac and wxMSW always invoke default action // if (!ret) { @@ -225,13 +161,13 @@ gtk_listbox_key_press_callback( GtkWidget *WXUNUSED(widget), gtk_window_activate_default( gtk_window ); } } - + // Always intercept, otherwise we'd get another dclick // event from row_activated return TRUE; } } - + return FALSE; } } @@ -263,29 +199,16 @@ static gint gtk_listbox_sort_callback(GtkTreeModel * WXUNUSED(model), GtkTreeIter *b, wxListBox *listbox) { - GtkTreeEntry* entry; - GtkTreeEntry* entry2; - - gtk_tree_model_get(GTK_TREE_MODEL(listbox->m_liststore), - a, - WXLISTBOX_DATACOLUMN_ARG(listbox), - &entry, -1); - gtk_tree_model_get(GTK_TREE_MODEL(listbox->m_liststore), - b, - WXLISTBOX_DATACOLUMN_ARG(listbox), - &entry2, -1); - wxCHECK_MSG(entry, 0, wxT("Could not get entry")); - wxCHECK_MSG(entry2, 0, wxT("Could not get entry2")); + wxGtkObject entry1(GetEntry(listbox->m_liststore, a, listbox)); + wxCHECK_MSG(entry1, 0, wxT("Could not get first entry")); + + wxGtkObject entry2(GetEntry(listbox->m_liststore, b, listbox)); + wxCHECK_MSG(entry2, 0, wxT("Could not get second entry")); //We compare collate keys here instead of calling g_utf8_collate //as it is rather slow (and even the docs reccommend this) - int ret = strcmp(gtk_tree_entry_get_collate_key(entry), - gtk_tree_entry_get_collate_key(entry2)); - - g_object_unref (entry); - g_object_unref (entry2); - - return ret; + return strcmp(gtk_tree_entry_get_collate_key(entry1), + gtk_tree_entry_get_collate_key(entry2)) >= 0; } } @@ -300,21 +223,13 @@ static gboolean gtk_listbox_searchequal_callback(GtkTreeModel * WXUNUSED(model), GtkTreeIter* iter, wxListBox* listbox) { - GtkTreeEntry* entry; - - gtk_tree_model_get(GTK_TREE_MODEL(listbox->m_liststore), - iter, - WXLISTBOX_DATACOLUMN_ARG(listbox), - &entry, -1); + wxGtkObject + entry(GetEntry(listbox->m_liststore, iter, listbox)); wxCHECK_MSG(entry, 0, wxT("Could not get entry")); - wxGtkString keycollatekey(g_utf8_collate_key(key, -1)); - - int ret = strcmp(keycollatekey, - gtk_tree_entry_get_collate_key(entry)); - g_object_unref (entry); + wxGtkString keycollatekey(g_utf8_collate_key(key, -1)); - return ret != 0; + return strcmp(keycollatekey, gtk_tree_entry_get_collate_key(entry)) != 0; } } @@ -322,15 +237,13 @@ static gboolean gtk_listbox_searchequal_callback(GtkTreeModel * WXUNUSED(model), // wxListBox //----------------------------------------------------------------------------- -IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControlWithItems) - // ---------------------------------------------------------------------------- // construction // ---------------------------------------------------------------------------- void wxListBox::Init() { - m_treeview = (GtkTreeView*) NULL; + m_treeview = NULL; #if wxUSE_CHECKLISTBOX m_hasCheckBoxes = false; #endif // wxUSE_CHECKLISTBOX @@ -361,7 +274,7 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id, return false; } - m_widget = gtk_scrolled_window_new( (GtkAdjustment*) NULL, (GtkAdjustment*) NULL ); + m_widget = gtk_scrolled_window_new( NULL, NULL ); g_object_ref(m_widget); if (style & wxLB_ALWAYS_SB) { @@ -375,7 +288,7 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id, } - GtkScrolledWindowSetBorder(m_widget, style); + GTKScrolledWindowSetBorder(m_widget, style); m_treeview = GTK_TREE_VIEW( gtk_tree_view_new( ) ); @@ -430,7 +343,12 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id, else // no multi-selection flags specified { m_windowStyle |= wxLB_SINGLE; - mode = GTK_SELECTION_SINGLE; + + // Notice that we must use BROWSE and not GTK_SELECTION_SINGLE because + // the latter allows to not select any items at all while a single + // selection listbox is supposed to always have a selection (at least + // once the user selected something, it might not have any initially). + mode = GTK_SELECTION_BROWSE; } GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview ); @@ -476,7 +394,7 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id, g_signal_connect_after (selection, "changed", G_CALLBACK (gtk_listitem_changed_callback), this); - + return true; } @@ -487,7 +405,7 @@ wxListBox::~wxListBox() Clear(); } -void wxListBox::GtkDisableEvents() +void wxListBox::GTKDisableEvents() { GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview ); @@ -495,13 +413,13 @@ void wxListBox::GtkDisableEvents() (gpointer) gtk_listitem_changed_callback, this); } -void wxListBox::GtkEnableEvents() +void wxListBox::GTKEnableEvents() { GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview ); g_signal_handlers_unblock_by_func(selection, (gpointer) gtk_listitem_changed_callback, this); - + UpdateOldSelections(); } @@ -509,7 +427,7 @@ void wxListBox::GtkEnableEvents() void wxListBox::Update() { wxWindow::Update(); - + if (m_treeview) gdk_window_process_updates(GTK_WIDGET(m_treeview)->window, TRUE); } @@ -531,7 +449,7 @@ int wxListBox::DoInsertItems(const wxArrayStringsAdapter& items, GtkTreeIter iter; if ( pos != GetCount() ) { - wxCHECK_MSG( GtkGetIteratorFor(pos, &iter), wxNOT_FOUND, + wxCHECK_MSG( GTKGetIteratorFor(pos, &iter), wxNOT_FOUND, wxT("internal wxListBox error in insertion") ); pIter = &iter; @@ -540,7 +458,7 @@ int wxListBox::DoInsertItems(const wxArrayStringsAdapter& items, const unsigned int numItems = items.GetCount(); for ( unsigned int i = 0; i < numItems; ++i ) { - GtkTreeEntry* entry = gtk_tree_entry_new(); + wxGtkObject entry(gtk_tree_entry_new()); gtk_tree_entry_set_label(entry, wxGTK_CONV(items[i])); gtk_tree_entry_set_destroy_func(entry, (GtkTreeEntryDestroy)gtk_tree_entry_destroy_cb, @@ -549,12 +467,10 @@ int wxListBox::DoInsertItems(const wxArrayStringsAdapter& items, GtkTreeIter itercur; gtk_list_store_insert_before(m_liststore, &itercur, pIter); - GtkSetItem(itercur, entry); - - g_object_unref (entry); + GTKSetItem(itercur, entry); if (clientData) - AssignNewItemClientData(GtkGetIndexFor(itercur), clientData, i, type); + AssignNewItemClientData(GTKGetIndexFor(itercur), clientData, i, type); } UpdateOldSelections(); @@ -570,13 +486,13 @@ void wxListBox::DoClear() { wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") ); - GtkDisableEvents(); // just in case + GTKDisableEvents(); // just in case InvalidateBestSize(); gtk_list_store_clear( m_liststore ); /* well, THAT was easy :) */ - - GtkEnableEvents(); + + GTKEnableEvents(); } void wxListBox::DoDeleteOneItem(unsigned int n) @@ -585,23 +501,23 @@ void wxListBox::DoDeleteOneItem(unsigned int n) InvalidateBestSize(); - GtkDisableEvents(); // just in case + GTKDisableEvents(); // just in case GtkTreeIter iter; - wxCHECK_RET( GtkGetIteratorFor(n, &iter), wxT("wrong listbox index") ); + wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("wrong listbox index") ); // this returns false if iter is invalid (e.g. deleting item at end) but // since we don't use iter, we ignore the return value gtk_list_store_remove(m_liststore, &iter); - - GtkEnableEvents(); + + GTKEnableEvents(); } // ---------------------------------------------------------------------------- // helper functions for working with iterators // ---------------------------------------------------------------------------- -bool wxListBox::GtkGetIteratorFor(unsigned pos, GtkTreeIter *iter) const +bool wxListBox::GTKGetIteratorFor(unsigned pos, GtkTreeIter *iter) const { if ( !gtk_tree_model_iter_nth_child(GTK_TREE_MODEL(m_liststore), iter, NULL, pos) ) @@ -613,14 +529,14 @@ bool wxListBox::GtkGetIteratorFor(unsigned pos, GtkTreeIter *iter) const return true; } -int wxListBox::GtkGetIndexFor(GtkTreeIter& iter) const +int wxListBox::GTKGetIndexFor(GtkTreeIter& iter) const { GtkTreePath *path = gtk_tree_model_get_path(GTK_TREE_MODEL(m_liststore), &iter); gint* pIntPath = gtk_tree_path_get_indices(path); - wxCHECK_MSG( pIntPath, wxNOT_FOUND, _T("failed to get iterator path") ); + wxCHECK_MSG( pIntPath, wxNOT_FOUND, wxT("failed to get iterator path") ); int idx = pIntPath[0]; @@ -630,21 +546,16 @@ int wxListBox::GtkGetIndexFor(GtkTreeIter& iter) const } // get GtkTreeEntry from position (note: you need to g_unref it if valid) -GtkTreeEntry *wxListBox::GtkGetEntry(unsigned n) const +GtkTreeEntry *wxListBox::GTKGetEntry(unsigned n) const { GtkTreeIter iter; - if ( !GtkGetIteratorFor(n, &iter) ) + if ( !GTKGetIteratorFor(n, &iter) ) return NULL; - - GtkTreeEntry* entry = NULL; - gtk_tree_model_get(GTK_TREE_MODEL(m_liststore), &iter, - WXLISTBOX_DATACOLUMN, &entry, -1); - - return entry; + return GetEntry(m_liststore, &iter, this); } -void wxListBox::GtkSetItem(GtkTreeIter& iter, const GtkTreeEntry *entry) +void wxListBox::GTKSetItem(GtkTreeIter& iter, const GtkTreeEntry *entry) { #if wxUSE_CHECKLISTBOX if ( m_hasCheckBoxes ) @@ -667,27 +578,18 @@ void wxListBox::GtkSetItem(GtkTreeIter& iter, const GtkTreeEntry *entry) void* wxListBox::DoGetItemClientData(unsigned int n) const { - wxCHECK_MSG( IsValid(n), NULL, - wxT("Invalid index passed to GetItemClientData") ); - - GtkTreeEntry* entry = GtkGetEntry(n); + wxGtkObject entry(GTKGetEntry(n)); wxCHECK_MSG(entry, NULL, wxT("could not get entry")); - void* userdata = gtk_tree_entry_get_userdata( entry ); - g_object_unref (entry); - return userdata; + return gtk_tree_entry_get_userdata( entry ); } void wxListBox::DoSetItemClientData(unsigned int n, void* clientData) { - wxCHECK_RET( IsValid(n), - wxT("Invalid index passed to SetItemClientData") ); - - GtkTreeEntry* entry = GtkGetEntry(n); + wxGtkObject entry(GTKGetEntry(n)); wxCHECK_RET(entry, wxT("could not get entry")); gtk_tree_entry_set_userdata( entry, clientData ); - g_object_unref (entry); } // ---------------------------------------------------------------------------- @@ -699,7 +601,7 @@ void wxListBox::SetString(unsigned int n, const wxString& label) wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetString") ); wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") ); - GtkTreeEntry* entry = GtkGetEntry(n); + GtkTreeEntry* entry = GTKGetEntry(n); wxCHECK_RET( entry, wxT("wrong listbox index") ); // update the item itself @@ -707,24 +609,21 @@ void wxListBox::SetString(unsigned int n, const wxString& label) // and update the model which will refresh the tree too GtkTreeIter iter; - wxCHECK_RET( GtkGetIteratorFor(n, &iter), _T("failed to get iterator") ); + wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("failed to get iterator") ); // FIXME: this resets the checked status of a wxCheckListBox item - GtkSetItem(iter, entry); + GTKSetItem(iter, entry); } wxString wxListBox::GetString(unsigned int n) const { wxCHECK_MSG( m_treeview != NULL, wxEmptyString, wxT("invalid listbox") ); - GtkTreeEntry* entry = GtkGetEntry(n); + wxGtkObject entry(GTKGetEntry(n)); wxCHECK_MSG( entry, wxEmptyString, wxT("wrong listbox index") ); - wxString label = wxGTK_CONV_BACK( gtk_tree_entry_get_label(entry) ); - - g_object_unref (entry); - return label; + return wxGTK_CONV_BACK( gtk_tree_entry_get_label(entry) ); } unsigned int wxListBox::GetCount() const @@ -756,6 +655,25 @@ int wxListBox::FindString( const wxString &item, bool bCase ) const // selection // ---------------------------------------------------------------------------- +void wxListBox::GTKOnActivated(int item) +{ + SendEvent(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, item, IsSelected(item)); +} + +void wxListBox::GTKOnSelectionChanged() +{ + if ( HasFlag(wxLB_MULTIPLE | wxLB_EXTENDED) ) + { + CalcAndSendEvent(); + } + else // single selection + { + const int item = GetSelection(); + if ( DoChangeSingleSelection(item) ) + SendEvent(wxEVT_COMMAND_LISTBOX_SELECTED, item, true); + } +} + int wxListBox::GetSelection() const { wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox")); @@ -769,7 +687,7 @@ int wxListBox::GetSelection() const if (!gtk_tree_selection_get_selected(selection, NULL, &iter)) return wxNOT_FOUND; - return GtkGetIndexFor(iter); + return GTKGetIndexFor(iter); } int wxListBox::GetSelections( wxArrayInt& aSelections ) const @@ -803,7 +721,7 @@ bool wxListBox::IsSelected( int n ) const GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview); GtkTreeIter iter; - wxCHECK_MSG( GtkGetIteratorFor(n, &iter), false, wxT("Invalid index") ); + wxCHECK_MSG( GTKGetIteratorFor(n, &iter), false, wxT("Invalid index") ); return gtk_tree_selection_iter_is_selected(selection, &iter); } @@ -812,23 +730,23 @@ void wxListBox::DoSetSelection( int n, bool select ) { wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") ); - GtkDisableEvents(); - + GTKDisableEvents(); + GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview); // passing -1 to SetSelection() is documented to deselect all items if ( n == wxNOT_FOUND ) { gtk_tree_selection_unselect_all(selection); - GtkEnableEvents(); + GTKEnableEvents(); return; } wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetSelection") ); - + GtkTreeIter iter; - wxCHECK_RET( GtkGetIteratorFor(n, &iter), wxT("Invalid index") ); + wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("Invalid index") ); if (select) gtk_tree_selection_select_iter(selection, &iter); @@ -842,7 +760,7 @@ void wxListBox::DoSetSelection( int n, bool select ) gtk_tree_path_free(path); - GtkEnableEvents(); + GTKEnableEvents(); } void wxListBox::DoScrollToCell(int n, float alignY, float alignX) @@ -855,7 +773,7 @@ void wxListBox::DoScrollToCell(int n, float alignY, float alignX) return; GtkTreeIter iter; - if ( !GtkGetIteratorFor(n, &iter) ) + if ( !GTKGetIteratorFor(n, &iter) ) return; GtkTreePath* path = gtk_tree_model_get_path( @@ -920,10 +838,19 @@ int wxListBox::DoListHitTest(const wxPoint& point) const // ---------------------------------------------------------------------------- #if wxUSE_TOOLTIPS -void wxListBox::ApplyToolTip( GtkTooltips *tips, const gchar *tip ) +void wxListBox::GTKApplyToolTip( GtkTooltips *tips, const gchar *tip ) { - // RN: Is this needed anymore? - gtk_tooltips_set_tip( tips, GTK_WIDGET( m_treeview ), tip, (gchar*) NULL ); +#if GTK_CHECK_VERSION(2, 12, 0) + if (!gtk_check_version(2, 12, 0)) + { + gtk_widget_set_tooltip_text(GTK_WIDGET( m_treeview ), tip); + } + else +#endif + { + // RN: Is this needed anymore? + gtk_tooltips_set_tip( tips, GTK_WIDGET( m_treeview ), tip, NULL ); + } } #endif // wxUSE_TOOLTIPS