Fix the URL generated by Doxygen @sampledir macro.

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

diff --git a/src/gtk/combobox.cpp b/src/gtk/combobox.cpp
index 6f0acae1372d3b828dcd292655c23cfdd1509062..045c6166ba478c697e6651a2bee894aafd52d198 100644 (file)
--- a/src/gtk/combobox.cpp
+++ b/src/gtk/combobox.cpp
@@ -1,365 +1,368 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:
 // Author:      Robert Roebling
 // Purpose:
 // Author:      Robert Roebling

-// Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Id:          $Id$
+// Copyright:   (c) 1998 Robert Roebling
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "combobox.h"
-#endif
+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"
+
+#if wxUSE_COMBOBOX

 
 #include "wx/combobox.h"
 
 #include "wx/combobox.h"

-#include <wx/intl.h>

 
 

-//-----------------------------------------------------------------------------
-// data
-//-----------------------------------------------------------------------------
+#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"
+
+// ----------------------------------------------------------------------------
+// GTK callbacks
+// ----------------------------------------------------------------------------
+
+extern "C" {
+static void
+gtkcombobox_text_changed_callback( GtkWidget *WXUNUSED(widget), wxComboBox *combo )
+{
+    if (!combo->m_hasVMT) return;
+
+    wxCommandEvent event( wxEVT_COMMAND_TEXT_UPDATED, combo->GetId() );
+    event.SetString( combo->GetValue() );
+    event.SetEventObject( combo );
+    combo->HandleWindowEvent( event );
+}

 
 

-extern bool   g_blockEventsOnDrag;
+static void
+gtkcombobox_changed_callback( GtkWidget *WXUNUSED(widget), wxComboBox *combo )
+{
+    combo->SendSelectionChangedEvent(wxEVT_COMMAND_COMBOBOX_SELECTED);
+}
+
+static void
+gtkcombobox_popupshown_callback(GObject *WXUNUSED(gobject),
+                                GParamSpec *WXUNUSED(param_spec),
+                                wxComboBox *combo)
+{
+    gboolean isShown;
+    g_object_get( combo->m_widget, "popup-shown", &isShown, NULL );
+    wxCommandEvent event( isShown ? wxEVT_COMMAND_COMBOBOX_DROPDOWN
+                                  : wxEVT_COMMAND_COMBOBOX_CLOSEUP,
+                          combo->GetId() );
+    event.SetEventObject( combo );
+    combo->HandleWindowEvent( event );
+}
+}

 
 //-----------------------------------------------------------------------------
 // wxComboBox
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // wxComboBox
 //-----------------------------------------------------------------------------
 

-//-----------------------------------------------------------------------------
-// clicked
-
-static void gtk_combo_clicked_callback( GtkWidget *WXUNUSED(widget), wxComboBox *combo )
-{
-  if (!combo->HasVMT()) return;
-  if (g_blockEventsOnDrag) return;
-  
-  if (combo->m_alreadySent)
-  {
-    combo->m_alreadySent = FALSE;
-    return;
-  }
-
-  combo->m_alreadySent = TRUE;
-  
-  wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, combo->GetId());
-  event.SetInt( combo->GetSelection() );
-  wxString tmp( combo->GetStringSelection() );
-  event.SetString( WXSTRINGCAST(tmp) );
-  event.SetEventObject(combo);
-  combo->GetEventHandler()->ProcessEvent(event);
-};
+BEGIN_EVENT_TABLE(wxComboBox, wxChoice)
+    EVT_CHAR(wxComboBox::OnChar)
+
+    EVT_MENU(wxID_CUT, wxComboBox::OnCut)
+    EVT_MENU(wxID_COPY, wxComboBox::OnCopy)
+    EVT_MENU(wxID_PASTE, wxComboBox::OnPaste)
+    EVT_MENU(wxID_UNDO, wxComboBox::OnUndo)
+    EVT_MENU(wxID_REDO, wxComboBox::OnRedo)
+    EVT_MENU(wxID_CLEAR, wxComboBox::OnDelete)
+    EVT_MENU(wxID_SELECTALL, wxComboBox::OnSelectAll)
+
+    EVT_UPDATE_UI(wxID_CUT, wxComboBox::OnUpdateCut)
+    EVT_UPDATE_UI(wxID_COPY, wxComboBox::OnUpdateCopy)
+    EVT_UPDATE_UI(wxID_PASTE, wxComboBox::OnUpdatePaste)
+    EVT_UPDATE_UI(wxID_UNDO, wxComboBox::OnUpdateUndo)
+    EVT_UPDATE_UI(wxID_REDO, wxComboBox::OnUpdateRedo)
+    EVT_UPDATE_UI(wxID_CLEAR, wxComboBox::OnUpdateDelete)
+    EVT_UPDATE_UI(wxID_SELECTALL, wxComboBox::OnUpdateSelectAll)
+END_EVENT_TABLE()
+
+void wxComboBox::Init()
+{
+    m_entry = NULL;
+}
+
+bool wxComboBox::Create( wxWindow *parent, wxWindowID id,
+                         const wxString& value,
+                         const wxPoint& pos, const wxSize& size,
+                         const wxArrayString& choices,
+                         long style, const wxValidator& validator,
+                         const wxString& name )
+{
+    wxCArrayString chs(choices);

 
 

-//-----------------------------------------------------------------------------
-// size 
-
-/*
-static gint gtk_combo_size_callback( GtkCombo *widget, GtkAllocation* alloc, wxComboBox *win )
-{ 
-  if (!win->HasVMT()) return FALSE;
-  if (g_blockEventsOnDrag) return FALSE;
-  if (!widget->button) return FALSE;
-  
-  widget->button->allocation.x = 
-    alloc->width - widget->button->allocation.width;
-  
-  return FALSE;
-};
-*/
+    return Create( parent, id, value, pos, size, chs.GetCount(),
+                   chs.GetStrings(), style, validator, name );
+}

 
 

-//-----------------------------------------------------------------------------
+bool wxComboBox::Create( wxWindow *parent, wxWindowID id, const wxString& value,
+                         const wxPoint& pos, const wxSize& size,
+                         int n, const wxString choices[],
+                         long style, const wxValidator& validator,
+                         const wxString& name )
+{
+    if (!PreCreation( parent, pos, size ) ||
+        !CreateBase( parent, id, pos, size, style, validator, name ))
+    {
+        wxFAIL_MSG( wxT("wxComboBox creation failed") );
+        return false;
+    }
+
+    if (HasFlag(wxCB_SORT))
+        m_strings = new wxGtkCollatedArrayString();
+
+    GTKCreateComboBoxWidget();
+
+    if (HasFlag(wxBORDER_NONE))
+    {
+        // Doesn't seem to work
+        // g_object_set (m_widget, "has-frame", FALSE, NULL);
+    }
+
+    GtkEntry * const entry = GetEntry();
+
+    if ( entry )
+    {
+        // Set it up to trigger default item on enter key press
+        gtk_entry_set_activates_default( entry,
+                                         !HasFlag(wxTE_PROCESS_ENTER) );
+
+        gtk_editable_set_editable(GTK_EDITABLE(entry), true);
+    }
+
+    Append(n, choices);
+
+    m_parent->DoAddChild( this );
+
+    if ( entry )
+        m_focusWidget = GTK_WIDGET( entry );
+
+    PostCreation(size);
+
+    if ( entry )
+    {
+        if (style & wxCB_READONLY)
+        {
+            // this will assert and do nothing if the value is not in our list
+            // of strings which is the desired behaviour (for consistency with
+            // wxMSW and also because it doesn't make sense to have a string
+            // which is not a possible choice in a read-only combobox)
+            SetStringSelection(value);
+            gtk_editable_set_editable(GTK_EDITABLE(entry), false);
+        }
+        else // editable combobox
+        {
+            // any value is accepted, even if it's not in our list
+            gtk_entry_set_text( entry, wxGTK_CONV(value) );
+        }
+
+        g_signal_connect_after (entry, "changed",
+                                G_CALLBACK (gtkcombobox_text_changed_callback), this);
+    }
+
+    g_signal_connect_after (m_widget, "changed",
+                        G_CALLBACK (gtkcombobox_changed_callback), this);
+
+    if ( !gtk_check_version(2,10,0) )
+    {
+        g_signal_connect (m_widget, "notify::popup-shown",
+                          G_CALLBACK (gtkcombobox_popupshown_callback), this);
+    }
+
+    SetInitialSize(size); // need this too because this is a wxControlWithItems
+
+    return true;
+}
+
+void wxComboBox::GTKCreateComboBoxWidget()
+{
+    m_widget = gtk_combo_box_entry_new_text();
+    g_object_ref(m_widget);

 
 

-IMPLEMENT_DYNAMIC_CLASS(wxComboBox,wxControl)
-
-bool wxComboBox::Create(wxWindow *parent, wxWindowID id, const wxString& value,
-  const wxPoint& pos, const wxSize& size,
-  int n, const wxString choices[],
-  long style, const wxString& name )
-{
-  m_alreadySent = FALSE;
-  m_needParent = TRUE;
-  
-  PreCreation( parent, id, pos, size, style, name );
-  
-  m_widget = gtk_combo_new();
-  
-  wxSize newSize = size;
-  if (newSize.x == -1) newSize.x = 100;
-  if (newSize.y == -1) newSize.y = 26;
-  SetSize( newSize.x, newSize.y );
-  
-  GtkWidget *list = GTK_COMBO(m_widget)->list;
-  
-  for (int i = 0; i < n; i++)
-  {
-    GtkWidget *list_item;
-    list_item = gtk_list_item_new_with_label( choices[i] ); 
-  
-    gtk_container_add( GTK_CONTAINER(list), list_item );
-    
-    m_clientData.Append( (wxObject*)NULL );
-    
-    gtk_widget_show( list_item );
-    
-    gtk_signal_connect( GTK_OBJECT(list_item), "select", 
-      GTK_SIGNAL_FUNC(gtk_combo_clicked_callback), (gpointer)this );
-  };
-  
-  PostCreation();
-
-/*
-  gtk_signal_connect( GTK_OBJECT(m_widget), "size_allocate", 
-    GTK_SIGNAL_FUNC(gtk_combo_size_callback), (gpointer)this );
-*/
-
-  if (!value.IsNull()) SetValue( value );
-    
-  Show( TRUE );
-    
-  return TRUE;
-};
-
-void wxComboBox::Clear(void)
-{
-  GtkWidget *list = GTK_COMBO(m_widget)->list;
-  gtk_list_clear_items( GTK_LIST(list), 0, Number() );
-  
-  m_clientData.Clear();
-};
-
-void wxComboBox::Append( const wxString &item )
-{
-  Append( item, (char*)NULL );
-};
-
-void wxComboBox::Append( const wxString &item, char *clientData )
-{
-  GtkWidget *list = GTK_COMBO(m_widget)->list;
-  
-  GtkWidget *list_item;
-  list_item = gtk_list_item_new_with_label( item ); 
-  
-  gtk_signal_connect( GTK_OBJECT(list_item), "select", 
-    GTK_SIGNAL_FUNC(gtk_combo_clicked_callback), (gpointer)this );
-  
-  gtk_container_add( GTK_CONTAINER(list), list_item );
-    
-  gtk_widget_show( list_item );
-  
-  m_clientData.Append( (wxObject*)clientData );
-};
-
-void wxComboBox::Delete( int n )
-{
-  GtkWidget *list = GTK_COMBO(m_widget)->list;
-  gtk_list_clear_items( GTK_LIST(list), n, n );
-  
-  wxNode *node = m_clientData.Nth( n );
-  if (!node)
-  {
-    wxFAIL_MSG( "wxComboBox: wrong index" );
-  }
-  else
-    m_clientData.DeleteNode( node );
-};
-
-int wxComboBox::FindString( const wxString &item )
-{
-  GtkWidget *list = GTK_COMBO(m_widget)->list;
-  
-  GList *child = GTK_LIST(list)->children;
-  int count = 0;
-  while (child)
-  {
-    GtkBin *bin = GTK_BIN( child->data );
-    GtkLabel *label = GTK_LABEL( bin->child );
-    if (item == label->label) return count;
-    count++;
-    child = child->next;
-  };
-  
-  wxFAIL_MSG( "wxComboBox: string not found" );
-  
-  return -1;
-};
-
-char* wxComboBox::GetClientData( int n )
-{
-  wxNode *node = m_clientData.Nth( n );
-  if (node) return (char*)node->Data();
-  
-  wxFAIL_MSG( "wxComboBox: wrong index" );
-  
-  return NULL;
-};
-
-void wxComboBox::SetClientData( int n, char * clientData )
-{
-  wxNode *node = m_clientData.Nth( n );
-  if (node) node->SetData( (wxObject*) clientData );
-  
-  wxFAIL_MSG( "wxComboBox: wrong index" );
-};
-
-int wxComboBox::GetSelection(void) const
-{
-  GtkWidget *list = GTK_COMBO(m_widget)->list;
-  
-  GList *selection = GTK_LIST(list)->selection;
-  if (selection)
-  {
-    GList *child = GTK_LIST(list)->children;
-    int count = 0;
-    while (child)
+    m_entry = GTK_ENTRY(gtk_bin_get_child(GTK_BIN(m_widget)));
+}
+
+GtkEditable *wxComboBox::GetEditable() const
+{
+    return GTK_EDITABLE(gtk_bin_get_child(GTK_BIN(m_widget)));
+}
+
+void wxComboBox::OnChar( wxKeyEvent &event )
+{
+    switch ( event.GetKeyCode() )
+    {
+        case WXK_RETURN:
+            if ( HasFlag(wxTE_PROCESS_ENTER) && GetEntry() )
+            {
+                // GTK automatically selects an item if its in the list
+                wxCommandEvent eventEnter(wxEVT_COMMAND_TEXT_ENTER, GetId());
+                eventEnter.SetString( GetValue() );
+                eventEnter.SetInt( GetSelection() );
+                eventEnter.SetEventObject( this );
+
+                if ( HandleWindowEvent(eventEnter) )
+                {
+                    // Catch GTK event so that GTK doesn't open the drop
+                    // down list upon RETURN.
+                    return;
+                }
+            }
+            break;
+    }
+
+    event.Skip();
+}
+
+void wxComboBox::EnableTextChangedEvents(bool enable)
+{
+    if ( !GetEntry() )
+        return;
+
+    if ( enable )
+    {
+        g_signal_handlers_unblock_by_func(gtk_bin_get_child(GTK_BIN(m_widget)),
+            (gpointer)gtkcombobox_text_changed_callback, this);
+    }
+    else // disable

     {
     {

-      if (child->data == selection->data) return count;
-      count++;
-      child = child->next;
-    };
-  };
-  
-  wxFAIL_MSG( "wxComboBox: no selection" );
-  
-  return -1;
-};
-
-wxString wxComboBox::GetString( int n ) const
-{
-  GtkWidget *list = GTK_COMBO(m_widget)->list;
-  
-  GList *child = g_list_nth( GTK_LIST(list)->children, n );
-  if (child)
-  {
-    GtkBin *bin = GTK_BIN( child->data );
-    GtkLabel *label = GTK_LABEL( bin->child );
-    return label->label;
-  };
-  
-  wxFAIL_MSG( "wxComboBox: wrong index" );
-  
-  return "";
-};
-
-wxString wxComboBox::GetStringSelection(void) const
-{
-  GtkWidget *list = GTK_COMBO(m_widget)->list;
-  
-  GList *selection = GTK_LIST(list)->selection;
-  if (selection)
-  {
-    GtkBin *bin = GTK_BIN( selection->data );
-    wxString tmp = GTK_LABEL( bin->child )->label;
-    return tmp;
-  };
-  
-  wxFAIL_MSG( "wxComboBox: no selection" );
-  
-  return "";
-};
-
-int wxComboBox::Number(void) const
-{
-  GtkWidget *list = GTK_COMBO(m_widget)->list;
-  
-  GList *child = GTK_LIST(list)->children;
-  int count = 0;
-  while (child) { count++; child = child->next; };
-  return count;
-};
-
-void wxComboBox::SetSelection( int n )
-{
-  GtkWidget *list = GTK_COMBO(m_widget)->list;
-  gtk_list_select_item( GTK_LIST(list), n );
-};
-
-void wxComboBox::SetStringSelection( const wxString &string )
-{
-  int res = FindString( string );
-  if (res == -1) return;
-  SetSelection( res );
-};
-
-wxString wxComboBox::GetValue(void) const
-{
-  GtkWidget *entry = GTK_COMBO(m_widget)->entry;
-  wxString tmp = gtk_entry_get_text( GTK_ENTRY(entry) );
-  return tmp;
-};
-
-void wxComboBox::SetValue( const wxString& value )
-{
-  GtkWidget *entry = GTK_COMBO(m_widget)->entry;
-  wxString tmp = "";
-  if (!value.IsNull()) tmp = value;
-  gtk_entry_set_text( GTK_ENTRY(entry), tmp );
-};
-
-void wxComboBox::Copy(void)
-{
-  GtkWidget *entry = GTK_COMBO(m_widget)->entry;
-  gtk_editable_copy_clipboard( GTK_EDITABLE(entry), 0 );
-};
-
-void wxComboBox::Cut(void)
-{
-  GtkWidget *entry = GTK_COMBO(m_widget)->entry;
-  gtk_editable_cut_clipboard( GTK_EDITABLE(entry), 0 );
-};
-
-void wxComboBox::Paste(void)
-{
-  GtkWidget *entry = GTK_COMBO(m_widget)->entry;
-  gtk_editable_paste_clipboard( GTK_EDITABLE(entry), 0 );
-};
-
-void wxComboBox::SetInsertionPoint( long pos )
+        g_signal_handlers_block_by_func(gtk_bin_get_child(GTK_BIN(m_widget)),
+            (gpointer)gtkcombobox_text_changed_callback, this);
+    }
+}
+
+void wxComboBox::GTKDisableEvents()
+{
+    EnableTextChangedEvents(false);
+
+    g_signal_handlers_block_by_func(m_widget,
+        (gpointer)gtkcombobox_changed_callback, this);
+    g_signal_handlers_block_by_func(m_widget,
+        (gpointer)gtkcombobox_popupshown_callback, this);
+}
+
+void wxComboBox::GTKEnableEvents()
+{
+    EnableTextChangedEvents(true);
+
+    g_signal_handlers_unblock_by_func(m_widget,
+        (gpointer)gtkcombobox_changed_callback, this);
+    g_signal_handlers_unblock_by_func(m_widget,
+        (gpointer)gtkcombobox_popupshown_callback, this);
+}
+
+GtkWidget* wxComboBox::GetConnectWidget()

 {
 {

-  GtkWidget *entry = GTK_COMBO(m_widget)->entry;
-  int tmp = (int) pos;
-  gtk_entry_set_position( GTK_ENTRY(entry), tmp );
-};
+    return GTK_WIDGET( GetEntry() );
+}

 
 

-void wxComboBox::SetInsertionPointEnd(void)
+GdkWindow* wxComboBox::GTKGetWindow(wxArrayGdkWindows& /* windows */) const

 {
 {

-  GtkWidget *entry = GTK_COMBO(m_widget)->entry;
-  int pos = GTK_ENTRY(entry)->text_length;
-  SetInsertionPoint( pos-1 );
-};
+    return gtk_entry_get_text_window(GetEntry());
+}
+
+// static
+wxVisualAttributes
+wxComboBox::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
+{
+    return GetDefaultAttributesFromGTKWidget(gtk_combo_box_entry_new, true);
+}
+
+void wxComboBox::SetValue(const wxString& value)
+{
+    if ( HasFlag(wxCB_READONLY) )
+        SetStringSelection(value);
+    else
+        wxTextEntry::SetValue(value);
+}
+
+// ----------------------------------------------------------------------------
+// standard event handling
+// ----------------------------------------------------------------------------

 
 

-long wxComboBox::GetInsertionPoint(void) const
+void wxComboBox::OnCut(wxCommandEvent& WXUNUSED(event))

 {
 {

-  GtkWidget *entry = GTK_COMBO(m_widget)->entry;
-  return (long) GTK_EDITABLE(entry)->current_pos;
-};
+    Cut();
+}

 
 

-long wxComboBox::GetLastPosition(void) const
+void wxComboBox::OnCopy(wxCommandEvent& WXUNUSED(event))

 {
 {

-  GtkWidget *entry = GTK_COMBO(m_widget)->entry;
-  int pos = GTK_ENTRY(entry)->text_length;
-  return (long) pos-1;
-};
+    Copy();
+}

 
 

-void wxComboBox::Replace( long from, long to, const wxString& value )
+void wxComboBox::OnPaste(wxCommandEvent& WXUNUSED(event))

 {
 {

-  GtkWidget *entry = GTK_COMBO(m_widget)->entry;
-  gtk_editable_delete_text( GTK_EDITABLE(entry), (gint)from, (gint)to );
-  if (value.IsNull()) return;
-  gint pos = (gint)to;
-  gtk_editable_insert_text( GTK_EDITABLE(entry), value, value.Length(), &pos );
-};
+    Paste();
+}

 
 

-void wxComboBox::Remove(long from, long to)
+void wxComboBox::OnUndo(wxCommandEvent& WXUNUSED(event))

 {
 {

-  GtkWidget *entry = GTK_COMBO(m_widget)->entry;
-  gtk_editable_delete_text( GTK_EDITABLE(entry), (gint)from, (gint)to );
-};
+    Undo();
+}

 
 

-void wxComboBox::SetSelection( long WXUNUSED(from), long WXUNUSED(to) )
+void wxComboBox::OnRedo(wxCommandEvent& WXUNUSED(event))

 {
 {

-};
+    Redo();
+}

 
 

-void wxComboBox::SetEditable( bool WXUNUSED(editable) )
+void wxComboBox::OnDelete(wxCommandEvent& WXUNUSED(event))

 {
 {

-};
+    RemoveSelection();
+}

 
 

-      
+void wxComboBox::OnSelectAll(wxCommandEvent& WXUNUSED(event))
+{
+    SelectAll();
+}
+
+void wxComboBox::OnUpdateCut(wxUpdateUIEvent& event)
+{
+    event.Enable( CanCut() );
+}
+
+void wxComboBox::OnUpdateCopy(wxUpdateUIEvent& event)
+{
+    event.Enable( CanCopy() );
+}
+
+void wxComboBox::OnUpdatePaste(wxUpdateUIEvent& event)
+{
+    event.Enable( CanPaste() );
+}
+
+void wxComboBox::OnUpdateUndo(wxUpdateUIEvent& event)
+{
+    event.Enable( CanUndo() );
+}
+
+void wxComboBox::OnUpdateRedo(wxUpdateUIEvent& event)
+{
+    event.Enable( CanRedo() );
+}
+
+void wxComboBox::OnUpdateDelete(wxUpdateUIEvent& event)
+{
+    event.Enable(HasSelection() && IsEditable()) ;
+}
+
+void wxComboBox::OnUpdateSelectAll(wxUpdateUIEvent& event)
+{
+    event.Enable(!wxTextEntry::IsEmpty());
+}
+
+void wxComboBox::Popup()
+{
+     gtk_combo_box_popup( GTK_COMBO_BOX(m_widget) );
+}
+
+void wxComboBox::Dismiss()
+{
+    gtk_combo_box_popdown( GTK_COMBO_BOX(m_widget) );
+}
+#endif // wxUSE_COMBOBOX