src/gtk/choice.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        choice.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10
  11 #ifdef __GNUG__
  12 #pragma implementation "choice.h"
  13 #endif
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_CHOICE
  18
  19 #include "wx/choice.h"
  20
  21 #include "wx/gtk/private.h"
  22
  23 //-----------------------------------------------------------------------------
  24 // idle system
  25 //-----------------------------------------------------------------------------
  26
  27 extern void wxapp_install_idle_handler();
  28 extern bool g_isIdle;
  29
  30 //-----------------------------------------------------------------------------
  31 // data
  32 //-----------------------------------------------------------------------------
  33
  34 extern bool   g_blockEventsOnDrag;
  35
  36 //-----------------------------------------------------------------------------
  37 // "activate"
  38 //-----------------------------------------------------------------------------
  39
  40 static void gtk_choice_clicked_callback( GtkWidget *WXUNUSED(widget), wxChoice *choice )
  41 {
  42     if (g_isIdle)
  43       wxapp_install_idle_handler();
  44
  45     if (!choice->m_hasVMT) return;
  46
  47     if (g_blockEventsOnDrag) return;
  48
  49     wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, choice->GetId() );
  50     int n = choice->GetSelection();
  51
  52     event.SetInt( n );
  53     event.SetString( choice->GetStringSelection() );
  54     event.SetEventObject(choice);
  55
  56     if ( choice->HasClientObjectData() )
  57         event.SetClientObject( choice->GetClientObject(n) );
  58     else if ( choice->HasClientUntypedData() )
  59         event.SetClientData( choice->GetClientData(n) );
  60
  61     choice->GetEventHandler()->ProcessEvent(event);
  62 }
  63
  64 //-----------------------------------------------------------------------------
  65 // wxChoice
  66 //-----------------------------------------------------------------------------
  67
  68 IMPLEMENT_DYNAMIC_CLASS(wxChoice,wxControl)
  69
  70 wxChoice::wxChoice()
  71 {
  72     m_strings = (wxSortedArrayString *)NULL;
  73 }
  74
  75 bool wxChoice::Create( wxWindow *parent, wxWindowID id,
  76                        const wxPoint &pos, const wxSize &size,
  77                        int n, const wxString choices[],
  78                        long style, const wxValidator& validator, const wxString &name )
  79 {
  80     m_needParent = TRUE;
  81 #if (GTK_MINOR_VERSION > 0)
  82     m_acceptsFocus = TRUE;
  83 #endif
  84
  85     if (!PreCreation( parent, pos, size ) ||
  86         !CreateBase( parent, id, pos, size, style, validator, name ))
  87     {
  88         wxFAIL_MSG( wxT("wxChoice creation failed") );
  89         return FALSE;
  90     }
  91
  92     m_widget = gtk_option_menu_new();
  93
  94     if ( style & wxCB_SORT )
  95     {
  96         // if our m_strings != NULL, DoAppend() will check for it and insert
  97         // items in the correct order
  98         m_strings = new wxSortedArrayString;
  99     }
 100
 101     GtkWidget *menu = gtk_menu_new();
 102
 103     for (int i = 0; i < n; i++)
 104     {
 105         GtkAddHelper(menu, i, choices[i]);
 106     }
 107
 108     gtk_option_menu_set_menu( GTK_OPTION_MENU(m_widget), menu );
 109
 110     m_parent->DoAddChild( this );
 111
 112     PostCreation();
 113
 114     SetFont( parent->GetFont() );
 115
 116     SetBestSize(size);
 117
 118     SetBackgroundColour( parent->GetBackgroundColour() );
 119     SetForegroundColour( parent->GetForegroundColour() );
 120
 121     Show( TRUE );
 122
 123     return TRUE;
 124 }
 125
 126 wxChoice::~wxChoice()
 127 {
 128     Clear();
 129
 130     delete m_strings;
 131 }
 132
 133 int wxChoice::DoAppend( const wxString &item )
 134 {
 135     wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid choice control") );
 136
 137     GtkWidget *menu = gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) );
 138
 139     return GtkAddHelper(menu, GetCount(), item);
 140 }
 141
 142 int wxChoice::DoInsert( const wxString &item, int pos )
 143 {
 144     wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid choice control") );
 145     wxCHECK_MSG( (pos>=0) && (pos<=GetCount()), -1, wxT("invalid index"));
 146
 147     if (pos == GetCount())
 148         return DoAppend(item);
 149
 150     GtkWidget *menu = gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) );
 151
 152     return GtkAddHelper(menu, pos, item);
 153 }
 154
 155 void wxChoice::DoSetItemClientData( int n, void* clientData )
 156 {
 157     wxCHECK_RET( m_widget != NULL, wxT("invalid choice control") );
 158
 159     wxNode *node = m_clientList.Item( n );
 160     wxCHECK_RET( node, wxT("invalid index in wxChoice::DoSetItemClientData") );
 161
 162     node->SetData( (wxObject*) clientData );
 163 }
 164
 165 void* wxChoice::DoGetItemClientData( int n ) const
 166 {
 167     wxCHECK_MSG( m_widget != NULL, NULL, wxT("invalid choice control") );
 168
 169     wxNode *node = m_clientList.Item( n );
 170     wxCHECK_MSG( node, NULL, wxT("invalid index in wxChoice::DoGetItemClientData") );
 171
 172     return node->GetData();
 173 }
 174
 175 void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
 176 {
 177     wxCHECK_RET( m_widget != NULL, wxT("invalid choice control") );
 178
 179     wxNode *node = m_clientList.Item( n );
 180     wxCHECK_RET( node, wxT("invalid index in wxChoice::DoSetItemClientObject") );
 181
 182     // wxItemContainer already deletes data for us
 183
 184     node->SetData( (wxObject*) clientData );
 185 }
 186
 187 wxClientData* wxChoice::DoGetItemClientObject( int n ) const
 188 {
 189     wxCHECK_MSG( m_widget != NULL, (wxClientData*) NULL, wxT("invalid choice control") );
 190
 191     wxNode *node = m_clientList.Item( n );
 192     wxCHECK_MSG( node, (wxClientData *)NULL,
 193                  wxT("invalid index in wxChoice::DoGetItemClientObject") );
 194
 195     return (wxClientData*) node->GetData();
 196 }
 197
 198 void wxChoice::Clear()
 199 {
 200     wxCHECK_RET( m_widget != NULL, wxT("invalid choice") );
 201
 202     gtk_option_menu_remove_menu( GTK_OPTION_MENU(m_widget) );
 203     GtkWidget *menu = gtk_menu_new();
 204     gtk_option_menu_set_menu( GTK_OPTION_MENU(m_widget), menu );
 205
 206     if ( HasClientObjectData() )
 207     {
 208         // destroy the data (due to Robert's idea of using wxList<wxObject>
 209         // and not wxList<wxClientData> we can't just say
 210         // m_clientList.DeleteContents(TRUE) - this would crash!
 211         wxNode *node = m_clientList.GetFirst();
 212         while ( node )
 213         {
 214             delete (wxClientData *)node->GetData();
 215             node = node->GetNext();
 216         }
 217     }
 218     m_clientList.Clear();
 219
 220     if ( m_strings )
 221         m_strings->Clear();
 222 }
 223
 224 void wxChoice::Delete( int n )
 225 {
 226     wxCHECK_RET( m_widget != NULL, wxT("invalid choice") );
 227
 228     // VZ: apparently GTK+ doesn't have a built-in function to do it (not even
 229     //     in 2.0), hence this dump implementation - still better than nothing
 230     int i,
 231         count = GetCount();
 232
 233     wxCHECK_RET( n >= 0 && n < count, _T("invalid index in wxChoice::Delete") );
 234
 235     wxArrayString items;
 236     items.Alloc(count);
 237     for ( i = 0; i < count; i++ )
 238     {
 239         if ( i != n )
 240             items.Add(GetString(i));
 241     }
 242
 243     Clear();
 244
 245     for ( i = 0; i < count - 1; i++ )
 246     {
 247         Append(items[i]);
 248     }
 249 }
 250
 251 int wxChoice::FindString( const wxString &string ) const
 252 {
 253     wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid choice") );
 254
 255     // If you read this code once and you think you understand
 256     // it, then you are very wrong. Robert Roebling.
 257
 258     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
 259     int count = 0;
 260     GList *child = menu_shell->children;
 261     while (child)
 262     {
 263         GtkBin *bin = GTK_BIN( child->data );
 264         GtkLabel *label = (GtkLabel *) NULL;
 265         if (bin->child)
 266             label = GTK_LABEL(bin->child);
 267         if (!label)
 268             label = GTK_LABEL( BUTTON_CHILD(m_widget) );
 269
 270         wxASSERT_MSG( label != NULL , wxT("wxChoice: invalid label") );
 271
 272 #ifdef __WXGTK20__
 273          wxString tmp( wxGTK_CONV_BACK( gtk_label_get_text( label) ) );
 274 #else
 275          wxString tmp( label->label );
 276 #endif
 277         if (string == tmp)
 278             return count;
 279
 280         child = child->next;
 281         count++;
 282     }
 283
 284     return -1;
 285 }
 286
 287 int wxChoice::GetSelection() const
 288 {
 289     wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid choice") );
 290
 291 #ifdef __WXGTK20__
 292
 293     return gtk_option_menu_get_history( GTK_OPTION_MENU(m_widget) );
 294
 295 #else
 296     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
 297     int count = 0;
 298
 299     GList *child = menu_shell->children;
 300     while (child)
 301     {
 302         GtkBin *bin = GTK_BIN( child->data );
 303         if (!bin->child) return count;
 304         child = child->next;
 305         count++;
 306     }
 307
 308     return -1;
 309 #endif
 310 }
 311
 312 void wxChoice::SetString( int WXUNUSED(n), const wxString& WXUNUSED(string) )
 313 {
 314     wxCHECK_RET( m_widget != NULL, wxT("invalid choice") );
 315
 316     wxFAIL_MSG(wxT("not implemented"));
 317 }
 318
 319 wxString wxChoice::GetString( int n ) const
 320 {
 321     wxCHECK_MSG( m_widget != NULL, wxT(""), wxT("invalid choice") );
 322
 323     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
 324     int count = 0;
 325     GList *child = menu_shell->children;
 326     while (child)
 327     {
 328         GtkBin *bin = GTK_BIN( child->data );
 329         if (count == n)
 330         {
 331             GtkLabel *label = (GtkLabel *) NULL;
 332             if (bin->child)
 333                 label = GTK_LABEL(bin->child);
 334             if (!label)
 335                 label = GTK_LABEL( BUTTON_CHILD(m_widget) );
 336
 337             wxASSERT_MSG( label != NULL , wxT("wxChoice: invalid label") );
 338
 339 #ifdef __WXGTK20__
 340             return wxString( wxGTK_CONV_BACK( gtk_label_get_text( label) ) );
 341 #else
 342             return wxString( label->label );
 343 #endif
 344         }
 345         child = child->next;
 346         count++;
 347     }
 348
 349     wxFAIL_MSG( wxT("wxChoice: invalid index in GetString()") );
 350
 351     return wxT("");
 352 }
 353
 354 int wxChoice::GetCount() const
 355 {
 356     wxCHECK_MSG( m_widget != NULL, 0, wxT("invalid choice") );
 357
 358     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
 359     int count = 0;
 360     GList *child = menu_shell->children;
 361     while (child)
 362     {
 363         count++;
 364         child = child->next;
 365     }
 366     return count;
 367 }
 368
 369 void wxChoice::SetSelection( int n )
 370 {
 371     wxCHECK_RET( m_widget != NULL, wxT("invalid choice") );
 372
 373     int tmp = n;
 374     gtk_option_menu_set_history( GTK_OPTION_MENU(m_widget), (gint)tmp );
 375 }
 376
 377 void wxChoice::ApplyWidgetStyle()
 378 {
 379     SetWidgetStyle();
 380
 381     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
 382
 383     gtk_widget_set_style( m_widget, m_widgetStyle );
 384     gtk_widget_set_style( GTK_WIDGET( menu_shell ), m_widgetStyle );
 385
 386     GList *child = menu_shell->children;
 387     while (child)
 388     {
 389         gtk_widget_set_style( GTK_WIDGET( child->data ), m_widgetStyle );
 390
 391         GtkBin *bin = GTK_BIN( child->data );
 392         GtkWidget *label = (GtkWidget *) NULL;
 393         if (bin->child)
 394             label = bin->child;
 395         if (!label)
 396             label = BUTTON_CHILD(m_widget);
 397
 398         gtk_widget_set_style( label, m_widgetStyle );
 399
 400         child = child->next;
 401     }
 402 }
 403
 404 int wxChoice::GtkAddHelper(GtkWidget *menu, int pos, const wxString& item)
 405 {
 406     wxCHECK_MSG((pos>=0) && (pos<=(int)m_clientList.GetCount()), -1, wxT("invalid index"));
 407
 408     GtkWidget *menu_item = gtk_menu_item_new_with_label( wxGTK_CONV( item ) );
 409
 410     size_t index;
 411     if ( m_strings )
 412     {
 413         // sorted control, need to insert at the correct index
 414         index = m_strings->Add(item);
 415
 416         gtk_menu_insert( GTK_MENU(menu), menu_item, index );
 417
 418         if ( index )
 419         {
 420             m_clientList.Insert( m_clientList.Item(index - 1),
 421                                  (wxObject*) NULL );
 422         }
 423         else
 424         {
 425             m_clientList.Insert( (wxObject*) NULL );
 426         }
 427     }
 428     else
 429     {
 430         // don't call wxChoice::GetCount() from here because it doesn't work
 431         // if we're called from ctor (and GtkMenuShell is still NULL)
 432
 433         // normal control, just append
 434         if (pos == (int)m_clientList.GetCount())
 435         {
 436         gtk_menu_append( GTK_MENU(menu), menu_item );
 437         m_clientList.Append( (wxObject*) NULL );
 438         index = m_clientList.GetCount() - 1;
 439         }
 440         else
 441         {
 442             gtk_menu_insert( GTK_MENU(menu), menu_item, pos );
 443             m_clientList.Insert( pos, (wxObject*) NULL );
 444             index = pos;
 445         }
 446     }
 447
 448     if (GTK_WIDGET_REALIZED(m_widget))
 449     {
 450         gtk_widget_realize( menu_item );
 451         gtk_widget_realize( GTK_BIN(menu_item)->child );
 452
 453         if (m_widgetStyle) ApplyWidgetStyle();
 454     }
 455
 456     gtk_signal_connect( GTK_OBJECT( menu_item ), "activate",
 457       GTK_SIGNAL_FUNC(gtk_choice_clicked_callback), (gpointer*)this );
 458
 459     gtk_widget_show( menu_item );
 460
 461     // return the index of the item in the control
 462     return index;
 463 }
 464
 465 wxSize wxChoice::DoGetBestSize() const
 466 {
 467     wxSize ret( wxControl::DoGetBestSize() );
 468
 469     // we know better our horizontal extent: it depends on the longest string
 470     // we have
 471     ret.x = 0;
 472     if ( m_widget )
 473     {
 474         int width;
 475         size_t count = GetCount();
 476         for ( size_t n = 0; n < count; n++ )
 477         {
 478             GetTextExtent( GetString(n), &width, NULL, NULL, NULL, &m_font );
 479             if ( width > ret.x )
 480                 ret.x = width;
 481         }
 482
 483         // add extra for the choice "=" button
 484
 485         // VZ: I don't know how to get the right value, it seems to be in
 486         //     GtkOptionMenuProps struct from gtkoptionmenu.c but we can't get
 487         //     to it - maybe we can use gtk_option_menu_size_request() for this
 488         //     somehow?
 489         //
 490         //     This default value works only for the default GTK+ theme (i.e.
 491         //     no theme at all) (FIXME)
 492         static const int widthChoiceIndicator = 35;
 493         ret.x += widthChoiceIndicator;
 494     }
 495
 496     // but not less than the minimal width
 497     if ( ret.x < 80 )
 498         ret.x = 80;
 499
 500     ret.y = 16 + GetCharHeight();
 501
 502     return ret;
 503 }
 504
 505 #endif // wxUSE_CHOICE
 506