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   wxASSERT( id != -1 ); // should find it!
 156
 157   if (!menu->IsEnabled(id)) return;
 158
 159   wxCommandEvent event( wxEVT_COMMAND_MENU_SELECTED, id );
 160   event.SetEventObject( menu );
 161   event.SetInt(id );
 162
 163   if (menu->m_callback)
 164   {
 165      (void) (*(menu->m_callback)) (*menu, event);
 166      return;
 167   }
 168
 169   if (menu->GetEventHandler()->ProcessEvent(event)) return;
 170
 171   wxWindow *win = menu->GetInvokingWindow();
 172   if (win) win->GetEventHandler()->ProcessEvent( event );
 173 }
 174
 175 //-----------------------------------------------------------------------------
 176 // "select"
 177 //-----------------------------------------------------------------------------
 178
 179 static void gtk_menu_hilight_callback( GtkWidget *widget, wxMenu *menu )
 180 {
 181   int id = menu->FindMenuIdByMenuItem(widget);
 182
 183   wxASSERT( id != -1 ); // should find it!
 184
 185   if (!menu->IsEnabled(id)) return;
 186
 187   wxCommandEvent event( wxEVT_MENU_HIGHLIGHT, id );
 188   event.SetEventObject( menu );
 189   event.SetInt(id );
 190
 191 /* wxMSW doesn't call callback here either
 192   if (menu->m_callback)
 193   {
 194      (void) (*(menu->m_callback)) (*menu, event);
 195      return;
 196   }
 197 */
 198
 199   if (menu->GetEventHandler()->ProcessEvent(event)) return;
 200
 201   wxWindow *win = menu->GetInvokingWindow();
 202   if (win) win->GetEventHandler()->ProcessEvent( event );
 203 }
 204
 205 //-----------------------------------------------------------------------------
 206 // wxMenu
 207 //-----------------------------------------------------------------------------
 208
 209 IMPLEMENT_DYNAMIC_CLASS(wxMenuItem,wxObject)
 210
 211 wxMenuItem::wxMenuItem()
 212 {
 213   m_id = ID_SEPARATOR;
 214   m_isCheckMenu = FALSE;
 215   m_isChecked = FALSE;
 216   m_isEnabled = TRUE;
 217   m_subMenu = (wxMenu *) NULL;
 218   m_menuItem = (GtkWidget *) NULL;
 219 }
 220
 221 void wxMenuItem::SetText(const wxString& str)
 222 {
 223   m_text = "";
 224   for ( const char *pc = str; *pc != '\0'; pc++ ) {
 225     if ( *pc == '&' )
 226       pc++; // skip it
 227
 228     m_text << *pc;
 229   }
 230 }
 231
 232 void wxMenuItem::Check( bool check )
 233 {
 234   wxCHECK_RET( IsCheckable(), "Can't check uncheckable item!" )
 235
 236   m_isChecked = check;
 237   gtk_check_menu_item_set_state( (GtkCheckMenuItem*)m_menuItem, (gint)check );
 238 }
 239
 240 void wxMenuItem::Enable( bool enable )
 241 {
 242   gtk_widget_set_sensitive( m_menuItem, enable );
 243   m_isEnabled = enable;
 244 }
 245
 246 bool wxMenuItem::IsChecked() const
 247 {
 248   wxCHECK( IsCheckable(), FALSE ); // can't get state of uncheckable item!
 249
 250   bool bIsChecked = ((GtkCheckMenuItem*)m_menuItem)->active != 0;
 251
 252   wxASSERT( bIsChecked == m_isChecked ); // consistency check
 253
 254   return bIsChecked;
 255 }
 256
 257 IMPLEMENT_DYNAMIC_CLASS(wxMenu,wxEvtHandler)
 258
 259 wxMenu::wxMenu( const wxString& title, const wxFunction func )
 260 {
 261   m_title = title;
 262   m_items.DeleteContents( TRUE );
 263   m_invokingWindow = (wxWindow *) NULL;
 264   m_menu = gtk_menu_new();  // Do not show!
 265
 266   m_callback = func;
 267   m_eventHandler = this;
 268   m_clientData = (void*) NULL;
 269
 270   if (m_title.IsNull()) m_title = "";
 271   if (m_title != "")
 272   {
 273     Append(-2, m_title);
 274     AppendSeparator();
 275   }
 276 }
 277
 278 void wxMenu::SetTitle( const wxString& title )
 279 {
 280   // Waiting for something better.
 281   m_title = title;
 282 }
 283
 284 const wxString wxMenu::GetTitle() const
 285 {
 286   return m_title;
 287 }
 288
 289 void wxMenu::AppendSeparator()
 290 {
 291   wxMenuItem *mitem = new wxMenuItem();
 292   mitem->SetId(ID_SEPARATOR);
 293
 294   GtkWidget *menuItem = gtk_menu_item_new();
 295   gtk_menu_append( GTK_MENU(m_menu), menuItem );
 296   gtk_widget_show( menuItem );
 297   mitem->SetMenuItem(menuItem);
 298   m_items.Append( mitem );
 299 }
 300
 301 void wxMenu::Append( int id, const wxString &item, const wxString &helpStr, bool checkable )
 302 {
 303   wxMenuItem *mitem = new wxMenuItem();
 304   mitem->SetId(id);
 305   mitem->SetText(item);
 306   mitem->SetHelp(helpStr);
 307   mitem->SetCheckable(checkable);
 308   const char *text = mitem->GetText();
 309   GtkWidget *menuItem = checkable ? gtk_check_menu_item_new_with_label(text)
 310                                   : gtk_menu_item_new_with_label(text);
 311
 312   mitem->SetMenuItem(menuItem);
 313
 314   gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
 315                       GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
 316                       (gpointer*)this );
 317
 318   gtk_signal_connect( GTK_OBJECT(menuItem), "select",
 319                       GTK_SIGNAL_FUNC(gtk_menu_hilight_callback),
 320                       (gpointer*)this );
 321
 322   gtk_menu_append( GTK_MENU(m_menu), menuItem );
 323   gtk_widget_show( menuItem );
 324   m_items.Append( mitem );
 325 }
 326
 327 void wxMenu::Append( int id, const wxString &text, wxMenu *subMenu, const wxString &helpStr )
 328 {
 329   wxMenuItem *mitem = new wxMenuItem();
 330   mitem->SetId(id);
 331   mitem->SetText(text);
 332
 333   GtkWidget *menuItem = gtk_menu_item_new_with_label(mitem->GetText());
 334   mitem->SetHelp(helpStr);
 335   mitem->SetMenuItem(menuItem);
 336   mitem->SetSubMenu(subMenu);
 337
 338   gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem), subMenu->m_menu );
 339   gtk_menu_append( GTK_MENU(m_menu), menuItem );
 340   gtk_widget_show( menuItem );
 341   m_items.Append( mitem );
 342 }
 343
 344 int wxMenu::FindItem( const wxString itemString ) const
 345 {
 346   wxString s( itemString );
 347
 348   int pos;
 349   do {
 350     pos = s.First( '&' );
 351     if (pos != -1) s.Remove( pos, 1 );
 352   } while (pos != -1);
 353
 354   wxNode *node = m_items.First();
 355   while (node)
 356   {
 357     wxMenuItem *item = (wxMenuItem*)node->Data();
 358     if (item->GetText() == s)
 359       return item->GetId();
 360     node = node->Next();
 361   }
 362
 363   return -1;
 364 }
 365
 366 void wxMenu::Enable( int id, bool enable )
 367 {
 368   wxMenuItem *item = FindItem(id);
 369   if ( item )
 370     item->Enable(enable);
 371 }
 372
 373 bool wxMenu::IsEnabled( int id ) const
 374 {
 375   wxMenuItem *item = FindItem(id);
 376   if ( item )
 377     return item->IsEnabled();
 378   else
 379     return FALSE;
 380 }
 381
 382 void wxMenu::Check( int id, bool enable )
 383 {
 384   wxMenuItem *item = FindItem(id);
 385   if ( item )
 386     item->Check(enable);
 387 }
 388
 389 bool wxMenu::IsChecked( int id ) const
 390 {
 391   wxMenuItem *item = FindItem(id);
 392   if ( item )
 393     return item->IsChecked();
 394   else
 395     return FALSE;
 396 }
 397
 398 void wxMenu::SetLabel( int id, const wxString &label )
 399 {
 400   wxMenuItem *item = FindItem(id);
 401   if (item)
 402     item->SetText(label);
 403 }
 404
 405 wxString wxMenu::GetLabel( int id ) const
 406 {
 407   wxMenuItem *item = FindItem(id);
 408   if (item) return item->GetText();
 409   return "";
 410 }
 411
 412 void wxMenu::SetHelpString( int id, const wxString& helpString )
 413 {
 414   wxMenuItem *item = FindItem(id);
 415   if (item) item->SetHelp( helpString );
 416 }
 417
 418 wxString wxMenu::GetHelpString( int id ) const
 419 {
 420   wxMenuItem *item = FindItem(id);
 421   if (item) return item->GetHelp();
 422   return "";
 423 }
 424
 425 int wxMenu::FindMenuIdByMenuItem( GtkWidget *menuItem ) const
 426 {
 427   wxNode *node = m_items.First();
 428   while (node)
 429   {
 430     wxMenuItem *item = (wxMenuItem*)node->Data();
 431     if (item->GetMenuItem() == menuItem)
 432       return item->GetId();
 433     node = node->Next();
 434   }
 435
 436   return -1;
 437 }
 438
 439 wxMenuItem *wxMenu::FindItem(int id) const
 440 {
 441   wxNode *node = m_items.First();
 442   while (node) {
 443     wxMenuItem *item = (wxMenuItem*)node->Data();
 444     if ( item->GetId() == id )
 445       return item;
 446     node = node->Next();
 447   }
 448
 449   // Not finding anything here can be correct
 450   // when search the entire menu system for
 451   // an entry -> no error message.
 452
 453   return (wxMenuItem *) NULL;
 454 }
 455
 456 void wxMenu::SetInvokingWindow( wxWindow *win )
 457 {
 458   m_invokingWindow = win;
 459 }
 460
 461 wxWindow *wxMenu::GetInvokingWindow()
 462 {
 463   return m_invokingWindow;
 464 }
 465
 466