src/gtk/listbox.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/listbox.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Modified By: Ryan Norton (GtkTreeView implementation)
   6 // Id:          $Id$
   7 // Copyright:   (c) 1998 Robert Roebling
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 // For compilers that support precompilation, includes "wx.h".
  12 #include "wx/wxprec.h"
  13
  14 #if wxUSE_LISTBOX
  15
  16 #include "wx/listbox.h"
  17
  18 #ifndef WX_PRECOMP
  19     #include "wx/dynarray.h"
  20     #include "wx/intl.h"
  21     #include "wx/log.h"
  22     #include "wx/utils.h"
  23     #include "wx/settings.h"
  24     #include "wx/checklst.h"
  25     #include "wx/arrstr.h"
  26 #endif
  27
  28 #include "wx/gtk/private.h"
  29 #include "wx/gtk/treeentry_gtk.h"
  30
  31 #if wxUSE_TOOLTIPS
  32     #include "wx/tooltip.h"
  33 #endif
  34
  35 #include <gdk/gdk.h>
  36 #include <gtk/gtk.h>
  37 #include <gdk/gdkkeysyms.h>
  38
  39 //-----------------------------------------------------------------------------
  40 // data
  41 //-----------------------------------------------------------------------------
  42
  43 extern bool           g_blockEventsOnDrag;
  44 extern bool           g_blockEventsOnScroll;
  45
  46
  47
  48 //-----------------------------------------------------------------------------
  49 // Macro to tell which row the strings are in (1 if native checklist, 0 if not)
  50 //-----------------------------------------------------------------------------
  51
  52 #if wxUSE_CHECKLISTBOX
  53 #   define WXLISTBOX_DATACOLUMN_ARG(x)  (x->m_hasCheckBoxes ? 1 : 0)
  54 #else
  55 #   define WXLISTBOX_DATACOLUMN_ARG(x)  (0)
  56 #endif // wxUSE_CHECKLISTBOX
  57
  58 #define WXLISTBOX_DATACOLUMN    WXLISTBOX_DATACOLUMN_ARG(this)
  59
  60 //-----------------------------------------------------------------------------
  61 // "row-activated"
  62 //-----------------------------------------------------------------------------
  63
  64 extern "C" {
  65 static void
  66 gtk_listbox_row_activated_callback(GtkTreeView        *treeview,
  67                                    GtkTreePath        *path,
  68                                    GtkTreeViewColumn  *col,
  69                                    wxListBox          *listbox)
  70 {
  71     if (g_isIdle) wxapp_install_idle_handler();
  72
  73     if (g_blockEventsOnDrag) return;
  74     if (g_blockEventsOnScroll) return;
  75
  76     // This is triggered by either a double-click or a space press
  77
  78     int sel = gtk_tree_path_get_indices(path)[0];
  79
  80     wxCommandEvent event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, listbox->GetId() );
  81     event.SetEventObject( listbox );
  82
  83     if (listbox->IsSelected(sel))
  84     {
  85         GtkTreeEntry* entry = listbox->GtkGetEntry(sel);
  86
  87         if (entry)
  88         {
  89             event.SetInt(sel);
  90             event.SetString(wxConvUTF8.cMB2WX(gtk_tree_entry_get_label(entry)));
  91
  92             if ( listbox->HasClientObjectData() )
  93                 event.SetClientObject( (wxClientData*) gtk_tree_entry_get_userdata(entry) );
  94             else if ( listbox->HasClientUntypedData() )
  95                 event.SetClientData( gtk_tree_entry_get_userdata(entry) );
  96
  97             g_object_unref (entry);
  98         }
  99         else
 100         {
 101             wxLogSysError(wxT("Internal error - could not get entry for double-click"));
 102             event.SetInt(-1);
 103         }
 104     }
 105     else
 106     {
 107         event.SetInt(-1);
 108     }
 109
 110     listbox->GetEventHandler()->ProcessEvent( event );
 111 }
 112 }
 113
 114 //-----------------------------------------------------------------------------
 115 // "key_press_event"
 116 //-----------------------------------------------------------------------------
 117
 118 extern "C" {
 119 static gint
 120 gtk_listbox_key_press_callback( GtkWidget *widget,
 121                                 GdkEventKey *gdk_event,
 122                                 wxListBox *listbox )
 123 {
 124     if (g_blockEventsOnDrag) return FALSE;
 125
 126     if ((gdk_event->keyval == GDK_Tab) || (gdk_event->keyval == GDK_ISO_Left_Tab))
 127     {
 128         wxNavigationKeyEvent new_event;
 129         /* GDK reports GDK_ISO_Left_Tab for SHIFT-TAB */
 130         new_event.SetDirection( (gdk_event->keyval == GDK_Tab) );
 131         /* CTRL-TAB changes the (parent) window, i.e. switch notebook page */
 132         new_event.SetWindowChange( (gdk_event->state & GDK_CONTROL_MASK) );
 133         new_event.SetCurrentFocus( listbox );
 134         if (listbox->GetEventHandler()->ProcessEvent( new_event ))
 135             return TRUE;
 136     }
 137
 138     return FALSE;
 139 }
 140 }
 141
 142 //-----------------------------------------------------------------------------
 143 // "changed"
 144 //-----------------------------------------------------------------------------
 145
 146 extern "C" {
 147 static void
 148 gtk_listitem_changed_callback( GtkTreeSelection* selection, wxListBox *listbox )
 149 {
 150     if (g_blockEventsOnDrag) return;
 151
 152     if (listbox->m_blockEvent) return;
 153
 154     wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, listbox->GetId() );
 155     event.SetEventObject( listbox );
 156
 157     if (listbox->HasFlag(wxLB_MULTIPLE) || listbox->HasFlag(wxLB_EXTENDED))
 158     {
 159         wxArrayInt selections;
 160         listbox->GetSelections( selections );
 161
 162         if (selections.GetCount() == 0)
 163         {
 164             // indicate that this is a deselection
 165             event.SetExtraLong( 0 );
 166             event.SetInt( -1 );
 167
 168             listbox->GetEventHandler()->ProcessEvent( event );
 169
 170             return;
 171         }
 172         else
 173         {
 174             // indicate that this is a selection
 175             event.SetExtraLong( 1 );
 176             event.SetInt( selections[0] );
 177
 178             listbox->GetEventHandler()->ProcessEvent( event );
 179         }
 180     }
 181     else
 182     {
 183         int index = listbox->GetSelection();
 184         if (index == wxNOT_FOUND)
 185         {
 186             // indicate that this is a deselection
 187             event.SetExtraLong( 0 );
 188             event.SetInt( -1 );
 189
 190             listbox->GetEventHandler()->ProcessEvent( event );
 191
 192             return;
 193         }
 194         else
 195         {
 196             GtkTreeEntry* entry = listbox->GtkGetEntry( index );
 197
 198             // indicate that this is a selection
 199             event.SetExtraLong( 1 );
 200
 201             event.SetInt( index );
 202             event.SetString(wxConvUTF8.cMB2WX(gtk_tree_entry_get_label(entry)));
 203
 204             if ( listbox->HasClientObjectData() )
 205                 event.SetClientObject(
 206                     (wxClientData*) gtk_tree_entry_get_userdata(entry)
 207                                  );
 208             else if ( listbox->HasClientUntypedData() )
 209                 event.SetClientData( gtk_tree_entry_get_userdata(entry) );
 210
 211             listbox->GetEventHandler()->ProcessEvent( event );
 212
 213             g_object_unref (entry);
 214         }
 215     }
 216 }
 217 }
 218
 219 //-----------------------------------------------------------------------------
 220 // GtkTreeEntry destruction (to destroy client data)
 221 //-----------------------------------------------------------------------------
 222
 223 extern "C" {
 224 static void gtk_tree_entry_destroy_cb(GtkTreeEntry* entry,
 225                                       wxListBox* listbox)
 226 {
 227     if (listbox->HasClientObjectData())
 228     {
 229         gpointer userdata = gtk_tree_entry_get_userdata(entry);
 230         if (userdata)
 231             delete (wxClientData *)userdata;
 232     }
 233 }
 234 }
 235
 236 //-----------------------------------------------------------------------------
 237 // Sorting callback (standard CmpNoCase return value)
 238 //-----------------------------------------------------------------------------
 239
 240 extern "C" {
 241 static gint gtk_listbox_sort_callback(GtkTreeModel *model,
 242                                       GtkTreeIter  *a,
 243                                       GtkTreeIter  *b,
 244                                       wxListBox    *listbox)
 245 {
 246     GtkTreeEntry* entry;
 247     GtkTreeEntry* entry2;
 248
 249     gtk_tree_model_get(GTK_TREE_MODEL(listbox->m_liststore),
 250                              a,
 251                              WXLISTBOX_DATACOLUMN_ARG(listbox),
 252                              &entry, -1);
 253     gtk_tree_model_get(GTK_TREE_MODEL(listbox->m_liststore),
 254                              b,
 255                              WXLISTBOX_DATACOLUMN_ARG(listbox),
 256                              &entry2, -1);
 257     wxCHECK_MSG(entry, 0, wxT("Could not get entry"));
 258     wxCHECK_MSG(entry2, 0, wxT("Could not get entry2"));
 259
 260     //We compare collate keys here instead of calling g_utf8_collate
 261     //as it is rather slow (and even the docs reccommend this)
 262     int ret = strcasecmp(gtk_tree_entry_get_collate_key(entry),
 263                          gtk_tree_entry_get_collate_key(entry2));
 264
 265     g_object_unref (entry);
 266     g_object_unref (entry2);
 267
 268     return ret;
 269 }
 270 }
 271
 272 //-----------------------------------------------------------------------------
 273 // Searching callback (TRUE == not equal, FALSE == equal)
 274 //-----------------------------------------------------------------------------
 275
 276 extern "C" {
 277 static gboolean gtk_listbox_searchequal_callback(GtkTreeModel* model,
 278                                                  gint column,
 279                                                  const gchar* key,
 280                                                  GtkTreeIter* iter,
 281                                                  wxListBox* listbox)
 282 {
 283     GtkTreeEntry* entry;
 284
 285     gtk_tree_model_get(GTK_TREE_MODEL(listbox->m_liststore),
 286                              iter,
 287                              WXLISTBOX_DATACOLUMN_ARG(listbox),
 288                              &entry, -1);
 289     wxCHECK_MSG(entry, 0, wxT("Could not get entry"));
 290     wxGtkString keycollatekey(g_utf8_collate_key(key, -1));
 291
 292     int ret = strcasecmp(keycollatekey,
 293                          gtk_tree_entry_get_collate_key(entry));
 294
 295     g_object_unref (entry);
 296
 297     return ret != 0;
 298 }
 299 }
 300
 301 //-----------------------------------------------------------------------------
 302 // wxListBox
 303 //-----------------------------------------------------------------------------
 304
 305 IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControl)
 306
 307 // ----------------------------------------------------------------------------
 308 // construction
 309 // ----------------------------------------------------------------------------
 310
 311 void wxListBox::Init()
 312 {
 313     m_treeview = (GtkTreeView*) NULL;
 314 #if wxUSE_CHECKLISTBOX
 315     m_hasCheckBoxes = false;
 316 #endif // wxUSE_CHECKLISTBOX
 317 }
 318
 319 bool wxListBox::Create( wxWindow *parent, wxWindowID id,
 320                         const wxPoint &pos, const wxSize &size,
 321                         const wxArrayString& choices,
 322                         long style, const wxValidator& validator,
 323                         const wxString &name )
 324 {
 325     wxCArrayString chs(choices);
 326
 327     return Create( parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
 328                    style, validator, name );
 329 }
 330
 331 bool wxListBox::Create( wxWindow *parent, wxWindowID id,
 332                         const wxPoint &pos, const wxSize &size,
 333                         int n, const wxString choices[],
 334                         long style, const wxValidator& validator,
 335                         const wxString &name )
 336 {
 337     m_needParent = true;
 338     m_blockEvent = false;
 339
 340     if (!PreCreation( parent, pos, size ) ||
 341         !CreateBase( parent, id, pos, size, style, validator, name ))
 342     {
 343         wxFAIL_MSG( wxT("wxListBox creation failed") );
 344         return false;
 345     }
 346
 347     m_widget = gtk_scrolled_window_new( (GtkAdjustment*) NULL, (GtkAdjustment*) NULL );
 348     if (style & wxLB_ALWAYS_SB)
 349     {
 350       gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
 351         GTK_POLICY_AUTOMATIC, GTK_POLICY_ALWAYS );
 352     }
 353     else
 354     {
 355       gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
 356         GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
 357     }
 358
 359
 360     GtkScrolledWindowSetBorder(m_widget, style);
 361
 362     m_treeview = GTK_TREE_VIEW( gtk_tree_view_new( ) );
 363
 364     //wxListBox doesn't have a header :)
 365     //NB: If enabled SetFirstItem doesn't work correctly
 366     gtk_tree_view_set_headers_visible(m_treeview, FALSE);
 367
 368 #if wxUSE_CHECKLISTBOX
 369     if(m_hasCheckBoxes)
 370         ((wxCheckListBox*)this)->DoCreateCheckList();
 371 #endif // wxUSE_CHECKLISTBOX
 372
 373     // Create the data column
 374     gtk_tree_view_insert_column_with_attributes(m_treeview, -1, "",
 375                                                 gtk_cell_renderer_text_new(),
 376                                                 "text",
 377                                                 WXLISTBOX_DATACOLUMN, NULL);
 378
 379     // Now create+set the model (GtkListStore) - first argument # of columns
 380 #if wxUSE_CHECKLISTBOX
 381     if(m_hasCheckBoxes)
 382         m_liststore = gtk_list_store_new(2, G_TYPE_BOOLEAN,
 383                                             GTK_TYPE_TREE_ENTRY);
 384     else
 385 #endif
 386         m_liststore = gtk_list_store_new(1, GTK_TYPE_TREE_ENTRY);
 387
 388     gtk_tree_view_set_model(m_treeview, GTK_TREE_MODEL(m_liststore));
 389
 390     g_object_unref (m_liststore); //free on treeview destruction
 391
 392     // Disable the pop-up textctrl that enables searching - note that
 393     // the docs specify that even if this disabled (which we are doing)
 394     // the user can still have it through the start-interactive-search
 395     // key binding...either way we want to provide a searchequal callback
 396     // NB: If this is enabled a doubleclick event (activate) gets sent
 397     //     on a successful search
 398     gtk_tree_view_set_search_column(m_treeview, WXLISTBOX_DATACOLUMN);
 399     gtk_tree_view_set_search_equal_func(m_treeview,
 400        (GtkTreeViewSearchEqualFunc) gtk_listbox_searchequal_callback,
 401                                         this,
 402                                         NULL);
 403
 404     gtk_tree_view_set_enable_search(m_treeview, FALSE);
 405
 406
 407     GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
 408
 409     g_signal_connect_after (selection, "changed",
 410                             G_CALLBACK (gtk_listitem_changed_callback), this);
 411
 412     GtkSelectionMode mode;
 413     if (style & wxLB_MULTIPLE)
 414     {
 415         mode = GTK_SELECTION_MULTIPLE;
 416     }
 417     else if (style & wxLB_EXTENDED)
 418     {
 419         mode = GTK_SELECTION_EXTENDED;
 420     }
 421     else
 422     {
 423         // if style was 0 set single mode
 424         m_windowStyle |= wxLB_SINGLE;
 425         mode = GTK_SELECTION_SINGLE;
 426     }
 427
 428     gtk_tree_selection_set_mode( selection, mode );
 429
 430     // Handle sortable stuff
 431     if(style & wxLB_SORT)
 432     {
 433         // Setup sorting in ascending (wx) order
 434         gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(m_liststore),
 435                                              WXLISTBOX_DATACOLUMN,
 436                                              GTK_SORT_ASCENDING);
 437
 438         // Set the sort callback
 439         gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(m_liststore),
 440                                         WXLISTBOX_DATACOLUMN,
 441                    (GtkTreeIterCompareFunc) gtk_listbox_sort_callback,
 442                                         this, //userdata
 443                                         NULL //"destroy notifier"
 444                                        );
 445     }
 446
 447
 448     gtk_container_add (GTK_CONTAINER (m_widget), GTK_WIDGET(m_treeview) );
 449
 450     gtk_widget_show( GTK_WIDGET(m_treeview) );
 451     m_focusWidget = GTK_WIDGET(m_treeview);
 452
 453     wxListBox::DoInsertItems(wxArrayString(n, choices), 0); // insert initial items
 454
 455     // generate dclick events
 456     g_signal_connect_after(m_treeview, "row-activated",
 457                      G_CALLBACK(gtk_listbox_row_activated_callback), this);
 458
 459     // for panel navigation
 460     g_signal_connect (m_treeview, "key_press_event",
 461                       G_CALLBACK (gtk_listbox_key_press_callback),
 462                            this);
 463
 464     m_parent->DoAddChild( this );
 465
 466     PostCreation(size);
 467     SetInitialSize(size); // need this too because this is a wxControlWithItems
 468
 469     return true;
 470 }
 471
 472 wxListBox::~wxListBox()
 473 {
 474     m_hasVMT = false;
 475
 476     Clear();
 477 }
 478
 479 // ----------------------------------------------------------------------------
 480 // adding items
 481 // ----------------------------------------------------------------------------
 482
 483 void wxListBox::GtkInsertItems(const wxArrayString& items,
 484                                void** clientData, unsigned int pos)
 485 {
 486     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 487
 488     InvalidateBestSize();
 489
 490     // Create and set column ids and GValues
 491
 492     unsigned int nNum = items.GetCount();
 493     unsigned int nCurCount = wxListBox::GetCount();
 494     wxASSERT_MSG(pos <= nCurCount, wxT("Invalid index passed to wxListBox"));
 495
 496     GtkTreeIter* pIter = NULL; // append by default
 497     GtkTreeIter iter;
 498     if (pos != nCurCount)
 499     {
 500         wxCHECK_RET( GtkGetIteratorFor(pos, &iter),
 501                      wxT("internal wxListBox error in insertion") );
 502
 503         pIter = &iter;
 504     }
 505
 506     for (unsigned int i = 0; i < nNum; ++i)
 507     {
 508         wxString label = items[i];
 509
 510         GtkTreeEntry* entry = gtk_tree_entry_new();
 511         gtk_tree_entry_set_label(entry, wxGTK_CONV(label));
 512         gtk_tree_entry_set_destroy_func(entry,
 513                 (GtkTreeEntryDestroy)gtk_tree_entry_destroy_cb,
 514                             this);
 515
 516         if (clientData)
 517             gtk_tree_entry_set_userdata(entry, clientData[i]);
 518
 519         GtkTreeIter itercur;
 520         gtk_list_store_insert_before(m_liststore, &itercur, pIter);
 521
 522         GtkSetItem(itercur, entry);
 523
 524         g_object_unref (entry);
 525     }
 526 }
 527
 528 void wxListBox::DoInsertItems(const wxArrayString& items, unsigned int pos)
 529 {
 530     wxCHECK_RET( IsValidInsert(pos), wxT("invalid index in wxListBox::InsertItems") );
 531
 532     GtkInsertItems(items, NULL, pos);
 533 }
 534
 535 int wxListBox::DoAppend( const wxString& item )
 536 {
 537     wxCHECK_MSG( m_treeview != NULL, -1, wxT("invalid listbox") );
 538
 539     InvalidateBestSize();
 540
 541     GtkTreeEntry* entry = gtk_tree_entry_new();
 542     gtk_tree_entry_set_label( entry, wxGTK_CONV(item) );
 543     gtk_tree_entry_set_destroy_func(entry,
 544                 (GtkTreeEntryDestroy)gtk_tree_entry_destroy_cb,
 545                             this);
 546
 547     GtkTreeIter itercur;
 548     gtk_list_store_insert_before( m_liststore, &itercur, NULL );
 549
 550     GtkSetItem(itercur, entry);
 551
 552     g_object_unref (entry);
 553
 554     return GtkGetIndexFor(itercur);
 555 }
 556
 557 void wxListBox::DoSetItems( const wxArrayString& items,
 558                             void **clientData)
 559 {
 560     Clear();
 561     GtkInsertItems(items, clientData, 0);
 562 }
 563
 564 // ----------------------------------------------------------------------------
 565 // deleting items
 566 // ----------------------------------------------------------------------------
 567
 568 void wxListBox::Clear()
 569 {
 570     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 571
 572     InvalidateBestSize();
 573
 574     gtk_list_store_clear( m_liststore ); /* well, THAT was easy :) */
 575 }
 576
 577 void wxListBox::Delete(unsigned int n)
 578 {
 579     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 580
 581     InvalidateBestSize();
 582
 583     GtkTreeIter iter;
 584     wxCHECK_RET( GtkGetIteratorFor(n, &iter), wxT("wrong listbox index") );
 585
 586     // this returns false if iter is invalid (e.g. deleting item at end) but
 587     // since we don't use iter, we ignore the return value
 588     gtk_list_store_remove(m_liststore, &iter);
 589 }
 590
 591 // ----------------------------------------------------------------------------
 592 // helper functions for working with iterators
 593 // ----------------------------------------------------------------------------
 594
 595 bool wxListBox::GtkGetIteratorFor(unsigned pos, GtkTreeIter *iter) const
 596 {
 597     if ( !gtk_tree_model_iter_nth_child(GTK_TREE_MODEL(m_liststore),
 598                                         iter, NULL, pos) )
 599     {
 600         wxLogDebug(wxT("gtk_tree_model_iter_nth_child(%u) failed"), pos);
 601         return false;
 602     }
 603
 604     return true;
 605 }
 606
 607 int wxListBox::GtkGetIndexFor(GtkTreeIter& iter) const
 608 {
 609     GtkTreePath *path =
 610         gtk_tree_model_get_path(GTK_TREE_MODEL(m_liststore), &iter);
 611
 612     gint* pIntPath = gtk_tree_path_get_indices(path);
 613
 614     wxCHECK_MSG( pIntPath, wxNOT_FOUND, _T("failed to get iterator path") );
 615
 616     int idx = pIntPath[0];
 617
 618     gtk_tree_path_free( path );
 619
 620     return idx;
 621 }
 622
 623 // get GtkTreeEntry from position (note: you need to g_unref it if valid)
 624 GtkTreeEntry *wxListBox::GtkGetEntry(unsigned n) const
 625 {
 626     GtkTreeIter iter;
 627     if ( !GtkGetIteratorFor(n, &iter) )
 628         return NULL;
 629
 630
 631     GtkTreeEntry* entry = NULL;
 632     gtk_tree_model_get(GTK_TREE_MODEL(m_liststore), &iter,
 633                        WXLISTBOX_DATACOLUMN, &entry, -1);
 634
 635     return entry;
 636 }
 637
 638 void wxListBox::GtkSetItem(GtkTreeIter& iter, const GtkTreeEntry *entry)
 639 {
 640 #if wxUSE_CHECKLISTBOX
 641     if ( m_hasCheckBoxes )
 642     {
 643         gtk_list_store_set(m_liststore, &iter,
 644                            0, FALSE, // FALSE == not toggled
 645                            1, entry,
 646                            -1);
 647     }
 648     else
 649 #endif // wxUSE_CHECKLISTBOX
 650     {
 651         gtk_list_store_set(m_liststore, &iter, 0, entry, -1);
 652     }
 653 }
 654
 655 // ----------------------------------------------------------------------------
 656 // client data
 657 // ----------------------------------------------------------------------------
 658
 659 void* wxListBox::DoGetItemClientData(unsigned int n) const
 660 {
 661     wxCHECK_MSG( IsValid(n), NULL,
 662                  wxT("Invalid index passed to GetItemClientData") );
 663
 664     GtkTreeEntry* entry = GtkGetEntry(n);
 665     wxCHECK_MSG(entry, NULL, wxT("could not get entry"));
 666
 667     void* userdata = gtk_tree_entry_get_userdata( entry );
 668     g_object_unref (entry);
 669     return userdata;
 670 }
 671
 672 wxClientData* wxListBox::DoGetItemClientObject(unsigned int n) const
 673 {
 674     return (wxClientData*) wxListBox::DoGetItemClientData(n);
 675 }
 676
 677 void wxListBox::DoSetItemClientData(unsigned int n, void* clientData)
 678 {
 679     wxCHECK_RET( IsValid(n),
 680                  wxT("Invalid index passed to SetItemClientData") );
 681
 682     GtkTreeEntry* entry = GtkGetEntry(n);
 683     wxCHECK_RET(entry, wxT("could not get entry"));
 684
 685     gtk_tree_entry_set_userdata( entry, clientData );
 686     g_object_unref (entry);
 687 }
 688
 689 void wxListBox::DoSetItemClientObject(unsigned int n, wxClientData* clientData)
 690 {
 691     // wxItemContainer already deletes data for us
 692     wxListBox::DoSetItemClientData(n, (void*) clientData);
 693 }
 694
 695 // ----------------------------------------------------------------------------
 696 // string list access
 697 // ----------------------------------------------------------------------------
 698
 699 void wxListBox::SetString(unsigned int n, const wxString& label)
 700 {
 701     wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetString") );
 702     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 703
 704     GtkTreeEntry* entry = GtkGetEntry(n);
 705     wxCHECK_RET( entry, wxT("wrong listbox index") );
 706
 707     // update the item itself
 708     gtk_tree_entry_set_label(entry, wxGTK_CONV(label));
 709
 710     // and update the model which will refresh the tree too
 711     GtkTreeIter iter;
 712     wxCHECK_RET( GtkGetIteratorFor(n, &iter), _T("failed to get iterator") );
 713
 714     // FIXME: this resets the checked status of a wxCheckListBox item
 715
 716     GtkSetItem(iter, entry);
 717 }
 718
 719 wxString wxListBox::GetString(unsigned int n) const
 720 {
 721     wxCHECK_MSG( m_treeview != NULL, wxEmptyString, wxT("invalid listbox") );
 722
 723     GtkTreeEntry* entry = GtkGetEntry(n);
 724     wxCHECK_MSG( entry, wxEmptyString, wxT("wrong listbox index") );
 725
 726     wxString label = wxGTK_CONV_BACK( gtk_tree_entry_get_label(entry) );
 727
 728     g_object_unref (entry);
 729     return label;
 730 }
 731
 732 unsigned int wxListBox::GetCount() const
 733 {
 734     wxCHECK_MSG( m_treeview != NULL, 0, wxT("invalid listbox") );
 735
 736     return (unsigned int)gtk_tree_model_iter_n_children(GTK_TREE_MODEL(m_liststore), NULL);
 737 }
 738
 739 int wxListBox::FindString( const wxString &item, bool bCase ) const
 740 {
 741     wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") );
 742
 743     //Sort of hackish - maybe there is a faster way
 744     unsigned int nCount = wxListBox::GetCount();
 745
 746     for(unsigned int i = 0; i < nCount; ++i)
 747     {
 748         if( item.IsSameAs( wxListBox::GetString(i), bCase ) )
 749             return (int)i;
 750     }
 751
 752
 753     // it's not an error if the string is not found -> no wxCHECK
 754     return wxNOT_FOUND;
 755 }
 756
 757 // ----------------------------------------------------------------------------
 758 // selection
 759 // ----------------------------------------------------------------------------
 760
 761 int wxListBox::GetSelection() const
 762 {
 763     wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox"));
 764     wxCHECK_MSG( HasFlag(wxLB_SINGLE), wxNOT_FOUND,
 765                     wxT("must be single selection listbox"));
 766
 767     GtkTreeIter iter;
 768     GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
 769
 770     // only works on single-sel
 771     if (!gtk_tree_selection_get_selected(selection, NULL, &iter))
 772         return wxNOT_FOUND;
 773
 774     return GtkGetIndexFor(iter);
 775 }
 776
 777 int wxListBox::GetSelections( wxArrayInt& aSelections ) const
 778 {
 779     wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") );
 780
 781     aSelections.Empty();
 782
 783         int i = 0;
 784     GtkTreeIter iter;
 785     GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
 786
 787     if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(m_liststore), &iter))
 788     { //gtk_tree_selection_get_selected_rows is GTK 2.2+ so iter instead
 789         do
 790         {
 791             if (gtk_tree_selection_iter_is_selected(selection, &iter))
 792                 aSelections.Add(i);
 793
 794             i++;
 795         } while(gtk_tree_model_iter_next(GTK_TREE_MODEL(m_liststore), &iter));
 796     }
 797
 798     return aSelections.GetCount();
 799 }
 800
 801 bool wxListBox::IsSelected( int n ) const
 802 {
 803     wxCHECK_MSG( m_treeview != NULL, false, wxT("invalid listbox") );
 804
 805     GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
 806
 807     GtkTreeIter iter;
 808     wxCHECK_MSG( GtkGetIteratorFor(n, &iter), false, wxT("Invalid index") );
 809
 810     return gtk_tree_selection_iter_is_selected(selection, &iter);
 811 }
 812
 813 void wxListBox::DoSetSelection( int n, bool select )
 814 {
 815     // passing -1 to SetSelection() is documented to deselect all items
 816     if ( n == wxNOT_FOUND )
 817     {
 818         // ... and not generate any events in the process
 819         GtkDeselectAll();
 820         return;
 821     }
 822
 823     wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetSelection") );
 824
 825     // don't generate the selection event
 826     GtkSetSelection(n, select, true);
 827 }
 828
 829 void wxListBox::GtkDeselectAll()
 830 {
 831     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 832
 833     GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
 834
 835     m_blockEvent = true;
 836
 837     gtk_tree_selection_unselect_all(selection);
 838
 839     m_blockEvent = false;
 840 }
 841
 842 void wxListBox::GtkSetSelection(int n, const bool select, const bool blockEvent)
 843 {
 844     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 845
 846     GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
 847
 848     GtkTreeIter iter;
 849     wxCHECK_RET( GtkGetIteratorFor(n, &iter), wxT("Invalid index") );
 850
 851     m_blockEvent = blockEvent;
 852
 853     if (select)
 854         gtk_tree_selection_select_iter(selection, &iter);
 855     else
 856         gtk_tree_selection_unselect_iter(selection, &iter);
 857
 858     m_blockEvent = false;
 859 }
 860
 861 void wxListBox::DoSetFirstItem( int n )
 862 {
 863     wxCHECK_RET( m_treeview, wxT("invalid listbox") );
 864     wxCHECK_RET( IsValid(n), wxT("invalid index"));
 865
 866     //RN: I have no idea why this line is needed...
 867     if (gdk_pointer_is_grabbed () && GTK_WIDGET_HAS_GRAB (m_treeview))
 868         return;
 869
 870     GtkTreeIter iter;
 871     if ( !GtkGetIteratorFor(n, &iter) )
 872         return;
 873
 874     GtkTreePath* path = gtk_tree_model_get_path(
 875                             GTK_TREE_MODEL(m_liststore), &iter);
 876
 877     // Scroll to the desired cell (0.0 == topleft alignment)
 878     gtk_tree_view_scroll_to_cell(m_treeview, path, NULL,
 879                                  TRUE, 0.0f, 0.0f);
 880
 881     gtk_tree_path_free(path);
 882 }
 883
 884 // ----------------------------------------------------------------------------
 885 // hittest
 886 // ----------------------------------------------------------------------------
 887
 888 int wxListBox::DoListHitTest(const wxPoint& point) const
 889 {
 890     // gtk_tree_view_get_path_at_pos() also gets items that are not visible and
 891     // we only want visible items we need to check for it manually here
 892     if ( !GetClientRect().Contains(point) )
 893         return wxNOT_FOUND;
 894
 895     // need to translate from master window since it is in client coords
 896     gint binx, biny;
 897     gdk_window_get_geometry(gtk_tree_view_get_bin_window(m_treeview),
 898                             &binx, &biny, NULL, NULL, NULL);
 899
 900     GtkTreePath* path;
 901     if ( !gtk_tree_view_get_path_at_pos
 902           (
 903             m_treeview,
 904             point.x - binx,
 905             point.y - biny,
 906             &path,
 907             NULL,   // [out] column (always 0 here)
 908             NULL,   // [out] x-coord relative to the cell (not interested)
 909             NULL    // [out] y-coord relative to the cell
 910           ) )
 911     {
 912         return wxNOT_FOUND;
 913     }
 914
 915     int index = gtk_tree_path_get_indices(path)[0];
 916     gtk_tree_path_free(path);
 917
 918     return index;
 919 }
 920
 921 // ----------------------------------------------------------------------------
 922 // helpers
 923 // ----------------------------------------------------------------------------
 924
 925 #if wxUSE_TOOLTIPS
 926 void wxListBox::ApplyToolTip( GtkTooltips *tips, const wxChar *tip )
 927 {
 928     // RN: Is this needed anymore?
 929     gtk_tooltips_set_tip( tips, GTK_WIDGET( m_treeview ), wxGTK_CONV(tip), (gchar*) NULL );
 930 }
 931 #endif // wxUSE_TOOLTIPS
 932
 933 GtkWidget *wxListBox::GetConnectWidget()
 934 {
 935     // the correct widget for listbox events (such as mouse clicks for example)
 936     // is m_treeview, not the parent scrolled window
 937     return GTK_WIDGET(m_treeview);
 938 }
 939
 940 GdkWindow *wxListBox::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const
 941 {
 942     return gtk_tree_view_get_bin_window(m_treeview);
 943 }
 944
 945 void wxListBox::DoApplyWidgetStyle(GtkRcStyle *style)
 946 {
 947     if (m_hasBgCol && m_backgroundColour.Ok())
 948     {
 949         GdkWindow *window = gtk_tree_view_get_bin_window(m_treeview);
 950         if (window)
 951         {
 952             m_backgroundColour.CalcPixel( gdk_drawable_get_colormap( window ) );
 953             gdk_window_set_background( window, m_backgroundColour.GetColor() );
 954             gdk_window_clear( window );
 955         }
 956     }
 957
 958     gtk_widget_modify_style( GTK_WIDGET(m_treeview), style );
 959 }
 960
 961 wxSize wxListBox::DoGetBestSize() const
 962 {
 963     wxCHECK_MSG(m_treeview, wxDefaultSize, wxT("invalid tree view"));
 964
 965     // Start with a minimum size that's not too small
 966     int cx, cy;
 967     GetTextExtent( wxT("X"), &cx, &cy);
 968     int lbWidth = 3 * cx;
 969     int lbHeight = 10;
 970
 971     // Get the visible area of the tree view (limit to the 10th item
 972     // so that it isn't too big)
 973     unsigned int count = GetCount();
 974     if (count)
 975     {
 976         int wLine;
 977
 978         // Find the widest line
 979         for(unsigned int i = 0; i < count; i++) {
 980             wxString str(GetString(i));
 981             GetTextExtent(str, &wLine, NULL);
 982             lbWidth = wxMax(lbWidth, wLine);
 983         }
 984
 985         lbWidth += 3 * cx;
 986
 987         // And just a bit more for the checkbox if present and then some
 988         // (these are rough guesses)
 989 #if wxUSE_CHECKLISTBOX
 990         if ( m_hasCheckBoxes )
 991         {
 992             lbWidth += 35;
 993             cy = cy > 25 ? cy : 25; // rough height of checkbox
 994         }
 995 #endif
 996
 997         // don't make the listbox too tall (limit height to around 10 items) but don't
 998         // make it too small neither
 999         lbHeight = (cy+4) * wxMin(wxMax(count, 3), 10);
1000     }
1001
1002     // Add room for the scrollbar
1003     lbWidth += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
1004
1005     wxSize best(lbWidth, lbHeight);
1006     CacheBestSize(best);
1007     return best;
1008 }
1009
1010 // static
1011 wxVisualAttributes
1012 wxListBox::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
1013 {
1014     return GetDefaultAttributesFromGTKWidget(gtk_tree_view_new, true);
1015 }
1016
1017 #endif // wxUSE_LISTBOX