X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/291a8f20b30f3344b376b61e504c27bd5849e2b1..6c4d607e60293cdd7e9774ad0a5af224882d91e5:/src/gtk/listbox.cpp diff --git a/src/gtk/listbox.cpp b/src/gtk/listbox.cpp index 436ae7f1d6..fb70b0c0c7 100644 --- a/src/gtk/listbox.cpp +++ b/src/gtk/listbox.cpp @@ -1,773 +1,937 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: listbox.cpp +// Name: src/gtk/listbox.cpp // Purpose: // Author: Robert Roebling +// Modified By: Ryan Norton (GtkTreeView implementation) // Id: $Id$ // Copyright: (c) 1998 Robert Roebling // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// +// For compilers that support precompilation, includes "wx.h". +#include "wx/wxprec.h" -#ifdef __GNUG__ -#pragma implementation "listbox.h" -#endif +#if wxUSE_LISTBOX -#include "wx/dynarray.h" #include "wx/listbox.h" -#include "wx/utils.h" -#include "wx/intl.h" -#include "wx/checklst.h" -#if wxUSE_TOOLTIPS -#include "wx/tooltip.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 -#if wxUSE_DRAG_AND_DROP -#include "wx/dnd.h" +#include "wx/gtk/private.h" +#include "wx/gtk/private/object.h" +#include "wx/gtk/treeentry_gtk.h" + +#if wxUSE_TOOLTIPS + #include "wx/tooltip.h" #endif -#include "gdk/gdk.h" -#include "gtk/gtk.h" +#include +#include + +//----------------------------------------------------------------------------- +// data +//----------------------------------------------------------------------------- + +extern bool g_blockEventsOnDrag; +extern bool g_blockEventsOnScroll; -//------------------------------------------------------------------------- -// conditional compilation -//------------------------------------------------------------------------- -#if (GTK_MINOR_VERSION == 1) -#if (GTK_MICRO_VERSION >= 5) -#define NEW_GTK_SCROLL_CODE -#endif -#endif //----------------------------------------------------------------------------- -// data +// Macro to tell which row the strings are in (1 if native checklist, 0 if not) //----------------------------------------------------------------------------- -extern bool g_blockEventsOnDrag; -extern bool g_blockEventsOnScroll; +#if wxUSE_CHECKLISTBOX +# define WXLISTBOX_DATACOLUMN_ARG(x) (x->m_hasCheckBoxes ? 1 : 0) +#else +# define WXLISTBOX_DATACOLUMN_ARG(x) (0) +#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 //----------------------------------------------------------------------------- -// "button_press_event" +// "row-activated" //----------------------------------------------------------------------------- -static gint -gtk_listbox_button_press_callback( GtkWidget *widget, GdkEventButton *gdk_event, wxListBox *listbox ) +extern "C" { +static void +gtk_listbox_row_activated_callback(GtkTreeView * WXUNUSED(treeview), + GtkTreePath *path, + GtkTreeViewColumn * WXUNUSED(col), + wxListBox *listbox) { - if (g_blockEventsOnDrag) return FALSE; - if (g_blockEventsOnScroll) return FALSE; + if (g_blockEventsOnDrag) return; + if (g_blockEventsOnScroll) return; - if (!listbox->HasVMT()) return FALSE; + // This is triggered by either a double-click or a space press - int sel = listbox->GetIndex( widget ); + int sel = gtk_tree_path_get_indices(path)[0]; - if ((listbox->m_hasCheckBoxes) && (gdk_event->x < 15) && (gdk_event->type != GDK_2BUTTON_PRESS)) - { - wxCheckListBox *clb = (wxCheckListBox *)listbox; + listbox->GTKOnActivated(sel); +} +} - clb->Check( sel, !clb->IsChecked(sel) ); +//----------------------------------------------------------------------------- +// "changed" +//----------------------------------------------------------------------------- - wxCommandEvent event( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, listbox->GetId() ); - event.SetEventObject( listbox ); - event.SetInt( sel ); - listbox->GetEventHandler()->ProcessEvent( event ); - } +extern "C" { +static void +gtk_listitem_changed_callback(GtkTreeSelection * WXUNUSED(selection), + wxListBox *listbox ) +{ + if (g_blockEventsOnDrag) return; - if (gdk_event->type == GDK_2BUTTON_PRESS) - { - wxCommandEvent event( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, listbox->GetId() ); - event.SetEventObject( listbox ); + listbox->GTKOnSelectionChanged(); +} - wxArrayInt aSelections; - int count = listbox->GetSelections(aSelections); - if ( count > 0 ) - { - event.m_commandInt = aSelections[0] ; - event.m_clientData = listbox->GetClientData( event.m_commandInt ); - wxString str(listbox->GetString(event.m_commandInt)); - if (str != "") event.m_commandString = copystring((char *)(const char *)str); - } +} + +//----------------------------------------------------------------------------- +// "key_press_event" +//----------------------------------------------------------------------------- + +extern "C" { +static gboolean +gtk_listbox_key_press_callback( GtkWidget *WXUNUSED(widget), + GdkEventKey *gdk_event, + wxListBox *listbox ) +{ + if ((gdk_event->keyval == GDK_Return) || + (gdk_event->keyval == GDK_ISO_Enter) || + (gdk_event->keyval == GDK_KP_Enter)) + { + int index = -1; + if (!listbox->HasMultipleSelection()) + index = listbox->GetSelection(); else { - event.m_commandInt = -1 ; - event.m_commandString = copystring("") ; + wxArrayInt sels; + if (listbox->GetSelections( sels ) < 1) + return FALSE; + index = sels[0]; } - listbox->GetEventHandler()->ProcessEvent( event ); - - if (event.m_commandString) delete[] event.m_commandString ; + if (index != wxNOT_FOUND) + { + listbox->GTKOnActivated(index); + +// 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 ); + } + } + + // Always intercept, otherwise we'd get another dclick + // event from row_activated + return TRUE; + } } return FALSE; } +} //----------------------------------------------------------------------------- -// "key_press_event" +// GtkTreeEntry destruction (to destroy client data) //----------------------------------------------------------------------------- -static gint -gtk_listbox_key_press_callback( GtkWidget *widget, GdkEventKey *gdk_event, wxListBox *listbox ) +extern "C" { +static void gtk_tree_entry_destroy_cb(GtkTreeEntry* entry, + wxListBox* listbox) { - if (g_blockEventsOnDrag) return FALSE; - - if (!listbox->HasVMT()) return FALSE; - - if (gdk_event->keyval != ' ') return FALSE; - - int sel = listbox->GetIndex( widget ); + if (listbox->HasClientObjectData()) + { + gpointer userdata = gtk_tree_entry_get_userdata(entry); + if (userdata) + delete (wxClientData *)userdata; + } +} +} - wxCheckListBox *clb = (wxCheckListBox *)listbox; +//----------------------------------------------------------------------------- +// Sorting callback (standard CmpNoCase return value) +//----------------------------------------------------------------------------- - clb->Check( sel, !clb->IsChecked(sel) ); +extern "C" { +static gint gtk_listbox_sort_callback(GtkTreeModel * WXUNUSED(model), + GtkTreeIter *a, + GtkTreeIter *b, + wxListBox *listbox) +{ + wxGtkObject entry1(GetEntry(listbox->m_liststore, a, listbox)); + wxCHECK_MSG(entry1, 0, wxT("Could not get first entry")); - wxCommandEvent event( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, listbox->GetId() ); - event.SetEventObject( listbox ); - event.SetInt( sel ); - listbox->GetEventHandler()->ProcessEvent( event ); + wxGtkObject entry2(GetEntry(listbox->m_liststore, b, listbox)); + wxCHECK_MSG(entry2, 0, wxT("Could not get second entry")); - return FALSE; + //We compare collate keys here instead of calling g_utf8_collate + //as it is rather slow (and even the docs reccommend this) + return strcmp(gtk_tree_entry_get_collate_key(entry1), + gtk_tree_entry_get_collate_key(entry2)) >= 0; +} } //----------------------------------------------------------------------------- -// "select" and "deselect" +// Searching callback (TRUE == not equal, FALSE == equal) //----------------------------------------------------------------------------- -static void gtk_listitem_select_callback( GtkWidget *WXUNUSED(widget), wxListBox *listbox ) +extern "C" { +static gboolean gtk_listbox_searchequal_callback(GtkTreeModel * WXUNUSED(model), + gint WXUNUSED(column), + const gchar* key, + GtkTreeIter* iter, + wxListBox* listbox) { - if (!listbox->HasVMT()) return; - if (g_blockEventsOnDrag) return; + wxGtkObject + entry(GetEntry(listbox->m_liststore, iter, listbox)); + wxCHECK_MSG(entry, 0, wxT("Could not get entry")); - wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, listbox->GetId() ); + wxGtkString keycollatekey(g_utf8_collate_key(key, -1)); - wxArrayInt aSelections; - int count = listbox->GetSelections(aSelections); - if ( count > 0 ) - { - event.m_commandInt = aSelections[0] ; - event.m_clientData = listbox->GetClientData( event.m_commandInt ); - wxString str(listbox->GetString(event.m_commandInt)); - if (str != "") event.m_commandString = copystring((char *)(const char *)str); - } - else - { - event.m_commandInt = -1 ; - event.m_commandString = copystring("") ; - } - - event.SetEventObject( listbox ); - - listbox->GetEventHandler()->ProcessEvent( event ); - if (event.m_commandString) delete[] event.m_commandString ; + return strcmp(keycollatekey, gtk_tree_entry_get_collate_key(entry)) != 0; +} } //----------------------------------------------------------------------------- // wxListBox //----------------------------------------------------------------------------- -IMPLEMENT_DYNAMIC_CLASS(wxListBox,wxControl) +IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControlWithItems) + +// ---------------------------------------------------------------------------- +// construction +// ---------------------------------------------------------------------------- + +void wxListBox::Init() +{ + m_treeview = NULL; +#if wxUSE_CHECKLISTBOX + m_hasCheckBoxes = false; +#endif // wxUSE_CHECKLISTBOX +} -wxListBox::wxListBox() +bool wxListBox::Create( wxWindow *parent, wxWindowID id, + const wxPoint &pos, const wxSize &size, + const wxArrayString& choices, + long style, const wxValidator& validator, + const wxString &name ) { - m_list = (GtkList *) NULL; - m_hasCheckBoxes = FALSE; + wxCArrayString chs(choices); + + return Create( parent, id, pos, size, chs.GetCount(), chs.GetStrings(), + style, validator, name ); } bool wxListBox::Create( wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, int n, const wxString choices[], - long style, const wxValidator& validator, const wxString &name ) + long style, const wxValidator& validator, + const wxString &name ) { - m_needParent = TRUE; - m_acceptsFocus = TRUE; + if (!PreCreation( parent, pos, size ) || + !CreateBase( parent, id, pos, size, style, validator, name )) + { + wxFAIL_MSG( wxT("wxListBox creation failed") ); + return false; + } + + 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), + GTK_POLICY_AUTOMATIC, GTK_POLICY_ALWAYS ); + } + else + { + gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget), + GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC ); + } - PreCreation( parent, id, pos, size, style, name ); - SetValidator( validator ); + GTKScrolledWindowSetBorder(m_widget, style); - m_widget = gtk_scrolled_window_new( (GtkAdjustment*) NULL, (GtkAdjustment*) NULL ); - gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget), - GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC ); + m_treeview = GTK_TREE_VIEW( gtk_tree_view_new( ) ); - m_list = GTK_LIST( gtk_list_new() ); + //wxListBox doesn't have a header :) + //NB: If enabled SetFirstItem doesn't work correctly + gtk_tree_view_set_headers_visible(m_treeview, FALSE); - GtkSelectionMode mode = GTK_SELECTION_BROWSE; - if (style & wxLB_MULTIPLE) - mode = GTK_SELECTION_MULTIPLE; - else if (style & wxLB_EXTENDED) - mode = GTK_SELECTION_EXTENDED; +#if wxUSE_CHECKLISTBOX + if(m_hasCheckBoxes) + ((wxCheckListBox*)this)->DoCreateCheckList(); +#endif // wxUSE_CHECKLISTBOX - gtk_list_set_selection_mode( GTK_LIST(m_list), mode ); + // Create the data column + gtk_tree_view_insert_column_with_attributes(m_treeview, -1, "", + gtk_cell_renderer_text_new(), + "text", + WXLISTBOX_DATACOLUMN, NULL); -#ifdef NEW_GTK_SCROLL_CODE - gtk_scrolled_window_add_with_viewport( GTK_SCROLLED_WINDOW(m_widget), GTK_WIDGET(m_list) ); -#else - gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_list) ); + // Now create+set the model (GtkListStore) - first argument # of columns +#if wxUSE_CHECKLISTBOX + if(m_hasCheckBoxes) + m_liststore = gtk_list_store_new(2, G_TYPE_BOOLEAN, + GTK_TYPE_TREE_ENTRY); + else #endif + m_liststore = gtk_list_store_new(1, GTK_TYPE_TREE_ENTRY); -#ifdef __WXDEBUG__ - debug_focus_in( m_widget, "wxListBox::m_widget", name ); - - debug_focus_in( GTK_WIDGET(m_list), "wxListBox::m_list", name ); + gtk_tree_view_set_model(m_treeview, GTK_TREE_MODEL(m_liststore)); - GtkScrolledWindow *s_window = GTK_SCROLLED_WINDOW(m_widget); + g_object_unref (m_liststore); //free on treeview destruction - debug_focus_in( s_window->hscrollbar, "wxWindow::hsrcollbar", name ); - debug_focus_in( s_window->vscrollbar, "wxWindow::vsrcollbar", name ); + // Disable the pop-up textctrl that enables searching - note that + // the docs specify that even if this disabled (which we are doing) + // the user can still have it through the start-interactive-search + // key binding...either way we want to provide a searchequal callback + // NB: If this is enabled a doubleclick event (activate) gets sent + // on a successful search + gtk_tree_view_set_search_column(m_treeview, WXLISTBOX_DATACOLUMN); + gtk_tree_view_set_search_equal_func(m_treeview, + (GtkTreeViewSearchEqualFunc) gtk_listbox_searchequal_callback, + this, + NULL); -#ifdef NEW_GTK_SCROLL_CODE - GtkViewport *viewport = GTK_VIEWPORT(s_window->child); -#else - GtkViewport *viewport = GTK_VIEWPORT(s_window->viewport); -#endif + gtk_tree_view_set_enable_search(m_treeview, FALSE); - debug_focus_in( GTK_WIDGET(viewport), "wxWindow::viewport", name ); -#endif + GtkSelectionMode mode; + // GTK_SELECTION_EXTENDED is a deprecated synonym for GTK_SELECTION_MULTIPLE + if ( style & (wxLB_MULTIPLE | wxLB_EXTENDED) ) + { + mode = GTK_SELECTION_MULTIPLE; + } + else // no multi-selection flags specified + { + m_windowStyle |= wxLB_SINGLE; - gtk_widget_show( GTK_WIDGET(m_list) ); + // 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; + } - wxSize newSize = size; - if (newSize.x == -1) newSize.x = 100; - if (newSize.y == -1) newSize.y = 110; - SetSize( newSize.x, newSize.y ); + GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview ); + gtk_tree_selection_set_mode( selection, mode ); - for (int i = 0; i < n; i++) + // Handle sortable stuff + if(HasFlag(wxLB_SORT)) { - m_clientDataList.Append( (wxObject*) NULL ); - m_clientObjectList.Append( (wxObject*) NULL ); - - GtkWidget *list_item; + // 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 + gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(m_liststore), + WXLISTBOX_DATACOLUMN, + (GtkTreeIterCompareFunc) gtk_listbox_sort_callback, + this, //userdata + NULL //"destroy notifier" + ); + } - if (m_hasCheckBoxes) - { - wxString str = "[-] "; - str += choices[i]; - list_item = gtk_list_item_new_with_label( str ); - } - else - { - list_item = gtk_list_item_new_with_label( choices[i] ); - } -#ifdef __WXDEBUG__ - debug_focus_in( list_item, "wxListBox::list_item", name ); -#endif + gtk_container_add (GTK_CONTAINER (m_widget), GTK_WIDGET(m_treeview) ); - gtk_container_add( GTK_CONTAINER(m_list), list_item ); + gtk_widget_show( GTK_WIDGET(m_treeview) ); + m_focusWidget = GTK_WIDGET(m_treeview); - gtk_signal_connect( GTK_OBJECT(list_item), "select", - GTK_SIGNAL_FUNC(gtk_listitem_select_callback), (gpointer)this ); + Append(n, choices); // insert initial items - if (style & wxLB_MULTIPLE) - gtk_signal_connect( GTK_OBJECT(list_item), "deselect", - GTK_SIGNAL_FUNC(gtk_listitem_select_callback), (gpointer)this ); + // generate dclick events + g_signal_connect_after(m_treeview, "row-activated", + G_CALLBACK(gtk_listbox_row_activated_callback), this); - gtk_signal_connect( GTK_OBJECT(list_item), - "button_press_event", - (GtkSignalFunc)gtk_listbox_button_press_callback, - (gpointer) 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 ); - if (m_hasCheckBoxes) - { - gtk_signal_connect( GTK_OBJECT(list_item), - "key_press_event", - (GtkSignalFunc)gtk_listbox_key_press_callback, - (gpointer)this ); - } + PostCreation(size); + SetInitialSize(size); // need this too because this is a wxControlWithItems - ConnectWidget( list_item ); + g_signal_connect_after (selection, "changed", + G_CALLBACK (gtk_listitem_changed_callback), this); - gtk_widget_show( list_item ); - } + return true; +} - m_parent->AddChild( this ); +wxListBox::~wxListBox() +{ + m_hasVMT = false; - (m_parent->m_insertCallback)( m_parent, this ); + Clear(); +} - PostCreation(); +void wxListBox::GTKDisableEvents() +{ + GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview ); - gtk_widget_realize( GTK_WIDGET(m_list) ); + g_signal_handlers_block_by_func(selection, + (gpointer) gtk_listitem_changed_callback, this); +} - SetBackgroundColour( parent->GetBackgroundColour() ); - SetForegroundColour( parent->GetForegroundColour() ); +void wxListBox::GTKEnableEvents() +{ + GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview ); - Show( TRUE ); + g_signal_handlers_unblock_by_func(selection, + (gpointer) gtk_listitem_changed_callback, this); - return TRUE; + UpdateOldSelections(); } -wxListBox::~wxListBox() + +void wxListBox::Update() { - Clear(); + wxWindow::Update(); + + if (m_treeview) + gdk_window_process_updates(GTK_WIDGET(m_treeview)->window, TRUE); } -void wxListBox::AppendCommon( const wxString &item ) +// ---------------------------------------------------------------------------- +// adding items +// ---------------------------------------------------------------------------- + +int wxListBox::DoInsertItems(const wxArrayStringsAdapter& items, + unsigned int pos, + void **clientData, + wxClientDataType type) { - wxCHECK_RET( m_list != NULL, "invalid listbox" ); + wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") ); - GtkWidget *list_item; + InvalidateBestSize(); - if (m_hasCheckBoxes) + GtkTreeIter* pIter = NULL; // append by default + GtkTreeIter iter; + if ( pos != GetCount() ) { - wxString str = "[-] "; - str += item; - list_item = gtk_list_item_new_with_label( str ); + wxCHECK_MSG( GTKGetIteratorFor(pos, &iter), wxNOT_FOUND, + wxT("internal wxListBox error in insertion") ); + + pIter = &iter; } - else + + const unsigned int numItems = items.GetCount(); + for ( unsigned int i = 0; i < numItems; ++i ) { - list_item = gtk_list_item_new_with_label( item ); - } + 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); - gtk_signal_connect( GTK_OBJECT(list_item), "select", - GTK_SIGNAL_FUNC(gtk_listitem_select_callback), (gpointer)this ); + GtkTreeIter itercur; + gtk_list_store_insert_before(m_liststore, &itercur, pIter); - if (GetWindowStyleFlag() & wxLB_MULTIPLE) - gtk_signal_connect( GTK_OBJECT(list_item), "deselect", - GTK_SIGNAL_FUNC(gtk_listitem_select_callback), (gpointer)this ); + GTKSetItem(itercur, entry); - gtk_container_add( GTK_CONTAINER(m_list), list_item ); + if (clientData) + AssignNewItemClientData(GTKGetIndexFor(itercur), clientData, i, type); + } - if (m_widgetStyle) ApplyWidgetStyle(); + UpdateOldSelections(); - gtk_signal_connect( GTK_OBJECT(list_item), - "button_press_event", - (GtkSignalFunc)gtk_listbox_button_press_callback, - (gpointer) this ); + return pos + numItems - 1; +} - if (m_hasCheckBoxes) - { - gtk_signal_connect( GTK_OBJECT(list_item), - "key_press_event", - (GtkSignalFunc)gtk_listbox_key_press_callback, - (gpointer)this ); - } +// ---------------------------------------------------------------------------- +// deleting items +// ---------------------------------------------------------------------------- - gtk_widget_show( list_item ); +void wxListBox::DoClear() +{ + wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") ); - ConnectWidget( list_item ); + GTKDisableEvents(); // just in case -#if wxUSE_DRAG_AND_DROP -#ifndef NEW_GTK_DND_CODE - if (m_dropTarget) m_dropTarget->RegisterWidget( list_item ); -#endif -#endif + InvalidateBestSize(); -#if wxUSE_TOOLTIPS - if (m_toolTip) m_toolTip->Apply( this ); -#endif + gtk_list_store_clear( m_liststore ); /* well, THAT was easy :) */ + + GTKEnableEvents(); } -void wxListBox::Append( const wxString &item ) +void wxListBox::DoDeleteOneItem(unsigned int n) { - m_clientDataList.Append( (wxObject*) NULL ); - m_clientObjectList.Append( (wxObject*) NULL ); + wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") ); - AppendCommon( item ); -} + InvalidateBestSize(); -void wxListBox::Append( const wxString &item, void *clientData ) -{ - m_clientDataList.Append( (wxObject*) clientData ); - m_clientObjectList.Append( (wxObject*) NULL ); + GTKDisableEvents(); // just in case + + GtkTreeIter iter; + wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("wrong listbox index") ); - AppendCommon( item ); + // 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(); } -void wxListBox::Append( const wxString &item, wxClientData *clientData ) +// ---------------------------------------------------------------------------- +// helper functions for working with iterators +// ---------------------------------------------------------------------------- + +bool wxListBox::GTKGetIteratorFor(unsigned pos, GtkTreeIter *iter) const { - m_clientObjectList.Append( (wxObject*) clientData ); - m_clientDataList.Append( (wxObject*) NULL ); + if ( !gtk_tree_model_iter_nth_child(GTK_TREE_MODEL(m_liststore), + iter, NULL, pos) ) + { + wxLogDebug(wxT("gtk_tree_model_iter_nth_child(%u) failed"), pos); + return false; + } - AppendCommon( item ); + return true; } -void wxListBox::SetClientData( int n, void* clientData ) +int wxListBox::GTKGetIndexFor(GtkTreeIter& iter) const { - wxCHECK_RET( m_widget != NULL, "invalid combobox" ); + GtkTreePath *path = + gtk_tree_model_get_path(GTK_TREE_MODEL(m_liststore), &iter); - wxNode *node = m_clientDataList.Nth( n ); - if (!node) return; + gint* pIntPath = gtk_tree_path_get_indices(path); - node->SetData( (wxObject*) clientData ); -} + wxCHECK_MSG( pIntPath, wxNOT_FOUND, wxT("failed to get iterator path") ); -void* wxListBox::GetClientData( int n ) -{ - wxCHECK_MSG( m_widget != NULL, NULL, "invalid combobox" ); + int idx = pIntPath[0]; - wxNode *node = m_clientDataList.Nth( n ); - if (!node) return NULL; + gtk_tree_path_free( path ); - return node->Data(); + return idx; } -void wxListBox::SetClientObject( int n, wxClientData* clientData ) +// get GtkTreeEntry from position (note: you need to g_unref it if valid) +GtkTreeEntry *wxListBox::GTKGetEntry(unsigned n) const { - wxCHECK_RET( m_widget != NULL, "invalid combobox" ); + GtkTreeIter iter; + if ( !GTKGetIteratorFor(n, &iter) ) + return NULL; - wxNode *node = m_clientObjectList.Nth( n ); - if (!node) return; - - wxClientData *cd = (wxClientData*) node->Data(); - if (cd) delete cd; + return GetEntry(m_liststore, &iter, this); +} - node->SetData( (wxObject*) clientData ); +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); + } } -wxClientData* wxListBox::GetClientObject( int n ) +// ---------------------------------------------------------------------------- +// client data +// ---------------------------------------------------------------------------- + +void* wxListBox::DoGetItemClientData(unsigned int n) const { - wxCHECK_MSG( m_widget != NULL, (wxClientData*)NULL, "invalid combobox" ); + wxCHECK_MSG( IsValid(n), NULL, + wxT("Invalid index passed to GetItemClientData") ); - wxNode *node = m_clientObjectList.Nth( n ); - if (!node) return (wxClientData*) NULL; + wxGtkObject entry(GTKGetEntry(n)); + wxCHECK_MSG(entry, NULL, wxT("could not get entry")); - return (wxClientData*) node->Data(); + return gtk_tree_entry_get_userdata( entry ); } -void wxListBox::Clear() +void wxListBox::DoSetItemClientData(unsigned int n, void* clientData) { - wxCHECK_RET( m_list != NULL, "invalid listbox" ); - - gtk_list_clear_items( m_list, 0, Number() ); + wxCHECK_RET( IsValid(n), + wxT("Invalid index passed to SetItemClientData") ); - wxNode *node = m_clientObjectList.First(); - while (node) - { - wxClientData *cd = (wxClientData*)node->Data(); - if (cd) delete cd; - node = node->Next(); - } - m_clientObjectList.Clear(); + wxGtkObject entry(GTKGetEntry(n)); + wxCHECK_RET(entry, wxT("could not get entry")); - m_clientDataList.Clear(); + gtk_tree_entry_set_userdata( entry, clientData ); } -void wxListBox::Delete( int n ) +// ---------------------------------------------------------------------------- +// string list access +// ---------------------------------------------------------------------------- + +void wxListBox::SetString(unsigned int n, const wxString& label) { - wxCHECK_RET( m_list != NULL, "invalid listbox" ); + wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetString") ); + wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") ); - GList *child = g_list_nth( m_list->children, n ); + GtkTreeEntry* entry = GTKGetEntry(n); + wxCHECK_RET( entry, wxT("wrong listbox index") ); - wxCHECK_RET( child, "wrong listbox index" ); + // update the item itself + gtk_tree_entry_set_label(entry, wxGTK_CONV(label)); - GList *list = g_list_append( (GList*) NULL, child->data ); - gtk_list_remove_items( m_list, list ); - g_list_free( list ); + // and update the model which will refresh the tree too + GtkTreeIter iter; + wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("failed to get iterator") ); - wxNode *node = m_clientObjectList.Nth( n ); - if (node) - { - wxClientData *cd = (wxClientData*)node->Data(); - if (cd) delete cd; - m_clientObjectList.DeleteNode( node ); - } + // FIXME: this resets the checked status of a wxCheckListBox item - node = m_clientDataList.Nth( n ); - if (node) - { - m_clientDataList.DeleteNode( node ); - } + GTKSetItem(iter, entry); } -void wxListBox::Deselect( int n ) +wxString wxListBox::GetString(unsigned int n) const { - wxCHECK_RET( m_list != NULL, "invalid listbox" ); + wxCHECK_MSG( m_treeview != NULL, wxEmptyString, wxT("invalid listbox") ); + + wxGtkObject entry(GTKGetEntry(n)); + wxCHECK_MSG( entry, wxEmptyString, wxT("wrong listbox index") ); - gtk_list_unselect_item( m_list, n ); + return wxGTK_CONV_BACK( gtk_tree_entry_get_label(entry) ); } -int wxListBox::FindString( const wxString &item ) const +unsigned int wxListBox::GetCount() const { - wxCHECK_MSG( m_list != NULL, -1, "invalid listbox" ); + wxCHECK_MSG( m_treeview != NULL, 0, wxT("invalid listbox") ); - GList *child = m_list->children; - int count = 0; - while (child) - { - GtkBin *bin = GTK_BIN( child->data ); - GtkLabel *label = GTK_LABEL( bin->child ); + return (unsigned int)gtk_tree_model_iter_n_children(GTK_TREE_MODEL(m_liststore), NULL); +} - wxString str = label->label; - if (m_hasCheckBoxes) str.Remove( 0, 4 ); +int wxListBox::FindString( const wxString &item, bool bCase ) const +{ + wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") ); - if (str == item) return count; + //Sort of hackish - maybe there is a faster way + unsigned int nCount = wxListBox::GetCount(); - count++; - child = child->next; + for(unsigned int i = 0; i < nCount; ++i) + { + if( item.IsSameAs( wxListBox::GetString(i), bCase ) ) + return (int)i; } - // it's not an error if the string is not found -> no wxCHECK - return -1; + // it's not an error if the string is not found -> no wxCHECK + return wxNOT_FOUND; } -int wxListBox::GetSelection() const -{ - wxCHECK_MSG( m_list != NULL, -1, "invalid listbox" ); +// ---------------------------------------------------------------------------- +// selection +// ---------------------------------------------------------------------------- - GList *child = m_list->children; - int count = 0; - while (child) - { - if (GTK_WIDGET(child->data)->state == GTK_STATE_SELECTED) return count; - count++; - child = child->next; - } - return -1; +void wxListBox::GTKOnActivated(int item) +{ + SendEvent(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, item, IsSelected(item)); } -int wxListBox::GetSelections( wxArrayInt& aSelections ) const +void wxListBox::GTKOnSelectionChanged() { - wxCHECK_MSG( m_list != NULL, -1, "invalid listbox" ); - - // get the number of selected items first - GList *child = m_list->children; - int count = 0; - for (child = m_list->children; child != NULL; child = child->next) + if ( HasFlag(wxLB_MULTIPLE | wxLB_EXTENDED) ) { - if (GTK_WIDGET(child->data)->state == GTK_STATE_SELECTED) - count++; + CalcAndSendEvent(); } - - aSelections.Empty(); - - if (count > 0) + else // single selection { - // now fill the list - aSelections.Alloc(count); // optimization attempt - int i = 0; - for (child = m_list->children; child != NULL; child = child->next, i++) - { - if (GTK_WIDGET(child->data)->state == GTK_STATE_SELECTED) - aSelections.Add(i); - } + const int item = GetSelection(); + if ( DoChangeSingleSelection(item) ) + SendEvent(wxEVT_COMMAND_LISTBOX_SELECTED, item, true); } - - return count; } -wxString wxListBox::GetString( int n ) const +int wxListBox::GetSelection() const { - wxCHECK_MSG( m_list != NULL, "", "invalid listbox" ); + wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox")); + wxCHECK_MSG( HasFlag(wxLB_SINGLE), wxNOT_FOUND, + wxT("must be single selection listbox")); - GList *child = g_list_nth( m_list->children, n ); - if (child) - { - GtkBin *bin = GTK_BIN( child->data ); - GtkLabel *label = GTK_LABEL( bin->child ); + GtkTreeIter iter; + GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview); - wxString str = label->label; - if (m_hasCheckBoxes) str.Remove( 0, 4 ); + // only works on single-sel + if (!gtk_tree_selection_get_selected(selection, NULL, &iter)) + return wxNOT_FOUND; - return str; - } - wxFAIL_MSG("wrong listbox index"); - return ""; + return GTKGetIndexFor(iter); } -wxString wxListBox::GetStringSelection() const +int wxListBox::GetSelections( wxArrayInt& aSelections ) const { - wxCHECK_MSG( m_list != NULL, "", "invalid listbox" ); + wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") ); - GList *selection = m_list->selection; - if (selection) - { - GtkBin *bin = GTK_BIN( selection->data ); - GtkLabel *label = GTK_LABEL( bin->child ); + aSelections.Empty(); + + int i = 0; + GtkTreeIter iter; + GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview); - wxString str = label->label; - if (m_hasCheckBoxes) str.Remove( 0, 4 ); + if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(m_liststore), &iter)) + { //gtk_tree_selection_get_selected_rows is GTK 2.2+ so iter instead + do + { + if (gtk_tree_selection_iter_is_selected(selection, &iter)) + aSelections.Add(i); - return str; + i++; + } while(gtk_tree_model_iter_next(GTK_TREE_MODEL(m_liststore), &iter)); } - wxFAIL_MSG("no listbox selection available"); - return ""; + return aSelections.GetCount(); } -int wxListBox::Number() +bool wxListBox::IsSelected( int n ) const { - wxCHECK_MSG( m_list != NULL, -1, "invalid listbox" ); + wxCHECK_MSG( m_treeview != NULL, false, wxT("invalid listbox") ); + + GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview); - GList *child = m_list->children; - int count = 0; - while (child) { count++; child = child->next; } - return count; + GtkTreeIter iter; + wxCHECK_MSG( GTKGetIteratorFor(n, &iter), false, wxT("Invalid index") ); + + return gtk_tree_selection_iter_is_selected(selection, &iter); } -bool wxListBox::Selected( int n ) +void wxListBox::DoSetSelection( int n, bool select ) { - wxCHECK_MSG( m_list != NULL, FALSE, "invalid listbox" ); + wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") ); + + GTKDisableEvents(); - GList *target = g_list_nth( m_list->children, n ); - if (target) + GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview); + + // passing -1 to SetSelection() is documented to deselect all items + if ( n == wxNOT_FOUND ) { - GList *child = m_list->selection; - while (child) - { - if (child->data == target->data) return TRUE; - child = child->next; - } + gtk_tree_selection_unselect_all(selection); + GTKEnableEvents(); + return; } - wxFAIL_MSG("wrong listbox index"); - return FALSE; -} - -void wxListBox::Set( int WXUNUSED(n), const wxString *WXUNUSED(choices) ) -{ - wxFAIL_MSG("wxListBox::Set not implemented"); -} -void wxListBox::SetFirstItem( int WXUNUSED(n) ) -{ - wxFAIL_MSG("wxListBox::SetFirstItem not implemented"); -} + wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetSelection") ); -void wxListBox::SetFirstItem( const wxString &WXUNUSED(item) ) -{ - wxFAIL_MSG("wxListBox::SetFirstItem not implemented"); -} -void wxListBox::SetSelection( int n, bool select ) -{ - wxCHECK_RET( m_list != NULL, "invalid listbox" ); + GtkTreeIter iter; + wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("Invalid index") ); if (select) - gtk_list_select_item( m_list, n ); + gtk_tree_selection_select_iter(selection, &iter); else - gtk_list_unselect_item( m_list, n ); -} + gtk_tree_selection_unselect_iter(selection, &iter); -void wxListBox::SetString( int n, const wxString &string ) -{ - wxCHECK_RET( m_list != NULL, "invalid listbox" ); + GtkTreePath* path = gtk_tree_model_get_path( + GTK_TREE_MODEL(m_liststore), &iter); - GList *child = g_list_nth( m_list->children, n ); - if (child) - { - GtkBin *bin = GTK_BIN( child->data ); - GtkLabel *label = GTK_LABEL( bin->child ); + gtk_tree_view_scroll_to_cell(m_treeview, path, NULL, FALSE, 0.0f, 0.0f); - wxString str; - if (m_hasCheckBoxes) str += "[-] "; - str += string; + gtk_tree_path_free(path); - gtk_label_set( label, str ); - } - else - { - wxFAIL_MSG("wrong listbox index"); - } + GTKEnableEvents(); } -void wxListBox::SetStringSelection( const wxString &string, bool select ) +void wxListBox::DoScrollToCell(int n, float alignY, float alignX) { - wxCHECK_RET( m_list != NULL, "invalid listbox" ); + 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)) + return; + + GtkTreeIter iter; + if ( !GTKGetIteratorFor(n, &iter) ) + return; - SetSelection( FindString(string), select ); + 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, alignY, alignX); + + gtk_tree_path_free(path); } -int wxListBox::GetIndex( GtkWidget *item ) const +void wxListBox::DoSetFirstItem(int n) { - if (item) - { - GList *child = m_list->children; - int count = 0; - while (child) - { - if (GTK_WIDGET(child->data) == item) return count; - count++; - child = child->next; - } - } - return -1; + DoScrollToCell(n, 0, 0); } -#if wxUSE_TOOLTIPS -void wxListBox::ApplyToolTip( GtkTooltips *tips, const char *tip ) +void wxListBox::EnsureVisible(int n) { - GList *child = m_list->children; - while (child) - { - gtk_tooltips_set_tip( tips, GTK_WIDGET( child->data ), tip, (gchar*) NULL ); - child = child->next; - } + DoScrollToCell(n, 0.5, 0); } -#endif // wxUSE_TOOLTIPS -#if wxUSE_DRAG_AND_DROP -void wxListBox::SetDropTarget( wxDropTarget *dropTarget ) +// ---------------------------------------------------------------------------- +// hittest +// ---------------------------------------------------------------------------- + +int wxListBox::DoListHitTest(const wxPoint& point) const { - wxCHECK_RET( m_list != NULL, "invalid listbox" ); + // 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), + &binx, &biny, NULL, NULL, NULL); -#ifndef NEW_GTK_DND_CODE - if (m_dropTarget) + GtkTreePath* path; + if ( !gtk_tree_view_get_path_at_pos + ( + m_treeview, + point.x - binx, + point.y - biny, + &path, + NULL, // [out] column (always 0 here) + NULL, // [out] x-coord relative to the cell (not interested) + NULL // [out] y-coord relative to the cell + ) ) { - GList *child = m_list->children; - while (child) - { - m_dropTarget->UnregisterWidget( GTK_WIDGET( child->data ) ); - child = child->next; - } + return wxNOT_FOUND; } -#endif - wxWindow::SetDropTarget( dropTarget ); + int index = gtk_tree_path_get_indices(path)[0]; + gtk_tree_path_free(path); -#ifndef NEW_GTK_DND_CODE - if (m_dropTarget) - { - GList *child = m_list->children; - while (child) - { - m_dropTarget->RegisterWidget( GTK_WIDGET( child->data ) ); - child = child->next; - } - } -#endif + return index; } -#endif + +// ---------------------------------------------------------------------------- +// helpers +// ---------------------------------------------------------------------------- + +#if wxUSE_TOOLTIPS +void wxListBox::GTKApplyToolTip( GtkTooltips *tips, const gchar *tip ) +{ + // RN: Is this needed anymore? + gtk_tooltips_set_tip( tips, GTK_WIDGET( m_treeview ), tip, NULL ); +} +#endif // wxUSE_TOOLTIPS GtkWidget *wxListBox::GetConnectWidget() { - return GTK_WIDGET(m_list); + // the correct widget for listbox events (such as mouse clicks for example) + // is m_treeview, not the parent scrolled window + return GTK_WIDGET(m_treeview); } -bool wxListBox::IsOwnGtkWindow( GdkWindow *window ) +GdkWindow *wxListBox::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const { - if (wxWindow::IsOwnGtkWindow( window )) return TRUE; + return gtk_tree_view_get_bin_window(m_treeview); +} - GList *child = m_list->children; - while (child) +void wxListBox::DoApplyWidgetStyle(GtkRcStyle *style) +{ + if (m_hasBgCol && m_backgroundColour.Ok()) { - GtkWidget *bin = GTK_WIDGET( child->data ); - if (bin->window == window) return TRUE; - child = child->next; + GdkWindow *window = gtk_tree_view_get_bin_window(m_treeview); + if (window) + { + m_backgroundColour.CalcPixel( gdk_drawable_get_colormap( window ) ); + gdk_window_set_background( window, m_backgroundColour.GetColor() ); + gdk_window_clear( window ); + } } - return FALSE; + gtk_widget_modify_style( GTK_WIDGET(m_treeview), style ); } -void wxListBox::ApplyWidgetStyle() +wxSize wxListBox::DoGetBestSize() const { - SetWidgetStyle(); + wxCHECK_MSG(m_treeview, wxDefaultSize, wxT("invalid tree view")); - if (m_backgroundColour.Ok()) + // Start with a minimum size that's not too small + int cx, cy; + GetTextExtent( wxT("X"), &cx, &cy); + int lbWidth = 0; + int lbHeight = 10; + + // Find the widest string. + const unsigned int count = GetCount(); + if ( count ) { - GdkWindow *window = GTK_WIDGET(m_list)->window; - m_backgroundColour.CalcPixel( gdk_window_get_colormap( window ) ); - gdk_window_set_background( window, m_backgroundColour.GetColor() ); - gdk_window_clear( window ); + int wLine; + for ( unsigned int i = 0; i < count; i++ ) + { + GetTextExtent(GetString(i), &wLine, NULL); + if ( wLine > lbWidth ) + lbWidth = wLine; + } } - GList *child = m_list->children; - while (child) + 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 ) { - gtk_widget_set_style( GTK_WIDGET(child->data), m_widgetStyle ); + lbWidth += 35; + cy = cy > 25 ? cy : 25; // rough height of checkbox + } +#endif - GtkBin *bin = GTK_BIN( child->data ); - GtkWidget *label = GTK_WIDGET( bin->child ); - gtk_widget_set_style( label, m_widgetStyle ); + // Add room for the scrollbar + lbWidth += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X); - child = child->next; - } + // 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; +} + +// static +wxVisualAttributes +wxListBox::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant)) +{ + return GetDefaultAttributesFromGTKWidget(gtk_tree_view_new, true); } +#endif // wxUSE_LISTBOX