]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk/choice.cpp
fixed Clear() for GTK+ 2.4+
[wxWidgets.git] / src / gtk / choice.cpp
index ca9d9c1785bb78a7f84805ed0087adf7485bc8fb..84eb8ca7f0fad9910cc9c66a8a44b9f2d83afeda 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        choice.cpp
+// Name:        src/gtk/choice.cpp
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
@@ -7,26 +7,22 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-
-#ifdef __GNUG__
-#pragma implementation "choice.h"
-#endif
-
-#include "wx/defs.h"
+#include "wx/wxprec.h"
 
 #if wxUSE_CHOICE
 
 #include "wx/choice.h"
+#include "wx/arrstr.h"
+
+// FIXME: We use GtkOptionMenu which has been deprecated since GTK+ 2.3.0 in
+// favour of GtkComboBox.
+// Later use GtkComboBox if GTK+ runtime version is new enough.
+#include <gtk/gtkversion.h>
+#if defined(GTK_DISABLE_DEPRECATED) && GTK_CHECK_VERSION(2,3,0)
+#undef GTK_DISABLE_DEPRECATED
+#endif
 
-#include <gdk/gdk.h>
-#include <gtk/gtk.h>
-
-//-----------------------------------------------------------------------------
-// idle system
-//-----------------------------------------------------------------------------
-
-extern void wxapp_install_idle_handler();
-extern bool g_isIdle;
+#include "wx/gtk/private.h"
 
 //-----------------------------------------------------------------------------
 // data
@@ -38,6 +34,7 @@ extern bool   g_blockEventsOnDrag;
 // "activate"
 //-----------------------------------------------------------------------------
 
+extern "C" {
 static void gtk_choice_clicked_callback( GtkWidget *WXUNUSED(widget), wxChoice *choice )
 {
     if (g_isIdle)
@@ -47,6 +44,12 @@ static void gtk_choice_clicked_callback( GtkWidget *WXUNUSED(widget), wxChoice *
 
     if (g_blockEventsOnDrag) return;
 
+    int selection = wxNOT_FOUND;
+
+    selection = gtk_option_menu_get_history( GTK_OPTION_MENU(choice->GetHandle()) );
+
+    choice->m_selection_hack = selection;
+
     wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, choice->GetId() );
     int n = choice->GetSelection();
 
@@ -61,6 +64,7 @@ static void gtk_choice_clicked_callback( GtkWidget *WXUNUSED(widget), wxChoice *
 
     choice->GetEventHandler()->ProcessEvent(event);
 }
+}
 
 //-----------------------------------------------------------------------------
 // wxChoice
@@ -73,21 +77,33 @@ wxChoice::wxChoice()
     m_strings = (wxSortedArrayString *)NULL;
 }
 
+bool wxChoice::Create( wxWindow *parent, wxWindowID id,
+                       const wxPoint &pos, const wxSize &size,
+                       const wxArrayString& choices,
+                       long style, const wxValidator& validator,
+                       const wxString &name )
+{
+    wxCArrayString chs(choices);
+
+    return Create( parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
+                   style, validator, name );
+}
+
 bool wxChoice::Create( wxWindow *parent, wxWindowID id,
                        const wxPoint &pos, const wxSize &size,
                        int n, const wxString choices[],
                        long style, const wxValidator& validator, const wxString &name )
 {
-    m_needParent = TRUE;
+    m_needParent = true;
 #if (GTK_MINOR_VERSION > 0)
-    m_acceptsFocus = TRUE;
+    m_acceptsFocus = true;
 #endif
 
     if (!PreCreation( parent, pos, size ) ||
         !CreateBase( parent, id, pos, size, style, validator, name ))
     {
         wxFAIL_MSG( wxT("wxChoice creation failed") );
-        return FALSE;
+        return false;
     }
 
     m_widget = gtk_option_menu_new();
@@ -99,36 +115,24 @@ bool wxChoice::Create( wxWindow *parent, wxWindowID id,
         m_strings = new wxSortedArrayString;
     }
 
+    // begin with no selection
+    m_selection_hack = wxNOT_FOUND;
+
     GtkWidget *menu = gtk_menu_new();
 
-    for (int i = 0; i < n; i++)
+    for (size_t i = 0; i < (size_t)n; i++)
     {
-        GtkAppendHelper(menu, choices[i]);
+        GtkAddHelper(menu, i, choices[i]);
     }
 
     gtk_option_menu_set_menu( GTK_OPTION_MENU(m_widget), menu );
 
     m_parent->DoAddChild( this );
 
-    PostCreation();
-
-    SetFont( parent->GetFont() );
-
-    wxSize size_best( DoGetBestSize() );
-    wxSize new_size( size );
-    if (new_size.x == -1)
-        new_size.x = size_best.x;
-    if (new_size.y == -1)
-        new_size.y = size_best.y;
-    if ((new_size.x != size.x) || (new_size.y != size.y))
-        SetSize( new_size.x, new_size.y );
-
-    SetBackgroundColour( parent->GetBackgroundColour() );
-    SetForegroundColour( parent->GetForegroundColour() );
-
-    Show( TRUE );
+    PostCreation(size);
+    SetBestSize(size); // need this too because this is a wxControlWithItems
 
-    return TRUE;
+    return true;
 }
 
 wxChoice::~wxChoice()
@@ -144,14 +148,34 @@ int wxChoice::DoAppend( const wxString &item )
 
     GtkWidget *menu = gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) );
 
-    return GtkAppendHelper(menu, item);
+    return GtkAddHelper(menu, GetCount(), item);
+}
+
+int wxChoice::DoInsert( const wxString &item, int pos )
+{
+    wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid choice control") );
+    wxCHECK_MSG( IsValidInsert(pos), -1, wxT("invalid index"));
+
+    if ((size_t)pos == GetCount())
+        return DoAppend(item);
+
+    GtkWidget *menu = gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) );
+
+    // if the item to insert is at or before the selection, and the selection is valid
+    if ((pos <= m_selection_hack) && (m_selection_hack != wxNOT_FOUND))
+    {
+        // move the selection forward one
+        m_selection_hack++;
+    }
+
+    return GtkAddHelper(menu, (size_t)pos, item);
 }
 
 void wxChoice::DoSetItemClientData( int n, void* clientData )
 {
     wxCHECK_RET( m_widget != NULL, wxT("invalid choice control") );
 
-    wxNode *node = m_clientList.Nth( n );
+    wxList::compatibility_iterator node = m_clientList.Item( n );
     wxCHECK_RET( node, wxT("invalid index in wxChoice::DoSetItemClientData") );
 
     node->SetData( (wxObject*) clientData );
@@ -161,21 +185,20 @@ void* wxChoice::DoGetItemClientData( int n ) const
 {
     wxCHECK_MSG( m_widget != NULL, NULL, wxT("invalid choice control") );
 
-    wxNode *node = m_clientList.Nth( n );
+    wxList::compatibility_iterator node = m_clientList.Item( n );
     wxCHECK_MSG( node, NULL, wxT("invalid index in wxChoice::DoGetItemClientData") );
 
-    return node->Data();
+    return node->GetData();
 }
 
 void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
 {
     wxCHECK_RET( m_widget != NULL, wxT("invalid choice control") );
 
-    wxNode *node = m_clientList.Nth( n );
+    wxList::compatibility_iterator node = m_clientList.Item( n );
     wxCHECK_RET( node, wxT("invalid index in wxChoice::DoSetItemClientObject") );
 
-    wxClientData *cd = (wxClientData*) node->Data();
-    delete cd;
+    // wxItemContainer already deletes data for us
 
     node->SetData( (wxObject*) clientData );
 }
@@ -184,11 +207,11 @@ wxClientData* wxChoice::DoGetItemClientObject( int n ) const
 {
     wxCHECK_MSG( m_widget != NULL, (wxClientData*) NULL, wxT("invalid choice control") );
 
-    wxNode *node = m_clientList.Nth( n );
+    wxList::compatibility_iterator node = m_clientList.Item( n );
     wxCHECK_MSG( node, (wxClientData *)NULL,
                  wxT("invalid index in wxChoice::DoGetItemClientObject") );
 
-    return (wxClientData*) node->Data();
+    return (wxClientData*) node->GetData();
 }
 
 void wxChoice::Clear()
@@ -203,28 +226,100 @@ void wxChoice::Clear()
     {
         // destroy the data (due to Robert's idea of using wxList<wxObject>
         // and not wxList<wxClientData> we can't just say
-        // m_clientList.DeleteContents(TRUE) - this would crash!
-        wxNode *node = m_clientList.First();
+        // m_clientList.DeleteContents(true) - this would crash!
+        wxList::compatibility_iterator node = m_clientList.GetFirst();
         while ( node )
         {
-            delete (wxClientData *)node->Data();
-            node = node->Next();
+            delete (wxClientData *)node->GetData();
+            node = node->GetNext();
         }
     }
     m_clientList.Clear();
 
     if ( m_strings )
         m_strings->Clear();
+
+    // begin with no selection
+    m_selection_hack = wxNOT_FOUND;
 }
 
-void wxChoice::Delete( int WXUNUSED(n) )
+void wxChoice::Delete( int n )
 {
-    wxFAIL_MSG( wxT("wxChoice:Delete not implemented") );
+    wxCHECK_RET( m_widget != NULL, wxT("invalid choice") );
+    wxCHECK_RET( IsValid(n), _T("invalid index in wxChoice::Delete") );
+
+    // VZ: apparently GTK+ doesn't have a built-in function to do it (not even
+    //     in 2.0), hence this dumb implementation -- still better than nothing
+    size_t i;
+    const size_t count = GetCount();
+
+    // if the item to delete is before the selection, and the selection is valid
+    if ((n < m_selection_hack) && (m_selection_hack != wxNOT_FOUND))
+    {
+        // move the selection back one
+        m_selection_hack--;
+    }
+    else if (n == m_selection_hack)
+    {
+        // invalidate the selection
+        m_selection_hack = wxNOT_FOUND;
+    }
+
+    const bool hasClientData = m_clientDataItemsType != wxClientData_None;
+    const bool hasObjectData = m_clientDataItemsType == wxClientData_Object;
+
+    wxList::compatibility_iterator node = m_clientList.GetFirst();
+
+    wxArrayString items;
+    wxArrayPtrVoid itemsData;
+    items.Alloc(count);
+    for ( i = 0; i < count; i++ )
+    {
+        if ( i != (size_t)n )
+        {
+            items.Add(GetString(i));
+            if ( hasClientData )
+            {
+                // also save the client data
+                itemsData.Add(node->GetData());
+            }
+        }
+        else // need to delete the client object too
+        {
+            if ( hasObjectData )
+            {
+                delete (wxClientData *)node->GetData();
+            }
+        }
+
+        if ( hasClientData )
+        {
+            node = node->GetNext();
+        }
+    }
+
+    if ( hasObjectData )
+    {
+        // prevent Clear() from destroying all client data
+        m_clientDataItemsType = wxClientData_None;
+    }
+
+    Clear();
+
+    for ( i = 0; i < count - 1; i++ )
+    {
+        Append(items[i]);
+
+        if ( hasObjectData )
+            SetClientObject(i, (wxClientData *)itemsData[i]);
+        else if ( hasClientData )
+            SetClientData(i, itemsData[i]);
+    }
 }
 
-int wxChoice::FindString( const wxString &string ) const
+int wxChoice::FindString( const wxString &string, bool bCase ) const
 {
-    wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid choice") );
+    wxCHECK_MSG( m_widget != NULL, wxNOT_FOUND, wxT("invalid choice") );
 
     // If you read this code once and you think you understand
     // it, then you are very wrong. Robert Roebling.
@@ -236,24 +331,35 @@ int wxChoice::FindString( const wxString &string ) const
     {
         GtkBin *bin = GTK_BIN( child->data );
         GtkLabel *label = (GtkLabel *) NULL;
-        if (bin->child) label = GTK_LABEL(bin->child);
-        if (!label) label = GTK_LABEL( GTK_BUTTON(m_widget)->child );
+        if (bin->child)
+            label = GTK_LABEL(bin->child);
+        if (!label)
+            label = GTK_LABEL(GTK_BIN(m_widget)->child);
 
         wxASSERT_MSG( label != NULL , wxT("wxChoice: invalid label") );
 
-       if (string == wxString(label->label,*wxConvCurrent))
-           return count;
+         wxString tmp( wxGTK_CONV_BACK( gtk_label_get_text( label) ) );
+        if (string.IsSameAs( tmp, bCase ))
+            return count;
 
-       child = child->next;
-       count++;
+        child = child->next;
+        count++;
     }
 
-    return -1;
+    return wxNOT_FOUND;
 }
 
 int wxChoice::GetSelection() const
 {
-    wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid choice") );
+    wxCHECK_MSG( m_widget != NULL, wxNOT_FOUND, wxT("invalid choice") );
+
+    return m_selection_hack;
+
+}
+
+void wxChoice::SetString( int n, const wxString& str )
+{
+    wxCHECK_RET( m_widget != NULL, wxT("invalid choice") );
 
     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
     int count = 0;
@@ -261,24 +367,28 @@ int wxChoice::GetSelection() const
     while (child)
     {
         GtkBin *bin = GTK_BIN( child->data );
-        if (!bin->child) return count;
-        child = child->next;
-        count++;
-    }
+        if (count == n)
+        {
+            GtkLabel *label = (GtkLabel *) NULL;
+            if (bin->child)
+                label = GTK_LABEL(bin->child);
+            if (!label)
+                label = GTK_LABEL(GTK_BIN(m_widget)->child);
 
-    return -1;
-}
+            wxASSERT_MSG( label != NULL , wxT("wxChoice: invalid label") );
 
-void wxChoice::SetString( int WXUNUSED(n), const wxString& WXUNUSED(string) )
-{
-    wxCHECK_RET( m_widget != NULL, wxT("invalid choice") );
+            gtk_label_set_text( label, wxGTK_CONV( str ) );
 
-    wxFAIL_MSG(wxT("not implemented"));
+            return;
+        }
+        child = child->next;
+        count++;
+    }
 }
 
 wxString wxChoice::GetString( int n ) const
 {
-    wxCHECK_MSG( m_widget != NULL, wxT(""), wxT("invalid choice") );
+    wxCHECK_MSG( m_widget != NULL, wxEmptyString, wxT("invalid choice") );
 
     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
     int count = 0;
@@ -289,12 +399,14 @@ wxString wxChoice::GetString( int n ) const
         if (count == n)
         {
             GtkLabel *label = (GtkLabel *) NULL;
-            if (bin->child) label = GTK_LABEL(bin->child);
-            if (!label) label = GTK_LABEL( GTK_BUTTON(m_widget)->child );
+            if (bin->child)
+                label = GTK_LABEL(bin->child);
+            if (!label)
+                label = GTK_LABEL(GTK_BIN(m_widget)->child);
 
             wxASSERT_MSG( label != NULL , wxT("wxChoice: invalid label") );
 
-            return wxString(label->label,*wxConvCurrent);
+            return wxString( wxGTK_CONV_BACK( gtk_label_get_text( label) ) );
         }
         child = child->next;
         count++;
@@ -302,15 +414,15 @@ wxString wxChoice::GetString( int n ) const
 
     wxFAIL_MSG( wxT("wxChoice: invalid index in GetString()") );
 
-    return wxT("");
+    return wxEmptyString;
 }
 
-int wxChoice::GetCount() const
+size_t wxChoice::GetCount() const
 {
     wxCHECK_MSG( m_widget != NULL, 0, wxT("invalid choice") );
 
     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
-    int count = 0;
+    size_t count = 0;
     GList *child = menu_shell->children;
     while (child)
     {
@@ -326,36 +438,56 @@ void wxChoice::SetSelection( int n )
 
     int tmp = n;
     gtk_option_menu_set_history( GTK_OPTION_MENU(m_widget), (gint)tmp );
+
+    // set the local selection variable manually
+    if ((n >= 0) && (n < (int)GetCount()))
+    {
+        // a valid selection has been made
+        m_selection_hack = n;
+    }
+    else if ((n == wxNOT_FOUND) || (GetCount() == 0))
+    {
+        // invalidates the selection if there are no items
+        // or if it is specifically set to wxNOT_FOUND
+        m_selection_hack = wxNOT_FOUND;
+    }
+    else
+    {
+        // this selects the first item by default if the selection is out of bounds
+        m_selection_hack = 0;
+    }
 }
 
-void wxChoice::ApplyWidgetStyle()
+void wxChoice::DoApplyWidgetStyle(GtkRcStyle *style)
 {
-    SetWidgetStyle();
-
     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
 
-    gtk_widget_set_style( m_widget, m_widgetStyle );
-    gtk_widget_set_style( GTK_WIDGET( menu_shell ), m_widgetStyle );
+    gtk_widget_modify_style( m_widget, style );
+    gtk_widget_modify_style( GTK_WIDGET( menu_shell ), style );
 
     GList *child = menu_shell->children;
     while (child)
     {
-        gtk_widget_set_style( GTK_WIDGET( child->data ), m_widgetStyle );
+        gtk_widget_modify_style( GTK_WIDGET( child->data ), style );
 
         GtkBin *bin = GTK_BIN( child->data );
         GtkWidget *label = (GtkWidget *) NULL;
-        if (bin->child) label = bin->child;
-        if (!label) label = GTK_BUTTON(m_widget)->child;
+        if (bin->child)
+            label = bin->child;
+        if (!label)
+            label = GTK_BIN(m_widget)->child;
 
-        gtk_widget_set_style( label, m_widgetStyle );
+        gtk_widget_modify_style( label, style );
 
         child = child->next;
     }
 }
 
-size_t wxChoice::GtkAppendHelper(GtkWidget *menu, const wxString& item)
+int wxChoice::GtkAddHelper(GtkWidget *menu, size_t pos, const wxString& item)
 {
-    GtkWidget *menu_item = gtk_menu_item_new_with_label( item.mbc_str() );
+    wxCHECK_MSG((pos>=0) && (pos<=m_clientList.GetCount()), -1, wxT("invalid index"));
+
+    GtkWidget *menu_item = gtk_menu_item_new_with_label( wxGTK_CONV( item ) );
 
     size_t index;
     if ( m_strings )
@@ -363,7 +495,7 @@ size_t wxChoice::GtkAppendHelper(GtkWidget *menu, const wxString& item)
         // sorted control, need to insert at the correct index
         index = m_strings->Add(item);
 
-        gtk_menu_insert( GTK_MENU(menu), menu_item, index );
+        gtk_menu_shell_insert( GTK_MENU_SHELL(menu), menu_item, index );
 
         if ( index )
         {
@@ -377,14 +509,22 @@ size_t wxChoice::GtkAppendHelper(GtkWidget *menu, const wxString& item)
     }
     else
     {
-        // normal control, just append
-        gtk_menu_append( GTK_MENU(menu), menu_item );
-
-        m_clientList.Append( (wxObject*) NULL );
-
         // don't call wxChoice::GetCount() from here because it doesn't work
         // if we're called from ctor (and GtkMenuShell is still NULL)
-        index = m_clientList.GetCount() - 1;
+
+        // normal control, just append
+        if (pos == m_clientList.GetCount())
+        {
+            gtk_menu_shell_append( GTK_MENU_SHELL(menu), menu_item );
+            m_clientList.Append( (wxObject*) NULL );
+            index = m_clientList.GetCount() - 1;
+        }
+        else
+        {
+            gtk_menu_shell_insert( GTK_MENU_SHELL(menu), menu_item, pos );
+            m_clientList.Insert( pos, (wxObject*) NULL );
+            index = pos;
+        }
     }
 
     if (GTK_WIDGET_REALIZED(m_widget))
@@ -392,11 +532,18 @@ size_t wxChoice::GtkAppendHelper(GtkWidget *menu, const wxString& item)
         gtk_widget_realize( menu_item );
         gtk_widget_realize( GTK_BIN(menu_item)->child );
 
-        if (m_widgetStyle) ApplyWidgetStyle();
+        ApplyWidgetStyle();
     }
 
-    gtk_signal_connect( GTK_OBJECT( menu_item ), "activate",
-      GTK_SIGNAL_FUNC(gtk_choice_clicked_callback), (gpointer*)this );
+    // The best size of a wxChoice should probably
+    // be changed everytime the control has been
+    // changed, but at least after adding an item
+    // it has to change. Adapted from Matt Ownby.
+    InvalidateBestSize();
+
+    g_signal_connect_after (menu_item, "activate",
+                            G_CALLBACK (gtk_choice_clicked_callback),
+                            this);
 
     gtk_widget_show( menu_item );
 
@@ -413,27 +560,53 @@ wxSize wxChoice::DoGetBestSize() const
     ret.x = 0;
     if ( m_widget )
     {
-        GdkFont *font = m_font.GetInternalFont();
-
-        wxCoord width;
+        int width;
         size_t count = GetCount();
         for ( size_t n = 0; n < count; n++ )
         {
-            width = (wxCoord)gdk_string_width(font, GetString(n).mbc_str());
+            GetTextExtent( GetString(n), &width, NULL, NULL, NULL );
             if ( width > ret.x )
                 ret.x = width;
         }
 
-        // for the choice "=" button
-        ret.x += 20;
+        // add extra for the choice "=" button
+
+        // VZ: I don't know how to get the right value, it seems to be in
+        //     GtkOptionMenuProps struct from gtkoptionmenu.c but we can't get
+        //     to it - maybe we can use gtk_option_menu_size_request() for this
+        //     somehow?
+        //
+        //     This default value works only for the default GTK+ theme (i.e.
+        //     no theme at all) (FIXME)
+        static const int widthChoiceIndicator = 35;
+        ret.x += widthChoiceIndicator;
     }
 
     // but not less than the minimal width
     if ( ret.x < 80 )
         ret.x = 80;
 
-    ret.y = 16 + gdk_char_height( m_widget->style->font, 'H' );
+    // If this request_size is called with no entries then
+    // the returned height is wrong. Give it a reasonable
+    // default value.
+    if (ret.y <= 18)
+        ret.y = 8 + GetCharHeight();
+
+    CacheBestSize(ret);
     return ret;
 }
 
-#endif
+bool wxChoice::IsOwnGtkWindow( GdkWindow *window )
+{
+    return GTK_BUTTON(m_widget)->event_window;
+}
+
+// static
+wxVisualAttributes
+wxChoice::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
+{
+    return GetDefaultAttributesFromGTKWidget(gtk_option_menu_new);
+}
+
+
+#endif // wxUSE_CHOICE