src/gtk/choice.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/choice.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #include "wx/wxprec.h"
  11
  12 #if wxUSE_CHOICE || wxUSE_COMBOBOX
  13
  14 #include "wx/choice.h"
  15
  16 #ifndef WX_PRECOMP
  17     #include "wx/arrstr.h"
  18 #endif
  19
  20 #include <gtk/gtk.h>
  21 #include "wx/gtk/private.h"
  22 #include "wx/gtk/private/gtk2-compat.h"
  23
  24 // ----------------------------------------------------------------------------
  25 // GTK callbacks
  26 // ----------------------------------------------------------------------------
  27
  28 extern "C" {
  29
  30 static void
  31 gtk_choice_changed_callback( GtkWidget *WXUNUSED(widget), wxChoice *choice )
  32 {
  33     choice->SendSelectionChangedEvent(wxEVT_COMMAND_CHOICE_SELECTED);
  34 }
  35
  36 }
  37
  38 //-----------------------------------------------------------------------------
  39 // wxChoice
  40 //-----------------------------------------------------------------------------
  41
  42 void wxChoice::Init()
  43 {
  44     m_strings = NULL;
  45     m_stringCellIndex = 0;
  46 }
  47
  48 bool wxChoice::Create( wxWindow *parent, wxWindowID id,
  49                        const wxPoint &pos, const wxSize &size,
  50                        const wxArrayString& choices,
  51                        long style, const wxValidator& validator,
  52                        const wxString &name )
  53 {
  54     wxCArrayString chs(choices);
  55
  56     return Create( parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
  57                    style, validator, name );
  58 }
  59
  60 bool wxChoice::Create( wxWindow *parent, wxWindowID id,
  61                        const wxPoint &pos, const wxSize &size,
  62                        int n, const wxString choices[],
  63                        long style, const wxValidator& validator,
  64                        const wxString &name )
  65 {
  66     if (!PreCreation( parent, pos, size ) ||
  67         !CreateBase( parent, id, pos, size, style, validator, name ))
  68     {
  69         wxFAIL_MSG( wxT("wxChoice creation failed") );
  70         return false;
  71     }
  72
  73     if ( IsSorted() )
  74     {
  75         // if our m_strings != NULL, Append() will check for it and insert
  76         // items in the correct order
  77         m_strings = new wxGtkCollatedArrayString;
  78     }
  79
  80 #ifdef __WXGTK3__
  81     m_widget = gtk_combo_box_text_new();
  82 #else
  83     m_widget = gtk_combo_box_new_text();
  84 #endif
  85     g_object_ref(m_widget);
  86
  87     Append(n, choices);
  88
  89     m_parent->DoAddChild( this );
  90
  91     PostCreation(size);
  92
  93     g_signal_connect_after (m_widget, "changed",
  94                             G_CALLBACK (gtk_choice_changed_callback), this);
  95
  96     return true;
  97 }
  98
  99 wxChoice::~wxChoice()
 100 {
 101     delete m_strings;
 102 }
 103
 104 void wxChoice::GTKInsertComboBoxTextItem( unsigned int n, const wxString& text )
 105 {
 106 #ifdef __WXGTK3__
 107     gtk_combo_box_text_insert_text(GTK_COMBO_BOX_TEXT(m_widget), n, wxGTK_CONV(text));
 108 #else
 109     gtk_combo_box_insert_text( GTK_COMBO_BOX( m_widget ), n, wxGTK_CONV( text ) );
 110 #endif
 111 }
 112
 113 int wxChoice::DoInsertItems(const wxArrayStringsAdapter & items,
 114                             unsigned int pos,
 115                             void **clientData, wxClientDataType type)
 116 {
 117     wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid control") );
 118
 119     wxASSERT_MSG( !IsSorted() || (pos == GetCount()),
 120                  wxT("In a sorted choice data could only be appended"));
 121
 122     const int count = items.GetCount();
 123
 124     int n = wxNOT_FOUND;
 125
 126     for ( int i = 0; i < count; ++i )
 127     {
 128         n = pos + i;
 129         // If sorted, use this wxSortedArrayStrings to determine
 130         // the right insertion point
 131         if (m_strings)
 132             n = m_strings->Add(items[i]);
 133
 134         GTKInsertComboBoxTextItem( n, items[i] );
 135
 136         m_clientData.Insert( NULL, n );
 137         AssignNewItemClientData(n, clientData, i, type);
 138     }
 139
 140     InvalidateBestSize();
 141
 142     return n;
 143 }
 144
 145 void wxChoice::DoSetItemClientData(unsigned int n, void* clientData)
 146 {
 147     m_clientData[n] = clientData;
 148 }
 149
 150 void* wxChoice::DoGetItemClientData(unsigned int n) const
 151 {
 152     return m_clientData[n];
 153 }
 154
 155 void wxChoice::DoClear()
 156 {
 157     wxCHECK_RET( m_widget != NULL, wxT("invalid control") );
 158
 159     GTKDisableEvents();
 160
 161     GtkComboBox* combobox = GTK_COMBO_BOX( m_widget );
 162     GtkTreeModel* model = gtk_combo_box_get_model( combobox );
 163     gtk_list_store_clear(GTK_LIST_STORE(model));
 164
 165     m_clientData.Clear();
 166
 167     if (m_strings)
 168         m_strings->Clear();
 169
 170     GTKEnableEvents();
 171
 172     InvalidateBestSize();
 173 }
 174
 175 void wxChoice::DoDeleteOneItem(unsigned int n)
 176 {
 177     wxCHECK_RET( m_widget != NULL, wxT("invalid control") );
 178     wxCHECK_RET( IsValid(n), wxT("invalid index in wxChoice::Delete") );
 179
 180     GtkComboBox* combobox = GTK_COMBO_BOX( m_widget );
 181     GtkTreeModel* model = gtk_combo_box_get_model( combobox );
 182     GtkListStore* store = GTK_LIST_STORE(model);
 183     GtkTreeIter iter;
 184     gtk_tree_model_iter_nth_child( model, &iter,
 185                                    NULL, (gint) n );
 186     gtk_list_store_remove( store, &iter );
 187
 188     m_clientData.RemoveAt( n );
 189     if ( m_strings )
 190         m_strings->RemoveAt( n );
 191
 192     InvalidateBestSize();
 193 }
 194
 195 int wxChoice::FindString( const wxString &item, bool bCase ) const
 196 {
 197     wxCHECK_MSG( m_widget != NULL, wxNOT_FOUND, wxT("invalid control") );
 198
 199     GtkComboBox* combobox = GTK_COMBO_BOX( m_widget );
 200     GtkTreeModel* model = gtk_combo_box_get_model( combobox );
 201     GtkTreeIter iter;
 202     gtk_tree_model_get_iter_first( model, &iter );
 203     if (!gtk_list_store_iter_is_valid(GTK_LIST_STORE(model), &iter ))
 204         return -1;
 205     int count = 0;
 206     do
 207     {
 208         GValue value = { 0, };
 209         gtk_tree_model_get_value( model, &iter, m_stringCellIndex, &value );
 210         wxString str = wxGTK_CONV_BACK( g_value_get_string( &value ) );
 211         g_value_unset( &value );
 212
 213         if (item.IsSameAs( str, bCase ) )
 214             return count;
 215
 216         count++;
 217     }
 218     while ( gtk_tree_model_iter_next(model, &iter) );
 219
 220     return wxNOT_FOUND;
 221 }
 222
 223 int wxChoice::GetSelection() const
 224 {
 225     return gtk_combo_box_get_active( GTK_COMBO_BOX( m_widget ) );
 226 }
 227
 228 void wxChoice::SetString(unsigned int n, const wxString &text)
 229 {
 230     wxCHECK_RET( m_widget != NULL, wxT("invalid control") );
 231
 232     GtkComboBox* combobox = GTK_COMBO_BOX( m_widget );
 233     wxCHECK_RET( IsValid(n), wxT("invalid index") );
 234
 235     GtkTreeModel *model = gtk_combo_box_get_model( combobox );
 236     GtkTreeIter iter;
 237     if (gtk_tree_model_iter_nth_child (model, &iter, NULL, n))
 238     {
 239         GValue value = { 0, };
 240         g_value_init( &value, G_TYPE_STRING );
 241         g_value_set_string( &value, wxGTK_CONV( text ) );
 242         gtk_list_store_set_value( GTK_LIST_STORE(model), &iter, m_stringCellIndex, &value );
 243         g_value_unset( &value );
 244     }
 245
 246     InvalidateBestSize();
 247 }
 248
 249 wxString wxChoice::GetString(unsigned int n) const
 250 {
 251     wxCHECK_MSG( m_widget != NULL, wxEmptyString, wxT("invalid control") );
 252
 253     wxString str;
 254
 255     GtkComboBox* combobox = GTK_COMBO_BOX( m_widget );
 256     GtkTreeModel *model = gtk_combo_box_get_model( combobox );
 257     GtkTreeIter iter;
 258     if (gtk_tree_model_iter_nth_child (model, &iter, NULL, n))
 259     {
 260         GValue value = { 0, };
 261         gtk_tree_model_get_value( model, &iter, m_stringCellIndex, &value );
 262         wxString tmp = wxGTK_CONV_BACK( g_value_get_string( &value ) );
 263         g_value_unset( &value );
 264         return tmp;
 265     }
 266
 267     return str;
 268 }
 269
 270 unsigned int wxChoice::GetCount() const
 271 {
 272     wxCHECK_MSG( m_widget != NULL, 0, wxT("invalid control") );
 273
 274     GtkComboBox* combobox = GTK_COMBO_BOX( m_widget );
 275     GtkTreeModel* model = gtk_combo_box_get_model( combobox );
 276     GtkTreeIter iter;
 277     gtk_tree_model_get_iter_first( model, &iter );
 278     if (!gtk_list_store_iter_is_valid(GTK_LIST_STORE(model), &iter ))
 279         return 0;
 280     unsigned int ret = 1;
 281     while (gtk_tree_model_iter_next( model, &iter ))
 282         ret++;
 283     return ret;
 284 }
 285
 286 void wxChoice::SetSelection( int n )
 287 {
 288     wxCHECK_RET( m_widget != NULL, wxT("invalid control") );
 289
 290     GTKDisableEvents();
 291
 292     GtkComboBox* combobox = GTK_COMBO_BOX( m_widget );
 293     gtk_combo_box_set_active( combobox, n );
 294
 295     GTKEnableEvents();
 296 }
 297
 298 void wxChoice::SetColumns(int n)
 299 {
 300     gtk_combo_box_set_wrap_width(GTK_COMBO_BOX(m_widget), n);
 301 }
 302
 303 int wxChoice::GetColumns() const
 304 {
 305     // gtk_combo_box_get_wrap_width() was added in gtk 2.6
 306     gint intval;
 307     g_object_get(G_OBJECT(m_widget), "wrap-width", &intval, NULL);
 308     return intval;
 309 }
 310
 311 void wxChoice::GTKDisableEvents()
 312 {
 313     g_signal_handlers_block_by_func(m_widget,
 314                                 (gpointer) gtk_choice_changed_callback, this);
 315 }
 316
 317 void wxChoice::GTKEnableEvents()
 318 {
 319     g_signal_handlers_unblock_by_func(m_widget,
 320                                 (gpointer) gtk_choice_changed_callback, this);
 321 }
 322
 323 GdkWindow *wxChoice::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const
 324 {
 325     return gtk_widget_get_window(m_widget);
 326 }
 327
 328 wxSize wxChoice::DoGetBestSize() const
 329 {
 330     // Get the height of the control from GTK+ itself, but use our own version
 331     // to compute the width large enough to show all our strings as GTK+
 332     // doesn't seem to take the control contents into account.
 333     return GetSizeFromTextSize(wxChoiceBase::DoGetBestSize().x);
 334 }
 335
 336 wxSize wxChoice::DoGetSizeFromTextSize(int xlen, int ylen) const
 337 {
 338     wxASSERT_MSG( m_widget, wxS("GetSizeFromTextSize called before creation") );
 339
 340     // a GtkEntry for wxComboBox and a GtkCellView for wxChoice
 341     GtkWidget* childPart = gtk_bin_get_child(GTK_BIN(m_widget));
 342
 343     // Set a as small as possible size for the control, so preferred sizes
 344     // return "natural" sizes, not taking into account the previous ones (which
 345     // seems to be GTK+3 behaviour)
 346     gtk_widget_set_size_request(m_widget, 0, 0);
 347
 348     // We are interested in the difference of sizes between the whole contol
 349     // and its child part. I.e. arrow, separators, etc.
 350     GtkRequisition req;
 351     gtk_widget_get_preferred_size(childPart, NULL, &req);
 352     wxSize totalS = GTKGetPreferredSize(m_widget);
 353
 354     wxSize tsize(xlen + totalS.x - req.width, totalS.y);
 355
 356     // For a wxChoice, not for wxComboBox, add some margins
 357     if ( !GTK_IS_ENTRY(childPart) )
 358         tsize.IncBy(5, 0);
 359
 360     // Perhaps the user wants something different from CharHeight
 361     if ( ylen > 0 )
 362         tsize.IncBy(0, ylen - GetCharHeight());
 363
 364     return tsize;
 365 }
 366
 367 void wxChoice::DoApplyWidgetStyle(GtkRcStyle *style)
 368 {
 369     GTKApplyStyle(m_widget, style);
 370     GTKApplyStyle(gtk_bin_get_child(GTK_BIN(m_widget)), style);
 371 }
 372
 373 // static
 374 wxVisualAttributes
 375 wxChoice::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 376 {
 377     return GetDefaultAttributesFromGTKWidget(gtk_combo_box_new());
 378 }
 379
 380 #endif // wxUSE_CHOICE || wxUSE_COMBOBOX