src/gtk/listbox.cpp

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