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