X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6493aacaeb7b22b9fa35c559f7753e9fec0da71f..abd474ea63667f727940a009cc3e0b23ba9f418f:/src/gtk/listbox.cpp diff --git a/src/gtk/listbox.cpp b/src/gtk/listbox.cpp index fbe7e88e41..d76523b681 100644 --- a/src/gtk/listbox.cpp +++ b/src/gtk/listbox.cpp @@ -14,23 +14,31 @@ #if wxUSE_LISTBOX #include "wx/listbox.h" -#include "wx/dynarray.h" -#include "wx/arrstr.h" -#include "wx/utils.h" -#include "wx/intl.h" -#include "wx/checklst.h" -#include "wx/settings.h" -#include "wx/log.h" + +#ifndef WX_PRECOMP + #include "wx/dynarray.h" + #include "wx/intl.h" + #include "wx/log.h" + #include "wx/utils.h" + #include "wx/settings.h" + #include "wx/checklst.h" + #include "wx/arrstr.h" +#endif + #include "wx/gtk/private.h" +#include "wx/gtk/private/object.h" #include "wx/gtk/treeentry_gtk.h" #if wxUSE_TOOLTIPS -#include "wx/tooltip.h" + #include "wx/tooltip.h" #endif -#include #include + #include +#if GTK_CHECK_VERSION(3,0,0) +#include +#endif //----------------------------------------------------------------------------- // data @@ -38,7 +46,6 @@ extern bool g_blockEventsOnDrag; extern bool g_blockEventsOnScroll; -extern wxCursor g_globalCursor; @@ -46,148 +53,75 @@ extern wxCursor g_globalCursor; // Macro to tell which row the strings are in (1 if native checklist, 0 if not) //----------------------------------------------------------------------------- -#if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST +#if wxUSE_CHECKLISTBOX # define WXLISTBOX_DATACOLUMN_ARG(x) (x->m_hasCheckBoxes ? 1 : 0) #else # define WXLISTBOX_DATACOLUMN_ARG(x) (0) -#endif // wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST +#endif // wxUSE_CHECKLISTBOX #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" //----------------------------------------------------------------------------- extern "C" { static void -gtk_listbox_row_activated_callback(GtkTreeView *treeview, +gtk_listbox_row_activated_callback(GtkTreeView * WXUNUSED(treeview), GtkTreePath *path, - GtkTreeViewColumn *col, + GtkTreeViewColumn * WXUNUSED(col), wxListBox *listbox) { - if (g_isIdle) wxapp_install_idle_handler(); - if (g_blockEventsOnDrag) return; if (g_blockEventsOnScroll) return; - if (!listbox->m_hasVMT) return; - - //Notes: - //1) This is triggered by either a double-click or a space press - //2) We handle both here because - //2a) in the case of a space/keypress we can't really know - // which item was pressed on because we can't get coords - // from a keyevent - //2b) It seems more correct + // This is triggered by either a double-click or a space press int sel = gtk_tree_path_get_indices(path)[0]; - if(!listbox->m_spacePressed) - { - //Assume it was double-click - 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(G_OBJECT(entry)); - } - else - { - wxLogSysError(wxT("Internal error - could not get entry for double-click")); - event.SetInt(-1); - } - } - else - event.SetInt(-1); - - listbox->GetEventHandler()->ProcessEvent( event ); - } - else - { - listbox->m_spacePressed = false; //don't block selection behaviour anymore - - //Space was pressed - toggle the appropriate checkbox and the selection -#if wxUSE_CHECKLISTBOX //Do it for both native and non-native - if (listbox->m_hasCheckBoxes) - { - wxCheckListBox *clb = (wxCheckListBox *)listbox; - - clb->Check( sel, !clb->IsChecked(sel) ); - - wxCommandEvent new_event( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, listbox->GetId() ); - new_event.SetEventObject( listbox ); - new_event.SetInt( sel ); - listbox->GetEventHandler()->ProcessEvent( new_event ); - } -#endif // wxUSE_CHECKLISTBOX - - if( (((listbox->GetWindowStyleFlag() & wxLB_MULTIPLE) != 0) || - ((listbox->GetWindowStyleFlag() & wxLB_EXTENDED) != 0)) ) - { - //toggle the selection + send event - listbox->GtkSetSelection(sel, !listbox->IsSelected( sel ), false); - } - } + listbox->GTKOnActivated(sel); } } //----------------------------------------------------------------------------- -// "button_press_event" +// "changed" //----------------------------------------------------------------------------- extern "C" { -static gint -gtk_listbox_button_press_callback( GtkWidget *widget, - GdkEventButton *gdk_event, - wxListBox *listbox ) +static void +gtk_listitem_changed_callback(GtkTreeSelection * WXUNUSED(selection), + wxListBox *listbox ) { - if (g_isIdle) wxapp_install_idle_handler(); - - if (g_blockEventsOnDrag) return FALSE; - if (g_blockEventsOnScroll) return FALSE; - - if (!listbox->m_hasVMT) return FALSE; - - //Just to be on the safe side - it should be unset in the activate callback - //but we don't want any obscure bugs if it doesn't get called somehow... - listbox->m_spacePressed = false; - -#if wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST - if ((listbox->m_hasCheckBoxes) && (gdk_event->x < 15) && (gdk_event->type != GDK_2BUTTON_PRESS)) - { - GtkTreePath* path; - gtk_tree_view_get_path_at_pos(GTK_TREE_VIEW(widget), - (gint)gdk_event->x, (gint)gdk_event->y, - &path, NULL, NULL, NULL); - int sel = gtk_tree_path_get_indices(path)[0]; - gtk_tree_path_free(path); - - wxCheckListBox *clb = (wxCheckListBox *)listbox; - - clb->Check( sel, !clb->IsChecked(sel) ); - - wxCommandEvent event( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, listbox->GetId() ); - event.SetEventObject( listbox ); - event.SetInt( sel ); - listbox->GetEventHandler()->ProcessEvent( event ); - } -#endif // wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST + if (g_blockEventsOnDrag) return; - return FALSE; + listbox->GTKOnSelectionChanged(); } + } //----------------------------------------------------------------------------- @@ -195,132 +129,50 @@ gtk_listbox_button_press_callback( GtkWidget *widget, //----------------------------------------------------------------------------- extern "C" { -static gint -gtk_listbox_key_press_callback( GtkWidget *widget, +static gboolean +gtk_listbox_key_press_callback( GtkWidget *WXUNUSED(widget), GdkEventKey *gdk_event, wxListBox *listbox ) { - if (g_isIdle) wxapp_install_idle_handler(); - - if (g_blockEventsOnDrag) return FALSE; - - - bool ret = false; - - if ((gdk_event->keyval == GDK_Tab) || (gdk_event->keyval == GDK_ISO_Left_Tab)) - { - wxNavigationKeyEvent new_event; - /* GDK reports GDK_ISO_Left_Tab for SHIFT-TAB */ - new_event.SetDirection( (gdk_event->keyval == GDK_Tab) ); - /* CTRL-TAB changes the (parent) window, i.e. switch notebook page */ - new_event.SetWindowChange( (gdk_event->state & GDK_CONTROL_MASK) ); - new_event.SetCurrentFocus( listbox ); - ret = listbox->GetEventHandler()->ProcessEvent( new_event ); - } - - if ((gdk_event->keyval == GDK_Return) && (!ret)) + if ((gdk_event->keyval == GDK_Return) || + (gdk_event->keyval == GDK_ISO_Enter) || + (gdk_event->keyval == GDK_KP_Enter)) { - // eat return in all modes (RN:WHY?) - ret = true; - } - - // Check or uncheck item with SPACE - if (gdk_event->keyval == ' ') + int index = -1; + if (!listbox->HasMultipleSelection()) + index = listbox->GetSelection(); + else { - //In the keyevent we don't know the index of the item - //and the activated event gets called anyway... - // - //Also, activating with the space causes the treeview to - //unselect all the items and then select the item in question - //wx's behaviour is to just toggle the item's selection state - //and leave the others alone - listbox->m_spacePressed = true; - } - - if (ret) - { - g_signal_stop_emission_by_name (widget, "key_press_event"); - return TRUE; - } - - return FALSE; -} -} - -//----------------------------------------------------------------------------- -// "select" and "deselect" -//----------------------------------------------------------------------------- - -extern "C" { -static gboolean gtk_listitem_select_cb( GtkTreeSelection* selection, - GtkTreeModel* model, - GtkTreePath* path, - gboolean is_selected, - wxListBox *listbox ) -{ - if (g_isIdle) wxapp_install_idle_handler(); - - if (!listbox->m_hasVMT) return TRUE; - if (g_blockEventsOnDrag) return TRUE; - - if (listbox->m_spacePressed) return FALSE; //see keyevent callback - if (listbox->m_blockEvent) return TRUE; - - // NB: wxdocs explicitly say that this event only gets sent when - // something is actually selected, plus the controls example - // assumes so and passes -1 to the dogetclientdata funcs if not - - // OK, so basically we need to do a bit of a run-around here as - // 1) is_selected says whether the item(s?) are CURRENTLY selected - - // i.e. if is_selected is FALSE then the item is going to be - // selected right now! - // 2) However, since it is not already selected and the user - // will expect it to be we need to manually select it and - // return FALSE telling GTK we handled the selection - if (is_selected) return TRUE; - - int nIndex = gtk_tree_path_get_indices(path)[0]; - GtkTreeEntry* entry = listbox->GtkGetEntry(nIndex); - - if(entry) - { - //Now, as mentioned above, we manually select the row that is/was going - //to be selected anyway by GTK - listbox->m_blockEvent = true; //if we don't block events we will lock the - //app due to recursion!! - - GtkTreeSelection* selection = - gtk_tree_view_get_selection(listbox->m_treeview); - GtkTreeIter iter; - gtk_tree_model_get_iter(GTK_TREE_MODEL(listbox->m_liststore), &iter, path); - gtk_tree_selection_select_iter(selection, &iter); - - listbox->m_blockEvent = false; - - //Finally, send the wx event - wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, listbox->GetId() ); - event.SetEventObject( listbox ); - - // indicate whether this is a selection or a deselection - event.SetExtraLong( 1 ); - - event.SetInt(nIndex); - event.SetString(wxConvUTF8.cMB2WX(gtk_tree_entry_get_label(entry))); + wxArrayInt sels; + if (listbox->GetSelections( sels ) < 1) + return FALSE; + index = sels[0]; + } - if ( listbox->HasClientObjectData() ) - event.SetClientObject( - (wxClientData*) gtk_tree_entry_get_userdata(entry) - ); - else if ( listbox->HasClientUntypedData() ) - event.SetClientData( gtk_tree_entry_get_userdata(entry) ); + if (index != wxNOT_FOUND) + { + listbox->GTKOnActivated(index); - listbox->GetEventHandler()->ProcessEvent( event ); +// wxMac and wxMSW always invoke default action +// if (!ret) + { + // DClick not handled -> invoke default action + wxWindow *tlw = wxGetTopLevelParent( listbox ); + if (tlw) + { + GtkWindow *gtk_window = GTK_WINDOW( tlw->GetHandle() ); + if (gtk_window) + gtk_window_activate_default( gtk_window ); + } + } - g_object_unref(G_OBJECT(entry)); - return FALSE; //We handled it/did it manually + // Always intercept, otherwise we'd get another dclick + // event from row_activated + return TRUE; + } } - return TRUE; //allow selection to change + return FALSE; } } @@ -332,10 +184,10 @@ extern "C" { static void gtk_tree_entry_destroy_cb(GtkTreeEntry* entry, wxListBox* listbox) { - if(listbox->HasClientObjectData()) + if (listbox->HasClientObjectData()) { gpointer userdata = gtk_tree_entry_get_userdata(entry); - if(userdata) + if (userdata) delete (wxClientData *)userdata; } } @@ -346,34 +198,21 @@ static void gtk_tree_entry_destroy_cb(GtkTreeEntry* entry, //----------------------------------------------------------------------------- extern "C" { -static gint gtk_listbox_sort_callback(GtkTreeModel *model, +static gint gtk_listbox_sort_callback(GtkTreeModel * WXUNUSED(model), GtkTreeIter *a, 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 = strcasecmp(gtk_tree_entry_get_collate_key(entry), - gtk_tree_entry_get_collate_key(entry2)); - - g_object_unref(G_OBJECT(entry)); - g_object_unref(G_OBJECT(entry2)); - - return ret; + return strcmp(gtk_tree_entry_get_collate_key(entry1), + gtk_tree_entry_get_collate_key(entry2)) >= 0; } } @@ -382,28 +221,19 @@ static gint gtk_listbox_sort_callback(GtkTreeModel *model, //----------------------------------------------------------------------------- extern "C" { -static gboolean gtk_listbox_searchequal_callback(GtkTreeModel* model, - gint column, +static gboolean gtk_listbox_searchequal_callback(GtkTreeModel * WXUNUSED(model), + gint WXUNUSED(column), const gchar* key, 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")); - gchar* keycollatekey = g_utf8_collate_key(key, -1); - - int ret = strcasecmp(keycollatekey, - gtk_tree_entry_get_collate_key(entry)); - g_free(keycollatekey); - g_object_unref(G_OBJECT(entry)); + wxGtkString keycollatekey(g_utf8_collate_key(key, -1)); - return ret != 0; + return strcmp(keycollatekey, gtk_tree_entry_get_collate_key(entry)) != 0; } } @@ -411,19 +241,16 @@ static gboolean gtk_listbox_searchequal_callback(GtkTreeModel* model, // wxListBox //----------------------------------------------------------------------------- -IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControl) - // ---------------------------------------------------------------------------- // construction // ---------------------------------------------------------------------------- void wxListBox::Init() { - m_treeview = (GtkTreeView*) NULL; + m_treeview = NULL; #if wxUSE_CHECKLISTBOX m_hasCheckBoxes = false; #endif // wxUSE_CHECKLISTBOX - m_spacePressed = false; } bool wxListBox::Create( wxWindow *parent, wxWindowID id, @@ -444,10 +271,6 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id, long style, const wxValidator& validator, const wxString &name ) { - m_needParent = true; - m_acceptsFocus = true; - m_blockEvent = false; - if (!PreCreation( parent, pos, size ) || !CreateBase( parent, id, pos, size, style, validator, name )) { @@ -455,7 +278,8 @@ 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) { gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget), @@ -468,7 +292,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( ) ); @@ -476,10 +300,10 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id, //NB: If enabled SetFirstItem doesn't work correctly gtk_tree_view_set_headers_visible(m_treeview, FALSE); -#if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST +#if wxUSE_CHECKLISTBOX if(m_hasCheckBoxes) ((wxCheckListBox*)this)->DoCreateCheckList(); -#endif // wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST +#endif // wxUSE_CHECKLISTBOX // Create the data column gtk_tree_view_insert_column_with_attributes(m_treeview, -1, "", @@ -488,7 +312,7 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id, WXLISTBOX_DATACOLUMN, NULL); // Now create+set the model (GtkListStore) - first argument # of columns -#if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST +#if wxUSE_CHECKLISTBOX if(m_hasCheckBoxes) m_liststore = gtk_list_store_new(2, G_TYPE_BOOLEAN, GTK_TYPE_TREE_ENTRY); @@ -498,7 +322,7 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id, gtk_tree_view_set_model(m_treeview, GTK_TREE_MODEL(m_liststore)); - g_object_unref(G_OBJECT(m_liststore)); //free on treeview destruction + g_object_unref (m_liststore); //free on treeview destruction // Disable the pop-up textctrl that enables searching - note that // the docs specify that even if this disabled (which we are doing) @@ -514,39 +338,35 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id, gtk_tree_view_set_enable_search(m_treeview, FALSE); - - GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview ); - gtk_tree_selection_set_select_function(selection, - (GtkTreeSelectionFunc)gtk_listitem_select_cb, - this, NULL); //NULL == destroycb - GtkSelectionMode mode; - if (style & wxLB_MULTIPLE) + // GTK_SELECTION_EXTENDED is a deprecated synonym for GTK_SELECTION_MULTIPLE + if ( style & (wxLB_MULTIPLE | wxLB_EXTENDED) ) { mode = GTK_SELECTION_MULTIPLE; } - else if (style & wxLB_EXTENDED) - { - mode = GTK_SELECTION_EXTENDED; - } - else + else // no multi-selection flags specified { - // if style was 0 set single mode 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 ); gtk_tree_selection_set_mode( selection, mode ); - //Handle sortable stuff - if(style & wxLB_SORT) + // Handle sortable stuff + if(HasFlag(wxLB_SORT)) { - //Setup sorting in ascending (wx) order + // Setup sorting in ascending (wx) order gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(m_liststore), WXLISTBOX_DATACOLUMN, GTK_SORT_ASCENDING); - //Set the sort callback + // Set the sort callback gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(m_liststore), WXLISTBOX_DATACOLUMN, (GtkTreeIterCompareFunc) gtk_listbox_sort_callback, @@ -559,25 +379,25 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id, gtk_container_add (GTK_CONTAINER (m_widget), GTK_WIDGET(m_treeview) ); gtk_widget_show( GTK_WIDGET(m_treeview) ); + m_focusWidget = GTK_WIDGET(m_treeview); - wxListBox::DoInsertItems(wxArrayString(n, choices), 0); // insert initial items + Append(n, choices); // insert initial items - //treeview-specific events - g_signal_connect(m_treeview, "row-activated", + // generate dclick events + g_signal_connect_after(m_treeview, "row-activated", G_CALLBACK(gtk_listbox_row_activated_callback), this); - // other events - g_signal_connect (m_treeview, "button_press_event", - G_CALLBACK (gtk_listbox_button_press_callback), - this); + // for intercepting dclick generation by g_signal_connect (m_treeview, "key_press_event", G_CALLBACK (gtk_listbox_key_press_callback), this); - m_parent->DoAddChild( this ); PostCreation(size); - SetBestSize(size); // need this too because this is a wxControlWithItems + SetInitialSize(size); // need this too because this is a wxControlWithItems + + g_signal_connect_after (selection, "changed", + G_CALLBACK (gtk_listitem_changed_callback), this); return true; } @@ -589,163 +409,171 @@ wxListBox::~wxListBox() Clear(); } +void wxListBox::GTKDisableEvents() +{ + GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview ); + + g_signal_handlers_block_by_func(selection, + (gpointer) gtk_listitem_changed_callback, this); +} + +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(); +} + + +void wxListBox::Update() +{ + wxWindow::Update(); + + if (m_treeview) + gdk_window_process_updates(gtk_widget_get_window(GTK_WIDGET(m_treeview)), true); +} + // ---------------------------------------------------------------------------- // adding items // ---------------------------------------------------------------------------- -void wxListBox::GtkInsertItems(const wxArrayString& items, - void** clientData, unsigned int pos) +int wxListBox::DoInsertItems(const wxArrayStringsAdapter& items, + unsigned int pos, + void **clientData, + wxClientDataType type) { - wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") ); + wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") ); InvalidateBestSize(); - // Create and set column ids and GValues - - unsigned int nNum = items.GetCount(); - unsigned int nCurCount = wxListBox::GetCount(); - wxASSERT_MSG(pos <= nCurCount, wxT("Invalid index passed to wxListBox")); - GtkTreeIter* pIter = NULL; // append by default GtkTreeIter iter; - if (pos != nCurCount) + if ( pos != GetCount() ) { - gboolean res = gtk_tree_model_iter_nth_child( - GTK_TREE_MODEL(m_liststore), - &iter, NULL, //NULL = parent = get first - (int)pos ); - if(!res) - { - wxLogSysError(wxT("internal wxListBox error in insertion")); - return; - } + wxCHECK_MSG( GTKGetIteratorFor(pos, &iter), wxNOT_FOUND, + wxT("internal wxListBox error in insertion") ); pIter = &iter; } - for (unsigned int i = 0; i < nNum; ++i) + const unsigned int numItems = items.GetCount(); + for ( unsigned int i = 0; i < numItems; ++i ) { - wxString label = items[i]; - -#if wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST - if (m_hasCheckBoxes) - { - label.Prepend(wxCHECKLBOX_STRING); - } -#endif // wxUSE_CHECKLISTBOX - - - GtkTreeEntry* entry = gtk_tree_entry_new(); - gtk_tree_entry_set_label(entry, wxConvUTF8.cWX2MB(label)); + 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, this); - if (clientData) - gtk_tree_entry_set_userdata(entry, clientData[i]); - GtkTreeIter itercur; gtk_list_store_insert_before(m_liststore, &itercur, pIter); -#if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST - if (m_hasCheckBoxes) - { - gtk_list_store_set(m_liststore, &itercur, - 0, FALSE, //FALSE == not toggled - 1, entry, -1); - } - else -#endif - gtk_list_store_set(m_liststore, &itercur, - 0, entry, -1); + GTKSetItem(itercur, entry); - g_object_unref(G_OBJECT(entry)); //liststore always refs :) + if (clientData) + AssignNewItemClientData(GTKGetIndexFor(itercur), clientData, i, type); } -} - -void wxListBox::DoInsertItems(const wxArrayString& items, unsigned int pos) -{ - wxCHECK_RET( IsValidInsert(pos), wxT("invalid index in wxListBox::InsertItems") ); - - GtkInsertItems(items, NULL, pos); -} -int wxListBox::DoAppend( const wxString& item ) -{ - // Call DoInsertItems - unsigned int nWhere = wxListBox::GetCount(); - wxArrayString aItems; - aItems.Add(item); - wxListBox::DoInsertItems(aItems, nWhere); - return nWhere; -} + UpdateOldSelections(); -void wxListBox::DoSetItems( const wxArrayString& items, - void **clientData) -{ - Clear(); - GtkInsertItems(items, clientData, 0); + return pos + numItems - 1; } // ---------------------------------------------------------------------------- // deleting items // ---------------------------------------------------------------------------- -void wxListBox::Clear() +void wxListBox::DoClear() { wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") ); + GTKDisableEvents(); // just in case + InvalidateBestSize(); gtk_list_store_clear( m_liststore ); /* well, THAT was easy :) */ + + GTKEnableEvents(); } -void wxListBox::Delete(unsigned int n) +void wxListBox::DoDeleteOneItem(unsigned int n) { wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") ); InvalidateBestSize(); - GtkTreeIter iter; - gboolean res = gtk_tree_model_iter_nth_child( - GTK_TREE_MODEL(m_liststore), - &iter, NULL, //NULL = parent = get first - n - ); + GTKDisableEvents(); // just in case - wxCHECK_RET( res, wxT("wrong listbox index") ); + GtkTreeIter iter; + wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("wrong listbox index") ); - //this returns false if iter is invalid (i.e. deleting item - //at end) but since we don't use iter, well... :) + // 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(); } // ---------------------------------------------------------------------------- -// get GtkTreeEntry from position (note: you need to g_unref it if valid) +// helper functions for working with iterators // ---------------------------------------------------------------------------- -struct _GtkTreeEntry* wxListBox::GtkGetEntry(int n) const +bool wxListBox::GTKGetIteratorFor(unsigned pos, GtkTreeIter *iter) const { - GtkTreeIter iter; - gboolean res = gtk_tree_model_iter_nth_child( - GTK_TREE_MODEL(m_liststore), - &iter, NULL, //NULL = parent = get first - n ); - - if (!res) + if ( !gtk_tree_model_iter_nth_child(GTK_TREE_MODEL(m_liststore), + iter, NULL, pos) ) { - wxLogDebug(wxT("gtk_tree_model_iter_nth_child failed\n") - wxT("Passed in value was:[%i] List size:[%u]"), - n, wxListBox::GetCount() ); - return NULL; + wxLogDebug(wxT("gtk_tree_model_iter_nth_child(%u) failed"), pos); + return false; } + return true; +} + +int wxListBox::GTKGetIndexFor(GtkTreeIter& iter) const +{ + GtkTreePath *path = + gtk_tree_model_get_path(GTK_TREE_MODEL(m_liststore), &iter); - GtkTreeEntry* entry = NULL; - gtk_tree_model_get(GTK_TREE_MODEL(m_liststore), &iter, - WXLISTBOX_DATACOLUMN, &entry, -1); + gint* pIntPath = gtk_tree_path_get_indices(path); - return entry; + wxCHECK_MSG( pIntPath, wxNOT_FOUND, wxT("failed to get iterator path") ); + + int idx = pIntPath[0]; + + gtk_tree_path_free( path ); + + return idx; +} + +// get GtkTreeEntry from position (note: you need to g_unref it if valid) +GtkTreeEntry *wxListBox::GTKGetEntry(unsigned n) const +{ + GtkTreeIter iter; + if ( !GTKGetIteratorFor(n, &iter) ) + return NULL; + + return GetEntry(m_liststore, &iter, this); +} + +void wxListBox::GTKSetItem(GtkTreeIter& iter, const GtkTreeEntry *entry) +{ +#if wxUSE_CHECKLISTBOX + if ( m_hasCheckBoxes ) + { + gtk_list_store_set(m_liststore, &iter, + 0, FALSE, // FALSE == not toggled + 1, entry, + -1); + } + else +#endif // wxUSE_CHECKLISTBOX + { + gtk_list_store_set(m_liststore, &iter, 0, entry, -1); + } } // ---------------------------------------------------------------------------- @@ -754,95 +582,52 @@ struct _GtkTreeEntry* wxListBox::GtkGetEntry(int n) const 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(G_OBJECT(entry)); - return userdata; -} - -wxClientData* wxListBox::DoGetItemClientObject(unsigned int n) const -{ - return (wxClientData*) wxListBox::DoGetItemClientData(n); + 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(G_OBJECT(entry)); -} - -void wxListBox::DoSetItemClientObject(unsigned int n, wxClientData* clientData) -{ - // wxItemContainer already deletes data for us - wxListBox::DoSetItemClientData(n, (void*) clientData); } // ---------------------------------------------------------------------------- // string list access // ---------------------------------------------------------------------------- -void wxListBox::SetString(unsigned int n, const wxString &string) +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") ); - wxString label = string; + // update the item itself + gtk_tree_entry_set_label(entry, wxGTK_CONV(label)); -#if wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST - if (m_hasCheckBoxes) - label.Prepend(wxCHECKLBOX_STRING); -#endif // wxUSE_CHECKLISTBOX + // and update the model which will refresh the tree too + GtkTreeIter iter; + wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("failed to get iterator") ); - // RN: This may look wierd but the problem is that the TreeView - // doesn't resort or update when changed above and there is no real - // notification function... - void* userdata = gtk_tree_entry_get_userdata(entry); - gtk_tree_entry_set_userdata(entry, NULL); //don't delete on destroy - g_object_unref(G_OBJECT(entry)); - - bool bWasSelected = wxListBox::IsSelected(n); - wxListBox::Delete(n); - - wxArrayString aItems; - aItems.Add(label); - GtkInsertItems(aItems, &userdata, n); - if (bWasSelected) - wxListBox::GtkSetSelection(n, true, true); + // FIXME: this resets the checked status of a wxCheckListBox item + + 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) ); - -#if wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST - // checklistboxes have "[±] " prepended to their lables, remove it - // - // NB: 4 below is the length of wxCHECKLBOX_STRING from wx/gtk/checklst.h - if ( m_hasCheckBoxes ) - label.erase(0, 4); -#endif // wxUSE_CHECKLISTBOX - - g_object_unref(G_OBJECT(entry)); - return label; + return wxGTK_CONV_BACK( gtk_tree_entry_get_label(entry) ); } unsigned int wxListBox::GetCount() const @@ -874,10 +659,29 @@ 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, -1, wxT("invalid listbox")); - wxCHECK_MSG( HasFlag(wxLB_SINGLE), -1, + wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox")); + wxCHECK_MSG( HasFlag(wxLB_SINGLE), wxNOT_FOUND, wxT("must be single selection listbox")); GtkTreeIter iter; @@ -885,25 +689,18 @@ int wxListBox::GetSelection() const // only works on single-sel if (!gtk_tree_selection_get_selected(selection, NULL, &iter)) - return -1; - - GtkTreePath* path = - gtk_tree_model_get_path(GTK_TREE_MODEL(m_liststore), &iter); - - int sel = gtk_tree_path_get_indices(path)[0]; - - gtk_tree_path_free(path); + return wxNOT_FOUND; - return sel; + return GTKGetIndexFor(iter); } int wxListBox::GetSelections( wxArrayInt& aSelections ) const { - wxCHECK_MSG( m_treeview != NULL, -1, wxT("invalid listbox") ); + wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") ); aSelections.Empty(); - int i = 0; + int i = 0; GtkTreeIter iter; GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview); @@ -928,78 +725,92 @@ bool wxListBox::IsSelected( int n ) const GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview); GtkTreeIter iter; - gboolean res = gtk_tree_model_iter_nth_child( - GTK_TREE_MODEL(m_liststore), - &iter, NULL, //NULL = parent = get first - n ); - - wxCHECK_MSG( res, false, wxT("Invalid index") ); + wxCHECK_MSG( GTKGetIteratorFor(n, &iter), false, wxT("Invalid index") ); return gtk_tree_selection_iter_is_selected(selection, &iter); } void wxListBox::DoSetSelection( int n, bool select ) -{ - return GtkSetSelection(n, select, true); //docs say no events here -} - -void wxListBox::GtkSetSelection(int n, const bool select, const bool blockEvent) { wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") ); + GTKDisableEvents(); + GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview); - GtkTreeIter iter; - gboolean res = gtk_tree_model_iter_nth_child( - GTK_TREE_MODEL(m_liststore), - &iter, NULL, //NULL = parent = get first - n - ); - wxCHECK_RET( res, wxT("Invalid index") ); + // passing -1 to SetSelection() is documented to deselect all items + if ( n == wxNOT_FOUND ) + { + gtk_tree_selection_unselect_all(selection); + GTKEnableEvents(); + return; + } - m_blockEvent = blockEvent; + wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetSelection") ); + + + GtkTreeIter iter; + wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("Invalid index") ); if (select) gtk_tree_selection_select_iter(selection, &iter); else gtk_tree_selection_unselect_iter(selection, &iter); - m_blockEvent = false; + GtkTreePath* path = gtk_tree_model_get_path( + GTK_TREE_MODEL(m_liststore), &iter); + + gtk_tree_view_scroll_to_cell(m_treeview, path, NULL, FALSE, 0.0f, 0.0f); + + gtk_tree_path_free(path); + + GTKEnableEvents(); } -void wxListBox::DoSetFirstItem( int n ) +void wxListBox::DoScrollToCell(int n, float alignY, float alignX) { wxCHECK_RET( m_treeview, wxT("invalid listbox") ); wxCHECK_RET( IsValid(n), wxT("invalid index")); //RN: I have no idea why this line is needed... - if (gdk_pointer_is_grabbed () && GTK_WIDGET_HAS_GRAB (m_treeview)) + if (gdk_pointer_is_grabbed () && gtk_widget_has_grab(GTK_WIDGET(m_treeview))) return; GtkTreeIter iter; - gtk_tree_model_iter_nth_child( - GTK_TREE_MODEL(m_liststore), - &iter, - NULL, //NULL = parent = get first - n - ); + if ( !GTKGetIteratorFor(n, &iter) ) + return; GtkTreePath* path = gtk_tree_model_get_path( GTK_TREE_MODEL(m_liststore), &iter); // Scroll to the desired cell (0.0 == topleft alignment) gtk_tree_view_scroll_to_cell(m_treeview, path, NULL, - TRUE, 0.0f, 0.0f); + TRUE, alignY, alignX); gtk_tree_path_free(path); } +void wxListBox::DoSetFirstItem(int n) +{ + DoScrollToCell(n, 0, 0); +} + +void wxListBox::EnsureVisible(int n) +{ + DoScrollToCell(n, 0.5, 0); +} + // ---------------------------------------------------------------------------- // hittest // ---------------------------------------------------------------------------- int wxListBox::DoListHitTest(const wxPoint& point) const { + // gtk_tree_view_get_path_at_pos() also gets items that are not visible and + // we only want visible items we need to check for it manually here + if ( !GetClientRect().Contains(point) ) + return wxNOT_FOUND; + // need to translate from master window since it is in client coords gint binx, biny; gdk_window_get_geometry(gtk_tree_view_get_bin_window(m_treeview), @@ -1030,14 +841,6 @@ int wxListBox::DoListHitTest(const wxPoint& point) const // helpers // ---------------------------------------------------------------------------- -#if wxUSE_TOOLTIPS -void wxListBox::ApplyToolTip( GtkTooltips *tips, const wxChar *tip ) -{ - // RN: Is this needed anymore? - gtk_tooltips_set_tip( tips, GTK_WIDGET( m_treeview ), wxGTK_CONV(tip), (gchar*) NULL ); -} -#endif // wxUSE_TOOLTIPS - GtkWidget *wxListBox::GetConnectWidget() { // the correct widget for listbox events (such as mouse clicks for example) @@ -1045,14 +848,14 @@ GtkWidget *wxListBox::GetConnectWidget() return GTK_WIDGET(m_treeview); } -bool wxListBox::IsOwnGtkWindow( GdkWindow *window ) +GdkWindow *wxListBox::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const { - return (window == gtk_tree_view_get_bin_window(m_treeview)); + return gtk_tree_view_get_bin_window(m_treeview); } void wxListBox::DoApplyWidgetStyle(GtkRcStyle *style) { - if (m_hasBgCol && m_backgroundColour.Ok()) + if (m_hasBgCol && m_backgroundColour.IsOk()) { GdkWindow *window = gtk_tree_view_get_bin_window(m_treeview); if (window) @@ -1066,26 +869,6 @@ void wxListBox::DoApplyWidgetStyle(GtkRcStyle *style) gtk_widget_modify_style( GTK_WIDGET(m_treeview), style ); } -void wxListBox::OnInternalIdle() -{ - //RN: Is this needed anymore? - wxCursor cursor = m_cursor; - if (g_globalCursor.Ok()) cursor = g_globalCursor; - - if (GTK_WIDGET(m_treeview)->window && cursor.Ok()) - { - /* I now set the cursor the anew in every OnInternalIdle call - as setting the cursor in a parent window also effects the - windows above so that checking for the current cursor is - not possible. */ - GdkWindow *window = gtk_tree_view_get_bin_window(m_treeview); - gdk_window_set_cursor( window, cursor.GetCursor() ); - } - - if (wxUpdateUIEvent::CanUpdate(this)) - UpdateWindowUI(wxUPDATE_UI_FROMIDLE); -} - wxSize wxListBox::DoGetBestSize() const { wxCHECK_MSG(m_treeview, wxDefaultSize, wxT("invalid tree view")); @@ -1093,43 +876,40 @@ wxSize wxListBox::DoGetBestSize() const // Start with a minimum size that's not too small int cx, cy; GetTextExtent( wxT("X"), &cx, &cy); - int lbWidth = 3 * cx; + int lbWidth = 0; int lbHeight = 10; - // Get the visible area of the tree view (limit to the 10th item - // so that it isn't too big) - unsigned int count = GetCount(); - if (count) + // Find the widest string. + const unsigned int count = GetCount(); + if ( count ) { int wLine; - - // Find the widest line - for(unsigned int i = 0; i < count; i++) { - wxString str(GetString(i)); - GetTextExtent(str, &wLine, NULL); - lbWidth = wxMax(lbWidth, wLine); - } - - lbWidth += 3 * cx; - - // And just a bit more for the checkbox if present and then some - // (these are rough guesses) -#if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST - if ( m_hasCheckBoxes ) + for ( unsigned int i = 0; i < count; i++ ) { - lbWidth += 35; - cy = cy > 25 ? cy : 25; // rough height of checkbox + GetTextExtent(GetString(i), &wLine, NULL); + if ( wLine > lbWidth ) + lbWidth = wLine; } -#endif + } - // don't make the listbox too tall (limit height to around 10 items) but don't - // make it too small neither - lbHeight = (cy+4) * wxMin(wxMax(count, 3), 10); + lbWidth += 3 * cx; + + // And just a bit more for the checkbox if present and then some + // (these are rough guesses) +#if wxUSE_CHECKLISTBOX + if ( m_hasCheckBoxes ) + { + lbWidth += 35; + cy = cy > 25 ? cy : 25; // rough height of checkbox } +#endif // Add room for the scrollbar lbWidth += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X); + // Don't make the listbox too tall but don't make it too small neither + lbHeight = (cy+4) * wxMin(wxMax(count, 3), 10); + wxSize best(lbWidth, lbHeight); CacheBestSize(best); return best;