fixes for several fatal problems when using wxComboCtrl as popup (patch 1539124)

[wxWidgets.git] / src / gtk1 / combobox.cpp

diff --git a/src/gtk1/combobox.cpp b/src/gtk1/combobox.cpp
index 9b11ce5315ad62c420f55ea2deaaecbf7ce03d15..ea3d169aac8c1d4876b86f98663f4288117c57d2 100644 (file)
--- a/src/gtk1/combobox.cpp
+++ b/src/gtk1/combobox.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        combobox.cpp
+// Name:        src/gtk1/combobox.cpp

 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$


@@ -7,24 +7,21 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "combobox.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 

-#include "wx/combobox.h"
-

 #if wxUSE_COMBOBOX
 
 #if wxUSE_COMBOBOX
 

-#include "wx/settings.h"
-#include "wx/arrstr.h"
-#include "wx/intl.h"
+#include "wx/combobox.h"

 
 

-#include "wx/textctrl.h"    // for wxEVT_COMMAND_TEXT_UPDATED
+#ifndef WX_PRECOMP
+    #include "wx/intl.h"
+    #include "wx/settings.h"
+    #include "wx/textctrl.h"    // for wxEVT_COMMAND_TEXT_UPDATED
+    #include "wx/arrstr.h"
+#endif

 
 

-#include "wx/gtk/private.h"
+#include "wx/gtk1/private.h"

 
 //-----------------------------------------------------------------------------
 // idle system
 
 //-----------------------------------------------------------------------------
 // idle system


@@ -38,7 +35,8 @@ extern bool g_isIdle;
 //-----------------------------------------------------------------------------
 
 extern bool   g_blockEventsOnDrag;
 //-----------------------------------------------------------------------------
 
 extern bool   g_blockEventsOnDrag;

-static int    g_SelectionBeforePopup = -2; // -2 <=> the popup is hidden
+static int    g_SelectionBeforePopup = wxID_NONE; // this means the popup is hidden
+

 //-----------------------------------------------------------------------------
 //  "changed" - typing and list item matches get changed, select-child
 //              if it doesn't match an item then just get a single changed
 //-----------------------------------------------------------------------------
 //  "changed" - typing and list item matches get changed, select-child
 //              if it doesn't match an item then just get a single changed


@@ -78,18 +76,29 @@ gtk_popup_hide_callback(GtkCombo *WXUNUSED(gtk_combo), wxComboBox *combo)
 {
     // when the popup is hidden, throw a SELECTED event only if the combobox
     // selection changed.
 {
     // when the popup is hidden, throw a SELECTED event only if the combobox
     // selection changed.

-    int curSelection = combo->GetSelection();
-    if (g_SelectionBeforePopup != curSelection)
+    const int curSelection = combo->GetCurrentSelection();
+
+    const bool hasChanged = curSelection != g_SelectionBeforePopup;
+
+    // reset the selection flag to value meaning that it is hidden and do it
+    // now, before generating the events, so that GetSelection() returns the
+    // new value from the event handler
+    g_SelectionBeforePopup = wxID_NONE;
+
+    if ( hasChanged )

     {
         wxCommandEvent event( wxEVT_COMMAND_COMBOBOX_SELECTED, combo->GetId() );
         event.SetInt( curSelection );
         event.SetString( combo->GetStringSelection() );
         event.SetEventObject( combo );
         combo->GetEventHandler()->ProcessEvent( event );
     {
         wxCommandEvent event( wxEVT_COMMAND_COMBOBOX_SELECTED, combo->GetId() );
         event.SetInt( curSelection );
         event.SetString( combo->GetStringSelection() );
         event.SetEventObject( combo );
         combo->GetEventHandler()->ProcessEvent( event );

-    }

 
 

-    // reset the selection flag to an identifiable value (-2 = hidden)
-    g_SelectionBeforePopup = -2;
+        // for consistency with the other ports, send TEXT event
+        wxCommandEvent event2( wxEVT_COMMAND_TEXT_UPDATED, combo->GetId() );
+        event2.SetString( combo->GetStringSelection() );
+        event2.SetEventObject( combo );
+        combo->GetEventHandler()->ProcessEvent( event2 );
+    }

 }
 }
 
 }
 }
 


@@ -98,8 +107,7 @@ static void
 gtk_popup_show_callback(GtkCombo *WXUNUSED(gtk_combo), wxComboBox *combo)
 {
     // store the combobox selection value before the popup is shown
 gtk_popup_show_callback(GtkCombo *WXUNUSED(gtk_combo), wxComboBox *combo)
 {
     // store the combobox selection value before the popup is shown

-  // if there is no selection, combo->GetSelection() returns -1
-    g_SelectionBeforePopup = combo->GetSelection();
+    g_SelectionBeforePopup = combo->GetCurrentSelection();

 }
 }
 
 }
 }
 


@@ -117,7 +125,7 @@ gtk_combo_select_child_callback( GtkList *WXUNUSED(list), GtkWidget *WXUNUSED(wi
 
     if (g_blockEventsOnDrag) return;
 
 
     if (g_blockEventsOnDrag) return;
 

-    int curSelection = combo->GetSelection();
+    int curSelection = combo->GetCurrentSelection();

 
     if (combo->m_prevSelection == curSelection) return;
 
 
     if (combo->m_prevSelection == curSelection) return;
 


@@ -135,25 +143,26 @@ gtk_combo_select_child_callback( GtkList *WXUNUSED(list), GtkWidget *WXUNUSED(wi
     gtk_signal_connect_after( GTK_OBJECT(GTK_COMBO(combo->GetHandle())->entry), "changed",
       GTK_SIGNAL_FUNC(gtk_text_changed_callback), (gpointer)combo );
 
     gtk_signal_connect_after( GTK_OBJECT(GTK_COMBO(combo->GetHandle())->entry), "changed",
       GTK_SIGNAL_FUNC(gtk_text_changed_callback), (gpointer)combo );
 

-    // throw a SELECTED event only if the combobox popup is hidden (-2)
+    // throw a SELECTED event only if the combobox popup is hidden (wxID_NONE)

     // because when combobox popup is shown, gtk_combo_select_child_callback is
     // called each times the mouse is over an item with a pressed button so a lot
     // of SELECTED event could be generated if the user keep the mouse button down
     // and select other items ...
     // because when combobox popup is shown, gtk_combo_select_child_callback is
     // called each times the mouse is over an item with a pressed button so a lot
     // of SELECTED event could be generated if the user keep the mouse button down
     // and select other items ...

-    if (g_SelectionBeforePopup == -2)
+    if (g_SelectionBeforePopup == wxID_NONE)

     {
         wxCommandEvent event( wxEVT_COMMAND_COMBOBOX_SELECTED, combo->GetId() );
         event.SetInt( curSelection );
         event.SetString( combo->GetStringSelection() );
         event.SetEventObject( combo );
         combo->GetEventHandler()->ProcessEvent( event );
     {
         wxCommandEvent event( wxEVT_COMMAND_COMBOBOX_SELECTED, combo->GetId() );
         event.SetInt( curSelection );
         event.SetString( combo->GetStringSelection() );
         event.SetEventObject( combo );
         combo->GetEventHandler()->ProcessEvent( event );

-      }

 
 

-    // Now send the event ourselves
-    wxCommandEvent event2( wxEVT_COMMAND_TEXT_UPDATED, combo->GetId() );
-    event2.SetString( combo->GetValue() );
-    event2.SetEventObject( combo );
-    combo->GetEventHandler()->ProcessEvent( event2 );
+        // for consistency with the other ports, don't generate text update
+        // events while the user is browsing the combobox neither
+        wxCommandEvent event2( wxEVT_COMMAND_TEXT_UPDATED, combo->GetId() );
+        event2.SetString( combo->GetValue() );
+        event2.SetEventObject( combo );
+        combo->GetEventHandler()->ProcessEvent( event2 );
+    }

 }
 }
 
 }
 }
 


@@ -220,7 +229,7 @@ bool wxComboBox::Create( wxWindow *parent, wxWindowID id, const wxString& value,
 
     // Disable GTK's broken events ...
     gtk_signal_disconnect( GTK_OBJECT(combo->entry), combo->entry_change_id );
 
     // Disable GTK's broken events ...
     gtk_signal_disconnect( GTK_OBJECT(combo->entry), combo->entry_change_id );

-    // ... and add surogate handler.
+    // ... and add surrogate handler.

     combo->entry_change_id = gtk_signal_connect (GTK_OBJECT (combo->entry), "changed",
                   (GtkSignalFunc) gtk_dummy_callback, combo);
 
     combo->entry_change_id = gtk_signal_connect (GTK_OBJECT (combo->entry), "changed",
                   (GtkSignalFunc) gtk_dummy_callback, combo);
 


@@ -230,16 +239,9 @@ bool wxComboBox::Create( wxWindow *parent, wxWindowID id, const wxString& value,
     // and case-sensitive
     gtk_combo_set_case_sensitive( GTK_COMBO(m_widget), TRUE );
 
     // and case-sensitive
     gtk_combo_set_case_sensitive( GTK_COMBO(m_widget), TRUE );
 

-#ifdef __WXGTK20__
-    if (style & wxNO_BORDER)
-        g_object_set( GTK_ENTRY( combo->entry ), "has-frame", FALSE, NULL );
-#endif
-

     GtkWidget *list = GTK_COMBO(m_widget)->list;
 
     GtkWidget *list = GTK_COMBO(m_widget)->list;
 

-#ifndef __WXGTK20__

     // gtk_list_set_selection_mode( GTK_LIST(list), GTK_SELECTION_MULTIPLE );
     // gtk_list_set_selection_mode( GTK_LIST(list), GTK_SELECTION_MULTIPLE );

-#endif

 
     for (int i = 0; i < n; i++)
     {
 
     for (int i = 0; i < n; i++)
     {


@@ -346,11 +348,11 @@ int wxComboBox::DoAppend( const wxString &item )
 
     gtk_widget_show( list_item );
 
 
     gtk_widget_show( list_item );
 

-    const int count = GetCount();
+    const unsigned int count = GetCount();

 
 

-    if ( (int)m_clientDataList.GetCount() < count )
+    if ( m_clientDataList.GetCount() < count )

         m_clientDataList.Append( (wxObject*) NULL );
         m_clientDataList.Append( (wxObject*) NULL );

-    if ( (int)m_clientObjectList.GetCount() < count )
+    if ( m_clientObjectList.GetCount() < count )

         m_clientObjectList.Append( (wxObject*) NULL );
 
     EnableEvents();
         m_clientObjectList.Append( (wxObject*) NULL );
 
     EnableEvents();


@@ -360,17 +362,16 @@ int wxComboBox::DoAppend( const wxString &item )
     return count - 1;
 }
 
     return count - 1;
 }
 

-int wxComboBox::DoInsert( const wxString &item, int pos )
+int wxComboBox::DoInsert( const wxString &item, unsigned int pos )

 {
     wxCHECK_MSG( !(GetWindowStyle() & wxCB_SORT), -1,
                     wxT("can't insert into sorted list"));
 
     wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid combobox") );
 
 {
     wxCHECK_MSG( !(GetWindowStyle() & wxCB_SORT), -1,
                     wxT("can't insert into sorted list"));
 
     wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid combobox") );
 

-    int count = GetCount();
-    wxCHECK_MSG( (pos >= 0) && (pos <= count), -1, wxT("invalid index") );
+    wxCHECK_MSG( IsValidInsert(pos), -1, wxT("invalid index") );

 
 

-    if (pos == count)
+    if (pos == GetCount())

         return Append(item);
 
     DisableEvents();
         return Append(item);
 
     DisableEvents();


@@ -393,11 +394,11 @@ int wxComboBox::DoInsert( const wxString &item, int pos )
 
     gtk_widget_show( list_item );
 
 
     gtk_widget_show( list_item );
 

-    count = GetCount();
+    const unsigned int count = GetCount();

 
 

-    if ( (int)m_clientDataList.GetCount() < count )
+    if ( m_clientDataList.GetCount() < count )

         m_clientDataList.Insert( pos, (wxObject*) NULL );
         m_clientDataList.Insert( pos, (wxObject*) NULL );

-    if ( (int)m_clientObjectList.GetCount() < count )
+    if ( m_clientObjectList.GetCount() < count )

         m_clientObjectList.Insert( pos, (wxObject*) NULL );
 
     EnableEvents();
         m_clientObjectList.Insert( pos, (wxObject*) NULL );
 
     EnableEvents();


@@ -407,7 +408,7 @@ int wxComboBox::DoInsert( const wxString &item, int pos )
     return pos;
 }
 
     return pos;
 }
 

-void wxComboBox::DoSetItemClientData( int n, void* clientData )
+void wxComboBox::DoSetItemClientData(unsigned int n, void* clientData)

 {
     wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
 
 {
     wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
 


@@ -417,7 +418,7 @@ void wxComboBox::DoSetItemClientData( int n, void* clientData )
     node->SetData( (wxObject*) clientData );
 }
 
     node->SetData( (wxObject*) clientData );
 }
 

-void* wxComboBox::DoGetItemClientData( int n ) const
+void* wxComboBox::DoGetItemClientData(unsigned int n) const

 {
     wxCHECK_MSG( m_widget != NULL, NULL, wxT("invalid combobox") );
 
 {
     wxCHECK_MSG( m_widget != NULL, NULL, wxT("invalid combobox") );
 


@@ -426,7 +427,7 @@ void* wxComboBox::DoGetItemClientData( int n ) const
     return node ? node->GetData() : NULL;
 }
 
     return node ? node->GetData() : NULL;
 }
 

-void wxComboBox::DoSetItemClientObject( int n, wxClientData* clientData )
+void wxComboBox::DoSetItemClientObject(unsigned int n, wxClientData* clientData)

 {
     wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
 
 {
     wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
 


@@ -438,7 +439,7 @@ void wxComboBox::DoSetItemClientObject( int n, wxClientData* clientData )
     node->SetData( (wxObject*) clientData );
 }
 
     node->SetData( (wxObject*) clientData );
 }
 

-wxClientData* wxComboBox::DoGetItemClientObject( int n ) const
+wxClientData* wxComboBox::DoGetItemClientObject(unsigned int n) const

 {
     wxCHECK_MSG( m_widget != NULL, (wxClientData*)NULL, wxT("invalid combobox") );
 
 {
     wxCHECK_MSG( m_widget != NULL, (wxClientData*)NULL, wxT("invalid combobox") );
 


@@ -454,7 +455,7 @@ void wxComboBox::Clear()
     DisableEvents();
 
     GtkWidget *list = GTK_COMBO(m_widget)->list;
     DisableEvents();
 
     GtkWidget *list = GTK_COMBO(m_widget)->list;

-    gtk_list_clear_items( GTK_LIST(list), 0, GetCount() );
+    gtk_list_clear_items( GTK_LIST(list), 0, (int)GetCount() );

 
     wxList::compatibility_iterator node = m_clientObjectList.GetFirst();
     while (node)
 
     wxList::compatibility_iterator node = m_clientObjectList.GetFirst();
     while (node)


@@ -472,7 +473,7 @@ void wxComboBox::Clear()
     InvalidateBestSize();
 }
 
     InvalidateBestSize();
 }
 

-void wxComboBox::Delete( int n )
+void wxComboBox::Delete(unsigned int n)

 {
     wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
 
 {
     wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
 


@@ -509,7 +510,7 @@ void wxComboBox::Delete( int n )
     InvalidateBestSize();
 }
 
     InvalidateBestSize();
 }
 

-void wxComboBox::SetString(int n, const wxString &text)
+void wxComboBox::SetString(unsigned int n, const wxString &text)

 {
     wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
 
 {
     wxCHECK_RET( m_widget != NULL, wxT("invalid combobox") );
 


@@ -530,7 +531,7 @@ void wxComboBox::SetString(int n, const wxString &text)
     InvalidateBestSize();
 }
 
     InvalidateBestSize();
 }
 

-int wxComboBox::FindString( const wxString &item ) const
+int wxComboBox::FindString( const wxString &item, bool bCase ) const

 {
     wxCHECK_MSG( m_widget != NULL, wxNOT_FOUND, wxT("invalid combobox") );
 
 {
     wxCHECK_MSG( m_widget != NULL, wxNOT_FOUND, wxT("invalid combobox") );
 


@@ -542,12 +543,8 @@ int wxComboBox::FindString( const wxString &item ) const
     {
         GtkBin *bin = GTK_BIN( child->data );
         GtkLabel *label = GTK_LABEL( bin->child );
     {
         GtkBin *bin = GTK_BIN( child->data );
         GtkLabel *label = GTK_LABEL( bin->child );

-#ifdef __WXGTK20__
-        wxString str( wxGTK_CONV_BACK( gtk_label_get_text(label) ) );
-#else

         wxString str( label->label );
         wxString str( label->label );

-#endif
-        if (item == str)
+        if (item.IsSameAs( str , bCase ) )

             return count;
 
         count++;
             return count;
 
         count++;


@@ -558,6 +555,14 @@ int wxComboBox::FindString( const wxString &item ) const
 }
 
 int wxComboBox::GetSelection() const
 }
 
 int wxComboBox::GetSelection() const

+{
+    // if the popup is currently opened, use the selection as it had been
+    // before it dropped down
+    return g_SelectionBeforePopup == wxID_NONE ? GetCurrentSelection()
+                                               : g_SelectionBeforePopup;
+}
+
+int wxComboBox::GetCurrentSelection() const

 {
     wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid combobox") );
 
 {
     wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid combobox") );
 


@@ -576,10 +581,10 @@ int wxComboBox::GetSelection() const
         }
     }
 
         }
     }
 

-    return -1;
+    return wxNOT_FOUND;

 }
 
 }
 

-wxString wxComboBox::GetString( int n ) const
+wxString wxComboBox::GetString(unsigned int n) const

 {
     wxCHECK_MSG( m_widget != NULL, wxEmptyString, wxT("invalid combobox") );
 
 {
     wxCHECK_MSG( m_widget != NULL, wxEmptyString, wxT("invalid combobox") );
 


@@ -591,11 +596,7 @@ wxString wxComboBox::GetString( int n ) const
     {
         GtkBin *bin = GTK_BIN( child->data );
         GtkLabel *label = GTK_LABEL( bin->child );
     {
         GtkBin *bin = GTK_BIN( child->data );
         GtkLabel *label = GTK_LABEL( bin->child );

-#ifdef __WXGTK20__
-        str = wxGTK_CONV_BACK( gtk_label_get_text(label) );
-#else

         str = wxString( label->label );
         str = wxString( label->label );

-#endif

     }
     else
     {
     }
     else
     {


@@ -616,11 +617,7 @@ wxString wxComboBox::GetStringSelection() const
     {
         GtkBin *bin = GTK_BIN( selection->data );
         GtkLabel *label = GTK_LABEL( bin->child );
     {
         GtkBin *bin = GTK_BIN( selection->data );
         GtkLabel *label = GTK_LABEL( bin->child );

-#ifdef __WXGTK20__
-        wxString tmp( wxGTK_CONV_BACK( gtk_label_get_text(label) ) );
-#else

         wxString tmp( label->label );
         wxString tmp( label->label );

-#endif

         return tmp;
     }
 
         return tmp;
     }
 


@@ -629,14 +626,14 @@ wxString wxComboBox::GetStringSelection() const
     return wxEmptyString;
 }
 
     return wxEmptyString;
 }
 

-int wxComboBox::GetCount() const
+unsigned int wxComboBox::GetCount() const

 {
     wxCHECK_MSG( m_widget != NULL, 0, wxT("invalid combobox") );
 
     GtkWidget *list = GTK_COMBO(m_widget)->list;
 
     GList *child = GTK_LIST(list)->children;
 {
     wxCHECK_MSG( m_widget != NULL, 0, wxT("invalid combobox") );
 
     GtkWidget *list = GTK_COMBO(m_widget)->list;
 
     GList *child = GTK_LIST(list)->children;

-    int count = 0;
+    unsigned int count = 0;

     while (child) { count++; child = child->next; }
     return count;
 }
     while (child) { count++; child = child->next; }
     return count;
 }


@@ -801,7 +798,7 @@ void wxComboBox::Replace( long from, long to, const wxString& value )
     wxCharBuffer buffer = wxConvUTF8.cWX2MB( value );
     gtk_editable_insert_text( GTK_EDITABLE(entry), (const char*) buffer, strlen( (const char*) buffer ), &pos );
 #else
     wxCharBuffer buffer = wxConvUTF8.cWX2MB( value );
     gtk_editable_insert_text( GTK_EDITABLE(entry), (const char*) buffer, strlen( (const char*) buffer ), &pos );
 #else

-    gtk_editable_insert_text( GTK_EDITABLE(entry), value.c_str(), value.Length(), &pos );
+    gtk_editable_insert_text( GTK_EDITABLE(entry), value.c_str(), value.length(), &pos );

 #endif
 }
 
 #endif
 }
 


@@ -816,15 +813,8 @@ void wxComboBox::GetSelection( long* from, long* to ) const
     if (IsEditable())
     {
         GtkEditable *editable = GTK_EDITABLE(GTK_COMBO(m_widget)->entry);
     if (IsEditable())
     {
         GtkEditable *editable = GTK_EDITABLE(GTK_COMBO(m_widget)->entry);

-#ifdef __WXGTK20__
-        gint start, end;
-        gtk_editable_get_selection_bounds(editable, & start, & end);
-        *from = start;
-        *to = end;
-#else

         *from = (long) editable->selection_start_pos;
         *to = (long) editable->selection_end_pos;
         *from = (long) editable->selection_start_pos;
         *to = (long) editable->selection_end_pos;

-#endif

     }
 }
 
     }
 }
 


@@ -839,12 +829,12 @@ void wxComboBox::OnChar( wxKeyEvent &event )
     if ( event.GetKeyCode() == WXK_RETURN )
     {
         // GTK automatically selects an item if its in the list
     if ( event.GetKeyCode() == WXK_RETURN )
     {
         // GTK automatically selects an item if its in the list

-        wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, GetId());
-        event.SetString( GetValue() );
-        event.SetInt( GetSelection() );
-        event.SetEventObject( this );
+        wxCommandEvent eventEnter(wxEVT_COMMAND_TEXT_ENTER, GetId());
+        eventEnter.SetString( GetValue() );
+        eventEnter.SetInt( GetSelection() );
+        eventEnter.SetEventObject( this );

 
 

-        if (!GetEventHandler()->ProcessEvent( event ))
+        if (!GetEventHandler()->ProcessEvent( eventEnter ))

         {
             // This will invoke the dialog default action, such
             // as the clicking the default button.
         {
             // This will invoke the dialog default action, such
             // as the clicking the default button.


@@ -940,10 +930,10 @@ wxSize wxComboBox::DoGetBestSize() const
     if ( m_widget )
     {
         int width;
     if ( m_widget )
     {
         int width;

-        size_t count = GetCount();
-        for ( size_t n = 0; n < count; n++ )
+        unsigned int count = GetCount();
+        for ( unsigned int n = 0; n < count; n++ )

         {
         {

-            GetTextExtent( GetString(n), &width, NULL, NULL, NULL );
+            GetTextExtent(GetString(n), &width, NULL, NULL, NULL );

             if ( width > ret.x )
                 ret.x = width;
         }
             if ( width > ret.x )
                 ret.x = width;
         }