src/gtk/listbox.cpp

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