src/gtk/menu.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        menu.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifdef __GNUG__
  11 #pragma implementation "menu.h"
  12 #pragma implementation "menuitem.h"
  13 #endif
  14
  15 #include "wx/menu.h"
  16 #include "wx/log.h"
  17 #include "wx/intl.h"
  18
  19 //-----------------------------------------------------------------------------
  20 // wxMenuBar
  21 //-----------------------------------------------------------------------------
  22
  23 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar,wxWindow)
  24
  25 wxMenuBar::wxMenuBar()
  26 {
  27   m_needParent = FALSE; // hmmm
  28
  29   PreCreation( (wxWindow *) NULL, -1, wxDefaultPosition, wxDefaultSize, 0, "menu" );
  30
  31   m_menus.DeleteContents( TRUE );
  32
  33   m_menubar = gtk_menu_bar_new();
  34
  35   m_widget = GTK_WIDGET(m_menubar);
  36
  37   PostCreation();
  38
  39   Show( TRUE );
  40 }
  41
  42 void wxMenuBar::Append( wxMenu *menu, const wxString &title )
  43 {
  44   m_menus.Append( menu );
  45   menu->m_title = title;    // ??????
  46
  47   int pos;
  48   do {
  49     pos = menu->m_title.First( '&' );
  50     if (pos != -1) menu->m_title.Remove( pos, 1 );
  51   } while (pos != -1);
  52
  53   GtkWidget *root_menu;
  54   root_menu = gtk_menu_item_new_with_label( WXSTRINGCAST(menu->m_title) );
  55   gtk_widget_show( root_menu );
  56   gtk_menu_item_set_submenu( GTK_MENU_ITEM(root_menu), menu->m_menu );
  57
  58   gtk_menu_bar_append( GTK_MENU_BAR(m_menubar), root_menu );
  59 }
  60
  61 static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString, const wxString &itemString )
  62 {
  63   if (menu->m_title == menuString)
  64   {
  65     int res = menu->FindItem( itemString );
  66     if (res != -1) return res;
  67   }
  68   wxNode *node = menu->m_items.First();
  69   while (node)
  70   {
  71     wxMenuItem *item = (wxMenuItem*)node->Data();
  72     if (item->IsSubMenu())
  73       return FindMenuItemRecursive(item->GetSubMenu(), menuString, itemString);
  74     node = node->Next();
  75   }
  76   return -1;
  77 }
  78
  79 int wxMenuBar::FindMenuItem( const wxString &menuString, const wxString &itemString ) const
  80 {
  81   wxNode *node = m_menus.First();
  82   while (node)
  83   {
  84     wxMenu *menu = (wxMenu*)node->Data();
  85     int res = FindMenuItemRecursive( menu, menuString, itemString);
  86     if (res != -1) return res;
  87     node = node->Next();
  88   }
  89   return -1;
  90 }
  91
  92 // Find a wxMenuItem using its id. Recurses down into sub-menus
  93 static wxMenuItem* FindMenuItemByIdRecursive(const wxMenu* menu, int id)
  94 {
  95   wxMenuItem* result = menu->FindItem(id);
  96
  97   wxNode *node = menu->m_items.First();
  98   while ( node && result == NULL ) {
  99     wxMenuItem *item = (wxMenuItem*)node->Data();
 100     if ( item->IsSubMenu() )
 101       result = FindMenuItemByIdRecursive( item->GetSubMenu(), id );
 102     node = node->Next();
 103   }
 104
 105   return result;
 106 }
 107
 108 wxMenuItem* wxMenuBar::FindMenuItemById( int id ) const
 109 {
 110   wxMenuItem* result = 0;
 111   wxNode *node = m_menus.First();
 112   while (node && result == 0)
 113   {
 114     wxMenu *menu = (wxMenu*)node->Data();
 115     result = FindMenuItemByIdRecursive( menu, id );
 116     node = node->Next();
 117   }
 118   return result;
 119 }
 120
 121 void wxMenuBar::Check( int id, bool check )
 122 {
 123   wxMenuItem* item = FindMenuItemById( id );
 124   if (item) item->Check(check);
 125 }
 126
 127 bool wxMenuBar::Checked( int id ) const
 128 {
 129   wxMenuItem* item = FindMenuItemById( id );
 130   if (item) return item->IsChecked();
 131   return FALSE;
 132 }
 133
 134 void wxMenuBar::Enable( int id, bool enable )
 135 {
 136   wxMenuItem* item = FindMenuItemById( id );
 137   if (item) item->Enable(enable);
 138 }
 139
 140 bool wxMenuBar::Enabled( int id ) const
 141 {
 142   wxMenuItem* item = FindMenuItemById( id );
 143   if (item) return item->IsEnabled();
 144   return FALSE;
 145 }
 146
 147 //-----------------------------------------------------------------------------
 148 // "activate"
 149 //-----------------------------------------------------------------------------
 150
 151 static void gtk_menu_clicked_callback( GtkWidget *widget, wxMenu *menu )
 152 {
 153   int id = menu->FindMenuIdByMenuItem(widget);
 154
 155   // should find it for normal (not popup) menu
 156   wxASSERT( (id != -1) || (menu->GetInvokingWindow() != NULL) );
 157
 158   if (!menu->IsEnabled(id)) return;
 159
 160   wxCommandEvent event( wxEVT_COMMAND_MENU_SELECTED, id );
 161   event.SetEventObject( menu );
 162   event.SetInt(id );
 163
 164   if (menu->m_callback)
 165   {
 166      (void) (*(menu->m_callback)) (*menu, event);
 167      return;
 168   }
 169
 170   if (menu->GetEventHandler()->ProcessEvent(event)) return;
 171
 172   wxWindow *win = menu->GetInvokingWindow();
 173   if (win) win->GetEventHandler()->ProcessEvent( event );
 174 }
 175
 176 //-----------------------------------------------------------------------------
 177 // "select"
 178 //-----------------------------------------------------------------------------
 179
 180 static void gtk_menu_hilight_callback( GtkWidget *widget, wxMenu *menu )
 181 {
 182   int id = menu->FindMenuIdByMenuItem(widget);
 183
 184   wxASSERT( id != -1 ); // should find it!
 185
 186   if (!menu->IsEnabled(id)) return;
 187
 188   wxCommandEvent event( wxEVT_MENU_HIGHLIGHT, id );
 189   event.SetEventObject( menu );
 190   event.SetInt(id );
 191
 192 /* wxMSW doesn't call callback here either
 193   if (menu->m_callback)
 194   {
 195      (void) (*(menu->m_callback)) (*menu, event);
 196      return;
 197   }
 198 */
 199
 200   if (menu->GetEventHandler()->ProcessEvent(event)) return;
 201
 202   wxWindow *win = menu->GetInvokingWindow();
 203   if (win) win->GetEventHandler()->ProcessEvent( event );
 204 }
 205
 206 //-----------------------------------------------------------------------------
 207 // wxMenuItem
 208 //-----------------------------------------------------------------------------
 209
 210 IMPLEMENT_DYNAMIC_CLASS(wxMenuItem,wxObject)
 211
 212 wxMenuItem::wxMenuItem()
 213 {
 214   m_id = ID_SEPARATOR;
 215   m_isCheckMenu = FALSE;
 216   m_isChecked = FALSE;
 217   m_isEnabled = TRUE;
 218   m_subMenu = (wxMenu *) NULL;
 219   m_menuItem = (GtkWidget *) NULL;
 220 }
 221
 222 // it's valid for this function to be called even if m_menuItem == NULL
 223 void wxMenuItem::SetName(const wxString& str)
 224 {
 225   m_text = "";
 226   for ( const char *pc = str; *pc != '\0'; pc++ )
 227   {
 228     if ( *pc == '&' )
 229       pc++; // skip it
 230
 231     m_text << *pc;
 232   }
 233
 234   if ( m_menuItem )
 235   {
 236     GtkLabel *label = GTK_LABEL( GTK_BIN(m_menuItem)->child );
 237
 238     gtk_label_set( label, m_text.c_str());
 239   }
 240 }
 241
 242 void wxMenuItem::Check( bool check )
 243 {
 244   wxCHECK_RET( m_menuItem, "invalid menu item" );
 245
 246   wxCHECK_RET( IsCheckable(), "Can't check uncheckable item!" )
 247
 248   m_isChecked = check;
 249   gtk_check_menu_item_set_state( (GtkCheckMenuItem*)m_menuItem, (gint)check );
 250 }
 251
 252 void wxMenuItem::Enable( bool enable )
 253 {
 254   wxCHECK_RET( m_menuItem, "invalid menu item" );
 255
 256   gtk_widget_set_sensitive( m_menuItem, enable );
 257   m_isEnabled = enable;
 258 }
 259
 260 bool wxMenuItem::IsChecked() const
 261 {
 262   wxCHECK_MSG( m_menuItem, FALSE, "invalid menu item" );
 263
 264   wxCHECK( IsCheckable(), FALSE ); // can't get state of uncheckable item!
 265
 266   bool bIsChecked = ((GtkCheckMenuItem*)m_menuItem)->active != 0;
 267
 268   wxASSERT( bIsChecked == m_isChecked ); // consistency check
 269
 270   return bIsChecked;
 271 }
 272
 273 //-----------------------------------------------------------------------------
 274 // wxMenuItem
 275 //-----------------------------------------------------------------------------
 276
 277 IMPLEMENT_DYNAMIC_CLASS(wxMenu,wxEvtHandler)
 278
 279 wxMenu::wxMenu( const wxString& title, const wxFunction func )
 280 {
 281   m_title = title;
 282   m_items.DeleteContents( TRUE );
 283   m_invokingWindow = (wxWindow *) NULL;
 284   m_menu = gtk_menu_new();  // Do not show!
 285
 286   m_callback = func;
 287   m_eventHandler = this;
 288   m_clientData = (void*) NULL;
 289
 290   if (m_title.IsNull()) m_title = "";
 291   if (m_title != "")
 292   {
 293     Append(-2, m_title);
 294     AppendSeparator();
 295   }
 296 }
 297
 298 void wxMenu::SetTitle( const wxString& title )
 299 {
 300   // Waiting for something better.
 301   m_title = title;
 302 }
 303
 304 const wxString wxMenu::GetTitle() const
 305 {
 306   return m_title;
 307 }
 308
 309 void wxMenu::AppendSeparator()
 310 {
 311   wxMenuItem *mitem = new wxMenuItem();
 312   mitem->SetId(ID_SEPARATOR);
 313
 314   GtkWidget *menuItem = gtk_menu_item_new();
 315   gtk_menu_append( GTK_MENU(m_menu), menuItem );
 316   gtk_widget_show( menuItem );
 317   mitem->SetMenuItem(menuItem);
 318   m_items.Append( mitem );
 319 }
 320
 321 void wxMenu::Append( int id, const wxString &item, const wxString &helpStr, bool checkable )
 322 {
 323   wxMenuItem *mitem = new wxMenuItem();
 324   mitem->SetId(id);
 325   mitem->SetText(item);
 326   mitem->SetHelp(helpStr);
 327   mitem->SetCheckable(checkable);
 328   const char *text = mitem->GetText();
 329   GtkWidget *menuItem = checkable ? gtk_check_menu_item_new_with_label(text)
 330                                   : gtk_menu_item_new_with_label(text);
 331
 332   mitem->SetMenuItem(menuItem);
 333
 334   gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
 335                       GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
 336                       (gpointer*)this );
 337
 338   gtk_signal_connect( GTK_OBJECT(menuItem), "select",
 339                       GTK_SIGNAL_FUNC(gtk_menu_hilight_callback),
 340                       (gpointer*)this );
 341
 342   gtk_menu_append( GTK_MENU(m_menu), menuItem );
 343   gtk_widget_show( menuItem );
 344   m_items.Append( mitem );
 345 }
 346
 347 void wxMenu::Append( int id, const wxString &text, wxMenu *subMenu, const wxString &helpStr )
 348 {
 349   wxMenuItem *mitem = new wxMenuItem();
 350   mitem->SetId(id);
 351   mitem->SetText(text);
 352
 353   GtkWidget *menuItem = gtk_menu_item_new_with_label(mitem->GetText());
 354   mitem->SetHelp(helpStr);
 355   mitem->SetMenuItem(menuItem);
 356   mitem->SetSubMenu(subMenu);
 357
 358   gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem), subMenu->m_menu );
 359   gtk_menu_append( GTK_MENU(m_menu), menuItem );
 360   gtk_widget_show( menuItem );
 361   m_items.Append( mitem );
 362 }
 363
 364 int wxMenu::FindItem( const wxString itemString ) const
 365 {
 366   wxString s( itemString );
 367
 368   int pos;
 369   do {
 370     pos = s.First( '&' );
 371     if (pos != -1) s.Remove( pos, 1 );
 372   } while (pos != -1);
 373
 374   wxNode *node = m_items.First();
 375   while (node)
 376   {
 377     wxMenuItem *item = (wxMenuItem*)node->Data();
 378     if (item->GetText() == s)
 379       return item->GetId();
 380     node = node->Next();
 381   }
 382
 383   return -1;
 384 }
 385
 386 void wxMenu::Enable( int id, bool enable )
 387 {
 388   wxMenuItem *item = FindItem(id);
 389   if ( item )
 390     item->Enable(enable);
 391 }
 392
 393 bool wxMenu::IsEnabled( int id ) const
 394 {
 395   wxMenuItem *item = FindItem(id);
 396   if ( item )
 397     return item->IsEnabled();
 398   else
 399     return FALSE;
 400 }
 401
 402 void wxMenu::Check( int id, bool enable )
 403 {
 404   wxMenuItem *item = FindItem(id);
 405   if ( item )
 406     item->Check(enable);
 407 }
 408
 409 bool wxMenu::IsChecked( int id ) const
 410 {
 411   wxMenuItem *item = FindItem(id);
 412   if ( item )
 413     return item->IsChecked();
 414   else
 415     return FALSE;
 416 }
 417
 418 void wxMenu::SetLabel( int id, const wxString &label )
 419 {
 420   wxMenuItem *item = FindItem(id);
 421   if (item)
 422     item->SetText(label);
 423 }
 424
 425 wxString wxMenu::GetLabel( int id ) const
 426 {
 427   wxMenuItem *item = FindItem(id);
 428   if (item) return item->GetText();
 429   return "";
 430 }
 431
 432 void wxMenu::SetHelpString( int id, const wxString& helpString )
 433 {
 434   wxMenuItem *item = FindItem(id);
 435   if (item) item->SetHelp( helpString );
 436 }
 437
 438 wxString wxMenu::GetHelpString( int id ) const
 439 {
 440   wxMenuItem *item = FindItem(id);
 441   if (item) return item->GetHelp();
 442   return "";
 443 }
 444
 445 int wxMenu::FindMenuIdByMenuItem( GtkWidget *menuItem ) const
 446 {
 447   wxNode *node = m_items.First();
 448   while (node)
 449   {
 450     wxMenuItem *item = (wxMenuItem*)node->Data();
 451     if (item->GetMenuItem() == menuItem)
 452       return item->GetId();
 453     node = node->Next();
 454   }
 455
 456   return -1;
 457 }
 458
 459 wxMenuItem *wxMenu::FindItem(int id) const
 460 {
 461   wxNode *node = m_items.First();
 462   while (node) {
 463     wxMenuItem *item = (wxMenuItem*)node->Data();
 464     if ( item->GetId() == id )
 465       return item;
 466     node = node->Next();
 467   }
 468
 469   // Not finding anything here can be correct
 470   // when search the entire menu system for
 471   // an entry -> no error message.
 472
 473   return (wxMenuItem *) NULL;
 474 }
 475
 476 void wxMenu::SetInvokingWindow( wxWindow *win )
 477 {
 478   m_invokingWindow = win;
 479 }
 480
 481 wxWindow *wxMenu::GetInvokingWindow()
 482 {
 483   return m_invokingWindow;
 484 }
 485
 486