src/gtk/combobox.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/combobox.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 // For compilers that support precompilation, includes "wx.h".
  11 #include "wx/wxprec.h"
  12
  13 #if wxUSE_COMBOBOX
  14
  15 #include "wx/combobox.h"
  16
  17 #ifndef WX_PRECOMP
  18     #include "wx/intl.h"
  19     #include "wx/settings.h"
  20     #include "wx/textctrl.h"    // for wxEVT_COMMAND_TEXT_UPDATED
  21     #include "wx/arrstr.h"
  22 #endif
  23
  24 #include <gtk/gtk.h>
  25 #include "wx/gtk/private.h"
  26 #include "wx/gtk/private/gtk2-compat.h"
  27
  28 // ----------------------------------------------------------------------------
  29 // GTK callbacks
  30 // ----------------------------------------------------------------------------
  31
  32 extern "C" {
  33 static void
  34 gtkcombobox_text_changed_callback( GtkWidget *WXUNUSED(widget), wxComboBox *combo )
  35 {
  36     wxCommandEvent event( wxEVT_COMMAND_TEXT_UPDATED, combo->GetId() );
  37     event.SetString( combo->GetValue() );
  38     event.SetEventObject( combo );
  39     combo->HandleWindowEvent( event );
  40 }
  41
  42 static void
  43 gtkcombobox_changed_callback( GtkWidget *WXUNUSED(widget), wxComboBox *combo )
  44 {
  45     combo->SendSelectionChangedEvent(wxEVT_COMMAND_COMBOBOX_SELECTED);
  46 }
  47
  48 static void
  49 gtkcombobox_popupshown_callback(GObject *WXUNUSED(gobject),
  50                                 GParamSpec *WXUNUSED(param_spec),
  51                                 wxComboBox *combo)
  52 {
  53     gboolean isShown;
  54     g_object_get( combo->m_widget, "popup-shown", &isShown, NULL );
  55     wxCommandEvent event( isShown ? wxEVT_COMMAND_COMBOBOX_DROPDOWN
  56                                   : wxEVT_COMMAND_COMBOBOX_CLOSEUP,
  57                           combo->GetId() );
  58     event.SetEventObject( combo );
  59     combo->HandleWindowEvent( event );
  60 }
  61
  62 }
  63
  64 //-----------------------------------------------------------------------------
  65 // wxComboBox
  66 //-----------------------------------------------------------------------------
  67
  68 BEGIN_EVENT_TABLE(wxComboBox, wxChoice)
  69     EVT_CHAR(wxComboBox::OnChar)
  70
  71     EVT_MENU(wxID_CUT, wxComboBox::OnCut)
  72     EVT_MENU(wxID_COPY, wxComboBox::OnCopy)
  73     EVT_MENU(wxID_PASTE, wxComboBox::OnPaste)
  74     EVT_MENU(wxID_UNDO, wxComboBox::OnUndo)
  75     EVT_MENU(wxID_REDO, wxComboBox::OnRedo)
  76     EVT_MENU(wxID_CLEAR, wxComboBox::OnDelete)
  77     EVT_MENU(wxID_SELECTALL, wxComboBox::OnSelectAll)
  78
  79     EVT_UPDATE_UI(wxID_CUT, wxComboBox::OnUpdateCut)
  80     EVT_UPDATE_UI(wxID_COPY, wxComboBox::OnUpdateCopy)
  81     EVT_UPDATE_UI(wxID_PASTE, wxComboBox::OnUpdatePaste)
  82     EVT_UPDATE_UI(wxID_UNDO, wxComboBox::OnUpdateUndo)
  83     EVT_UPDATE_UI(wxID_REDO, wxComboBox::OnUpdateRedo)
  84     EVT_UPDATE_UI(wxID_CLEAR, wxComboBox::OnUpdateDelete)
  85     EVT_UPDATE_UI(wxID_SELECTALL, wxComboBox::OnUpdateSelectAll)
  86 END_EVENT_TABLE()
  87
  88 wxComboBox::~wxComboBox()
  89 {
  90     if (m_entry)
  91         GTKDisconnect(m_entry);
  92 }
  93
  94 void wxComboBox::Init()
  95 {
  96     m_entry = NULL;
  97 }
  98
  99 bool wxComboBox::Create( wxWindow *parent, wxWindowID id,
 100                          const wxString& value,
 101                          const wxPoint& pos, const wxSize& size,
 102                          const wxArrayString& choices,
 103                          long style, const wxValidator& validator,
 104                          const wxString& name )
 105 {
 106     wxCArrayString chs(choices);
 107
 108     return Create( parent, id, value, pos, size, chs.GetCount(),
 109                    chs.GetStrings(), style, validator, name );
 110 }
 111
 112 bool wxComboBox::Create( wxWindow *parent, wxWindowID id, const wxString& value,
 113                          const wxPoint& pos, const wxSize& size,
 114                          int n, const wxString choices[],
 115                          long style, const wxValidator& validator,
 116                          const wxString& name )
 117 {
 118     if (!PreCreation( parent, pos, size ) ||
 119         !CreateBase( parent, id, pos, size, style, validator, name ))
 120     {
 121         wxFAIL_MSG( wxT("wxComboBox creation failed") );
 122         return false;
 123     }
 124
 125     if (HasFlag(wxCB_SORT))
 126         m_strings = new wxGtkCollatedArrayString();
 127
 128     GTKCreateComboBoxWidget();
 129
 130     if (HasFlag(wxBORDER_NONE))
 131     {
 132         // Doesn't seem to work
 133         // g_object_set (m_widget, "has-frame", FALSE, NULL);
 134     }
 135
 136     GtkEntry * const entry = GetEntry();
 137
 138     if ( entry )
 139     {
 140         // Set it up to trigger default item on enter key press
 141         gtk_entry_set_activates_default( entry,
 142                                          !HasFlag(wxTE_PROCESS_ENTER) );
 143
 144         gtk_editable_set_editable(GTK_EDITABLE(entry), true);
 145     }
 146
 147     Append(n, choices);
 148
 149     m_parent->DoAddChild( this );
 150
 151     if ( entry )
 152         m_focusWidget = GTK_WIDGET( entry );
 153
 154     PostCreation(size);
 155
 156     if ( entry )
 157     {
 158         if (style & wxCB_READONLY)
 159         {
 160             // this will assert and do nothing if the value is not in our list
 161             // of strings which is the desired behaviour (for consistency with
 162             // wxMSW and also because it doesn't make sense to have a string
 163             // which is not a possible choice in a read-only combobox)
 164             SetStringSelection(value);
 165             gtk_editable_set_editable(GTK_EDITABLE(entry), false);
 166         }
 167         else // editable combobox
 168         {
 169             // any value is accepted, even if it's not in our list
 170             gtk_entry_set_text( entry, wxGTK_CONV(value) );
 171         }
 172
 173         g_signal_connect_after (entry, "changed",
 174                                 G_CALLBACK (gtkcombobox_text_changed_callback), this);
 175
 176         GTKConnectInsertTextSignal(entry);
 177         GTKConnectClipboardSignals(GTK_WIDGET(entry));
 178     }
 179
 180     g_signal_connect_after (m_widget, "changed",
 181                         G_CALLBACK (gtkcombobox_changed_callback), this);
 182
 183 #ifndef __WXGTK3__
 184     if ( !gtk_check_version(2,10,0) )
 185 #endif
 186     {
 187         g_signal_connect (m_widget, "notify::popup-shown",
 188                           G_CALLBACK (gtkcombobox_popupshown_callback), this);
 189     }
 190
 191     return true;
 192 }
 193
 194 void wxComboBox::GTKCreateComboBoxWidget()
 195 {
 196 #ifdef __WXGTK3__
 197     m_widget = gtk_combo_box_text_new_with_entry();
 198 #else
 199     m_widget = gtk_combo_box_entry_new_text();
 200 #endif
 201     g_object_ref(m_widget);
 202
 203     m_entry = GTK_ENTRY(gtk_bin_get_child(GTK_BIN(m_widget)));
 204 }
 205
 206 GtkEditable *wxComboBox::GetEditable() const
 207 {
 208     return GTK_EDITABLE(gtk_bin_get_child(GTK_BIN(m_widget)));
 209 }
 210
 211 void wxComboBox::OnChar( wxKeyEvent &event )
 212 {
 213     switch ( event.GetKeyCode() )
 214     {
 215         case WXK_RETURN:
 216             if ( HasFlag(wxTE_PROCESS_ENTER) && GetEntry() )
 217             {
 218                 // GTK automatically selects an item if its in the list
 219                 wxCommandEvent eventEnter(wxEVT_COMMAND_TEXT_ENTER, GetId());
 220                 eventEnter.SetString( GetValue() );
 221                 eventEnter.SetInt( GetSelection() );
 222                 eventEnter.SetEventObject( this );
 223
 224                 if ( HandleWindowEvent(eventEnter) )
 225                 {
 226                     // Catch GTK event so that GTK doesn't open the drop
 227                     // down list upon RETURN.
 228                     return;
 229                 }
 230             }
 231             break;
 232     }
 233
 234     event.Skip();
 235 }
 236
 237 void wxComboBox::EnableTextChangedEvents(bool enable)
 238 {
 239     if ( !GetEntry() )
 240         return;
 241
 242     if ( enable )
 243     {
 244         g_signal_handlers_unblock_by_func(gtk_bin_get_child(GTK_BIN(m_widget)),
 245             (gpointer)gtkcombobox_text_changed_callback, this);
 246     }
 247     else // disable
 248     {
 249         g_signal_handlers_block_by_func(gtk_bin_get_child(GTK_BIN(m_widget)),
 250             (gpointer)gtkcombobox_text_changed_callback, this);
 251     }
 252 }
 253
 254 void wxComboBox::GTKDisableEvents()
 255 {
 256     EnableTextChangedEvents(false);
 257
 258     g_signal_handlers_block_by_func(m_widget,
 259         (gpointer)gtkcombobox_changed_callback, this);
 260     g_signal_handlers_block_by_func(m_widget,
 261         (gpointer)gtkcombobox_popupshown_callback, this);
 262 }
 263
 264 void wxComboBox::GTKEnableEvents()
 265 {
 266     EnableTextChangedEvents(true);
 267
 268     g_signal_handlers_unblock_by_func(m_widget,
 269         (gpointer)gtkcombobox_changed_callback, this);
 270     g_signal_handlers_unblock_by_func(m_widget,
 271         (gpointer)gtkcombobox_popupshown_callback, this);
 272 }
 273
 274 GtkWidget* wxComboBox::GetConnectWidget()
 275 {
 276     return GTK_WIDGET( GetEntry() );
 277 }
 278
 279 GdkWindow* wxComboBox::GTKGetWindow(wxArrayGdkWindows& /* windows */) const
 280 {
 281 #ifdef __WXGTK3__
 282     // no access to internal GdkWindows
 283     return NULL;
 284 #else
 285     return gtk_entry_get_text_window(GetEntry());
 286 #endif
 287 }
 288
 289 // static
 290 wxVisualAttributes
 291 wxComboBox::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 292 {
 293 #ifdef __WXGTK3__
 294     return GetDefaultAttributesFromGTKWidget(gtk_combo_box_new_with_entry(), true);
 295 #else
 296     return GetDefaultAttributesFromGTKWidget(gtk_combo_box_entry_new(), true);
 297 #endif
 298 }
 299
 300 void wxComboBox::SetValue(const wxString& value)
 301 {
 302     if ( HasFlag(wxCB_READONLY) )
 303         SetStringSelection(value);
 304     else
 305         wxTextEntry::SetValue(value);
 306 }
 307
 308 void wxComboBox::SetString(unsigned int n, const wxString& text)
 309 {
 310     wxChoice::SetString(n, text);
 311
 312     if ( static_cast<int>(n) == GetSelection() )
 313     {
 314         // We also need to update the currently shown text, for consistency
 315         // with wxMSW and also because it makes sense as leaving the old string
 316         // in the text but not in the list would be confusing to the user.
 317         SetValue(text);
 318
 319         // And we need to keep the selection unchanged, modifying the item is
 320         // not supposed to deselect it.
 321         SetSelection(n);
 322     }
 323 }
 324
 325 // ----------------------------------------------------------------------------
 326 // standard event handling
 327 // ----------------------------------------------------------------------------
 328
 329 void wxComboBox::OnCut(wxCommandEvent& WXUNUSED(event))
 330 {
 331     Cut();
 332 }
 333
 334 void wxComboBox::OnCopy(wxCommandEvent& WXUNUSED(event))
 335 {
 336     Copy();
 337 }
 338
 339 void wxComboBox::OnPaste(wxCommandEvent& WXUNUSED(event))
 340 {
 341     Paste();
 342 }
 343
 344 void wxComboBox::OnUndo(wxCommandEvent& WXUNUSED(event))
 345 {
 346     Undo();
 347 }
 348
 349 void wxComboBox::OnRedo(wxCommandEvent& WXUNUSED(event))
 350 {
 351     Redo();
 352 }
 353
 354 void wxComboBox::OnDelete(wxCommandEvent& WXUNUSED(event))
 355 {
 356     RemoveSelection();
 357 }
 358
 359 void wxComboBox::OnSelectAll(wxCommandEvent& WXUNUSED(event))
 360 {
 361     SelectAll();
 362 }
 363
 364 void wxComboBox::OnUpdateCut(wxUpdateUIEvent& event)
 365 {
 366     event.Enable( CanCut() );
 367 }
 368
 369 void wxComboBox::OnUpdateCopy(wxUpdateUIEvent& event)
 370 {
 371     event.Enable( CanCopy() );
 372 }
 373
 374 void wxComboBox::OnUpdatePaste(wxUpdateUIEvent& event)
 375 {
 376     event.Enable( CanPaste() );
 377 }
 378
 379 void wxComboBox::OnUpdateUndo(wxUpdateUIEvent& event)
 380 {
 381     event.Enable( CanUndo() );
 382 }
 383
 384 void wxComboBox::OnUpdateRedo(wxUpdateUIEvent& event)
 385 {
 386     event.Enable( CanRedo() );
 387 }
 388
 389 void wxComboBox::OnUpdateDelete(wxUpdateUIEvent& event)
 390 {
 391     event.Enable(HasSelection() && IsEditable()) ;
 392 }
 393
 394 void wxComboBox::OnUpdateSelectAll(wxUpdateUIEvent& event)
 395 {
 396     event.Enable(!wxTextEntry::IsEmpty());
 397 }
 398
 399 void wxComboBox::Popup()
 400 {
 401      gtk_combo_box_popup( GTK_COMBO_BOX(m_widget) );
 402 }
 403
 404 void wxComboBox::Dismiss()
 405 {
 406     gtk_combo_box_popdown( GTK_COMBO_BOX(m_widget) );
 407 }
 408
 409 wxSize wxComboBox::DoGetSizeFromTextSize(int xlen, int ylen) const
 410 {
 411     wxSize tsize( wxChoice::DoGetSizeFromTextSize(xlen, ylen) );
 412
 413     GtkEntry* entry = GetEntry();
 414     if (entry)
 415     {
 416         // Add the margins we have previously set, but only the horizontal border
 417         // as vertical one has been taken account in the previous call.
 418         // Also get other GTK+ margins.
 419         tsize.IncBy(GTKGetEntryMargins(entry).x, 0);
 420     }
 421
 422     return tsize;
 423 }
 424
 425 #endif // wxUSE_COMBOBOX