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