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         GtkAppendHelper(menu, 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 GtkAppendHelper(menu, item);
 140 }
 141
 142 void wxChoice::DoSetItemClientData( int n, void* clientData )
 143 {
 144     wxCHECK_RET( m_widget != NULL, wxT("invalid choice control") );
 145
 146     wxNode *node = m_clientList.Nth( n );
 147     wxCHECK_RET( node, wxT("invalid index in wxChoice::DoSetItemClientData") );
 148
 149     node->SetData( (wxObject*) clientData );
 150 }
 151
 152 void* wxChoice::DoGetItemClientData( int n ) const
 153 {
 154     wxCHECK_MSG( m_widget != NULL, NULL, wxT("invalid choice control") );
 155
 156     wxNode *node = m_clientList.Nth( n );
 157     wxCHECK_MSG( node, NULL, wxT("invalid index in wxChoice::DoGetItemClientData") );
 158
 159     return node->Data();
 160 }
 161
 162 void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
 163 {
 164     wxCHECK_RET( m_widget != NULL, wxT("invalid choice control") );
 165
 166     wxNode *node = m_clientList.Nth( n );
 167     wxCHECK_RET( node, wxT("invalid index in wxChoice::DoSetItemClientObject") );
 168
 169     wxClientData *cd = (wxClientData*) node->Data();
 170     delete cd;
 171
 172     node->SetData( (wxObject*) clientData );
 173 }
 174
 175 wxClientData* wxChoice::DoGetItemClientObject( int n ) const
 176 {
 177     wxCHECK_MSG( m_widget != NULL, (wxClientData*) NULL, wxT("invalid choice control") );
 178
 179     wxNode *node = m_clientList.Nth( n );
 180     wxCHECK_MSG( node, (wxClientData *)NULL,
 181                  wxT("invalid index in wxChoice::DoGetItemClientObject") );
 182
 183     return (wxClientData*) node->Data();
 184 }
 185
 186 void wxChoice::Clear()
 187 {
 188     wxCHECK_RET( m_widget != NULL, wxT("invalid choice") );
 189
 190     gtk_option_menu_remove_menu( GTK_OPTION_MENU(m_widget) );
 191     GtkWidget *menu = gtk_menu_new();
 192     gtk_option_menu_set_menu( GTK_OPTION_MENU(m_widget), menu );
 193
 194     if ( HasClientObjectData() )
 195     {
 196         // destroy the data (due to Robert's idea of using wxList<wxObject>
 197         // and not wxList<wxClientData> we can't just say
 198         // m_clientList.DeleteContents(TRUE) - this would crash!
 199         wxNode *node = m_clientList.First();
 200         while ( node )
 201         {
 202             delete (wxClientData *)node->Data();
 203             node = node->Next();
 204         }
 205     }
 206     m_clientList.Clear();
 207
 208     if ( m_strings )
 209         m_strings->Clear();
 210 }
 211
 212 void wxChoice::Delete( int WXUNUSED(n) )
 213 {
 214     wxFAIL_MSG( wxT("wxChoice:Delete not implemented") );
 215 }
 216
 217 int wxChoice::FindString( const wxString &string ) const
 218 {
 219     wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid choice") );
 220
 221     // If you read this code once and you think you understand
 222     // it, then you are very wrong. Robert Roebling.
 223
 224     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
 225     int count = 0;
 226     GList *child = menu_shell->children;
 227     while (child)
 228     {
 229         GtkBin *bin = GTK_BIN( child->data );
 230         GtkLabel *label = (GtkLabel *) NULL;
 231         if (bin->child)
 232             label = GTK_LABEL(bin->child);
 233         if (!label)
 234             label = GTK_LABEL( BUTTON_CHILD(m_widget) );
 235
 236         wxASSERT_MSG( label != NULL , wxT("wxChoice: invalid label") );
 237
 238         if (string == wxString(label->label,*wxConvCurrent))
 239             return count;
 240
 241         child = child->next;
 242         count++;
 243     }
 244
 245     return -1;
 246 }
 247
 248 int wxChoice::GetSelection() const
 249 {
 250     wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid choice") );
 251
 252     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
 253     int count = 0;
 254     GList *child = menu_shell->children;
 255     while (child)
 256     {
 257         GtkBin *bin = GTK_BIN( child->data );
 258         if (!bin->child) return count;
 259         child = child->next;
 260         count++;
 261     }
 262
 263     return -1;
 264 }
 265
 266 void wxChoice::SetString( int WXUNUSED(n), const wxString& WXUNUSED(string) )
 267 {
 268     wxCHECK_RET( m_widget != NULL, wxT("invalid choice") );
 269
 270     wxFAIL_MSG(wxT("not implemented"));
 271 }
 272
 273 wxString wxChoice::GetString( int n ) const
 274 {
 275     wxCHECK_MSG( m_widget != NULL, wxT(""), wxT("invalid choice") );
 276
 277     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
 278     int count = 0;
 279     GList *child = menu_shell->children;
 280     while (child)
 281     {
 282         GtkBin *bin = GTK_BIN( child->data );
 283         if (count == n)
 284         {
 285             GtkLabel *label = (GtkLabel *) NULL;
 286             if (bin->child)
 287                 label = GTK_LABEL(bin->child);
 288             if (!label)
 289                 label = GTK_LABEL( BUTTON_CHILD(m_widget) );
 290
 291             wxASSERT_MSG( label != NULL , wxT("wxChoice: invalid label") );
 292
 293             return wxString(label->label,*wxConvCurrent);
 294         }
 295         child = child->next;
 296         count++;
 297     }
 298
 299     wxFAIL_MSG( wxT("wxChoice: invalid index in GetString()") );
 300
 301     return wxT("");
 302 }
 303
 304 int wxChoice::GetCount() const
 305 {
 306     wxCHECK_MSG( m_widget != NULL, 0, wxT("invalid choice") );
 307
 308     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
 309     int count = 0;
 310     GList *child = menu_shell->children;
 311     while (child)
 312     {
 313         count++;
 314         child = child->next;
 315     }
 316     return count;
 317 }
 318
 319 void wxChoice::SetSelection( int n )
 320 {
 321     wxCHECK_RET( m_widget != NULL, wxT("invalid choice") );
 322
 323     int tmp = n;
 324     gtk_option_menu_set_history( GTK_OPTION_MENU(m_widget), (gint)tmp );
 325 }
 326
 327 void wxChoice::ApplyWidgetStyle()
 328 {
 329     SetWidgetStyle();
 330
 331     GtkMenuShell *menu_shell = GTK_MENU_SHELL( gtk_option_menu_get_menu( GTK_OPTION_MENU(m_widget) ) );
 332
 333     gtk_widget_set_style( m_widget, m_widgetStyle );
 334     gtk_widget_set_style( GTK_WIDGET( menu_shell ), m_widgetStyle );
 335
 336     GList *child = menu_shell->children;
 337     while (child)
 338     {
 339         gtk_widget_set_style( GTK_WIDGET( child->data ), m_widgetStyle );
 340
 341         GtkBin *bin = GTK_BIN( child->data );
 342         GtkWidget *label = (GtkWidget *) NULL;
 343         if (bin->child)
 344             label = bin->child;
 345         if (!label)
 346             label = BUTTON_CHILD(m_widget);
 347
 348         gtk_widget_set_style( label, m_widgetStyle );
 349
 350         child = child->next;
 351     }
 352 }
 353
 354 size_t wxChoice::GtkAppendHelper(GtkWidget *menu, const wxString& item)
 355 {
 356     GtkWidget *menu_item = gtk_menu_item_new_with_label( item.mbc_str() );
 357
 358     size_t index;
 359     if ( m_strings )
 360     {
 361         // sorted control, need to insert at the correct index
 362         index = m_strings->Add(item);
 363
 364         gtk_menu_insert( GTK_MENU(menu), menu_item, index );
 365
 366         if ( index )
 367         {
 368             m_clientList.Insert( m_clientList.Item(index - 1),
 369                                  (wxObject*) NULL );
 370         }
 371         else
 372         {
 373             m_clientList.Insert( (wxObject*) NULL );
 374         }
 375     }
 376     else
 377     {
 378         // normal control, just append
 379         gtk_menu_append( GTK_MENU(menu), menu_item );
 380
 381         m_clientList.Append( (wxObject*) NULL );
 382
 383         // don't call wxChoice::GetCount() from here because it doesn't work
 384         // if we're called from ctor (and GtkMenuShell is still NULL)
 385         index = m_clientList.GetCount() - 1;
 386     }
 387
 388     if (GTK_WIDGET_REALIZED(m_widget))
 389     {
 390         gtk_widget_realize( menu_item );
 391         gtk_widget_realize( GTK_BIN(menu_item)->child );
 392
 393         if (m_widgetStyle) ApplyWidgetStyle();
 394     }
 395
 396     gtk_signal_connect( GTK_OBJECT( menu_item ), "activate",
 397       GTK_SIGNAL_FUNC(gtk_choice_clicked_callback), (gpointer*)this );
 398
 399     gtk_widget_show( menu_item );
 400
 401     // return the index of the item in the control
 402     return index;
 403 }
 404
 405 wxSize wxChoice::DoGetBestSize() const
 406 {
 407     wxSize ret( wxControl::DoGetBestSize() );
 408
 409     // we know better our horizontal extent: it depends on the longest string
 410     // we have
 411     ret.x = 0;
 412     if ( m_widget )
 413     {
 414         GdkFont *font = m_font.GetInternalFont();
 415
 416         wxCoord width;
 417         size_t count = GetCount();
 418         for ( size_t n = 0; n < count; n++ )
 419         {
 420             width = (wxCoord)gdk_string_width(font, GetString(n).mbc_str());
 421             if ( width > ret.x )
 422                 ret.x = width;
 423         }
 424
 425         // add extra for the choice "=" button
 426
 427         // VZ: I don't know how to get the right value, it seems to be in
 428         //     GtkOptionMenuProps struct from gtkoptionmenu.c but we can't get
 429         //     to it - maybe we can use gtk_option_menu_size_request() for this
 430         //     somehow?
 431         //
 432         //     This default value works only for the default GTK+ theme (i.e.
 433         //     no theme at all) (FIXME)
 434         static const int widthChoiceIndicator = 35;
 435         ret.x += widthChoiceIndicator;
 436     }
 437
 438     // but not less than the minimal width
 439     if ( ret.x < 80 )
 440         ret.x = 80;
 441
 442     ret.y = 16 + gdk_char_height(GET_STYLE_FONT( m_widget->style ), 'H');
 443
 444     return ret;
 445 }
 446
 447 #endif // wxUSE_CHOICE
 448