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