#11259: Correction for bad help button on OSX

[wxWidgets.git] / src / gtk / listbox.cpp

diff --git a/src/gtk/listbox.cpp b/src/gtk/listbox.cpp
index f1e5f96b1ebd071bcb212f15853b40014b6d6705..dccdd75c778edcaa1207435aed3c67fd8c840704 100644 (file)
--- a/src/gtk/listbox.cpp
+++ b/src/gtk/listbox.cpp
@@ -119,37 +119,15 @@ gtk_listitem_changed_callback(GtkTreeSelection * WXUNUSED(selection),
 {
     if (g_blockEventsOnDrag) return;
 
 {
     if (g_blockEventsOnDrag) return;
 

-    if (listbox->m_blockEvent) return;
-
-    wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, listbox->GetId() );
-    event.SetEventObject( listbox );
-
-    if (listbox->HasFlag(wxLB_MULTIPLE) || listbox->HasFlag(wxLB_EXTENDED))
+    if (listbox->HasFlag(wxLB_MULTIPLE | wxLB_EXTENDED))

     {
     {

-        wxArrayInt selections;
-        listbox->GetSelections( selections );
-
-        if (selections.GetCount() == 0)
-        {
-            // indicate that this is a deselection
-            event.SetExtraLong( 0 );
-            event.SetInt( -1 );
-
-            listbox->HandleWindowEvent( event );
-
-            return;
-        }
-        else
-        {
-            // indicate that this is a selection
-            event.SetExtraLong( 1 );
-            event.SetInt( selections[0] );
-
-            listbox->HandleWindowEvent( event );
-        }
+        listbox->CalcAndSendEvent();

     }
     }

-    else
+    else // single selection

     {
     {

+        wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, listbox->GetId() );
+        event.SetEventObject( listbox );
+

         int index = listbox->GetSelection();
         if (index == wxNOT_FOUND)
         {
         int index = listbox->GetSelection();
         if (index == wxNOT_FOUND)
         {


@@ -191,21 +169,31 @@ gtk_listitem_changed_callback(GtkTreeSelection * WXUNUSED(selection),
 //-----------------------------------------------------------------------------
 
 extern "C" {
 //-----------------------------------------------------------------------------
 
 extern "C" {

-static gint
+static gboolean

 gtk_listbox_key_press_callback( GtkWidget *WXUNUSED(widget),
                                 GdkEventKey *gdk_event,
                                 wxListBox *listbox )
 {
 gtk_listbox_key_press_callback( GtkWidget *WXUNUSED(widget),
                                 GdkEventKey *gdk_event,
                                 wxListBox *listbox )
 {

-    if ((gdk_event->keyval == GDK_Return) || 
+    if ((gdk_event->keyval == GDK_Return) ||

         (gdk_event->keyval == GDK_ISO_Enter) ||
         (gdk_event->keyval == GDK_KP_Enter))
     {
         (gdk_event->keyval == GDK_ISO_Enter) ||
         (gdk_event->keyval == GDK_KP_Enter))
     {

-        int index = listbox->GetSelection();
+        int index = -1;
+        if (!listbox->HasMultipleSelection())
+            index = listbox->GetSelection();
+        else
+        {
+            wxArrayInt sels;
+            if (listbox->GetSelections( sels ) < 1)
+                return FALSE;
+            index = sels[0];
+        }
+

         if (index != wxNOT_FOUND)
         {
             wxCommandEvent event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, listbox->GetId() );
             event.SetEventObject( listbox );
         if (index != wxNOT_FOUND)
         {
             wxCommandEvent event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, listbox->GetId() );
             event.SetEventObject( listbox );

-            
+

             GtkTreeEntry* entry = listbox->GtkGetEntry( index );
 
             // indicate that this is a selection
             GtkTreeEntry* entry = listbox->GtkGetEntry( index );
 
             // indicate that this is a selection


@@ -221,11 +209,12 @@ gtk_listbox_key_press_callback( GtkWidget *WXUNUSED(widget),
             else if ( listbox->HasClientUntypedData() )
                 event.SetClientData( gtk_tree_entry_get_userdata(entry) );
 
             else if ( listbox->HasClientUntypedData() )
                 event.SetClientData( gtk_tree_entry_get_userdata(entry) );
 

-            bool ret = listbox->HandleWindowEvent( event );
+            /* bool ret = */ listbox->HandleWindowEvent( event );

 
             g_object_unref (entry);
 
             g_object_unref (entry);

-            
-            if (!ret)
+
+//          wxMac and wxMSW always invoke default action
+//          if (!ret)

             {
                 // DClick not handled -> invoke default action
                 wxWindow *tlw = wxGetTopLevelParent( listbox );
             {
                 // DClick not handled -> invoke default action
                 wxWindow *tlw = wxGetTopLevelParent( listbox );


@@ -236,13 +225,13 @@ gtk_listbox_key_press_callback( GtkWidget *WXUNUSED(widget),
                         gtk_window_activate_default( gtk_window );
                 }
             }
                         gtk_window_activate_default( gtk_window );
                 }
             }

-            
+

             // Always intercept, otherwise we'd get another dclick
             // event from row_activated
             return TRUE;
         }
     }
             // Always intercept, otherwise we'd get another dclick
             // event from row_activated
             return TRUE;
         }
     }

-    
+

     return FALSE;
 }
 }
     return FALSE;
 }
 }


@@ -341,7 +330,7 @@ IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControlWithItems)
 
 void wxListBox::Init()
 {
 
 void wxListBox::Init()
 {

-    m_treeview = (GtkTreeView*) NULL;
+    m_treeview = NULL;

 #if wxUSE_CHECKLISTBOX
     m_hasCheckBoxes = false;
 #endif // wxUSE_CHECKLISTBOX
 #if wxUSE_CHECKLISTBOX
     m_hasCheckBoxes = false;
 #endif // wxUSE_CHECKLISTBOX


@@ -365,8 +354,6 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id,
                         long style, const wxValidator& validator,
                         const wxString &name )
 {
                         long style, const wxValidator& validator,
                         const wxString &name )
 {

-    m_blockEvent = false;
-

     if (!PreCreation( parent, pos, size ) ||
         !CreateBase( parent, id, pos, size, style, validator, name ))
     {
     if (!PreCreation( parent, pos, size ) ||
         !CreateBase( parent, id, pos, size, style, validator, name ))
     {


@@ -374,7 +361,8 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id,
         return false;
     }
 
         return false;
     }
 

-    m_widget = gtk_scrolled_window_new( (GtkAdjustment*) NULL, (GtkAdjustment*) NULL );
+    m_widget = gtk_scrolled_window_new( NULL, NULL );
+    g_object_ref(m_widget);

     if (style & wxLB_ALWAYS_SB)
     {
       gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
     if (style & wxLB_ALWAYS_SB)
     {
       gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),


@@ -387,7 +375,7 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id,
     }
 
 
     }
 
 

-    GtkScrolledWindowSetBorder(m_widget, style);
+    GTKScrolledWindowSetBorder(m_widget, style);

 
     m_treeview = GTK_TREE_VIEW( gtk_tree_view_new( ) );
 
 
     m_treeview = GTK_TREE_VIEW( gtk_tree_view_new( ) );
 


@@ -433,28 +421,19 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id,
 
     gtk_tree_view_set_enable_search(m_treeview, FALSE);
 
 
     gtk_tree_view_set_enable_search(m_treeview, FALSE);
 

-
-    GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
-
-    g_signal_connect_after (selection, "changed",
-                            G_CALLBACK (gtk_listitem_changed_callback), this);
-

     GtkSelectionMode mode;
     GtkSelectionMode mode;

-    if (style & wxLB_MULTIPLE)
+    // GTK_SELECTION_EXTENDED is a deprecated synonym for GTK_SELECTION_MULTIPLE
+    if ( style & (wxLB_MULTIPLE | wxLB_EXTENDED) )

     {
         mode = GTK_SELECTION_MULTIPLE;
     }
     {
         mode = GTK_SELECTION_MULTIPLE;
     }

-    else if (style & wxLB_EXTENDED)
-    {
-        mode = GTK_SELECTION_EXTENDED;
-    }
-    else
+    else // no multi-selection flags specified

     {
     {

-        // if style was 0 set single mode

         m_windowStyle |= wxLB_SINGLE;
         mode = GTK_SELECTION_SINGLE;
     }
 
         m_windowStyle |= wxLB_SINGLE;
         mode = GTK_SELECTION_SINGLE;
     }
 

+    GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );

     gtk_tree_selection_set_mode( selection, mode );
 
     // Handle sortable stuff
     gtk_tree_selection_set_mode( selection, mode );
 
     // Handle sortable stuff


@@ -495,6 +474,9 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id,
     PostCreation(size);
     SetInitialSize(size); // need this too because this is a wxControlWithItems
 
     PostCreation(size);
     SetInitialSize(size); // need this too because this is a wxControlWithItems
 

+    g_signal_connect_after (selection, "changed",
+                            G_CALLBACK (gtk_listitem_changed_callback), this);
+

     return true;
 }
 
     return true;
 }
 


@@ -505,6 +487,33 @@ wxListBox::~wxListBox()
     Clear();
 }
 
     Clear();
 }
 

+void wxListBox::GtkDisableEvents()
+{
+    GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
+
+    g_signal_handlers_block_by_func(selection,
+                                (gpointer) gtk_listitem_changed_callback, this);
+}
+
+void wxListBox::GtkEnableEvents()
+{
+    GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
+
+    g_signal_handlers_unblock_by_func(selection,
+                                (gpointer) gtk_listitem_changed_callback, this);
+
+    UpdateOldSelections();
+}
+
+
+void wxListBox::Update()
+{
+    wxWindow::Update();
+
+    if (m_treeview)
+        gdk_window_process_updates(GTK_WIDGET(m_treeview)->window, TRUE);
+}
+

 // ----------------------------------------------------------------------------
 // adding items
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // adding items
 // ----------------------------------------------------------------------------


@@ -548,6 +557,8 @@ int wxListBox::DoInsertItems(const wxArrayStringsAdapter& items,
             AssignNewItemClientData(GtkGetIndexFor(itercur), clientData, i, type);
     }
 
             AssignNewItemClientData(GtkGetIndexFor(itercur), clientData, i, type);
     }
 

+    UpdateOldSelections();
+

     return pos + numItems - 1;
 }
 
     return pos + numItems - 1;
 }
 


@@ -559,9 +570,13 @@ void wxListBox::DoClear()
 {
     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 
 {
     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 

+    GtkDisableEvents(); // just in case
+

     InvalidateBestSize();
 
     gtk_list_store_clear( m_liststore ); /* well, THAT was easy :) */
     InvalidateBestSize();
 
     gtk_list_store_clear( m_liststore ); /* well, THAT was easy :) */

+
+    GtkEnableEvents();

 }
 
 void wxListBox::DoDeleteOneItem(unsigned int n)
 }
 
 void wxListBox::DoDeleteOneItem(unsigned int n)


@@ -570,12 +585,16 @@ void wxListBox::DoDeleteOneItem(unsigned int n)
 
     InvalidateBestSize();
 
 
     InvalidateBestSize();
 

+    GtkDisableEvents(); // just in case
+

     GtkTreeIter iter;
     wxCHECK_RET( GtkGetIteratorFor(n, &iter), wxT("wrong listbox index") );
 
     // this returns false if iter is invalid (e.g. deleting item at end) but
     // since we don't use iter, we ignore the return value
     gtk_list_store_remove(m_liststore, &iter);
     GtkTreeIter iter;
     wxCHECK_RET( GtkGetIteratorFor(n, &iter), wxT("wrong listbox index") );
 
     // this returns false if iter is invalid (e.g. deleting item at end) but
     // since we don't use iter, we ignore the return value
     gtk_list_store_remove(m_liststore, &iter);

+
+    GtkEnableEvents();

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -601,7 +620,7 @@ int wxListBox::GtkGetIndexFor(GtkTreeIter& iter) const
 
     gint* pIntPath = gtk_tree_path_get_indices(path);
 
 
     gint* pIntPath = gtk_tree_path_get_indices(path);
 

-    wxCHECK_MSG( pIntPath, wxNOT_FOUND, _T("failed to get iterator path") );
+    wxCHECK_MSG( pIntPath, wxNOT_FOUND, wxT("failed to get iterator path") );

 
     int idx = pIntPath[0];
 
 
     int idx = pIntPath[0];
 


@@ -688,7 +707,7 @@ void wxListBox::SetString(unsigned int n, const wxString& label)
 
     // and update the model which will refresh the tree too
     GtkTreeIter iter;
 
     // and update the model which will refresh the tree too
     GtkTreeIter iter;

-    wxCHECK_RET( GtkGetIteratorFor(n, &iter), _T("failed to get iterator") );
+    wxCHECK_RET( GtkGetIteratorFor(n, &iter), wxT("failed to get iterator") );

 
     // FIXME: this resets the checked status of a wxCheckListBox item
 
 
     // FIXME: this resets the checked status of a wxCheckListBox item
 


@@ -759,7 +778,7 @@ int wxListBox::GetSelections( wxArrayInt& aSelections ) const
 
     aSelections.Empty();
 
 
     aSelections.Empty();
 

-        int i = 0;
+    int i = 0;

     GtkTreeIter iter;
     GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
 
     GtkTreeIter iter;
     GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
 


@@ -791,44 +810,26 @@ bool wxListBox::IsSelected( int n ) const
 
 void wxListBox::DoSetSelection( int n, bool select )
 {
 
 void wxListBox::DoSetSelection( int n, bool select )
 {

+    wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
+
+    GtkDisableEvents();
+
+    GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
+

     // passing -1 to SetSelection() is documented to deselect all items
     if ( n == wxNOT_FOUND )
     {
     // passing -1 to SetSelection() is documented to deselect all items
     if ( n == wxNOT_FOUND )
     {

-        // ... and not generate any events in the process
-        GtkDeselectAll();
+        gtk_tree_selection_unselect_all(selection);
+        GtkEnableEvents();

         return;
     }
 
     wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetSelection") );
 
         return;
     }
 
     wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetSelection") );
 

-    // don't generate the selection event
-    GtkSetSelection(n, select, true);
-}
-
-void wxListBox::GtkDeselectAll()
-{
-    wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
-
-    GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
-
-    m_blockEvent = true;
-
-    gtk_tree_selection_unselect_all(selection);
-
-    m_blockEvent = false;
-}
-
-void wxListBox::GtkSetSelection(int n, const bool select, const bool blockEvent)
-{
-    wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
-
-    GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);

 
     GtkTreeIter iter;
     wxCHECK_RET( GtkGetIteratorFor(n, &iter), wxT("Invalid index") );
 
 
     GtkTreeIter iter;
     wxCHECK_RET( GtkGetIteratorFor(n, &iter), wxT("Invalid index") );
 

-    m_blockEvent = blockEvent;
-

     if (select)
         gtk_tree_selection_select_iter(selection, &iter);
     else
     if (select)
         gtk_tree_selection_select_iter(selection, &iter);
     else


@@ -841,10 +842,10 @@ void wxListBox::GtkSetSelection(int n, const bool select, const bool blockEvent)
 
     gtk_tree_path_free(path);
 
 
     gtk_tree_path_free(path);
 

-    m_blockEvent = false;
+    GtkEnableEvents();

 }
 
 }
 

-void wxListBox::DoSetFirstItem( int n )
+void wxListBox::DoScrollToCell(int n, float alignY, float alignX)

 {
     wxCHECK_RET( m_treeview, wxT("invalid listbox") );
     wxCHECK_RET( IsValid(n), wxT("invalid index"));
 {
     wxCHECK_RET( m_treeview, wxT("invalid listbox") );
     wxCHECK_RET( IsValid(n), wxT("invalid index"));


@@ -862,11 +863,21 @@ void wxListBox::DoSetFirstItem( int n )
 
     // Scroll to the desired cell (0.0 == topleft alignment)
     gtk_tree_view_scroll_to_cell(m_treeview, path, NULL,
 
     // Scroll to the desired cell (0.0 == topleft alignment)
     gtk_tree_view_scroll_to_cell(m_treeview, path, NULL,

-                                 TRUE, 0.0f, 0.0f);
+                                 TRUE, alignY, alignX);

 
     gtk_tree_path_free(path);
 }
 
 
     gtk_tree_path_free(path);
 }
 

+void wxListBox::DoSetFirstItem(int n)
+{
+    DoScrollToCell(n, 0, 0);
+}
+
+void wxListBox::EnsureVisible(int n)
+{
+    DoScrollToCell(n, 0.5, 0);
+}
+

 // ----------------------------------------------------------------------------
 // hittest
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // hittest
 // ----------------------------------------------------------------------------


@@ -909,10 +920,10 @@ int wxListBox::DoListHitTest(const wxPoint& point) const
 // ----------------------------------------------------------------------------
 
 #if wxUSE_TOOLTIPS
 // ----------------------------------------------------------------------------
 
 #if wxUSE_TOOLTIPS

-void wxListBox::ApplyToolTip( GtkTooltips *tips, const gchar *tip )
+void wxListBox::GTKApplyToolTip( GtkTooltips *tips, const gchar *tip )

 {
     // RN: Is this needed anymore?
 {
     // RN: Is this needed anymore?

-    gtk_tooltips_set_tip( tips, GTK_WIDGET( m_treeview ), tip, (gchar*) NULL );
+    gtk_tooltips_set_tip( tips, GTK_WIDGET( m_treeview ), tip, NULL );

 }
 #endif // wxUSE_TOOLTIPS
 
 }
 #endif // wxUSE_TOOLTIPS
 


@@ -951,43 +962,40 @@ wxSize wxListBox::DoGetBestSize() const
     // Start with a minimum size that's not too small
     int cx, cy;
     GetTextExtent( wxT("X"), &cx, &cy);
     // Start with a minimum size that's not too small
     int cx, cy;
     GetTextExtent( wxT("X"), &cx, &cy);

-    int lbWidth = 3 * cx;
+    int lbWidth = 0;

     int lbHeight = 10;
 
     int lbHeight = 10;
 

-    // Get the visible area of the tree view (limit to the 10th item
-    // so that it isn't too big)
-    unsigned int count = GetCount();
-    if (count)
+    // Find the widest string.
+    const unsigned int count = GetCount();
+    if ( count )

     {
         int wLine;
     {
         int wLine;

-
-        // Find the widest line
-        for(unsigned int i = 0; i < count; i++) {
-            wxString str(GetString(i));
-            GetTextExtent(str, &wLine, NULL);
-            lbWidth = wxMax(lbWidth, wLine);
+        for ( unsigned int i = 0; i < count; i++ )
+        {
+            GetTextExtent(GetString(i), &wLine, NULL);
+            if ( wLine > lbWidth )
+                lbWidth = wLine;

         }
         }

+    }

 
 

-        lbWidth += 3 * cx;
+    lbWidth += 3 * cx;

 
 

-        // And just a bit more for the checkbox if present and then some
-        // (these are rough guesses)
+    // And just a bit more for the checkbox if present and then some
+    // (these are rough guesses)

 #if wxUSE_CHECKLISTBOX
 #if wxUSE_CHECKLISTBOX

-        if ( m_hasCheckBoxes )
-        {
-            lbWidth += 35;
-            cy = cy > 25 ? cy : 25; // rough height of checkbox
-        }
-#endif
-
-        // don't make the listbox too tall (limit height to around 10 items) but don't
-        // make it too small neither
-        lbHeight = (cy+4) * wxMin(wxMax(count, 3), 10);
+    if ( m_hasCheckBoxes )
+    {
+        lbWidth += 35;
+        cy = cy > 25 ? cy : 25; // rough height of checkbox

     }
     }

+#endif

 
     // Add room for the scrollbar
     lbWidth += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
 
 
     // Add room for the scrollbar
     lbWidth += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
 

+    // Don't make the listbox too tall but don't make it too small neither
+    lbHeight = (cy+4) * wxMin(wxMax(count, 3), 10);
+

     wxSize best(lbWidth, lbHeight);
     CacheBestSize(best);
     return best;
     wxSize best(lbWidth, lbHeight);
     CacheBestSize(best);
     return best;