src/gtk/listbox.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        listbox.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10
  11 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  12 #pragma implementation "listbox.h"
  13 #endif
  14
  15 // For compilers that support precompilation, includes "wx.h".
  16 #include "wx/wxprec.h"
  17
  18 #include "wx/defs.h"
  19
  20 #if wxUSE_LISTBOX
  21
  22 #include "wx/listbox.h"
  23 #include "wx/dynarray.h"
  24 #include "wx/arrstr.h"
  25 #include "wx/utils.h"
  26 #include "wx/intl.h"
  27 #include "wx/checklst.h"
  28 #include "wx/settings.h"
  29 #include "wx/gtk/private.h"
  30
  31 #if wxUSE_TOOLTIPS
  32 #include "wx/tooltip.h"
  33 #endif
  34
  35 #include <gdk/gdk.h>
  36 #include <gtk/gtk.h>
  37 #include <gdk/gdkkeysyms.h>
  38
  39 //-----------------------------------------------------------------------------
  40 // idle system
  41 //-----------------------------------------------------------------------------
  42
  43 extern void wxapp_install_idle_handler();
  44 extern bool g_isIdle;
  45
  46 //-----------------------------------------------------------------------------
  47 // data
  48 //-----------------------------------------------------------------------------
  49
  50 extern bool           g_blockEventsOnDrag;
  51 extern bool           g_blockEventsOnScroll;
  52 extern wxCursor       g_globalCursor;
  53 extern wxWindowGTK   *g_delayedFocus;
  54 extern wxWindowGTK   *g_focusWindow;
  55 extern wxWindowGTK   *g_focusWindowLast;
  56
  57 static bool       g_hasDoubleClicked = FALSE;
  58
  59 //-----------------------------------------------------------------------------
  60 // idle callback for SetFirstItem
  61 //-----------------------------------------------------------------------------
  62
  63 struct wxlistbox_idle_struct
  64 {
  65     wxListBox   *m_listbox;
  66     int          m_item;
  67     gint         m_tag;
  68 };
  69
  70 extern "C" gint wxlistbox_idle_callback( gpointer gdata )
  71 {
  72     wxlistbox_idle_struct* data = (wxlistbox_idle_struct*) gdata;
  73     gdk_threads_enter();
  74
  75     gtk_idle_remove( data->m_tag );
  76
  77     // check that the items haven't been deleted from the listbox since we had
  78     // installed this callback
  79     wxListBox *lbox = data->m_listbox;
  80     if ( data->m_item < lbox->GetCount() )
  81     {
  82         lbox->SetFirstItem( data->m_item );
  83     }
  84
  85     delete data;
  86
  87     gdk_threads_leave();
  88
  89     return TRUE;
  90 }
  91
  92 //-----------------------------------------------------------------------------
  93 // "focus_in_event"
  94 //-----------------------------------------------------------------------------
  95
  96 static gint gtk_listitem_focus_in_callback( GtkWidget *widget,
  97                                           GdkEvent *WXUNUSED(event),
  98                                           wxWindow *win )
  99 {
 100     if (g_isIdle)
 101         wxapp_install_idle_handler();
 102
 103     g_focusWindowLast =
 104     g_focusWindow = win;
 105
 106     // does the window itself think that it has the focus?
 107     if ( !win->m_hasFocus )
 108     {
 109         // not yet, notify it
 110         win->m_hasFocus = TRUE;
 111
 112         wxChildFocusEvent eventChildFocus(win);
 113         (void)win->GetEventHandler()->ProcessEvent(eventChildFocus);
 114
 115         wxFocusEvent eventFocus(wxEVT_SET_FOCUS, win->GetId());
 116         eventFocus.SetEventObject(win);
 117
 118         (void)win->GetEventHandler()->ProcessEvent(eventFocus);
 119     }
 120
 121     return FALSE;
 122 }
 123
 124 //-----------------------------------------------------------------------------
 125 // "focus_out_event"
 126 //-----------------------------------------------------------------------------
 127
 128 static gint gtk_listitem_focus_out_callback( GtkWidget *widget, GdkEventFocus *gdk_event, wxWindowGTK *win )
 129 {
 130     if (g_isIdle)
 131         wxapp_install_idle_handler();
 132
 133     g_focusWindow = (wxWindowGTK *)NULL;
 134
 135     // don't send the window a kill focus event if it thinks that it doesn't
 136     // have focus already
 137     if ( win->m_hasFocus )
 138     {
 139         win->m_hasFocus = FALSE;
 140
 141         wxFocusEvent event( wxEVT_KILL_FOCUS, win->GetId() );
 142         event.SetEventObject( win );
 143
 144         // even if we did process the event in wx code, still let GTK itself
 145         // process it too as otherwise bad things happen, especially in GTK2
 146         // where the text control simply aborts the program if it doesn't get
 147         // the matching focus out event
 148         (void)win->GetEventHandler()->ProcessEvent( event );
 149     }
 150
 151     return FALSE;
 152 }
 153
 154 //-----------------------------------------------------------------------------
 155 // "button_release_event"
 156 //-----------------------------------------------------------------------------
 157
 158 /* we would normally emit a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event once
 159    a GDK_2BUTTON_PRESS occurs, but this has the particular problem of the
 160    listbox keeping the focus until it receives a GDK_BUTTON_RELEASE event.
 161    this can lead to race conditions so that we emit the dclick event
 162    after the GDK_BUTTON_RELEASE event after the GDK_2BUTTON_PRESS event */
 163
 164 static gint
 165 gtk_listbox_button_release_callback( GtkWidget * WXUNUSED(widget),
 166                                      GdkEventButton * WXUNUSED(gdk_event),
 167                                      wxListBox *listbox )
 168 {
 169     if (g_isIdle) wxapp_install_idle_handler();
 170
 171     if (g_blockEventsOnDrag) return FALSE;
 172     if (g_blockEventsOnScroll) return FALSE;
 173
 174     if (!listbox->m_hasVMT) return FALSE;
 175
 176     if (!g_hasDoubleClicked) return FALSE;
 177
 178     wxCommandEvent event( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, listbox->GetId() );
 179     event.SetEventObject( listbox );
 180
 181     wxArrayInt aSelections;
 182     int n, count = listbox->GetSelections(aSelections);
 183     if ( count > 0 )
 184     {
 185         n = aSelections[0];
 186         if ( listbox->HasClientObjectData() )
 187             event.SetClientObject( listbox->GetClientObject(n) );
 188         else if ( listbox->HasClientUntypedData() )
 189             event.SetClientData( listbox->GetClientData(n) );
 190         event.SetString( listbox->GetString(n) );
 191     }
 192     else
 193     {
 194         n = -1;
 195     }
 196
 197     event.m_commandInt = n;
 198
 199     listbox->GetEventHandler()->ProcessEvent( event );
 200
 201     return FALSE;
 202 }
 203
 204 //-----------------------------------------------------------------------------
 205 // "button_press_event"
 206 //-----------------------------------------------------------------------------
 207
 208 static gint
 209 gtk_listbox_button_press_callback( GtkWidget *widget,
 210                                    GdkEventButton *gdk_event,
 211                                    wxListBox *listbox )
 212 {
 213     if (g_isIdle) wxapp_install_idle_handler();
 214
 215     if (g_blockEventsOnDrag) return FALSE;
 216     if (g_blockEventsOnScroll) return FALSE;
 217
 218     if (!listbox->m_hasVMT) return FALSE;
 219
 220     int sel = listbox->GtkGetIndex( widget );
 221
 222 #if wxUSE_CHECKLISTBOX
 223     if ((listbox->m_hasCheckBoxes) && (gdk_event->x < 15) && (gdk_event->type != GDK_2BUTTON_PRESS))
 224     {
 225         wxCheckListBox *clb = (wxCheckListBox *)listbox;
 226
 227         clb->Check( sel, !clb->IsChecked(sel) );
 228
 229         wxCommandEvent event( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, listbox->GetId() );
 230         event.SetEventObject( listbox );
 231         event.SetInt( sel );
 232         listbox->GetEventHandler()->ProcessEvent( event );
 233     }
 234 #endif // wxUSE_CHECKLISTBOX
 235
 236     /* emit wxEVT_COMMAND_LISTBOX_DOUBLECLICKED later */
 237     g_hasDoubleClicked = (gdk_event->type == GDK_2BUTTON_PRESS);
 238
 239     return FALSE;
 240 }
 241
 242 //-----------------------------------------------------------------------------
 243 // "key_press_event"
 244 //-----------------------------------------------------------------------------
 245
 246 static gint
 247 gtk_listbox_key_press_callback( GtkWidget *widget, GdkEventKey *gdk_event, wxListBox *listbox )
 248 {
 249     if (g_isIdle)
 250         wxapp_install_idle_handler();
 251
 252     if (g_blockEventsOnDrag)
 253         return FALSE;
 254
 255     bool ret = FALSE;
 256
 257     if ((gdk_event->keyval == GDK_Tab) || (gdk_event->keyval == GDK_ISO_Left_Tab))
 258     {
 259         wxNavigationKeyEvent new_event;
 260         /* GDK reports GDK_ISO_Left_Tab for SHIFT-TAB */
 261         new_event.SetDirection( (gdk_event->keyval == GDK_Tab) );
 262         /* CTRL-TAB changes the (parent) window, i.e. switch notebook page */
 263         new_event.SetWindowChange( (gdk_event->state & GDK_CONTROL_MASK) );
 264         new_event.SetCurrentFocus( listbox );
 265         ret = listbox->GetEventHandler()->ProcessEvent( new_event );
 266     }
 267
 268     if ((gdk_event->keyval == GDK_Return) && (!ret))
 269     {
 270         // eat return in all modes
 271         ret = TRUE;
 272     }
 273
 274 #if wxUSE_CHECKLISTBOX
 275     if ((gdk_event->keyval == ' ') && (listbox->m_hasCheckBoxes) && (!ret))
 276     {
 277         int sel = listbox->GtkGetIndex( widget );
 278
 279         wxCheckListBox *clb = (wxCheckListBox *)listbox;
 280
 281         clb->Check( sel, !clb->IsChecked(sel) );
 282
 283         wxCommandEvent new_event( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, listbox->GetId() );
 284         new_event.SetEventObject( listbox );
 285         new_event.SetInt( sel );
 286         ret = listbox->GetEventHandler()->ProcessEvent( new_event );
 287     }
 288 #endif // wxUSE_CHECKLISTBOX
 289
 290     // Check or uncheck item with SPACE
 291     if ((gdk_event->keyval == ' ') && (!ret) &&
 292          (((listbox->GetWindowStyleFlag() & wxLB_MULTIPLE) != 0) ||
 293           ((listbox->GetWindowStyleFlag() & wxLB_EXTENDED) != 0)) )
 294     {
 295         int sel = listbox->GtkGetIndex( widget );
 296
 297         if (sel != -1)
 298         {
 299             ret = TRUE;
 300
 301             if (listbox->IsSelected( sel ))
 302                 gtk_list_unselect_item( listbox->m_list, sel );
 303             else
 304                 gtk_list_select_item( listbox->m_list, sel );
 305
 306             wxCommandEvent new_event(wxEVT_COMMAND_LISTBOX_SELECTED, listbox->GetId() );
 307             new_event.SetEventObject( listbox );
 308             wxArrayInt aSelections;
 309             int n, count = listbox->GetSelections(aSelections);
 310             if ( count > 0 )
 311             {
 312                 n = aSelections[0];
 313                 if ( listbox->HasClientObjectData() )
 314                     new_event.SetClientObject( listbox->GetClientObject(n) );
 315                 else if ( listbox->HasClientUntypedData() )
 316                     new_event.SetClientData( listbox->GetClientData(n) );
 317                 new_event.SetString( listbox->GetString(n) );
 318             }
 319             else
 320             {
 321                 n = -1;
 322             }
 323             new_event.m_commandInt = n;
 324             listbox->GetEventHandler()->ProcessEvent( new_event );
 325         }
 326     }
 327
 328     if (ret)
 329     {
 330         gtk_signal_emit_stop_by_name( GTK_OBJECT(widget), "key_press_event" );
 331         return TRUE;
 332     }
 333
 334     return FALSE;
 335 }
 336
 337 //-----------------------------------------------------------------------------
 338 // "select" and "deselect"
 339 //-----------------------------------------------------------------------------
 340
 341 static void gtk_listitem_select_cb( GtkWidget *widget, wxListBox *listbox, bool is_selection );
 342
 343 static void gtk_listitem_select_callback( GtkWidget *widget, wxListBox *listbox )
 344 {
 345     gtk_listitem_select_cb( widget, listbox, TRUE );
 346 }
 347
 348 static void gtk_listitem_deselect_callback( GtkWidget *widget, wxListBox *listbox )
 349 {
 350     gtk_listitem_select_cb( widget, listbox, FALSE );
 351 }
 352
 353 static void gtk_listitem_select_cb( GtkWidget *widget,
 354                                     wxListBox *listbox,
 355                                     bool is_selection )
 356 {
 357     if (g_isIdle) wxapp_install_idle_handler();
 358
 359     if (!listbox->m_hasVMT) return;
 360     if (g_blockEventsOnDrag) return;
 361
 362     if (listbox->m_blockEvent) return;
 363
 364     wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, listbox->GetId() );
 365     event.SetEventObject( listbox );
 366
 367     // indicate whether this is a selection or a deselection
 368     event.SetExtraLong( is_selection );
 369
 370     if ((listbox->GetWindowStyleFlag() & wxLB_SINGLE) != 0)
 371     {
 372         int sel = listbox->GtkGetIndex( widget );
 373
 374         if (listbox->m_prevSelection != sel)
 375             gtk_list_unselect_item( listbox->m_list, listbox->m_prevSelection );
 376
 377         listbox->m_prevSelection = sel;
 378     }
 379
 380     wxArrayInt aSelections;
 381     int n, count = listbox->GetSelections(aSelections);
 382     if ( count > 0 )
 383     {
 384         n = aSelections[0];
 385         if ( listbox->HasClientObjectData() )
 386             event.SetClientObject( listbox->GetClientObject(n) );
 387         else if ( listbox->HasClientUntypedData() )
 388             event.SetClientData( listbox->GetClientData(n) );
 389         event.SetString( listbox->GetString(n) );
 390     }
 391     else
 392     {
 393         n = -1;
 394     }
 395
 396     event.m_commandInt = n;
 397
 398 //    No longer required with new code in wxLB_SINGLE
 399 //    listbox->GetEventHandler()->AddPendingEvent( event );
 400     listbox->GetEventHandler()->ProcessEvent( event );
 401 }
 402
 403 //-----------------------------------------------------------------------------
 404 // wxListBox
 405 //-----------------------------------------------------------------------------
 406
 407 IMPLEMENT_DYNAMIC_CLASS(wxListBox,wxControl)
 408
 409 // ----------------------------------------------------------------------------
 410 // construction
 411 // ----------------------------------------------------------------------------
 412
 413 wxListBox::wxListBox()
 414 {
 415     m_list = (GtkList *) NULL;
 416 #if wxUSE_CHECKLISTBOX
 417     m_hasCheckBoxes = FALSE;
 418 #endif // wxUSE_CHECKLISTBOX
 419 }
 420
 421 bool wxListBox::Create( wxWindow *parent, wxWindowID id,
 422                         const wxPoint &pos, const wxSize &size,
 423                         const wxArrayString& choices,
 424                         long style, const wxValidator& validator,
 425                         const wxString &name )
 426 {
 427     wxCArrayString chs(choices);
 428
 429     return Create( parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
 430                    style, validator, name );
 431 }
 432
 433 bool wxListBox::Create( wxWindow *parent, wxWindowID id,
 434                         const wxPoint &pos, const wxSize &size,
 435                         int n, const wxString choices[],
 436                         long style, const wxValidator& validator,
 437                         const wxString &name )
 438 {
 439     m_needParent = TRUE;
 440     m_acceptsFocus = TRUE;
 441     m_prevSelection = 0;  // or -1 ??
 442     m_blockEvent = FALSE;
 443
 444     if (!PreCreation( parent, pos, size ) ||
 445         !CreateBase( parent, id, pos, size, style, validator, name ))
 446     {
 447         wxFAIL_MSG( wxT("wxListBox creation failed") );
 448         return FALSE;
 449     }
 450
 451     m_widget = gtk_scrolled_window_new( (GtkAdjustment*) NULL, (GtkAdjustment*) NULL );
 452     if (style & wxLB_ALWAYS_SB)
 453     {
 454       gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
 455         GTK_POLICY_AUTOMATIC, GTK_POLICY_ALWAYS );
 456     }
 457     else
 458     {
 459       gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
 460         GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
 461     }
 462
 463     m_list = GTK_LIST( gtk_list_new() );
 464
 465     GtkSelectionMode mode;
 466     if (style & wxLB_MULTIPLE)
 467     {
 468         mode = GTK_SELECTION_MULTIPLE;
 469     }
 470     else if (style & wxLB_EXTENDED)
 471     {
 472         mode = GTK_SELECTION_EXTENDED;
 473     }
 474     else
 475     {
 476         // if style was 0 set single mode
 477         m_windowStyle |= wxLB_SINGLE;
 478         mode = GTK_SELECTION_MULTIPLE;
 479     }
 480
 481     gtk_list_set_selection_mode( GTK_LIST(m_list), mode );
 482
 483     gtk_scrolled_window_add_with_viewport( GTK_SCROLLED_WINDOW(m_widget), GTK_WIDGET(m_list) );
 484
 485     /* make list scroll when moving the focus down using cursor keys */
 486     gtk_container_set_focus_vadjustment(
 487         GTK_CONTAINER(m_list),
 488         gtk_scrolled_window_get_vadjustment(
 489             GTK_SCROLLED_WINDOW(m_widget)));
 490
 491     gtk_widget_show( GTK_WIDGET(m_list) );
 492
 493     if ( style & wxLB_SORT )
 494     {
 495         // this will change DoAppend() behaviour
 496         m_strings = new wxSortedArrayString;
 497     }
 498     else
 499     {
 500         m_strings = (wxSortedArrayString *)NULL;
 501     }
 502
 503     for (int i = 0; i < n; i++)
 504     {
 505         // add one by one
 506         DoAppend(choices[i]);
 507     }
 508
 509     m_parent->DoAddChild( this );
 510
 511     PostCreation(size);
 512     SetBestSize(size); // need this too because this is a wxControlWithItems
 513
 514     return TRUE;
 515 }
 516
 517 wxListBox::~wxListBox()
 518 {
 519     m_hasVMT = FALSE;
 520
 521     Clear();
 522
 523     if (m_strings)
 524       delete m_strings;
 525 }
 526
 527 // ----------------------------------------------------------------------------
 528 // adding items
 529 // ----------------------------------------------------------------------------
 530
 531 void wxListBox::DoInsertItems(const wxArrayString& items, int pos)
 532 {
 533     wxCHECK_RET( m_list != NULL, wxT("invalid listbox") );
 534
 535     // VZ: notice that InsertItems knows nothing about sorting, so calling it
 536     //     from outside (and not from our own Append) is likely to break
 537     //     everything
 538
 539     // code elsewhere supposes we have as many items in m_clientList as items
 540     // in the listbox
 541     wxASSERT_MSG( m_clientList.GetCount() == (size_t)GetCount(),
 542                   wxT("bug in client data management") );
 543
 544     InvalidateBestSize();
 545
 546     GList *children = m_list->children;
 547     int length = g_list_length(children);
 548
 549     wxCHECK_RET( pos <= length, wxT("invalid index in wxListBox::InsertItems") );
 550
 551     size_t nItems = items.GetCount();
 552     int index;
 553
 554     if (m_strings)
 555     {
 556         for (size_t n = 0; n < nItems; n++)
 557         {
 558             index = m_strings->Add( items[n] );
 559
 560             if (index != GetCount())
 561             {
 562                 GtkAddItem( items[n], index );
 563                 wxList::compatibility_iterator node = m_clientList.Item( index );
 564                 m_clientList.Insert( node, (wxObject*) NULL );
 565             }
 566             else
 567             {
 568                 GtkAddItem( items[n] );
 569                 m_clientList.Append( (wxObject*) NULL );
 570             }
 571         }
 572     }
 573     else
 574     {
 575         if (pos == length)
 576         {
 577             for ( size_t n = 0; n < nItems; n++ )
 578             {
 579                 GtkAddItem( items[n] );
 580
 581                 m_clientList.Append((wxObject *)NULL);
 582             }
 583         }
 584         else
 585         {
 586             wxList::compatibility_iterator node = m_clientList.Item( pos );
 587             for ( size_t n = 0; n < nItems; n++ )
 588             {
 589                 GtkAddItem( items[n], pos+n );
 590
 591                 m_clientList.Insert( node, (wxObject *)NULL );
 592             }
 593         }
 594     }
 595
 596     wxASSERT_MSG( m_clientList.GetCount() == (size_t)GetCount(),
 597                       wxT("bug in client data management") );
 598 }
 599
 600 int wxListBox::DoAppend( const wxString& item )
 601 {
 602     InvalidateBestSize();
 603
 604     if (m_strings)
 605     {
 606         // need to determine the index
 607         int index = m_strings->Add( item );
 608
 609         // only if not at the end anyway
 610         if (index != GetCount())
 611         {
 612            GtkAddItem( item, index );
 613
 614            wxList::compatibility_iterator node = m_clientList.Item( index );
 615            m_clientList.Insert( node, (wxObject *)NULL );
 616
 617            return index;
 618         }
 619     }
 620
 621     GtkAddItem(item);
 622
 623     m_clientList.Append((wxObject *)NULL);
 624
 625     return GetCount() - 1;
 626 }
 627
 628 void wxListBox::GtkAddItem( const wxString &item, int pos )
 629 {
 630     wxCHECK_RET( m_list != NULL, wxT("invalid listbox") );
 631
 632     GtkWidget *list_item;
 633
 634     wxString label(item);
 635 #if wxUSE_CHECKLISTBOX
 636     if (m_hasCheckBoxes)
 637     {
 638         label.Prepend(wxCHECKLBOX_STRING);
 639     }
 640 #endif // wxUSE_CHECKLISTBOX
 641
 642     list_item = gtk_list_item_new_with_label( wxGTK_CONV( label ) );
 643
 644     GList *gitem_list = g_list_alloc ();
 645     gitem_list->data = list_item;
 646
 647     if (pos == -1)
 648         gtk_list_append_items( GTK_LIST (m_list), gitem_list );
 649     else
 650         gtk_list_insert_items( GTK_LIST (m_list), gitem_list, pos );
 651
 652     gtk_signal_connect( GTK_OBJECT(list_item), "select",
 653       GTK_SIGNAL_FUNC(gtk_listitem_select_callback), (gpointer)this );
 654
 655     if (HasFlag(wxLB_MULTIPLE) || HasFlag(wxLB_EXTENDED))
 656         gtk_signal_connect( GTK_OBJECT(list_item), "deselect",
 657           GTK_SIGNAL_FUNC(gtk_listitem_deselect_callback), (gpointer)this );
 658
 659     gtk_signal_connect( GTK_OBJECT(list_item),
 660                         "button_press_event",
 661                         (GtkSignalFunc)gtk_listbox_button_press_callback,
 662                         (gpointer) this );
 663
 664     gtk_signal_connect_after( GTK_OBJECT(list_item),
 665                         "button_release_event",
 666                         (GtkSignalFunc)gtk_listbox_button_release_callback,
 667                         (gpointer) this );
 668
 669     gtk_signal_connect( GTK_OBJECT(list_item),
 670                            "key_press_event",
 671                            (GtkSignalFunc)gtk_listbox_key_press_callback,
 672                            (gpointer)this );
 673
 674
 675     gtk_signal_connect( GTK_OBJECT(list_item), "focus_in_event",
 676             GTK_SIGNAL_FUNC(gtk_listitem_focus_in_callback), (gpointer)this );
 677
 678     gtk_signal_connect( GTK_OBJECT(list_item), "focus_out_event",
 679             GTK_SIGNAL_FUNC(gtk_listitem_focus_out_callback), (gpointer)this );
 680
 681
 682     ConnectWidget( list_item );
 683
 684     gtk_widget_show( list_item );
 685
 686     if (GTK_WIDGET_REALIZED(m_widget))
 687     {
 688         gtk_widget_realize( list_item );
 689         gtk_widget_realize( GTK_BIN(list_item)->child );
 690
 691 #if wxUSE_TOOLTIPS
 692         if (m_tooltip) m_tooltip->Apply( this );
 693 #endif
 694     }
 695
 696     // Apply current widget style to the new list_item
 697     GtkRcStyle *style = CreateWidgetStyle();
 698     if (style)
 699     {
 700         gtk_widget_modify_style( GTK_WIDGET( list_item ), style );
 701         GtkBin *bin = GTK_BIN( list_item );
 702         GtkWidget *label = GTK_WIDGET( bin->child );
 703         gtk_widget_modify_style( label, style );
 704         gtk_rc_style_unref( style );
 705     }
 706 }
 707
 708 void wxListBox::DoSetItems( const wxArrayString& items,
 709                             void **clientData)
 710 {
 711     Clear();
 712
 713     DoInsertItems(items, 0);
 714
 715     if ( clientData )
 716     {
 717         size_t count = items.GetCount();
 718         for ( size_t n = 0; n < count; n++ )
 719         {
 720             SetClientData(n, clientData[n]);
 721         }
 722     }
 723 }
 724
 725 // ----------------------------------------------------------------------------
 726 // deleting items
 727 // ----------------------------------------------------------------------------
 728
 729 void wxListBox::Clear()
 730 {
 731     wxCHECK_RET( m_list != NULL, wxT("invalid listbox") );
 732
 733     gtk_list_clear_items( m_list, 0, GetCount() );
 734
 735     if ( GTK_LIST(m_list)->last_focus_child != NULL  )
 736     {
 737         // This should be NULL, I think.
 738         GTK_LIST(m_list)->last_focus_child = NULL;
 739     }
 740
 741     if ( HasClientObjectData() )
 742     {
 743         // destroy the data (due to Robert's idea of using wxList<wxObject>
 744         // and not wxList<wxClientData> we can't just say
 745         // m_clientList.DeleteContents(TRUE) - this would crash!
 746         wxList::compatibility_iterator node = m_clientList.GetFirst();
 747         while ( node )
 748         {
 749             delete (wxClientData *)node->GetData();
 750             node = node->GetNext();
 751         }
 752     }
 753     m_clientList.Clear();
 754
 755     if ( m_strings )
 756         m_strings->Clear();
 757 }
 758
 759 void wxListBox::Delete( int n )
 760 {
 761     wxCHECK_RET( m_list != NULL, wxT("invalid listbox") );
 762
 763     GList *child = g_list_nth( m_list->children, n );
 764
 765     wxCHECK_RET( child, wxT("wrong listbox index") );
 766
 767     GList *list = g_list_append( (GList*) NULL, child->data );
 768     gtk_list_remove_items( m_list, list );
 769     g_list_free( list );
 770
 771     wxList::compatibility_iterator node = m_clientList.Item( n );
 772     if ( node )
 773     {
 774         if ( m_clientDataItemsType == wxClientData_Object )
 775         {
 776             wxClientData *cd = (wxClientData*)node->GetData();
 777             delete cd;
 778         }
 779
 780         m_clientList.Erase( node );
 781     }
 782
 783     if ( m_strings )
 784         m_strings->RemoveAt(n);
 785 }
 786
 787 // ----------------------------------------------------------------------------
 788 // client data
 789 // ----------------------------------------------------------------------------
 790
 791 void wxListBox::DoSetItemClientData( int n, void* clientData )
 792 {
 793     wxCHECK_RET( m_widget != NULL, wxT("invalid listbox control") );
 794
 795     wxList::compatibility_iterator node = m_clientList.Item( n );
 796     wxCHECK_RET( node, wxT("invalid index in wxListBox::DoSetItemClientData") );
 797
 798     node->SetData( (wxObject*) clientData );
 799 }
 800
 801 void* wxListBox::DoGetItemClientData( int n ) const
 802 {
 803     wxCHECK_MSG( m_widget != NULL, NULL, wxT("invalid listbox control") );
 804
 805     wxList::compatibility_iterator node = m_clientList.Item( n );
 806     wxCHECK_MSG( node, NULL, wxT("invalid index in wxListBox::DoGetItemClientData") );
 807
 808     return node->GetData();
 809 }
 810
 811 void wxListBox::DoSetItemClientObject( int n, wxClientData* clientData )
 812 {
 813     wxCHECK_RET( m_widget != NULL, wxT("invalid listbox control") );
 814
 815     wxList::compatibility_iterator node = m_clientList.Item( n );
 816     wxCHECK_RET( node, wxT("invalid index in wxListBox::DoSetItemClientObject") );
 817
 818     // wxItemContainer already deletes data for us
 819
 820     node->SetData( (wxObject*) clientData );
 821 }
 822
 823 wxClientData* wxListBox::DoGetItemClientObject( int n ) const
 824 {
 825     wxCHECK_MSG( m_widget != NULL, (wxClientData*) NULL, wxT("invalid listbox control") );
 826
 827     wxList::compatibility_iterator node = m_clientList.Item( n );
 828     wxCHECK_MSG( node, (wxClientData *)NULL,
 829                  wxT("invalid index in wxListBox::DoGetItemClientObject") );
 830
 831     return (wxClientData*) node->GetData();
 832 }
 833
 834 // ----------------------------------------------------------------------------
 835 // string list access
 836 // ----------------------------------------------------------------------------
 837
 838 wxString wxListBox::GetRealLabel(GList *item) const
 839 {
 840     GtkBin *bin = GTK_BIN( item->data );
 841     GtkLabel *label = GTK_LABEL( bin->child );
 842
 843     wxString str;
 844
 845 #ifdef __WXGTK20__
 846     str = wxGTK_CONV_BACK( gtk_label_get_text( label ) );
 847 #else
 848     str = wxString( label->label );
 849 #endif
 850
 851 #if wxUSE_CHECKLISTBOX
 852     // checklistboxes have "[±] " prepended to their lables, remove it
 853     //
 854     // NB: 4 below is the length of wxCHECKLBOX_STRING from wx/gtk/checklst.h
 855     if ( m_hasCheckBoxes )
 856         str.erase(0, 4);
 857 #endif // wxUSE_CHECKLISTBOX
 858
 859     return str;
 860 }
 861
 862 void wxListBox::SetString( int n, const wxString &string )
 863 {
 864     wxCHECK_RET( m_list != NULL, wxT("invalid listbox") );
 865
 866     GList *child = g_list_nth( m_list->children, n );
 867     if (child)
 868     {
 869         GtkBin *bin = GTK_BIN( child->data );
 870         GtkLabel *label = GTK_LABEL( bin->child );
 871
 872         wxString str;
 873 #if wxUSE_CHECKLISTBOX
 874         if (m_hasCheckBoxes)
 875             str += wxCHECKLBOX_STRING;
 876 #endif // wxUSE_CHECKLISTBOX
 877         str += string;
 878
 879         gtk_label_set( label, wxGTK_CONV( str ) );
 880     }
 881     else
 882     {
 883         wxFAIL_MSG(wxT("wrong listbox index"));
 884     }
 885 }
 886
 887 wxString wxListBox::GetString( int n ) const
 888 {
 889     wxCHECK_MSG( m_list != NULL, wxT(""), wxT("invalid listbox") );
 890
 891     GList *child = g_list_nth( m_list->children, n );
 892     if (child)
 893     {
 894         return GetRealLabel(child);
 895     }
 896
 897     wxFAIL_MSG(wxT("wrong listbox index"));
 898
 899     return wxT("");
 900 }
 901
 902 int wxListBox::GetCount() const
 903 {
 904     wxCHECK_MSG( m_list != NULL, -1, wxT("invalid listbox") );
 905
 906     GList *children = m_list->children;
 907     return g_list_length(children);
 908 }
 909
 910 int wxListBox::FindString( const wxString &item ) const
 911 {
 912     wxCHECK_MSG( m_list != NULL, -1, wxT("invalid listbox") );
 913
 914     GList *child = m_list->children;
 915     int count = 0;
 916     while (child)
 917     {
 918         if ( GetRealLabel(child) == item )
 919             return count;
 920
 921         count++;
 922         child = child->next;
 923     }
 924
 925     // it's not an error if the string is not found -> no wxCHECK
 926
 927     return wxNOT_FOUND;
 928 }
 929
 930 // ----------------------------------------------------------------------------
 931 // selection
 932 // ----------------------------------------------------------------------------
 933
 934 int wxListBox::GetSelection() const
 935 {
 936     wxCHECK_MSG( m_list != NULL, -1, wxT("invalid listbox") );
 937
 938     GList *child = m_list->children;
 939     int count = 0;
 940     while (child)
 941     {
 942         if (GTK_WIDGET(child->data)->state == GTK_STATE_SELECTED) return count;
 943         count++;
 944         child = child->next;
 945     }
 946     return -1;
 947 }
 948
 949 int wxListBox::GetSelections( wxArrayInt& aSelections ) const
 950 {
 951     wxCHECK_MSG( m_list != NULL, -1, wxT("invalid listbox") );
 952
 953     // get the number of selected items first
 954     GList *child = m_list->children;
 955     int count = 0;
 956     for (child = m_list->children; child != NULL; child = child->next)
 957     {
 958         if (GTK_WIDGET(child->data)->state == GTK_STATE_SELECTED)
 959             count++;
 960     }
 961
 962     aSelections.Empty();
 963
 964     if (count > 0)
 965     {
 966         // now fill the list
 967         aSelections.Alloc(count); // optimization attempt
 968         int i = 0;
 969         for (child = m_list->children; child != NULL; child = child->next, i++)
 970         {
 971             if (GTK_WIDGET(child->data)->state == GTK_STATE_SELECTED)
 972                  aSelections.Add(i);
 973         }
 974     }
 975
 976     return count;
 977 }
 978
 979 bool wxListBox::IsSelected( int n ) const
 980 {
 981     wxCHECK_MSG( m_list != NULL, FALSE, wxT("invalid listbox") );
 982
 983     GList *target = g_list_nth( m_list->children, n );
 984
 985     wxCHECK_MSG( target, FALSE, wxT("invalid listbox index") );
 986
 987     return (GTK_WIDGET(target->data)->state == GTK_STATE_SELECTED) ;
 988 }
 989
 990 void wxListBox::SetSelection( int n, bool select )
 991 {
 992     wxCHECK_RET( m_list != NULL, wxT("invalid listbox") );
 993
 994     m_blockEvent = TRUE;
 995
 996     if (select)
 997     {
 998         if ((m_windowStyle & wxLB_SINGLE) != 0)
 999             gtk_list_unselect_item( m_list, m_prevSelection );
1000         gtk_list_select_item( m_list, n );
1001         m_prevSelection = n;
1002     }
1003     else
1004         gtk_list_unselect_item( m_list, n );
1005
1006     m_blockEvent = FALSE;
1007 }
1008
1009 void wxListBox::DoSetFirstItem( int n )
1010 {
1011     wxCHECK_RET( m_list, wxT("invalid listbox") );
1012
1013     if (gdk_pointer_is_grabbed () && GTK_WIDGET_HAS_GRAB (m_list))
1014         return;
1015
1016     // terribly efficient
1017     const gchar *vadjustment_key = "gtk-vadjustment";
1018     guint vadjustment_key_id = g_quark_from_static_string (vadjustment_key);
1019
1020     GtkAdjustment *adjustment =
1021        (GtkAdjustment*) gtk_object_get_data_by_id (GTK_OBJECT (m_list), vadjustment_key_id);
1022     wxCHECK_RET( adjustment, wxT("invalid listbox code") );
1023
1024     GList *target = g_list_nth( m_list->children, n );
1025     wxCHECK_RET( target, wxT("invalid listbox index") );
1026
1027     GtkWidget *item = GTK_WIDGET(target->data);
1028     wxCHECK_RET( item, wxT("invalid listbox code") );
1029
1030     if (item->allocation.y == -1)
1031     {
1032         wxlistbox_idle_struct* data = new wxlistbox_idle_struct;
1033         data->m_listbox = this;
1034         data->m_item = n;
1035         data->m_tag = gtk_idle_add_priority( 800, wxlistbox_idle_callback, (gpointer) data );
1036
1037         return;
1038     }
1039
1040     float y = item->allocation.y;
1041     if (y > adjustment->upper - adjustment->page_size)
1042         y = adjustment->upper - adjustment->page_size;
1043     gtk_adjustment_set_value( adjustment, y );
1044 }
1045
1046 // ----------------------------------------------------------------------------
1047 // helpers
1048 // ----------------------------------------------------------------------------
1049
1050 int wxListBox::GtkGetIndex( GtkWidget *item ) const
1051 {
1052     if (item)
1053     {
1054         GList *child = m_list->children;
1055         int count = 0;
1056         while (child)
1057         {
1058             if (GTK_WIDGET(child->data) == item) return count;
1059             count++;
1060             child = child->next;
1061         }
1062     }
1063     return -1;
1064 }
1065
1066 #if wxUSE_TOOLTIPS
1067 void wxListBox::ApplyToolTip( GtkTooltips *tips, const wxChar *tip )
1068 {
1069     GList *child = m_list->children;
1070     while (child)
1071     {
1072         gtk_tooltips_set_tip( tips, GTK_WIDGET( child->data ), wxConvCurrent->cWX2MB(tip), (gchar*) NULL );
1073         child = child->next;
1074     }
1075 }
1076 #endif // wxUSE_TOOLTIPS
1077
1078 GtkWidget *wxListBox::GetConnectWidget()
1079 {
1080     // return GTK_WIDGET(m_list);
1081     return m_widget;
1082 }
1083
1084 bool wxListBox::IsOwnGtkWindow( GdkWindow *window )
1085 {
1086     return TRUE;
1087
1088 #if 0
1089     if (m_widget->window == window) return TRUE;
1090
1091     if (GTK_WIDGET(m_list)->window == window) return TRUE;
1092
1093     GList *child = m_list->children;
1094     while (child)
1095     {
1096         GtkWidget *bin = GTK_WIDGET( child->data );
1097         if (bin->window == window) return TRUE;
1098         child = child->next;
1099     }
1100
1101     return FALSE;
1102 #endif
1103 }
1104
1105 void wxListBox::DoApplyWidgetStyle(GtkRcStyle *style)
1106 {
1107     if (m_hasBgCol && m_backgroundColour.Ok())
1108     {
1109         GdkWindow *window = GTK_WIDGET(m_list)->window;
1110         if ( window )
1111         {
1112             m_backgroundColour.CalcPixel( gdk_window_get_colormap( window ) );
1113             gdk_window_set_background( window, m_backgroundColour.GetColor() );
1114             gdk_window_clear( window );
1115         }
1116     }
1117
1118     GList *child = m_list->children;
1119     while (child)
1120     {
1121         gtk_widget_modify_style( GTK_WIDGET(child->data), style );
1122
1123         GtkBin *bin = GTK_BIN( child->data );
1124         GtkWidget *label = GTK_WIDGET( bin->child );
1125         gtk_widget_modify_style( label, style );
1126
1127         child = child->next;
1128     }
1129 }
1130
1131 void wxListBox::OnInternalIdle()
1132 {
1133     wxCursor cursor = m_cursor;
1134     if (g_globalCursor.Ok()) cursor = g_globalCursor;
1135
1136     if (GTK_WIDGET(m_list)->window && cursor.Ok())
1137     {
1138         /* I now set the cursor the anew in every OnInternalIdle call
1139            as setting the cursor in a parent window also effects the
1140            windows above so that checking for the current cursor is
1141            not possible. */
1142
1143         gdk_window_set_cursor( GTK_WIDGET(m_list)->window, cursor.GetCursor() );
1144
1145         GList *child = m_list->children;
1146         while (child)
1147         {
1148             GtkBin *bin = GTK_BIN( child->data );
1149             GtkWidget *label = GTK_WIDGET( bin->child );
1150
1151             if (!label->window)
1152                 break;
1153             else
1154                 gdk_window_set_cursor( label->window, cursor.GetCursor() );
1155
1156             child = child->next;
1157         }
1158     }
1159
1160     if (g_delayedFocus == this)
1161     {
1162         if (GTK_WIDGET_REALIZED(m_widget))
1163         {
1164             gtk_widget_grab_focus( m_widget );
1165             g_delayedFocus = NULL;
1166         }
1167     }
1168
1169     if (wxUpdateUIEvent::CanUpdate(this))
1170         UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
1171 }
1172
1173 wxSize wxListBox::DoGetBestSize() const
1174 {
1175     int lbWidth = 100;  // some defaults
1176     int lbHeight = 110;
1177     int wLine;
1178
1179     // Find the widest line
1180     for(int i = 0; i < GetCount(); i++) {
1181         wxString str(GetString(i));
1182         GetTextExtent(str, &wLine, NULL);
1183         lbWidth = wxMax(lbWidth, wLine);
1184     }
1185
1186     // Add room for the scrollbar
1187     lbWidth += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
1188
1189     // And just a bit more
1190     int cx, cy;
1191     GetTextExtent( wxT("X"), &cx, &cy);
1192     lbWidth += 3 * cx;
1193
1194     // don't make the listbox too tall (limit height to around 10 items) but don't
1195     // make it too small neither
1196     lbHeight = (cy+4) * wxMin(wxMax(GetCount(), 3), 10);
1197
1198     wxSize best(lbWidth, lbHeight);
1199     CacheBestSize(best);
1200     return best;
1201 }
1202
1203 void wxListBox::FixUpMouseEvent(GtkWidget *widget, wxCoord& x, wxCoord& y)
1204 {
1205     // the mouse event coords are relative to the listbox items, we need to
1206     // translate them to the normal client coords
1207     x += widget->allocation.x;
1208     y += widget->allocation.y;
1209 }
1210
1211
1212 // static
1213 wxVisualAttributes
1214 wxListBox::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
1215 {
1216     return GetDefaultAttributesFromGTKWidget(gtk_list_new, true);
1217 }
1218
1219 #endif // wxUSE_LISTBOX
1220