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