src/gtk/menu.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        menu.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Created:     01/02/97
   6 // Id:          $Id$
   7 // Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11
  12 #ifdef __GNUG__
  13 #pragma implementation "menu.h"
  14 #endif
  15
  16 #include "wx/menu.h"
  17 #include "wx/log.h"
  18 #include "wx/intl.h"
  19
  20 //-----------------------------------------------------------------------------
  21 // wxMenuBar
  22 //-----------------------------------------------------------------------------
  23
  24 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar,wxWindow)
  25
  26 wxMenuBar::wxMenuBar()
  27 {
  28   m_needParent = FALSE; // hmmm
  29
  30   PreCreation( (wxWindow *) NULL, -1, wxDefaultPosition, wxDefaultSize, 0, "menu" );
  31
  32   m_menus.DeleteContents( TRUE );
  33
  34   m_widget = gtk_handle_box_new();
  35
  36   m_menubar = gtk_menu_bar_new();
  37
  38   gtk_container_add( GTK_CONTAINER(m_widget), m_menubar );
  39
  40   gtk_widget_show( m_menubar );
  41
  42   PostCreation();
  43
  44   Show( TRUE );
  45 }
  46
  47 void wxMenuBar::Append( wxMenu *menu, const wxString &title )
  48 {
  49   m_menus.Append( menu );
  50   menu->m_title = title;    // ??????
  51
  52   int pos;
  53   do {
  54     pos = menu->m_title.First( '&' );
  55     if (pos != -1) menu->m_title.Remove( pos, 1 );
  56   } while (pos != -1);
  57
  58   GtkWidget *root_menu;
  59   root_menu = gtk_menu_item_new_with_label( WXSTRINGCAST(menu->m_title) );
  60   gtk_widget_show( root_menu );
  61   gtk_menu_item_set_submenu( GTK_MENU_ITEM(root_menu), menu->m_menu );
  62
  63   gtk_menu_bar_append( GTK_MENU_BAR(m_menubar), root_menu );
  64 }
  65
  66 static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString, const wxString &itemString )
  67 {
  68   if (menu->m_title == menuString)
  69   {
  70     int res = menu->FindItem( itemString );
  71     if (res != -1) return res;
  72   }
  73   wxNode *node = menu->m_items.First();
  74   while (node)
  75   {
  76     wxMenuItem *item = (wxMenuItem*)node->Data();
  77     if (item->IsSubMenu())
  78       return FindMenuItemRecursive(item->GetSubMenu(), menuString, itemString);
  79     node = node->Next();
  80   }
  81   return -1;
  82 }
  83
  84 int wxMenuBar::FindMenuItem( const wxString &menuString, const wxString &itemString ) const
  85 {
  86   wxNode *node = m_menus.First();
  87   while (node)
  88   {
  89     wxMenu *menu = (wxMenu*)node->Data();
  90     int res = FindMenuItemRecursive( menu, menuString, itemString);
  91     if (res != -1) return res;
  92     node = node->Next();
  93   }
  94   return -1;
  95 }
  96
  97 // Find a wxMenuItem using its id. Recurses down into sub-menus
  98 static wxMenuItem* FindMenuItemByIdRecursive(const wxMenu* menu, int id)
  99 {
 100   wxMenuItem* result = menu->FindItem(id);
 101
 102   wxNode *node = menu->m_items.First();
 103   while ( node && result == NULL ) {
 104     wxMenuItem *item = (wxMenuItem*)node->Data();
 105     if ( item->IsSubMenu() )
 106       result = FindMenuItemByIdRecursive( item->GetSubMenu(), id );
 107     node = node->Next();
 108   }
 109
 110   return result;
 111 }
 112
 113 wxMenuItem* wxMenuBar::FindMenuItemById( int id ) const
 114 {
 115   wxMenuItem* result = 0;
 116   wxNode *node = m_menus.First();
 117   while (node && result == 0)
 118   {
 119     wxMenu *menu = (wxMenu*)node->Data();
 120     result = FindMenuItemByIdRecursive( menu, id );
 121     node = node->Next();
 122   }
 123   return result;
 124 }
 125
 126 void wxMenuBar::Check( int id, bool check )
 127 {
 128   wxMenuItem* item = FindMenuItemById( id );
 129   if (item) item->Check(check);
 130 }
 131
 132 bool wxMenuBar::Checked( int id ) const
 133 {
 134   wxMenuItem* item = FindMenuItemById( id );
 135   if (item) return item->IsChecked();
 136   return FALSE;
 137 }
 138
 139 void wxMenuBar::Enable( int id, bool enable )
 140 {
 141   wxMenuItem* item = FindMenuItemById( id );
 142   if (item) item->Enable(enable);
 143 }
 144
 145 bool wxMenuBar::Enabled( int id ) const
 146 {
 147   wxMenuItem* item = FindMenuItemById( id );
 148   if (item) return item->IsEnabled();
 149   return FALSE;
 150 }
 151
 152 //-----------------------------------------------------------------------------
 153 // "activate"
 154 //-----------------------------------------------------------------------------
 155
 156 static void gtk_menu_clicked_callback( GtkWidget *widget, wxMenu *menu )
 157 {
 158   int id = menu->FindMenuIdByMenuItem(widget);
 159
 160   wxASSERT( id != -1 ); // should find it!
 161
 162   if (!menu->IsEnabled(id)) return;
 163
 164   wxCommandEvent event( wxEVT_COMMAND_MENU_SELECTED, id );
 165   event.SetEventObject( menu );
 166   event.SetInt(id );
 167
 168   if (menu->m_callback)
 169   {
 170      (void) (*(menu->m_callback)) (*menu, event);
 171      return;
 172   }
 173
 174   if (menu->GetEventHandler()->ProcessEvent(event)) return;
 175
 176   wxWindow *win = menu->GetInvokingWindow();
 177   if (win) win->GetEventHandler()->ProcessEvent( event );
 178 }
 179
 180 //-----------------------------------------------------------------------------
 181 // "select"
 182 //-----------------------------------------------------------------------------
 183
 184 static void gtk_menu_hilight_callback( GtkWidget *widget, wxMenu *menu )
 185 {
 186   int id = menu->FindMenuIdByMenuItem(widget);
 187
 188   wxASSERT( id != -1 ); // should find it!
 189
 190   if (!menu->IsEnabled(id)) return;
 191
 192   wxCommandEvent event( wxEVT_MENU_HIGHLIGHT, id );
 193   event.SetEventObject( menu );
 194   event.SetInt(id );
 195
 196   if (menu->m_callback)
 197   {
 198      (void) (*(menu->m_callback)) (*menu, event);
 199      return;
 200   }
 201
 202   if (menu->GetEventHandler()->ProcessEvent(event)) return;
 203
 204   wxWindow *win = menu->GetInvokingWindow();
 205   if (win) win->GetEventHandler()->ProcessEvent( event );
 206 }
 207
 208 //-----------------------------------------------------------------------------
 209 // wxMenu
 210 //-----------------------------------------------------------------------------
 211
 212 IMPLEMENT_DYNAMIC_CLASS(wxMenuItem,wxObject)
 213
 214 wxMenuItem::wxMenuItem()
 215 {
 216   m_id = ID_SEPARATOR;
 217   m_isCheckMenu = FALSE;
 218   m_isChecked = FALSE;
 219   m_isEnabled = TRUE;
 220   m_subMenu = (wxMenu *) NULL;
 221   m_menuItem = (GtkWidget *) NULL;
 222 }
 223
 224 void wxMenuItem::SetText(const wxString& str)
 225 {
 226   m_text = "";
 227   for ( const char *pc = str; *pc != '\0'; pc++ ) {
 228     if ( *pc == '&' )
 229       pc++; // skip it
 230
 231     m_text << *pc;
 232   }
 233 }
 234
 235 void wxMenuItem::Check( bool check )
 236 {
 237   wxCHECK_RET( IsCheckable(), "Can't check uncheckable item!" )
 238
 239   m_isChecked = check;
 240   gtk_check_menu_item_set_state( (GtkCheckMenuItem*)m_menuItem, (gint)check );
 241 }
 242
 243 void wxMenuItem::Enable( bool enable )
 244 {
 245   gtk_widget_set_sensitive( m_menuItem, enable );
 246   m_isEnabled = enable;
 247 }
 248
 249 bool wxMenuItem::IsChecked() const
 250 {
 251   wxCHECK( IsCheckable(), FALSE ); // can't get state of uncheckable item!
 252
 253   bool bIsChecked = ((GtkCheckMenuItem*)m_menuItem)->active != 0;
 254
 255   wxASSERT( bIsChecked == m_isChecked ); // consistency check
 256
 257   return bIsChecked;
 258 }
 259
 260 IMPLEMENT_DYNAMIC_CLASS(wxMenu,wxEvtHandler)
 261
 262 wxMenu::wxMenu( const wxString& title, const wxFunction func )
 263 {
 264   m_title = title;
 265   m_items.DeleteContents( TRUE );
 266   m_invokingWindow = (wxWindow *) NULL;
 267   m_menu = gtk_menu_new();  // Do not show!
 268   m_callback = func;
 269   m_eventHandler = this;
 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   wxLogDebug( "wxMenu::FindItem: item %d not found.", id);
 450
 451   return (wxMenuItem *) NULL;
 452 }
 453
 454 void wxMenu::SetInvokingWindow( wxWindow *win )
 455 {
 456   m_invokingWindow = win;
 457 }
 458
 459 wxWindow *wxMenu::GetInvokingWindow()
 460 {
 461   return m_invokingWindow;
 462 }
 463
 464