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