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