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 #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                         int n, const wxString choices[],
 322                         long style, const wxValidator& validator,
 323                         const wxString &name )
 324 {
 325     m_needParent = TRUE;
 326     m_acceptsFocus = TRUE;
 327     m_prevSelection = 0;  // or -1 ??
 328     m_blockEvent = FALSE;
 329
 330     if (!PreCreation( parent, pos, size ) ||
 331         !CreateBase( parent, id, pos, size, style, validator, name ))
 332     {
 333         wxFAIL_MSG( wxT("wxListBox creation failed") );
 334         return FALSE;
 335     }
 336
 337     m_widget = gtk_scrolled_window_new( (GtkAdjustment*) NULL, (GtkAdjustment*) NULL );
 338     if (style & wxLB_ALWAYS_SB)
 339     {
 340       gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
 341         GTK_POLICY_AUTOMATIC, GTK_POLICY_ALWAYS );
 342     }
 343     else
 344     {
 345       gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
 346         GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
 347     }
 348
 349     m_list = GTK_LIST( gtk_list_new() );
 350
 351     GtkSelectionMode mode;
 352     if (style & wxLB_MULTIPLE)
 353     {
 354         mode = GTK_SELECTION_MULTIPLE;
 355     }
 356     else if (style & wxLB_EXTENDED)
 357     {
 358         mode = GTK_SELECTION_EXTENDED;
 359     }
 360     else
 361     {
 362         // if style was 0 set single mode
 363         m_windowStyle |= wxLB_SINGLE;
 364         mode = GTK_SELECTION_MULTIPLE;
 365     }
 366
 367     gtk_list_set_selection_mode( GTK_LIST(m_list), mode );
 368
 369     gtk_scrolled_window_add_with_viewport( GTK_SCROLLED_WINDOW(m_widget), GTK_WIDGET(m_list) );
 370
 371     /* make list scroll when moving the focus down using cursor keys */
 372     gtk_container_set_focus_vadjustment(
 373         GTK_CONTAINER(m_list),
 374         gtk_scrolled_window_get_vadjustment(
 375             GTK_SCROLLED_WINDOW(m_widget)));
 376
 377     gtk_widget_show( GTK_WIDGET(m_list) );
 378
 379     if ( style & wxLB_SORT )
 380     {
 381         // this will change DoAppend() behaviour
 382         m_strings = new wxSortedArrayString;
 383     }
 384     else
 385     {
 386         m_strings = (wxSortedArrayString *)NULL;
 387     }
 388
 389     for (int i = 0; i < n; i++)
 390     {
 391         // add one by one
 392         DoAppend(choices[i]);
 393     }
 394
 395     // call it after appending the strings to the listbox, otherwise it doesn't
 396     // work correctly
 397     SetBestSize( size );
 398
 399     m_parent->DoAddChild( this );
 400
 401     PostCreation();
 402
 403     SetBackgroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_LISTBOX ) );
 404     SetForegroundColour( parent->GetForegroundColour() );
 405     SetFont( parent->GetFont() );
 406
 407     Show( TRUE );
 408
 409     return TRUE;
 410 }
 411
 412 wxListBox::~wxListBox()
 413 {
 414     m_hasVMT = FALSE;
 415
 416     Clear();
 417
 418     if (m_strings)
 419       delete m_strings;
 420 }
 421
 422 // ----------------------------------------------------------------------------
 423 // adding items
 424 // ----------------------------------------------------------------------------
 425
 426 void wxListBox::DoInsertItems(const wxArrayString& items, int pos)
 427 {
 428     wxCHECK_RET( m_list != NULL, wxT("invalid listbox") );
 429
 430     // VZ: notice that InsertItems knows nothing about sorting, so calling it
 431     //     from outside (and not from our own Append) is likely to break
 432     //     everything
 433
 434     // code elsewhere supposes we have as many items in m_clientList as items
 435     // in the listbox
 436     wxASSERT_MSG( m_clientList.GetCount() == (size_t)GetCount(),
 437                   wxT("bug in client data management") );
 438
 439     GList *children = m_list->children;
 440     int length = g_list_length(children);
 441
 442     wxCHECK_RET( pos <= length, wxT("invalid index in wxListBox::InsertItems") );
 443
 444     size_t nItems = items.GetCount();
 445     int index;
 446
 447     if (m_strings)
 448     {
 449         for (size_t n = 0; n < nItems; n++)
 450         {
 451             index = m_strings->Add( items[n] );
 452
 453             if (index != GetCount())
 454             {
 455                 GtkAddItem( items[n], index );
 456                 wxList::compatibility_iterator node = m_clientList.Item( index );
 457                 m_clientList.Insert( node, (wxObject*) NULL );
 458             }
 459             else
 460             {
 461                 GtkAddItem( items[n] );
 462                 m_clientList.Append( (wxObject*) NULL );
 463             }
 464         }
 465     }
 466     else
 467     {
 468         if (pos == length)
 469         {
 470             for ( size_t n = 0; n < nItems; n++ )
 471             {
 472                 GtkAddItem( items[n] );
 473
 474                 m_clientList.Append((wxObject *)NULL);
 475             }
 476         }
 477         else
 478         {
 479             wxList::compatibility_iterator node = m_clientList.Item( pos );
 480             for ( size_t n = 0; n < nItems; n++ )
 481             {
 482                 GtkAddItem( items[n], pos+n );
 483
 484                 m_clientList.Insert( node, (wxObject *)NULL );
 485             }
 486         }
 487     }
 488
 489     wxASSERT_MSG( m_clientList.GetCount() == (size_t)GetCount(),
 490                       wxT("bug in client data management") );
 491 }
 492
 493 int wxListBox::DoAppend( const wxString& item )
 494 {
 495     if (m_strings)
 496     {
 497         // need to determine the index
 498         int index = m_strings->Add( item );
 499
 500         // only if not at the end anyway
 501         if (index != GetCount())
 502         {
 503            GtkAddItem( item, index );
 504
 505            wxList::compatibility_iterator node = m_clientList.Item( index );
 506            m_clientList.Insert( node, (wxObject *)NULL );
 507
 508            return index;
 509         }
 510     }
 511
 512     GtkAddItem(item);
 513
 514     m_clientList.Append((wxObject *)NULL);
 515
 516     return GetCount() - 1;
 517 }
 518
 519 void wxListBox::GtkAddItem( const wxString &item, int pos )
 520 {
 521     wxCHECK_RET( m_list != NULL, wxT("invalid listbox") );
 522
 523     GtkWidget *list_item;
 524
 525     wxString label(item);
 526 #if wxUSE_CHECKLISTBOX
 527     if (m_hasCheckBoxes)
 528     {
 529         label.Prepend(wxCHECKLBOX_STRING);
 530     }
 531 #endif // wxUSE_CHECKLISTBOX
 532
 533     list_item = gtk_list_item_new_with_label( wxGTK_CONV( label ) );
 534
 535     GList *gitem_list = g_list_alloc ();
 536     gitem_list->data = list_item;
 537
 538     if (pos == -1)
 539         gtk_list_append_items( GTK_LIST (m_list), gitem_list );
 540     else
 541         gtk_list_insert_items( GTK_LIST (m_list), gitem_list, pos );
 542
 543     gtk_signal_connect( GTK_OBJECT(list_item), "select",
 544       GTK_SIGNAL_FUNC(gtk_listitem_select_callback), (gpointer)this );
 545
 546     if (HasFlag(wxLB_MULTIPLE) || HasFlag(wxLB_EXTENDED))
 547         gtk_signal_connect( GTK_OBJECT(list_item), "deselect",
 548           GTK_SIGNAL_FUNC(gtk_listitem_deselect_callback), (gpointer)this );
 549
 550     gtk_signal_connect( GTK_OBJECT(list_item),
 551                         "button_press_event",
 552                         (GtkSignalFunc)gtk_listbox_button_press_callback,
 553                         (gpointer) this );
 554
 555     gtk_signal_connect_after( GTK_OBJECT(list_item),
 556                         "button_release_event",
 557                         (GtkSignalFunc)gtk_listbox_button_release_callback,
 558                         (gpointer) this );
 559
 560     gtk_signal_connect( GTK_OBJECT(list_item),
 561                            "key_press_event",
 562                            (GtkSignalFunc)gtk_listbox_key_press_callback,
 563                            (gpointer)this );
 564
 565     ConnectWidget( list_item );
 566
 567     gtk_widget_show( list_item );
 568
 569     if (GTK_WIDGET_REALIZED(m_widget))
 570     {
 571         gtk_widget_realize( list_item );
 572         gtk_widget_realize( GTK_BIN(list_item)->child );
 573
 574         // Apply current widget style to the new list_item
 575         if (m_widgetStyle)
 576         {
 577             gtk_widget_set_style( GTK_WIDGET( list_item ), m_widgetStyle );
 578             GtkBin *bin = GTK_BIN( list_item );
 579             GtkWidget *label = GTK_WIDGET( bin->child );
 580             gtk_widget_set_style( label, m_widgetStyle );
 581         }
 582
 583 #if wxUSE_TOOLTIPS
 584         if (m_tooltip) m_tooltip->Apply( this );
 585 #endif
 586     }
 587 }
 588
 589 void wxListBox::DoSetItems( const wxArrayString& items,
 590                             void **clientData)
 591 {
 592     Clear();
 593
 594     DoInsertItems(items, 0);
 595
 596     if ( clientData )
 597     {
 598         size_t count = items.GetCount();
 599         for ( size_t n = 0; n < count; n++ )
 600         {
 601             SetClientData(n, clientData[n]);
 602         }
 603     }
 604 }
 605
 606 // ----------------------------------------------------------------------------
 607 // deleting items
 608 // ----------------------------------------------------------------------------
 609
 610 void wxListBox::Clear()
 611 {
 612     wxCHECK_RET( m_list != NULL, wxT("invalid listbox") );
 613
 614     gtk_list_clear_items( m_list, 0, GetCount() );
 615
 616     if ( GTK_LIST(m_list)->last_focus_child != NULL  )
 617     {
 618         // This should be NULL, I think.
 619         GTK_LIST(m_list)->last_focus_child = NULL;
 620     }
 621
 622     if ( HasClientObjectData() )
 623     {
 624         // destroy the data (due to Robert's idea of using wxList<wxObject>
 625         // and not wxList<wxClientData> we can't just say
 626         // m_clientList.DeleteContents(TRUE) - this would crash!
 627         wxList::compatibility_iterator node = m_clientList.GetFirst();
 628         while ( node )
 629         {
 630             delete (wxClientData *)node->GetData();
 631             node = node->GetNext();
 632         }
 633     }
 634     m_clientList.Clear();
 635
 636     if ( m_strings )
 637         m_strings->Clear();
 638 }
 639
 640 void wxListBox::Delete( int n )
 641 {
 642     wxCHECK_RET( m_list != NULL, wxT("invalid listbox") );
 643
 644     GList *child = g_list_nth( m_list->children, n );
 645
 646     wxCHECK_RET( child, wxT("wrong listbox index") );
 647
 648     GList *list = g_list_append( (GList*) NULL, child->data );
 649     gtk_list_remove_items( m_list, list );
 650     g_list_free( list );
 651
 652     wxList::compatibility_iterator node = m_clientList.Item( n );
 653     if ( node )
 654     {
 655         if ( m_clientDataItemsType == wxClientData_Object )
 656         {
 657             wxClientData *cd = (wxClientData*)node->GetData();
 658             delete cd;
 659         }
 660
 661         m_clientList.Erase( node );
 662     }
 663
 664     if ( m_strings )
 665         m_strings->RemoveAt(n);
 666 }
 667
 668 // ----------------------------------------------------------------------------
 669 // client data
 670 // ----------------------------------------------------------------------------
 671
 672 void wxListBox::DoSetItemClientData( int n, void* clientData )
 673 {
 674     wxCHECK_RET( m_widget != NULL, wxT("invalid listbox control") );
 675
 676     wxList::compatibility_iterator node = m_clientList.Item( n );
 677     wxCHECK_RET( node, wxT("invalid index in wxListBox::DoSetItemClientData") );
 678
 679     node->SetData( (wxObject*) clientData );
 680 }
 681
 682 void* wxListBox::DoGetItemClientData( int n ) const
 683 {
 684     wxCHECK_MSG( m_widget != NULL, NULL, wxT("invalid listbox control") );
 685
 686     wxList::compatibility_iterator node = m_clientList.Item( n );
 687     wxCHECK_MSG( node, NULL, wxT("invalid index in wxListBox::DoGetItemClientData") );
 688
 689     return node->GetData();
 690 }
 691
 692 void wxListBox::DoSetItemClientObject( int n, wxClientData* clientData )
 693 {
 694     wxCHECK_RET( m_widget != NULL, wxT("invalid listbox control") );
 695
 696     wxList::compatibility_iterator node = m_clientList.Item( n );
 697     wxCHECK_RET( node, wxT("invalid index in wxListBox::DoSetItemClientObject") );
 698
 699     // wxItemContainer already deletes data for us
 700
 701     node->SetData( (wxObject*) clientData );
 702 }
 703
 704 wxClientData* wxListBox::DoGetItemClientObject( int n ) const
 705 {
 706     wxCHECK_MSG( m_widget != NULL, (wxClientData*) NULL, wxT("invalid listbox control") );
 707
 708     wxList::compatibility_iterator node = m_clientList.Item( n );
 709     wxCHECK_MSG( node, (wxClientData *)NULL,
 710                  wxT("invalid index in wxListBox::DoGetItemClientObject") );
 711
 712     return (wxClientData*) node->GetData();
 713 }
 714
 715 // ----------------------------------------------------------------------------
 716 // string list access
 717 // ----------------------------------------------------------------------------
 718
 719 wxString wxListBox::GetRealLabel(GList *item) const
 720 {
 721     GtkBin *bin = GTK_BIN( item->data );
 722     GtkLabel *label = GTK_LABEL( bin->child );
 723
 724     wxString str;
 725
 726 #ifdef __WXGTK20__
 727     str = wxGTK_CONV_BACK( gtk_label_get_text( label ) );
 728 #else
 729     str = wxString( label->label );
 730 #endif
 731
 732 #if wxUSE_CHECKLISTBOX
 733     // checklistboxes have "[±] " prepended to their lables, remove it
 734     //
 735     // NB: 4 below is the length of wxCHECKLBOX_STRING from wx/gtk/checklst.h
 736     if ( m_hasCheckBoxes )
 737         str.erase(0, 4);
 738 #endif // wxUSE_CHECKLISTBOX
 739
 740     return str;
 741 }
 742
 743 void wxListBox::SetString( int n, const wxString &string )
 744 {
 745     wxCHECK_RET( m_list != NULL, wxT("invalid listbox") );
 746
 747     GList *child = g_list_nth( m_list->children, n );
 748     if (child)
 749     {
 750         GtkBin *bin = GTK_BIN( child->data );
 751         GtkLabel *label = GTK_LABEL( bin->child );
 752
 753         wxString str;
 754 #if wxUSE_CHECKLISTBOX
 755         if (m_hasCheckBoxes)
 756             str += wxCHECKLBOX_STRING;
 757 #endif // wxUSE_CHECKLISTBOX
 758         str += string;
 759
 760         gtk_label_set( label, wxGTK_CONV( str ) );
 761     }
 762     else
 763     {
 764         wxFAIL_MSG(wxT("wrong listbox index"));
 765     }
 766 }
 767
 768 wxString wxListBox::GetString( int n ) const
 769 {
 770     wxCHECK_MSG( m_list != NULL, wxT(""), wxT("invalid listbox") );
 771
 772     GList *child = g_list_nth( m_list->children, n );
 773     if (child)
 774     {
 775         return GetRealLabel(child);
 776     }
 777
 778     wxFAIL_MSG(wxT("wrong listbox index"));
 779
 780     return wxT("");
 781 }
 782
 783 int wxListBox::GetCount() const
 784 {
 785     wxCHECK_MSG( m_list != NULL, -1, wxT("invalid listbox") );
 786
 787     GList *children = m_list->children;
 788     return g_list_length(children);
 789 }
 790
 791 int wxListBox::FindString( const wxString &item ) const
 792 {
 793     wxCHECK_MSG( m_list != NULL, -1, wxT("invalid listbox") );
 794
 795     GList *child = m_list->children;
 796     int count = 0;
 797     while (child)
 798     {
 799         if ( GetRealLabel(child) == item )
 800             return count;
 801
 802         count++;
 803         child = child->next;
 804     }
 805
 806     // it's not an error if the string is not found -> no wxCHECK
 807
 808     return wxNOT_FOUND;
 809 }
 810
 811 // ----------------------------------------------------------------------------
 812 // selection
 813 // ----------------------------------------------------------------------------
 814
 815 int wxListBox::GetSelection() const
 816 {
 817     wxCHECK_MSG( m_list != NULL, -1, wxT("invalid listbox") );
 818
 819     GList *child = m_list->children;
 820     int count = 0;
 821     while (child)
 822     {
 823         if (GTK_WIDGET(child->data)->state == GTK_STATE_SELECTED) return count;
 824         count++;
 825         child = child->next;
 826     }
 827     return -1;
 828 }
 829
 830 int wxListBox::GetSelections( wxArrayInt& aSelections ) const
 831 {
 832     wxCHECK_MSG( m_list != NULL, -1, wxT("invalid listbox") );
 833
 834     // get the number of selected items first
 835     GList *child = m_list->children;
 836     int count = 0;
 837     for (child = m_list->children; child != NULL; child = child->next)
 838     {
 839         if (GTK_WIDGET(child->data)->state == GTK_STATE_SELECTED)
 840             count++;
 841     }
 842
 843     aSelections.Empty();
 844
 845     if (count > 0)
 846     {
 847         // now fill the list
 848         aSelections.Alloc(count); // optimization attempt
 849         int i = 0;
 850         for (child = m_list->children; child != NULL; child = child->next, i++)
 851         {
 852             if (GTK_WIDGET(child->data)->state == GTK_STATE_SELECTED)
 853                  aSelections.Add(i);
 854         }
 855     }
 856
 857     return count;
 858 }
 859
 860 bool wxListBox::IsSelected( int n ) const
 861 {
 862     wxCHECK_MSG( m_list != NULL, FALSE, wxT("invalid listbox") );
 863
 864     GList *target = g_list_nth( m_list->children, n );
 865
 866     wxCHECK_MSG( target, FALSE, wxT("invalid listbox index") );
 867
 868     return (GTK_WIDGET(target->data)->state == GTK_STATE_SELECTED) ;
 869 }
 870
 871 void wxListBox::SetSelection( int n, bool select )
 872 {
 873     wxCHECK_RET( m_list != NULL, wxT("invalid listbox") );
 874
 875     m_blockEvent = TRUE;
 876
 877     if (select)
 878     {
 879         if ((m_windowStyle & wxLB_SINGLE) != 0)
 880             gtk_list_unselect_item( m_list, m_prevSelection );
 881         gtk_list_select_item( m_list, n );
 882         m_prevSelection = n;
 883     }
 884     else
 885         gtk_list_unselect_item( m_list, n );
 886
 887     m_blockEvent = FALSE;
 888 }
 889
 890 void wxListBox::DoSetFirstItem( int n )
 891 {
 892     wxCHECK_RET( m_list, wxT("invalid listbox") );
 893
 894     if (gdk_pointer_is_grabbed () && GTK_WIDGET_HAS_GRAB (m_list))
 895         return;
 896
 897     // terribly efficient
 898     const gchar *vadjustment_key = "gtk-vadjustment";
 899     guint vadjustment_key_id = g_quark_from_static_string (vadjustment_key);
 900
 901     GtkAdjustment *adjustment =
 902        (GtkAdjustment*) gtk_object_get_data_by_id (GTK_OBJECT (m_list), vadjustment_key_id);
 903     wxCHECK_RET( adjustment, wxT("invalid listbox code") );
 904
 905     GList *target = g_list_nth( m_list->children, n );
 906     wxCHECK_RET( target, wxT("invalid listbox index") );
 907
 908     GtkWidget *item = GTK_WIDGET(target->data);
 909     wxCHECK_RET( item, wxT("invalid listbox code") );
 910
 911     if (item->allocation.y == -1)
 912     {
 913         wxlistbox_idle_struct* data = new wxlistbox_idle_struct;
 914         data->m_listbox = this;
 915         data->m_item = n;
 916         data->m_tag = gtk_idle_add_priority( 800, wxlistbox_idle_callback, (gpointer) data );
 917
 918         return;
 919     }
 920
 921     float y = item->allocation.y;
 922     if (y > adjustment->upper - adjustment->page_size)
 923         y = adjustment->upper - adjustment->page_size;
 924     gtk_adjustment_set_value( adjustment, y );
 925 }
 926
 927 // ----------------------------------------------------------------------------
 928 // helpers
 929 // ----------------------------------------------------------------------------
 930
 931 int wxListBox::GtkGetIndex( GtkWidget *item ) const
 932 {
 933     if (item)
 934     {
 935         GList *child = m_list->children;
 936         int count = 0;
 937         while (child)
 938         {
 939             if (GTK_WIDGET(child->data) == item) return count;
 940             count++;
 941             child = child->next;
 942         }
 943     }
 944     return -1;
 945 }
 946
 947 #if wxUSE_TOOLTIPS
 948 void wxListBox::ApplyToolTip( GtkTooltips *tips, const wxChar *tip )
 949 {
 950     GList *child = m_list->children;
 951     while (child)
 952     {
 953         gtk_tooltips_set_tip( tips, GTK_WIDGET( child->data ), wxConvCurrent->cWX2MB(tip), (gchar*) NULL );
 954         child = child->next;
 955     }
 956 }
 957 #endif // wxUSE_TOOLTIPS
 958
 959 GtkWidget *wxListBox::GetConnectWidget()
 960 {
 961     return GTK_WIDGET(m_list);
 962 }
 963
 964 bool wxListBox::IsOwnGtkWindow( GdkWindow *window )
 965 {
 966     if (m_widget->window == window) return TRUE;
 967
 968     if (GTK_WIDGET(m_list)->window == window) return TRUE;
 969
 970     GList *child = m_list->children;
 971     while (child)
 972     {
 973         GtkWidget *bin = GTK_WIDGET( child->data );
 974         if (bin->window == window) return TRUE;
 975         child = child->next;
 976     }
 977
 978     return FALSE;
 979 }
 980
 981 void wxListBox::ApplyWidgetStyle()
 982 {
 983     SetWidgetStyle();
 984
 985     if (m_backgroundColour.Ok())
 986     {
 987         GdkWindow *window = GTK_WIDGET(m_list)->window;
 988         if ( window )
 989         {
 990             m_backgroundColour.CalcPixel( gdk_window_get_colormap( window ) );
 991             gdk_window_set_background( window, m_backgroundColour.GetColor() );
 992             gdk_window_clear( window );
 993         }
 994     }
 995
 996     GList *child = m_list->children;
 997     while (child)
 998     {
 999         gtk_widget_set_style( GTK_WIDGET(child->data), m_widgetStyle );
1000
1001         GtkBin *bin = GTK_BIN( child->data );
1002         GtkWidget *label = GTK_WIDGET( bin->child );
1003         gtk_widget_set_style( label, m_widgetStyle );
1004
1005         child = child->next;
1006     }
1007 }
1008
1009 void wxListBox::OnInternalIdle()
1010 {
1011     wxCursor cursor = m_cursor;
1012     if (g_globalCursor.Ok()) cursor = g_globalCursor;
1013
1014     if (GTK_WIDGET(m_list)->window && cursor.Ok())
1015     {
1016         /* I now set the cursor the anew in every OnInternalIdle call
1017            as setting the cursor in a parent window also effects the
1018            windows above so that checking for the current cursor is
1019            not possible. */
1020
1021         gdk_window_set_cursor( GTK_WIDGET(m_list)->window, cursor.GetCursor() );
1022
1023         GList *child = m_list->children;
1024         while (child)
1025         {
1026             GtkBin *bin = GTK_BIN( child->data );
1027             GtkWidget *label = GTK_WIDGET( bin->child );
1028
1029             if (!label->window)
1030                 break;
1031             else
1032                 gdk_window_set_cursor( label->window, cursor.GetCursor() );
1033
1034             child = child->next;
1035         }
1036     }
1037
1038     if (g_delayedFocus == this)
1039     {
1040         if (GTK_WIDGET_REALIZED(m_widget))
1041         {
1042             gtk_widget_grab_focus( m_widget );
1043             g_delayedFocus = NULL;
1044         }
1045     }
1046
1047     if (wxUpdateUIEvent::CanUpdate(this))
1048         UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
1049 }
1050
1051 wxSize wxListBox::DoGetBestSize() const
1052 {
1053     int lbWidth = 100;  // some defaults
1054     int lbHeight = 110;
1055     int wLine;
1056
1057     // Find the widest line
1058     for(int i = 0; i < GetCount(); i++) {
1059         wxString str(GetString(i));
1060         GetTextExtent(str, &wLine, NULL);
1061         lbWidth = wxMax(lbWidth, wLine);
1062     }
1063
1064     // Add room for the scrollbar
1065     lbWidth += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
1066
1067     // And just a bit more
1068     int cx, cy;
1069     GetTextExtent( wxT("X"), &cx, &cy);
1070     lbWidth += 3 * cx;
1071
1072     // don't make the listbox too tall (limit height to around 10 items) but don't
1073     // make it too small neither
1074     lbHeight = (cy+4) * wxMin(wxMax(GetCount(), 3), 10);
1075
1076     return wxSize(lbWidth, lbHeight);
1077 }
1078
1079 void wxListBox::FixUpMouseEvent(GtkWidget *widget, wxCoord& x, wxCoord& y)
1080 {
1081     // the mouse event coords are relative to the listbox items, we need to
1082     // translate them to the normal client coords
1083     x += widget->allocation.x;
1084     y += widget->allocation.y;
1085 }
1086
1087 #endif // wxUSE_LISTBOX
1088