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 #include "wx/dynarray.h"
  18 #include "wx/arrstr.h"
  19 #include "wx/utils.h"
  20 #include "wx/intl.h"
  21 #include "wx/checklst.h"
  22 #include "wx/settings.h"
  23 #include "wx/log.h"
  24 #include "wx/gtk/private.h"
  25 #include "wx/gtk/treeentry_gtk.h"
  26
  27 #if wxUSE_TOOLTIPS
  28 #include "wx/tooltip.h"
  29 #endif
  30
  31 #include <gdk/gdk.h>
  32 #include <gtk/gtk.h>
  33 #include <gdk/gdkkeysyms.h>
  34
  35 //-----------------------------------------------------------------------------
  36 // data
  37 //-----------------------------------------------------------------------------
  38
  39 extern bool           g_blockEventsOnDrag;
  40 extern bool           g_blockEventsOnScroll;
  41 extern wxCursor       g_globalCursor;
  42
  43
  44
  45 //-----------------------------------------------------------------------------
  46 // Macro to tell which row the strings are in (1 if native checklist, 0 if not)
  47 //-----------------------------------------------------------------------------
  48
  49 #if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
  50 #   define WXLISTBOX_DATACOLUMN_ARG(x)  (x->m_hasCheckBoxes ? 1 : 0)
  51 #else
  52 #   define WXLISTBOX_DATACOLUMN_ARG(x)  (0)
  53 #endif // wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
  54
  55 #define WXLISTBOX_DATACOLUMN    WXLISTBOX_DATACOLUMN_ARG(this)
  56
  57 //-----------------------------------------------------------------------------
  58 // "row-activated"
  59 //-----------------------------------------------------------------------------
  60
  61 extern "C" {
  62 static void
  63 gtk_listbox_row_activated_callback(GtkTreeView        *treeview,
  64                                    GtkTreePath        *path,
  65                                    GtkTreeViewColumn  *col,
  66                                    wxListBox          *listbox)
  67 {
  68     if (g_isIdle) wxapp_install_idle_handler();
  69
  70     if (g_blockEventsOnDrag) return;
  71     if (g_blockEventsOnScroll) return;
  72
  73     if (!listbox->m_hasVMT) return;
  74
  75     //Notes:
  76     //1) This is triggered by either a double-click or a space press
  77     //2) We handle both here because
  78     //2a) in the case of a space/keypress we can't really know
  79     //    which item was pressed on because we can't get coords
  80     //    from a keyevent
  81     //2b) It seems more correct
  82
  83     int sel = gtk_tree_path_get_indices(path)[0];
  84
  85     if(!listbox->m_spacePressed)
  86     {
  87         //Assume it was double-click
  88         wxCommandEvent event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, listbox->GetId() );
  89         event.SetEventObject( listbox );
  90
  91         if(listbox->IsSelected(sel))
  92         {
  93             GtkTreeEntry* entry = listbox->GtkGetEntry(sel);
  94
  95             if(entry)
  96             {
  97                 event.SetInt(sel);
  98                 event.SetString(wxConvUTF8.cMB2WX(gtk_tree_entry_get_label(entry)));
  99
 100                 if ( listbox->HasClientObjectData() )
 101                     event.SetClientObject(
 102                     (wxClientData*) gtk_tree_entry_get_userdata(entry) );
 103                 else if ( listbox->HasClientUntypedData() )
 104                     event.SetClientData( gtk_tree_entry_get_userdata(entry) );
 105                 g_object_unref(G_OBJECT(entry));
 106             }
 107             else
 108             {
 109                 wxLogSysError(wxT("Internal error - could not get entry for double-click"));
 110                 event.SetInt(-1);
 111             }
 112         }
 113         else
 114             event.SetInt(-1);
 115
 116         listbox->GetEventHandler()->ProcessEvent( event );
 117     }
 118     else
 119     {
 120         listbox->m_spacePressed = false; //don't block selection behaviour anymore
 121
 122         //Space was pressed - toggle the appropriate checkbox and the selection
 123 #if wxUSE_CHECKLISTBOX //Do it for both native and non-native
 124         if (listbox->m_hasCheckBoxes)
 125         {
 126             wxCheckListBox *clb = (wxCheckListBox *)listbox;
 127
 128             clb->Check( sel, !clb->IsChecked(sel) );
 129
 130             wxCommandEvent new_event( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, listbox->GetId() );
 131             new_event.SetEventObject( listbox );
 132             new_event.SetInt( sel );
 133             listbox->GetEventHandler()->ProcessEvent( new_event );
 134         }
 135 #endif // wxUSE_CHECKLISTBOX
 136
 137         if(  (((listbox->GetWindowStyleFlag() & wxLB_MULTIPLE) != 0) ||
 138               ((listbox->GetWindowStyleFlag() & wxLB_EXTENDED) != 0)) )
 139         {
 140             //toggle the selection + send event
 141             listbox->GtkSetSelection(sel, !listbox->IsSelected( sel ), false);
 142         }
 143     }
 144 }
 145 }
 146
 147 //-----------------------------------------------------------------------------
 148 // "button_press_event"
 149 //-----------------------------------------------------------------------------
 150
 151 extern "C" {
 152 static gint
 153 gtk_listbox_button_press_callback( GtkWidget *widget,
 154                                    GdkEventButton *gdk_event,
 155                                    wxListBox *listbox )
 156 {
 157     if (g_isIdle) wxapp_install_idle_handler();
 158
 159     if (g_blockEventsOnDrag) return FALSE;
 160     if (g_blockEventsOnScroll) return FALSE;
 161
 162     if (!listbox->m_hasVMT) return FALSE;
 163
 164     //Just to be on the safe side - it should be unset in the activate callback
 165     //but we don't want any obscure bugs if it doesn't get called somehow...
 166     listbox->m_spacePressed = false;
 167
 168 #if wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST
 169     if ((listbox->m_hasCheckBoxes) && (gdk_event->x < 15) && (gdk_event->type != GDK_2BUTTON_PRESS))
 170     {
 171         GtkTreePath* path;
 172         gtk_tree_view_get_path_at_pos(GTK_TREE_VIEW(widget),
 173                                   (gint)gdk_event->x, (gint)gdk_event->y,
 174                                   &path, NULL, NULL, NULL);
 175         int sel = gtk_tree_path_get_indices(path)[0];
 176         gtk_tree_path_free(path);
 177
 178         wxCheckListBox *clb = (wxCheckListBox *)listbox;
 179
 180         clb->Check( sel, !clb->IsChecked(sel) );
 181
 182         wxCommandEvent event( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, listbox->GetId() );
 183         event.SetEventObject( listbox );
 184         event.SetInt( sel );
 185         listbox->GetEventHandler()->ProcessEvent( event );
 186     }
 187 #endif // wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST
 188
 189     return FALSE;
 190 }
 191 }
 192
 193 //-----------------------------------------------------------------------------
 194 // "key_press_event"
 195 //-----------------------------------------------------------------------------
 196
 197 extern "C" {
 198 static gint
 199 gtk_listbox_key_press_callback( GtkWidget *widget,
 200                                 GdkEventKey *gdk_event,
 201                                 wxListBox *listbox )
 202 {
 203     if (g_isIdle) wxapp_install_idle_handler();
 204
 205     if (g_blockEventsOnDrag) return FALSE;
 206
 207
 208     bool ret = false;
 209
 210     if ((gdk_event->keyval == GDK_Tab) || (gdk_event->keyval == GDK_ISO_Left_Tab))
 211     {
 212         wxNavigationKeyEvent new_event;
 213         /* GDK reports GDK_ISO_Left_Tab for SHIFT-TAB */
 214         new_event.SetDirection( (gdk_event->keyval == GDK_Tab) );
 215         /* CTRL-TAB changes the (parent) window, i.e. switch notebook page */
 216         new_event.SetWindowChange( (gdk_event->state & GDK_CONTROL_MASK) );
 217         new_event.SetCurrentFocus( listbox );
 218         ret = listbox->GetEventHandler()->ProcessEvent( new_event );
 219     }
 220
 221     if ((gdk_event->keyval == GDK_Return) && (!ret))
 222     {
 223         // eat return in all modes (RN:WHY?)
 224         ret = true;
 225     }
 226
 227     // Check or uncheck item with SPACE
 228     if (gdk_event->keyval == ' ')
 229         {
 230         //In the keyevent we don't know the index of the item
 231         //and the activated event gets called anyway...
 232         //
 233         //Also, activating with the space causes the treeview to
 234         //unselect all the items and then select the item in question
 235         //wx's behaviour is to just toggle the item's selection state
 236         //and leave the others alone
 237         listbox->m_spacePressed = true;
 238     }
 239
 240     if (ret)
 241     {
 242         g_signal_stop_emission_by_name (widget, "key_press_event");
 243         return TRUE;
 244     }
 245
 246     return FALSE;
 247 }
 248 }
 249
 250 //-----------------------------------------------------------------------------
 251 // "select" and "deselect"
 252 //-----------------------------------------------------------------------------
 253
 254 extern "C" {
 255 static gboolean gtk_listitem_select_cb( GtkTreeSelection* selection,
 256                                         GtkTreeModel* model,
 257                                         GtkTreePath* path,
 258                                         gboolean is_selected,
 259                                         wxListBox *listbox )
 260 {
 261     if (g_isIdle) wxapp_install_idle_handler();
 262
 263     if (!listbox->m_hasVMT) return TRUE;
 264     if (g_blockEventsOnDrag) return TRUE;
 265
 266     if (listbox->m_spacePressed) return FALSE; //see keyevent callback
 267     if (listbox->m_blockEvent) return TRUE;
 268
 269     // NB: wxdocs explicitly say that this event only gets sent when
 270     // something is actually selected, plus the controls example
 271     // assumes so and passes -1 to the dogetclientdata funcs if not
 272
 273     // OK, so basically we need to do a bit of a run-around here as
 274     // 1) is_selected says whether the item(s?) are CURRENTLY selected -
 275     //    i.e. if is_selected is FALSE then the item is going to be
 276     //    selected right now!
 277     // 2) However, since it is not already selected and the user
 278     //    will expect it to be we need to manually select it and
 279     //    return FALSE telling GTK we handled the selection
 280     if (is_selected) return TRUE;
 281
 282     int nIndex = gtk_tree_path_get_indices(path)[0];
 283     GtkTreeEntry* entry = listbox->GtkGetEntry(nIndex);
 284
 285     if(entry)
 286     {
 287         //Now, as mentioned above, we manually select the row that is/was going
 288         //to be selected anyway by GTK
 289         listbox->m_blockEvent = true; //if we don't block events we will lock the
 290                                       //app due to recursion!!
 291
 292         GtkTreeSelection* selection =
 293             gtk_tree_view_get_selection(listbox->m_treeview);
 294         GtkTreeIter iter;
 295         gtk_tree_model_get_iter(GTK_TREE_MODEL(listbox->m_liststore), &iter, path);
 296         gtk_tree_selection_select_iter(selection, &iter);
 297
 298         listbox->m_blockEvent = false;
 299
 300         //Finally, send the wx event
 301         wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, listbox->GetId() );
 302         event.SetEventObject( listbox );
 303
 304         // indicate whether this is a selection or a deselection
 305         event.SetExtraLong( 1 );
 306
 307         event.SetInt(nIndex);
 308         event.SetString(wxConvUTF8.cMB2WX(gtk_tree_entry_get_label(entry)));
 309
 310         if ( listbox->HasClientObjectData() )
 311             event.SetClientObject(
 312                     (wxClientData*) gtk_tree_entry_get_userdata(entry)
 313                                  );
 314         else if ( listbox->HasClientUntypedData() )
 315             event.SetClientData( gtk_tree_entry_get_userdata(entry) );
 316
 317         listbox->GetEventHandler()->ProcessEvent( event );
 318
 319         g_object_unref(G_OBJECT(entry));
 320         return FALSE;  //We handled it/did it manually
 321     }
 322
 323     return TRUE; //allow selection to change
 324 }
 325 }
 326
 327 //-----------------------------------------------------------------------------
 328 // GtkTreeEntry destruction (to destroy client data)
 329 //-----------------------------------------------------------------------------
 330
 331 extern "C" {
 332 static void gtk_tree_entry_destroy_cb(GtkTreeEntry* entry,
 333                                       wxListBox* listbox)
 334 {
 335     if(listbox->HasClientObjectData())
 336     {
 337         gpointer userdata = gtk_tree_entry_get_userdata(entry);
 338         if(userdata)
 339             delete (wxClientData *)userdata;
 340     }
 341 }
 342 }
 343
 344 //-----------------------------------------------------------------------------
 345 // Sorting callback (standard CmpNoCase return value)
 346 //-----------------------------------------------------------------------------
 347
 348 extern "C" {
 349 static gint gtk_listbox_sort_callback(GtkTreeModel *model,
 350                                       GtkTreeIter  *a,
 351                                       GtkTreeIter  *b,
 352                                       wxListBox    *listbox)
 353 {
 354     GtkTreeEntry* entry;
 355     GtkTreeEntry* entry2;
 356
 357     gtk_tree_model_get(GTK_TREE_MODEL(listbox->m_liststore),
 358                              a,
 359                              WXLISTBOX_DATACOLUMN_ARG(listbox),
 360                              &entry, -1);
 361     gtk_tree_model_get(GTK_TREE_MODEL(listbox->m_liststore),
 362                              b,
 363                              WXLISTBOX_DATACOLUMN_ARG(listbox),
 364                              &entry2, -1);
 365     wxCHECK_MSG(entry, 0, wxT("Could not get entry"));
 366     wxCHECK_MSG(entry2, 0, wxT("Could not get entry2"));
 367
 368     //We compare collate keys here instead of calling g_utf8_collate
 369     //as it is rather slow (and even the docs reccommend this)
 370     int ret = strcasecmp(gtk_tree_entry_get_collate_key(entry),
 371                          gtk_tree_entry_get_collate_key(entry2));
 372
 373     g_object_unref(G_OBJECT(entry));
 374     g_object_unref(G_OBJECT(entry2));
 375
 376     return ret;
 377 }
 378 }
 379
 380 //-----------------------------------------------------------------------------
 381 // Searching callback (TRUE == not equal, FALSE == equal)
 382 //-----------------------------------------------------------------------------
 383
 384 extern "C" {
 385 static gboolean gtk_listbox_searchequal_callback(GtkTreeModel* model,
 386                                                  gint column,
 387                                                  const gchar* key,
 388                                                  GtkTreeIter* iter,
 389                                                  wxListBox* listbox)
 390 {
 391     GtkTreeEntry* entry;
 392
 393     gtk_tree_model_get(GTK_TREE_MODEL(listbox->m_liststore),
 394                              iter,
 395                              WXLISTBOX_DATACOLUMN_ARG(listbox),
 396                              &entry, -1);
 397     wxCHECK_MSG(entry, 0, wxT("Could not get entry"));
 398     gchar* keycollatekey = g_utf8_collate_key(key, -1);
 399
 400     int ret = strcasecmp(keycollatekey,
 401                          gtk_tree_entry_get_collate_key(entry));
 402
 403     g_free(keycollatekey);
 404     g_object_unref(G_OBJECT(entry));
 405
 406     return ret != 0;
 407 }
 408 }
 409
 410 //-----------------------------------------------------------------------------
 411 // wxListBox
 412 //-----------------------------------------------------------------------------
 413
 414 IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControl)
 415
 416 // ----------------------------------------------------------------------------
 417 // construction
 418 // ----------------------------------------------------------------------------
 419
 420 void wxListBox::Init()
 421 {
 422     m_treeview = (GtkTreeView*) NULL;
 423 #if wxUSE_CHECKLISTBOX
 424     m_hasCheckBoxes = false;
 425 #endif // wxUSE_CHECKLISTBOX
 426     m_spacePressed = false;
 427 }
 428
 429 bool wxListBox::Create( wxWindow *parent, wxWindowID id,
 430                         const wxPoint &pos, const wxSize &size,
 431                         const wxArrayString& choices,
 432                         long style, const wxValidator& validator,
 433                         const wxString &name )
 434 {
 435     wxCArrayString chs(choices);
 436
 437     return Create( parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
 438                    style, validator, name );
 439 }
 440
 441 bool wxListBox::Create( wxWindow *parent, wxWindowID id,
 442                         const wxPoint &pos, const wxSize &size,
 443                         int n, const wxString choices[],
 444                         long style, const wxValidator& validator,
 445                         const wxString &name )
 446 {
 447     m_needParent = true;
 448     m_acceptsFocus = true;
 449     m_blockEvent = false;
 450
 451     if (!PreCreation( parent, pos, size ) ||
 452         !CreateBase( parent, id, pos, size, style, validator, name ))
 453     {
 454         wxFAIL_MSG( wxT("wxListBox creation failed") );
 455         return false;
 456     }
 457
 458     m_widget = gtk_scrolled_window_new( (GtkAdjustment*) NULL, (GtkAdjustment*) NULL );
 459     if (style & wxLB_ALWAYS_SB)
 460     {
 461       gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
 462         GTK_POLICY_AUTOMATIC, GTK_POLICY_ALWAYS );
 463     }
 464     else
 465     {
 466       gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
 467         GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
 468     }
 469
 470     m_treeview = GTK_TREE_VIEW( gtk_tree_view_new( ) );
 471
 472     //wxListBox doesn't have a header :)
 473     //NB: If enabled SetFirstItem doesn't work correctly
 474     gtk_tree_view_set_headers_visible(m_treeview, FALSE);
 475
 476 #if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
 477     if(m_hasCheckBoxes)
 478         ((wxCheckListBox*)this)->DoCreateCheckList();
 479 #endif // wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
 480
 481     // Create the data column
 482     gtk_tree_view_insert_column_with_attributes(m_treeview, -1, "",
 483                                                 gtk_cell_renderer_text_new(),
 484                                                 "text",
 485                                                 WXLISTBOX_DATACOLUMN, NULL);
 486
 487     // Now create+set the model (GtkListStore) - first argument # of columns
 488 #if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
 489     if(m_hasCheckBoxes)
 490         m_liststore = gtk_list_store_new(2, G_TYPE_BOOLEAN,
 491                                             GTK_TYPE_TREE_ENTRY);
 492     else
 493 #endif
 494         m_liststore = gtk_list_store_new(1, GTK_TYPE_TREE_ENTRY);
 495
 496     gtk_tree_view_set_model(m_treeview, GTK_TREE_MODEL(m_liststore));
 497
 498     g_object_unref(G_OBJECT(m_liststore)); //free on treeview destruction
 499
 500     // Disable the pop-up textctrl that enables searching - note that
 501     // the docs specify that even if this disabled (which we are doing)
 502     // the user can still have it through the start-interactive-search
 503     // key binding...either way we want to provide a searchequal callback
 504     // NB: If this is enabled a doubleclick event (activate) gets sent
 505     //     on a successful search
 506     gtk_tree_view_set_search_column(m_treeview, WXLISTBOX_DATACOLUMN);
 507     gtk_tree_view_set_search_equal_func(m_treeview,
 508        (GtkTreeViewSearchEqualFunc) gtk_listbox_searchequal_callback,
 509                                         this,
 510                                         NULL);
 511
 512     gtk_tree_view_set_enable_search(m_treeview, FALSE);
 513
 514
 515     GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
 516     gtk_tree_selection_set_select_function(selection,
 517                      (GtkTreeSelectionFunc)gtk_listitem_select_cb,
 518                                            this, NULL); //NULL == destroycb
 519
 520     GtkSelectionMode mode;
 521     if (style & wxLB_MULTIPLE)
 522     {
 523         mode = GTK_SELECTION_MULTIPLE;
 524     }
 525     else if (style & wxLB_EXTENDED)
 526     {
 527         mode = GTK_SELECTION_EXTENDED;
 528     }
 529     else
 530     {
 531         // if style was 0 set single mode
 532         m_windowStyle |= wxLB_SINGLE;
 533         mode = GTK_SELECTION_SINGLE;
 534     }
 535
 536     gtk_tree_selection_set_mode( selection, mode );
 537
 538     //Handle sortable stuff
 539     if(style & wxLB_SORT)
 540     {
 541         //Setup sorting in ascending (wx) order
 542         gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(m_liststore),
 543                                              WXLISTBOX_DATACOLUMN,
 544                                              GTK_SORT_ASCENDING);
 545
 546         //Set the sort callback
 547         gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(m_liststore),
 548                                         WXLISTBOX_DATACOLUMN,
 549                    (GtkTreeIterCompareFunc) gtk_listbox_sort_callback,
 550                                         this, //userdata
 551                                         NULL //"destroy notifier"
 552                                        );
 553     }
 554
 555
 556     gtk_container_add (GTK_CONTAINER (m_widget), GTK_WIDGET(m_treeview) );
 557
 558     gtk_widget_show( GTK_WIDGET(m_treeview) );
 559
 560     wxListBox::DoInsertItems(wxArrayString(n, choices), 0); // insert initial items
 561
 562     //treeview-specific events
 563     g_signal_connect(m_treeview, "row-activated",
 564                      G_CALLBACK(gtk_listbox_row_activated_callback), this);
 565
 566     // other events
 567     g_signal_connect (m_treeview, "button_press_event",
 568                       G_CALLBACK (gtk_listbox_button_press_callback),
 569                       this);
 570     g_signal_connect (m_treeview, "key_press_event",
 571                       G_CALLBACK (gtk_listbox_key_press_callback),
 572                            this);
 573
 574     m_parent->DoAddChild( this );
 575
 576     PostCreation(size);
 577     SetBestSize(size); // need this too because this is a wxControlWithItems
 578
 579     return true;
 580 }
 581
 582 wxListBox::~wxListBox()
 583 {
 584     m_hasVMT = false;
 585
 586     Clear();
 587 }
 588
 589 // ----------------------------------------------------------------------------
 590 // adding items
 591 // ----------------------------------------------------------------------------
 592
 593 void wxListBox::GtkInsertItems(const wxArrayString& items,
 594                                void** clientData, unsigned int pos)
 595 {
 596     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 597
 598     InvalidateBestSize();
 599
 600     // Create and set column ids and GValues
 601
 602     unsigned int nNum = items.GetCount();
 603     unsigned int nCurCount = wxListBox::GetCount();
 604     wxASSERT_MSG(pos <= nCurCount, wxT("Invalid index passed to wxListBox"));
 605
 606     GtkTreeIter* pIter = NULL; // append by default
 607     GtkTreeIter iter;
 608     if (pos != nCurCount)
 609     {
 610         gboolean res = gtk_tree_model_iter_nth_child(
 611                         GTK_TREE_MODEL(m_liststore),
 612                         &iter, NULL, //NULL = parent = get first
 613                         (int)pos );
 614         if(!res)
 615         {
 616             wxLogSysError(wxT("internal wxListBox error in insertion"));
 617             return;
 618         }
 619
 620         pIter = &iter;
 621     }
 622
 623     for (unsigned int i = 0; i < nNum; ++i)
 624     {
 625         wxString label = items[i];
 626
 627 #if wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST
 628         if (m_hasCheckBoxes)
 629         {
 630             label.Prepend(wxCHECKLBOX_STRING);
 631         }
 632 #endif // wxUSE_CHECKLISTBOX
 633
 634
 635         GtkTreeEntry* entry = gtk_tree_entry_new();
 636         gtk_tree_entry_set_label(entry, wxConvUTF8.cWX2MB(label));
 637         gtk_tree_entry_set_destroy_func(entry,
 638                 (GtkTreeEntryDestroy)gtk_tree_entry_destroy_cb,
 639                             this);
 640
 641         if (clientData)
 642             gtk_tree_entry_set_userdata(entry, clientData[i]);
 643
 644         GtkTreeIter itercur;
 645         gtk_list_store_insert_before(m_liststore, &itercur, pIter);
 646
 647 #if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
 648         if (m_hasCheckBoxes)
 649         {
 650             gtk_list_store_set(m_liststore, &itercur,
 651                                  0, FALSE, //FALSE == not toggled
 652                                  1, entry, -1);
 653         }
 654         else
 655 #endif
 656             gtk_list_store_set(m_liststore, &itercur,
 657                                  0, entry, -1);
 658
 659         g_object_unref(G_OBJECT(entry)); //liststore always refs :)
 660     }
 661 }
 662
 663 void wxListBox::DoInsertItems(const wxArrayString& items, unsigned int pos)
 664 {
 665     wxCHECK_RET( IsValidInsert(pos), wxT("invalid index in wxListBox::InsertItems") );
 666
 667     GtkInsertItems(items, NULL, pos);
 668 }
 669
 670 int wxListBox::DoAppend( const wxString& item )
 671 {
 672     // Call DoInsertItems
 673     unsigned int nWhere = wxListBox::GetCount();
 674     wxArrayString aItems;
 675     aItems.Add(item);
 676     wxListBox::DoInsertItems(aItems, nWhere);
 677     return nWhere;
 678 }
 679
 680 void wxListBox::DoSetItems( const wxArrayString& items,
 681                             void **clientData)
 682 {
 683     Clear();
 684     GtkInsertItems(items, clientData, 0);
 685 }
 686
 687 // ----------------------------------------------------------------------------
 688 // deleting items
 689 // ----------------------------------------------------------------------------
 690
 691 void wxListBox::Clear()
 692 {
 693     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 694
 695     InvalidateBestSize();
 696
 697     gtk_list_store_clear( m_liststore ); /* well, THAT was easy :) */
 698 }
 699
 700 void wxListBox::Delete(unsigned int n)
 701 {
 702     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 703
 704     InvalidateBestSize();
 705
 706     GtkTreeIter iter;
 707     gboolean res = gtk_tree_model_iter_nth_child(
 708                         GTK_TREE_MODEL(m_liststore),
 709                         &iter, NULL, //NULL = parent = get first
 710                         n
 711                    );
 712
 713     wxCHECK_RET( res, wxT("wrong listbox index") );
 714
 715     //this returns false if iter is invalid (i.e. deleting item
 716     //at end) but since we don't use iter, well... :)
 717     gtk_list_store_remove(m_liststore, &iter);
 718 }
 719
 720 // ----------------------------------------------------------------------------
 721 // get GtkTreeEntry from position (note: you need to g_unref it if valid)
 722 // ----------------------------------------------------------------------------
 723
 724 struct _GtkTreeEntry* wxListBox::GtkGetEntry(int n) const
 725 {
 726     GtkTreeIter iter;
 727     gboolean res = gtk_tree_model_iter_nth_child(
 728                         GTK_TREE_MODEL(m_liststore),
 729                         &iter, NULL, //NULL = parent = get first
 730                         n );
 731
 732     if (!res)
 733     {
 734         wxLogDebug(wxT("gtk_tree_model_iter_nth_child failed\n")
 735                    wxT("Passed in value was:[%i]  List size:[%u]"),
 736                    n, wxListBox::GetCount() );
 737         return NULL;
 738     }
 739
 740
 741     GtkTreeEntry* entry = NULL;
 742     gtk_tree_model_get(GTK_TREE_MODEL(m_liststore), &iter,
 743                        WXLISTBOX_DATACOLUMN, &entry, -1);
 744
 745     return entry;
 746 }
 747
 748 // ----------------------------------------------------------------------------
 749 // client data
 750 // ----------------------------------------------------------------------------
 751
 752 void* wxListBox::DoGetItemClientData(unsigned int n) const
 753 {
 754     wxCHECK_MSG( IsValid(n), NULL,
 755                  wxT("Invalid index passed to GetItemClientData") );
 756
 757     GtkTreeEntry* entry = GtkGetEntry(n);
 758     wxCHECK_MSG(entry, NULL, wxT("could not get entry"));
 759
 760     void* userdata = gtk_tree_entry_get_userdata( entry );
 761     g_object_unref(G_OBJECT(entry));
 762     return userdata;
 763 }
 764
 765 wxClientData* wxListBox::DoGetItemClientObject(unsigned int n) const
 766 {
 767     return (wxClientData*) wxListBox::DoGetItemClientData(n);
 768 }
 769
 770 void wxListBox::DoSetItemClientData(unsigned int n, void* clientData)
 771 {
 772     wxCHECK_RET( IsValid(n),
 773                  wxT("Invalid index passed to SetItemClientData") );
 774
 775     GtkTreeEntry* entry = GtkGetEntry(n);
 776     wxCHECK_RET(entry, wxT("could not get entry"));
 777
 778     gtk_tree_entry_set_userdata( entry, clientData );
 779     g_object_unref(G_OBJECT(entry));
 780 }
 781
 782 void wxListBox::DoSetItemClientObject(unsigned int n, wxClientData* clientData)
 783 {
 784     // wxItemContainer already deletes data for us
 785     wxListBox::DoSetItemClientData(n, (void*) clientData);
 786 }
 787
 788 // ----------------------------------------------------------------------------
 789 // string list access
 790 // ----------------------------------------------------------------------------
 791
 792 void wxListBox::SetString(unsigned int n, const wxString &string)
 793 {
 794     wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetString") );
 795     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 796
 797     GtkTreeEntry* entry = GtkGetEntry(n);
 798     wxCHECK_RET( entry, wxT("wrong listbox index") );
 799
 800     wxString label = string;
 801
 802 #if wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST
 803     if (m_hasCheckBoxes)
 804         label.Prepend(wxCHECKLBOX_STRING);
 805 #endif // wxUSE_CHECKLISTBOX
 806
 807     // RN: This may look wierd but the problem is that the TreeView
 808     // doesn't resort or update when changed above and there is no real
 809     // notification function...
 810     void* userdata = gtk_tree_entry_get_userdata(entry);
 811     gtk_tree_entry_set_userdata(entry, NULL); //don't delete on destroy
 812     g_object_unref(G_OBJECT(entry));
 813
 814     bool bWasSelected = wxListBox::IsSelected(n);
 815     wxListBox::Delete(n);
 816
 817     wxArrayString aItems;
 818     aItems.Add(label);
 819     GtkInsertItems(aItems, &userdata, n);
 820     if (bWasSelected)
 821         wxListBox::GtkSetSelection(n, true, true);
 822 }
 823
 824 wxString wxListBox::GetString(unsigned int n) const
 825 {
 826     wxCHECK_MSG( m_treeview != NULL, wxEmptyString, wxT("invalid listbox") );
 827
 828     GtkTreeEntry* entry = GtkGetEntry(n);
 829     wxCHECK_MSG( entry, wxEmptyString, wxT("wrong listbox index") );
 830
 831     wxString label = wxGTK_CONV_BACK( gtk_tree_entry_get_label(entry) );
 832
 833 #if wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST
 834     // checklistboxes have "[±] " prepended to their lables, remove it
 835     //
 836     // NB: 4 below is the length of wxCHECKLBOX_STRING from wx/gtk/checklst.h
 837     if ( m_hasCheckBoxes )
 838         label.erase(0, 4);
 839 #endif // wxUSE_CHECKLISTBOX
 840
 841     g_object_unref(G_OBJECT(entry));
 842     return label;
 843 }
 844
 845 unsigned int wxListBox::GetCount() const
 846 {
 847     wxCHECK_MSG( m_treeview != NULL, 0, wxT("invalid listbox") );
 848
 849     return (unsigned int)gtk_tree_model_iter_n_children(GTK_TREE_MODEL(m_liststore), NULL);
 850 }
 851
 852 int wxListBox::FindString( const wxString &item, bool bCase ) const
 853 {
 854     wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") );
 855
 856     //Sort of hackish - maybe there is a faster way
 857     unsigned int nCount = wxListBox::GetCount();
 858
 859     for(unsigned int i = 0; i < nCount; ++i)
 860     {
 861         if( item.IsSameAs( wxListBox::GetString(i), bCase ) )
 862             return (int)i;
 863     }
 864
 865
 866     // it's not an error if the string is not found -> no wxCHECK
 867     return wxNOT_FOUND;
 868 }
 869
 870 // ----------------------------------------------------------------------------
 871 // selection
 872 // ----------------------------------------------------------------------------
 873
 874 int wxListBox::GetSelection() const
 875 {
 876     wxCHECK_MSG( m_treeview != NULL, -1, wxT("invalid listbox"));
 877     wxCHECK_MSG( HasFlag(wxLB_SINGLE), -1,
 878                     wxT("must be single selection listbox"));
 879
 880     GtkTreeIter iter;
 881     GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
 882
 883     // only works on single-sel
 884     if (!gtk_tree_selection_get_selected(selection, NULL, &iter))
 885         return -1;
 886
 887     GtkTreePath* path =
 888         gtk_tree_model_get_path(GTK_TREE_MODEL(m_liststore), &iter);
 889
 890     int sel = gtk_tree_path_get_indices(path)[0];
 891
 892     gtk_tree_path_free(path);
 893
 894     return sel;
 895 }
 896
 897 int wxListBox::GetSelections( wxArrayInt& aSelections ) const
 898 {
 899     wxCHECK_MSG( m_treeview != NULL, -1, wxT("invalid listbox") );
 900
 901     aSelections.Empty();
 902
 903         int i = 0;
 904     GtkTreeIter iter;
 905     GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
 906
 907     if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(m_liststore), &iter))
 908     { //gtk_tree_selection_get_selected_rows is GTK 2.2+ so iter instead
 909         do
 910         {
 911             if (gtk_tree_selection_iter_is_selected(selection, &iter))
 912                 aSelections.Add(i);
 913
 914             i++;
 915         } while(gtk_tree_model_iter_next(GTK_TREE_MODEL(m_liststore), &iter));
 916     }
 917
 918     return aSelections.GetCount();
 919 }
 920
 921 bool wxListBox::IsSelected( int n ) const
 922 {
 923     wxCHECK_MSG( m_treeview != NULL, false, wxT("invalid listbox") );
 924
 925     GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
 926
 927     GtkTreeIter iter;
 928     gboolean res = gtk_tree_model_iter_nth_child(
 929                         GTK_TREE_MODEL(m_liststore),
 930                         &iter, NULL, //NULL = parent = get first
 931                         n );
 932
 933     wxCHECK_MSG( res, false, wxT("Invalid index") );
 934
 935     return gtk_tree_selection_iter_is_selected(selection, &iter);
 936 }
 937
 938 void wxListBox::DoSetSelection( int n, bool select )
 939 {
 940     return GtkSetSelection(n, select, true); //docs say no events here
 941 }
 942
 943 void wxListBox::GtkSetSelection(int n, const bool select, const bool blockEvent)
 944 {
 945     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 946
 947     GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
 948
 949     GtkTreeIter iter;
 950     gboolean res = gtk_tree_model_iter_nth_child(
 951                         GTK_TREE_MODEL(m_liststore),
 952                         &iter, NULL, //NULL = parent = get first
 953                         n
 954                                                 );
 955     wxCHECK_RET( res, wxT("Invalid index") );
 956
 957     m_blockEvent = blockEvent;
 958
 959     if (select)
 960         gtk_tree_selection_select_iter(selection, &iter);
 961     else
 962         gtk_tree_selection_unselect_iter(selection, &iter);
 963
 964     m_blockEvent = false;
 965 }
 966
 967 void wxListBox::DoSetFirstItem( int n )
 968 {
 969     wxCHECK_RET( m_treeview, wxT("invalid listbox") );
 970     wxCHECK_RET( IsValid(n), wxT("invalid index"));
 971
 972     //RN: I have no idea why this line is needed...
 973     if (gdk_pointer_is_grabbed () && GTK_WIDGET_HAS_GRAB (m_treeview))
 974         return;
 975
 976     GtkTreeIter iter;
 977     gtk_tree_model_iter_nth_child(
 978                                     GTK_TREE_MODEL(m_liststore),
 979                                     &iter,
 980                                     NULL, //NULL = parent = get first
 981                                     n
 982                                  );
 983
 984     GtkTreePath* path = gtk_tree_model_get_path(
 985                             GTK_TREE_MODEL(m_liststore), &iter);
 986
 987     // Scroll to the desired cell (0.0 == topleft alignment)
 988     gtk_tree_view_scroll_to_cell(m_treeview, path, NULL,
 989                                  TRUE, 0.0f, 0.0f);
 990
 991     gtk_tree_path_free(path);
 992 }
 993
 994 // ----------------------------------------------------------------------------
 995 // hittest
 996 // ----------------------------------------------------------------------------
 997
 998 int wxListBox::DoListHitTest(const wxPoint& point) const
 999 {
1000     // need to translate from master window since it is in client coords
1001     gint binx, biny;
1002     gdk_window_get_geometry(gtk_tree_view_get_bin_window(m_treeview),
1003                             &binx, &biny, NULL, NULL, NULL);
1004
1005     GtkTreePath* path;
1006     if ( !gtk_tree_view_get_path_at_pos
1007           (
1008             m_treeview,
1009             point.x - binx,
1010             point.y - biny,
1011             &path,
1012             NULL,   // [out] column (always 0 here)
1013             NULL,   // [out] x-coord relative to the cell (not interested)
1014             NULL    // [out] y-coord relative to the cell
1015           ) )
1016     {
1017         return wxNOT_FOUND;
1018     }
1019
1020     int index = gtk_tree_path_get_indices(path)[0];
1021     gtk_tree_path_free(path);
1022
1023     return index;
1024 }
1025
1026 // ----------------------------------------------------------------------------
1027 // helpers
1028 // ----------------------------------------------------------------------------
1029
1030 #if wxUSE_TOOLTIPS
1031 void wxListBox::ApplyToolTip( GtkTooltips *tips, const wxChar *tip )
1032 {
1033     // RN: Is this needed anymore?
1034     gtk_tooltips_set_tip( tips, GTK_WIDGET( m_treeview ), wxGTK_CONV(tip), (gchar*) NULL );
1035 }
1036 #endif // wxUSE_TOOLTIPS
1037
1038 GtkWidget *wxListBox::GetConnectWidget()
1039 {
1040     // the correct widget for listbox events (such as mouse clicks for example)
1041     // is m_treeview, not the parent scrolled window
1042     return GTK_WIDGET(m_treeview);
1043 }
1044
1045 bool wxListBox::IsOwnGtkWindow( GdkWindow *window )
1046 {
1047     return (window == gtk_tree_view_get_bin_window(m_treeview));
1048 }
1049
1050 void wxListBox::DoApplyWidgetStyle(GtkRcStyle *style)
1051 {
1052     if (m_hasBgCol && m_backgroundColour.Ok())
1053     {
1054         GdkWindow *window = gtk_tree_view_get_bin_window(m_treeview);
1055         if (window)
1056         {
1057             m_backgroundColour.CalcPixel( gdk_window_get_colormap( window ) );
1058             gdk_window_set_background( window, m_backgroundColour.GetColor() );
1059             gdk_window_clear( window );
1060         }
1061     }
1062
1063     gtk_widget_modify_style( GTK_WIDGET(m_treeview), style );
1064 }
1065
1066 void wxListBox::OnInternalIdle()
1067 {
1068     //RN: Is this needed anymore?
1069     wxCursor cursor = m_cursor;
1070     if (g_globalCursor.Ok()) cursor = g_globalCursor;
1071
1072     if (GTK_WIDGET(m_treeview)->window && cursor.Ok())
1073     {
1074         /* I now set the cursor the anew in every OnInternalIdle call
1075            as setting the cursor in a parent window also effects the
1076            windows above so that checking for the current cursor is
1077            not possible. */
1078         GdkWindow *window = gtk_tree_view_get_bin_window(m_treeview);
1079         gdk_window_set_cursor( window, cursor.GetCursor() );
1080     }
1081
1082     if (wxUpdateUIEvent::CanUpdate(this))
1083         UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
1084 }
1085
1086 wxSize wxListBox::DoGetBestSize() const
1087 {
1088     wxCHECK_MSG(m_treeview, wxDefaultSize, wxT("invalid tree view"));
1089
1090     // Start with a minimum size that's not too small
1091     int cx, cy;
1092     GetTextExtent( wxT("X"), &cx, &cy);
1093     int lbWidth = 3 * cx;
1094     int lbHeight = 10;
1095
1096     // Get the visible area of the tree view (limit to the 10th item
1097     // so that it isn't too big)
1098     unsigned int count = GetCount();
1099     if (count)
1100     {
1101         int wLine;
1102
1103         // Find the widest line
1104         for(unsigned int i = 0; i < count; i++) {
1105             wxString str(GetString(i));
1106             GetTextExtent(str, &wLine, NULL);
1107             lbWidth = wxMax(lbWidth, wLine);
1108         }
1109
1110         lbWidth += 3 * cx;
1111
1112         // And just a bit more for the checkbox if present and then some
1113         // (these are rough guesses)
1114 #if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
1115         if ( m_hasCheckBoxes )
1116         {
1117             lbWidth += 35;
1118             cy = cy > 25 ? cy : 25; // rough height of checkbox
1119         }
1120 #endif
1121
1122         // don't make the listbox too tall (limit height to around 10 items) but don't
1123         // make it too small neither
1124         lbHeight = (cy+4) * wxMin(wxMax(count, 3), 10);
1125     }
1126
1127     // Add room for the scrollbar
1128     lbWidth += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
1129
1130     wxSize best(lbWidth, lbHeight);
1131     CacheBestSize(best);
1132     return best;
1133 }
1134
1135 // static
1136 wxVisualAttributes
1137 wxListBox::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
1138 {
1139     return GetDefaultAttributesFromGTKWidget(gtk_tree_view_new, true);
1140 }
1141
1142 #endif // wxUSE_LISTBOX