]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk/choice.cpp
More comments about non-native GTH widgets.
[wxWidgets.git] / src / gtk / choice.cpp
index 4edcdc8b942e7ef2e1f0499a1f784804685b21eb..737522f7ada89e092399945b7e55b1d5aa8c5a39 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        choice.cpp
+// Name:        src/gtk/choice.cpp
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
@@ -7,25 +7,25 @@
 // 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/gtk/private.h"
+#ifndef WX_PRECOMP
+    #include "wx/arrstr.h"
+#endif
 
-//-----------------------------------------------------------------------------
-// idle system
-//-----------------------------------------------------------------------------
+// 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
 
-extern void wxapp_install_idle_handler();
-extern bool g_isIdle;
+#include "wx/gtk/private.h"
 
 //-----------------------------------------------------------------------------
 // data
@@ -37,6 +37,7 @@ extern bool   g_blockEventsOnDrag;
 // "activate"
 //-----------------------------------------------------------------------------
 
+extern "C" {
 static void gtk_choice_clicked_callback( GtkWidget *WXUNUSED(widget), wxChoice *choice )
 {
     if (g_isIdle)
@@ -46,6 +47,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();
 
@@ -60,6 +67,7 @@ static void gtk_choice_clicked_callback( GtkWidget *WXUNUSED(widget), wxChoice *
 
     choice->GetEventHandler()->ProcessEvent(event);
 }
+}
 
 //-----------------------------------------------------------------------------
 // wxChoice
@@ -72,21 +80,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();
@@ -98,29 +118,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 (unsigned int i = 0; i < (unsigned int)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() );
-
-    SetBestSize(size);
+    PostCreation(size);
+    SetBestSize(size); // need this too because this is a wxControlWithItems
 
-    SetBackgroundColour( parent->GetBackgroundColour() );
-    SetForegroundColour( parent->GetForegroundColour() );
-
-    Show( TRUE );
-
-    return TRUE;
+    return true;
 }
 
 wxChoice::~wxChoice()
@@ -136,34 +151,54 @@ 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);
 }
 
-void wxChoice::DoSetItemClientData( int n, void* clientData )
+int wxChoice::DoInsert(const wxString &item, unsigned int pos)
+{
+    wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid choice control") );
+    wxCHECK_MSG( IsValidInsert(pos), -1, wxT("invalid index"));
+
+    if (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 (((int)pos <= m_selection_hack) && (m_selection_hack != wxNOT_FOUND))
+    {
+        // move the selection forward one
+        m_selection_hack++;
+    }
+
+    return GtkAddHelper(menu, pos, item);
+}
+
+void wxChoice::DoSetItemClientData(unsigned int n, void* clientData)
 {
     wxCHECK_RET( m_widget != NULL, wxT("invalid choice control") );
 
-    wxNode *node = m_clientList.Item( n );
+    wxList::compatibility_iterator node = m_clientList.Item( n );
     wxCHECK_RET( node, wxT("invalid index in wxChoice::DoSetItemClientData") );
 
     node->SetData( (wxObject*) clientData );
 }
 
-void* wxChoice::DoGetItemClientData( int n ) const
+void* wxChoice::DoGetItemClientData(unsigned int n) const
 {
     wxCHECK_MSG( m_widget != NULL, NULL, wxT("invalid choice control") );
 
-    wxNode *node = m_clientList.Item( n );
+    wxList::compatibility_iterator node = m_clientList.Item( n );
     wxCHECK_MSG( node, NULL, wxT("invalid index in wxChoice::DoGetItemClientData") );
 
     return node->GetData();
 }
 
-void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
+void wxChoice::DoSetItemClientObject(unsigned int n, wxClientData* clientData)
 {
     wxCHECK_RET( m_widget != NULL, wxT("invalid choice control") );
 
-    wxNode *node = m_clientList.Item( n );
+    wxList::compatibility_iterator node = m_clientList.Item( n );
     wxCHECK_RET( node, wxT("invalid index in wxChoice::DoSetItemClientObject") );
 
     // wxItemContainer already deletes data for us
@@ -171,11 +206,11 @@ void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
     node->SetData( (wxObject*) clientData );
 }
 
-wxClientData* wxChoice::DoGetItemClientObject( int n ) const
+wxClientData* wxChoice::DoGetItemClientObject(unsigned int n) const
 {
     wxCHECK_MSG( m_widget != NULL, (wxClientData*) NULL, wxT("invalid choice control") );
 
-    wxNode *node = m_clientList.Item( n );
+    wxList::compatibility_iterator node = m_clientList.Item( n );
     wxCHECK_MSG( node, (wxClientData *)NULL,
                  wxT("invalid index in wxChoice::DoGetItemClientObject") );
 
@@ -194,8 +229,8 @@ 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.GetFirst();
+        // m_clientList.DeleteContents(true) - this would crash!
+        wxList::compatibility_iterator node = m_clientList.GetFirst();
         while ( node )
         {
             delete (wxClientData *)node->GetData();
@@ -206,25 +241,70 @@ void wxChoice::Clear()
 
     if ( m_strings )
         m_strings->Clear();
+
+    // begin with no selection
+    m_selection_hack = wxNOT_FOUND;
 }
 
-void wxChoice::Delete( int n )
+void wxChoice::Delete(unsigned int n)
 {
     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 dump implementation - still better than nothing
-    int i,
-        count = GetCount();
+    //     in 2.0), hence this dumb implementation -- still better than nothing
+    unsigned int i;
+    const unsigned int count = GetCount();
 
-    wxCHECK_RET( n >= 0 && n < count, _T("invalid index in wxChoice::Delete") );
+    // if the item to delete is before the selection, and the selection is valid
+    if (((int)n < m_selection_hack) && (m_selection_hack != wxNOT_FOUND))
+    {
+        // move the selection back one
+        m_selection_hack--;
+    }
+    else if ((int)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 != 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();
@@ -232,12 +312,17 @@ void wxChoice::Delete( int n )
     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.
@@ -252,63 +337,64 @@ int wxChoice::FindString( const wxString &string ) const
         if (bin->child)
             label = GTK_LABEL(bin->child);
         if (!label)
-            label = GTK_LABEL( BUTTON_CHILD(m_widget) );
+            label = GTK_LABEL(GTK_BIN(m_widget)->child);
 
         wxASSERT_MSG( label != NULL , wxT("wxChoice: invalid label") );
-        
-#ifdef __WXGTK20__
+
          wxString tmp( wxGTK_CONV_BACK( gtk_label_get_text( label) ) );
-#else
-         wxString tmp( label->label );
-#endif
-        if (string == tmp)
+        if (string.IsSameAs( tmp, bCase ))
             return count;
 
         child = child->next;
         count++;
     }
 
-    return -1;
+    return wxNOT_FOUND;
 }
 
 int wxChoice::GetSelection() const
 {
-    wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid choice") );
-    
-#ifdef __WXGTK20__
+    wxCHECK_MSG( m_widget != NULL, wxNOT_FOUND, wxT("invalid choice") );
+
+    return m_selection_hack;
+
+}
+
+void wxChoice::SetString(unsigned int n, const wxString& str)
+{
+    wxCHECK_RET( m_widget != NULL, wxT("invalid choice") );
 
-    return gtk_option_menu_get_history( GTK_OPTION_MENU(m_widget) );
-    
-#else
     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
-    int count = 0;
-    
+    unsigned int count = 0;
     GList *child = menu_shell->children;
     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;
-#endif
-}
+            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
+wxString wxChoice::GetString(unsigned 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;
+    unsigned int count = 0;
     GList *child = menu_shell->children;
     while (child)
     {
@@ -319,15 +405,11 @@ wxString wxChoice::GetString( int n ) const
             if (bin->child)
                 label = GTK_LABEL(bin->child);
             if (!label)
-                label = GTK_LABEL( BUTTON_CHILD(m_widget) );
+                label = GTK_LABEL(GTK_BIN(m_widget)->child);
 
             wxASSERT_MSG( label != NULL , wxT("wxChoice: invalid label") );
 
-#ifdef __WXGTK20__
             return wxString( wxGTK_CONV_BACK( gtk_label_get_text( label) ) );
-#else
-            return wxString( label->label );
-#endif
         }
         child = child->next;
         count++;
@@ -335,15 +417,15 @@ wxString wxChoice::GetString( int n ) const
 
     wxFAIL_MSG( wxT("wxChoice: invalid index in GetString()") );
 
-    return wxT("");
+    return wxEmptyString;
 }
 
-int wxChoice::GetCount() const
+unsigned int 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;
+    unsigned int count = 0;
     GList *child = menu_shell->children;
     while (child)
     {
@@ -359,46 +441,64 @@ 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) && ((unsigned int)n < 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 = BUTTON_CHILD(m_widget);
+            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, unsigned int pos, const wxString& item)
 {
+    wxCHECK_MSG(pos<=m_clientList.GetCount(), -1, wxT("invalid index"));
+
     GtkWidget *menu_item = gtk_menu_item_new_with_label( wxGTK_CONV( item ) );
 
-    size_t index;
+    unsigned int index;
     if ( m_strings )
     {
         // 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 )
         {
@@ -412,14 +512,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))
@@ -427,11 +535,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 );
 
@@ -449,10 +564,10 @@ wxSize wxChoice::DoGetBestSize() const
     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, &m_font );
+            GetTextExtent( GetString(n), &width, NULL, NULL, NULL );
             if ( width > ret.x )
                 ret.x = width;
         }
@@ -474,10 +589,27 @@ wxSize wxChoice::DoGetBestSize() const
     if ( ret.x < 80 )
         ret.x = 80;
 
-    ret.y = 16 + GetCharHeight();
+    // 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 // wxUSE_CHOICE
+GdkWindow *wxChoice::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const
+{
+    return GTK_BUTTON(m_widget)->event_window;
+}
 
+// static
+wxVisualAttributes
+wxChoice::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
+{
+    return GetDefaultAttributesFromGTKWidget(gtk_option_menu_new);
+}
+
+
+#endif // wxUSE_CHOICE