Corrected/added support for column headers with icon and text

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

diff --git a/src/gtk/choice.cpp b/src/gtk/choice.cpp
index ef1d9b5280bca4a9f6336c4d34efc4c140a2868d..8f25aa9632eae89568b00cd1df64d2341d45d6f8 100644 (file)
--- a/src/gtk/choice.cpp
+++ b/src/gtk/choice.cpp
@@ -7,21 +7,25 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#include "wx/defs.h"
+#include "wx/wxprec.h"

 
 #if wxUSE_CHOICE
 
 #include "wx/choice.h"
 
 #if wxUSE_CHOICE
 
 #include "wx/choice.h"

-#include "wx/arrstr.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
 
 //-----------------------------------------------------------------------------
 // data


@@ -36,9 +40,6 @@ extern bool   g_blockEventsOnDrag;
 extern "C" {
 static void gtk_choice_clicked_callback( GtkWidget *WXUNUSED(widget), wxChoice *choice )
 {
 extern "C" {
 static void gtk_choice_clicked_callback( GtkWidget *WXUNUSED(widget), wxChoice *choice )
 {

-    if (g_isIdle)
-      wxapp_install_idle_handler();
-

     if (!choice->m_hasVMT) return;
 
     if (g_blockEventsOnDrag) return;
     if (!choice->m_hasVMT) return;
 
     if (g_blockEventsOnDrag) return;


@@ -61,7 +62,7 @@ static void gtk_choice_clicked_callback( GtkWidget *WXUNUSED(widget), wxChoice *
     else if ( choice->HasClientUntypedData() )
         event.SetClientData( choice->GetClientData(n) );
 
     else if ( choice->HasClientUntypedData() )
         event.SetClientData( choice->GetClientData(n) );
 

-    choice->GetEventHandler()->ProcessEvent(event);
+    choice->HandleWindowEvent(event);

 }
 }
 
 }
 }
 


@@ -69,7 +70,7 @@ static void gtk_choice_clicked_callback( GtkWidget *WXUNUSED(widget), wxChoice *
 // wxChoice
 //-----------------------------------------------------------------------------
 
 // wxChoice
 //-----------------------------------------------------------------------------
 

-IMPLEMENT_DYNAMIC_CLASS(wxChoice,wxControl)
+IMPLEMENT_DYNAMIC_CLASS(wxChoice, wxControlWithItems)

 
 wxChoice::wxChoice()
 {
 
 wxChoice::wxChoice()
 {


@@ -93,11 +94,6 @@ bool wxChoice::Create( wxWindow *parent, wxWindowID id,
                        int n, const wxString choices[],
                        long style, const wxValidator& validator, const wxString &name )
 {
                        int n, const wxString choices[],
                        long style, const wxValidator& validator, const wxString &name )
 {

-    m_needParent = true;
-#if (GTK_MINOR_VERSION > 0)
-    m_acceptsFocus = true;
-#endif
-

     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 ))
     {


@@ -107,19 +103,19 @@ bool wxChoice::Create( wxWindow *parent, wxWindowID id,
 
     m_widget = gtk_option_menu_new();
 
 
     m_widget = gtk_option_menu_new();
 

-    if ( style & wxCB_SORT )
+    if ( IsSorted() )

     {
     {

-        // if our m_strings != NULL, DoAppend() will check for it and insert
+        // if our m_strings != NULL, Append() will check for it and insert

         // items in the correct order
         m_strings = new wxSortedArrayString;
     }
 
         // items in the correct order
         m_strings = new wxSortedArrayString;
     }
 

-    // begin with no selection
-    m_selection_hack = wxNOT_FOUND;
+    // If we have items, GTK will choose the first item by default
+    m_selection_hack = n > 0 ? 0 : wxNOT_FOUND;

 
     GtkWidget *menu = gtk_menu_new();
 
 
     GtkWidget *menu = gtk_menu_new();
 

-    for (int i = 0; i < n; i++)
+    for (unsigned int i = 0; i < (unsigned int)n; i++)

     {
         GtkAddHelper(menu, i, choices[i]);
     }
     {
         GtkAddHelper(menu, i, choices[i]);
     }


@@ -129,7 +125,14 @@ bool wxChoice::Create( wxWindow *parent, wxWindowID id,
     m_parent->DoAddChild( this );
 
     PostCreation(size);
     m_parent->DoAddChild( this );
 
     PostCreation(size);

-    SetBestSize(size); // need this too because this is a wxControlWithItems
+    SetInitialSize(size); // need this too because this is a wxControlWithItems
+
+    // workaround for bug in gtk_option_menu_set_history(), it causes
+    // gtk_widget_size_allocate() to be called with the current
+    // widget->allocation values, which will be zero if a proper
+    // size_allocate has not occured yet
+    m_widget->allocation.width = m_width;
+    m_widget->allocation.height = m_height;

 
     return true;
 }
 
     return true;
 }


@@ -141,79 +144,52 @@ wxChoice::~wxChoice()
     delete m_strings;
 }
 
     delete m_strings;
 }
 

-int wxChoice::DoAppend( const wxString &item )
+int wxChoice::DoInsertItems(const wxArrayStringsAdapter & items,
+                            unsigned int pos,
+                            void **clientData, wxClientDataType type)

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

-    GtkWidget *menu = gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) );
-
-    return GtkAddHelper(menu, GetCount(), item);
-}
+    const unsigned int count = items.GetCount();

 
 

-int wxChoice::DoInsert( const wxString &item, int pos )
-{
-    wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid choice control") );
-    wxCHECK_MSG( (pos>=0) && (pos<=GetCount()), -1, wxT("invalid index"));
+    GtkWidget *menu = gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) );

 
 

-    if (pos == GetCount())
-        return DoAppend(item);
+    for ( unsigned int i = 0; i < count; ++i, ++pos )
+    {
+        int n = GtkAddHelper(menu, pos, items[i]);
+        if ( n == wxNOT_FOUND )
+            return n;

 
 

-    GtkWidget *menu = gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) );
+        AssignNewItemClientData(n, clientData, i, type);
+    }

 
     // if the item to insert is at or before the selection, and the selection is valid
 
     // 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))
+    if (((int)pos <= m_selection_hack) && (m_selection_hack != wxNOT_FOUND))

     {
     {

-        // move the selection forward one
-        m_selection_hack++;
+        // move the selection forward
+        m_selection_hack += count;

     }
 
     }
 

-    return GtkAddHelper(menu, pos, item);
-}
-
-void wxChoice::DoSetItemClientData( int n, void* clientData )
-{
-    wxCHECK_RET( m_widget != NULL, wxT("invalid choice control") );
-
-    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
-{
-    wxCHECK_MSG( m_widget != NULL, NULL, wxT("invalid choice control") );
-
-    wxList::compatibility_iterator node = m_clientList.Item( n );
-    wxCHECK_MSG( node, NULL, wxT("invalid index in wxChoice::DoGetItemClientData") );
+    // We must set the selection so that it can be read back even if 
+    // the user has not modified it since GTK+ will then select the
+    // first item so well return 0.
+    if ((count > 0) && (m_selection_hack==wxNOT_FOUND))
+        m_selection_hack = 0;

 
 

-    return node->GetData();
+    return pos - 1;

 }
 
 }
 

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

 {
 {

-    wxCHECK_RET( m_widget != NULL, wxT("invalid choice control") );
-
-    wxList::compatibility_iterator node = m_clientList.Item( n );
-    wxCHECK_RET( node, wxT("invalid index in wxChoice::DoSetItemClientObject") );
-
-    // wxItemContainer already deletes data for us
-
-    node->SetData( (wxObject*) clientData );
+    m_clientData[n] = clientData;

 }
 
 }
 

-wxClientData* wxChoice::DoGetItemClientObject( int n ) const
+void* wxChoice::DoGetItemClientData(unsigned int n) const

 {
 {

-    wxCHECK_MSG( m_widget != NULL, (wxClientData*) NULL, wxT("invalid choice control") );
-
-    wxList::compatibility_iterator node = m_clientList.Item( n );
-    wxCHECK_MSG( node, (wxClientData *)NULL,
-                 wxT("invalid index in wxChoice::DoGetItemClientObject") );
-
-    return (wxClientData*) node->GetData();
+    return m_clientData[n];

 }
 
 }
 

-void wxChoice::Clear()
+void wxChoice::DoClear()

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


@@ -221,19 +197,7 @@ void wxChoice::Clear()
     GtkWidget *menu = gtk_menu_new();
     gtk_option_menu_set_menu( GTK_OPTION_MENU(m_widget), menu );
 
     GtkWidget *menu = gtk_menu_new();
     gtk_option_menu_set_menu( GTK_OPTION_MENU(m_widget), menu );
 

-    if ( HasClientObjectData() )
-    {
-        // 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!
-        wxList::compatibility_iterator node = m_clientList.GetFirst();
-        while ( node )
-        {
-            delete (wxClientData *)node->GetData();
-            node = node->GetNext();
-        }
-    }
-    m_clientList.Clear();
+    m_clientData.Clear();

 
     if ( m_strings )
         m_strings->Clear();
 
     if ( m_strings )
         m_strings->Clear();


@@ -242,79 +206,51 @@ void wxChoice::Clear()
     m_selection_hack = wxNOT_FOUND;
 }
 
     m_selection_hack = wxNOT_FOUND;
 }
 

-void wxChoice::Delete( int n )
+void wxChoice::DoDeleteOneItem(unsigned int n)

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

-
-    // 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
-    int i,
-        count = GetCount();
-
-    wxCHECK_RET( n >= 0 && n < count, _T("invalid index in wxChoice::Delete") );
+    wxCHECK_RET( IsValid(n), _T("invalid index in wxChoice::Delete") );

 
     // if the item to delete is before the selection, and the selection is valid
 
     // if the item to delete is before the selection, and the selection is valid

-    if ((n < m_selection_hack) && (m_selection_hack != wxNOT_FOUND))
+    if (((int)n < m_selection_hack) && (m_selection_hack != wxNOT_FOUND))

     {
         // move the selection back one
         m_selection_hack--;
     }
     {
         // move the selection back one
         m_selection_hack--;
     }

-    else if (n == m_selection_hack)
+    else if ((int)n == m_selection_hack)

     {
         // invalidate the selection
         m_selection_hack = wxNOT_FOUND;
     }
 
     {
         // 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();
+    // 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
+    const unsigned int count = GetCount();

 
     wxArrayString items;
     wxArrayPtrVoid itemsData;
 
     wxArrayString items;
     wxArrayPtrVoid itemsData;

-    items.Alloc(count);
-    for ( i = 0; i < count; i++ )
+    items.Alloc(count - 1);
+    itemsData.Alloc(count - 1);
+    for ( unsigned i = 0; i < count; i++ )

     {
         if ( i != n )
         {
             items.Add(GetString(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();
+            itemsData.Add(m_clientData[i]);

         }
     }
 
         }
     }
 

-    if ( hasObjectData )
-    {
-        // prevent Clear() from destroying all client data
-        m_clientDataItemsType = wxClientData_None;
-    }
-
-    Clear();
+    wxChoice::DoClear();

 
 

-    for ( i = 0; i < count - 1; i++ )
+    if ( count > 1 )

     {
     {

-        Append(items[i]);
-
-        if ( hasObjectData )
-            SetClientObject(i, (wxClientData *)itemsData[i]);
-        else if ( hasClientData )
-            SetClientData(i, itemsData[i]);
+        void ** const data = &itemsData[0];
+        if ( HasClientObjectData() )
+            Append(items, wx_reinterpret_cast(wxClientData **, data));
+        else
+            Append(items, data);

     }
     }

+    //else: the control is now empty, nothing to append

 }
 
 int wxChoice::FindString( const wxString &string, bool bCase ) const
 }
 
 int wxChoice::FindString( const wxString &string, bool bCase ) const


@@ -357,12 +293,12 @@ int wxChoice::GetSelection() const
 
 }
 
 
 }
 

-void wxChoice::SetString( int n, const wxString& str )
+void wxChoice::SetString(unsigned 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) ) );
 {
     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;
+    unsigned int count = 0;

     GList *child = menu_shell->children;
     while (child)
     {
     GList *child = menu_shell->children;
     while (child)
     {


@@ -378,6 +314,8 @@ void wxChoice::SetString( int n, const wxString& str )
             wxASSERT_MSG( label != NULL , wxT("wxChoice: invalid label") );
 
             gtk_label_set_text( label, wxGTK_CONV( str ) );
             wxASSERT_MSG( label != NULL , wxT("wxChoice: invalid label") );
 
             gtk_label_set_text( label, wxGTK_CONV( str ) );

+            
+            InvalidateBestSize();

 
             return;
         }
 
             return;
         }


@@ -386,12 +324,12 @@ void wxChoice::SetString( int n, const wxString& str )
     }
 }
 
     }
 }
 

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

 {
     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) ) );
 {
     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)
     {
     GList *child = menu_shell->children;
     while (child)
     {


@@ -417,12 +355,12 @@ wxString wxChoice::GetString( int n ) const
     return wxEmptyString;
 }
 
     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) ) );
 {
     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)
     {
     GList *child = menu_shell->children;
     while (child)
     {


@@ -440,7 +378,7 @@ void wxChoice::SetSelection( int n )
     gtk_option_menu_set_history( GTK_OPTION_MENU(m_widget), (gint)tmp );
 
     // set the local selection variable manually
     gtk_option_menu_set_history( GTK_OPTION_MENU(m_widget), (gint)tmp );
 
     // set the local selection variable manually

-    if ((n >= 0) && (n < GetCount()))
+    if ((n >= 0) && ((unsigned int)n < GetCount()))

     {
         // a valid selection has been made
         m_selection_hack = n;
     {
         // a valid selection has been made
         m_selection_hack = n;


@@ -483,49 +421,26 @@ void wxChoice::DoApplyWidgetStyle(GtkRcStyle *style)
     }
 }
 
     }
 }
 

-int wxChoice::GtkAddHelper(GtkWidget *menu, int pos, const wxString& item)
+int wxChoice::GtkAddHelper(GtkWidget *menu, unsigned int pos, const wxString& item)

 {
 {

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

 
     GtkWidget *menu_item = gtk_menu_item_new_with_label( wxGTK_CONV( item ) );
 
 
     GtkWidget *menu_item = gtk_menu_item_new_with_label( wxGTK_CONV( item ) );
 

-    size_t index;

     if ( m_strings )
     {
         // sorted control, need to insert at the correct 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 );
-
-        if ( index )
-        {
-            m_clientList.Insert( m_clientList.Item(index - 1),
-                                 (wxObject*) NULL );
-        }
-        else
-        {
-            m_clientList.Insert( (wxObject*) NULL );
-        }
+        pos = m_strings->Add(item);

     }
     }

+
+    // don't call wxChoice::GetCount() from here because it doesn't work
+    // if we're called from ctor (and GtkMenuShell is still NULL)
+    if (pos == m_clientData.GetCount())
+        gtk_menu_shell_append( GTK_MENU_SHELL(menu), menu_item );

     else
     else

-    {
-        // don't call wxChoice::GetCount() from here because it doesn't work
-        // if we're called from ctor (and GtkMenuShell is still NULL)
+        gtk_menu_shell_insert( GTK_MENU_SHELL(menu), menu_item, pos );

 
 

-        // normal control, just append
-        if (pos == (int)m_clientList.GetCount())
-        {
-            gtk_menu_append( GTK_MENU(menu), menu_item );
-            m_clientList.Append( (wxObject*) NULL );
-            index = m_clientList.GetCount() - 1;
-        }
-        else
-        {
-            gtk_menu_insert( GTK_MENU(menu), menu_item, pos );
-            m_clientList.Insert( pos, (wxObject*) NULL );
-            index = pos;
-        }
-    }
+    m_clientData.Insert( NULL, pos );

 
     if (GTK_WIDGET_REALIZED(m_widget))
     {
 
     if (GTK_WIDGET_REALIZED(m_widget))
     {


@@ -548,7 +463,7 @@ int wxChoice::GtkAddHelper(GtkWidget *menu, int pos, const wxString& item)
     gtk_widget_show( menu_item );
 
     // return the index of the item in the control
     gtk_widget_show( menu_item );
 
     // return the index of the item in the control

-    return index;
+    return pos;

 }
 
 wxSize wxChoice::DoGetBestSize() const
 }
 
 wxSize wxChoice::DoGetBestSize() const


@@ -561,8 +476,8 @@ wxSize wxChoice::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 );
             if ( width > ret.x )
         {
             GetTextExtent( GetString(n), &width, NULL, NULL, NULL );
             if ( width > ret.x )


@@ -596,7 +511,7 @@ wxSize wxChoice::DoGetBestSize() const
     return ret;
 }
 
     return ret;
 }
 

-bool wxChoice::IsOwnGtkWindow( GdkWindow *window )
+GdkWindow *wxChoice::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const

 {
     return GTK_BUTTON(m_widget)->event_window;
 }
 {
     return GTK_BUTTON(m_widget)->event_window;
 }