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 // wxMenuItem
 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 // it's valid for this function to be called even if m_menuItem == NULL
 222 void wxMenuItem::SetName(const wxString& str)
 223 {
 224   m_text = "";
 225   for ( const char *pc = str; *pc != '\0'; pc++ )
 226   {
 227     if ( *pc == '&' )
 228       pc++; // skip it
 229
 230     m_text << *pc;
 231   }
 232
 233   if ( m_menuItem )
 234   {
 235     GtkLabel *label = GTK_LABEL( GTK_BIN(m_menuItem)->child );
 236
 237     gtk_label_set( label, m_text.c_str());
 238   }
 239 }
 240
 241 void wxMenuItem::Check( bool check )
 242 {
 243   wxCHECK_RET( m_menuItem, "invalid menu item" );
 244
 245   wxCHECK_RET( IsCheckable(), "Can't check uncheckable item!" )
 246
 247   m_isChecked = check;
 248   gtk_check_menu_item_set_state( (GtkCheckMenuItem*)m_menuItem, (gint)check );
 249 }
 250
 251 void wxMenuItem::Enable( bool enable )
 252 {
 253   wxCHECK_RET( m_menuItem, "invalid menu item" );
 254
 255   gtk_widget_set_sensitive( m_menuItem, enable );
 256   m_isEnabled = enable;
 257 }
 258
 259 bool wxMenuItem::IsChecked() const
 260 {
 261   wxCHECK_MSG( m_menuItem, FALSE, "invalid menu item" );
 262
 263   wxCHECK( IsCheckable(), FALSE ); // can't get state of uncheckable item!
 264
 265   bool bIsChecked = ((GtkCheckMenuItem*)m_menuItem)->active != 0;
 266
 267   wxASSERT( bIsChecked == m_isChecked ); // consistency check
 268
 269   return bIsChecked;
 270 }
 271
 272 //-----------------------------------------------------------------------------
 273 // wxMenuItem
 274 //-----------------------------------------------------------------------------
 275
 276 IMPLEMENT_DYNAMIC_CLASS(wxMenu,wxEvtHandler)
 277
 278 wxMenu::wxMenu( const wxString& title, const wxFunction func )
 279 {
 280   m_title = title;
 281   m_items.DeleteContents( TRUE );
 282   m_invokingWindow = (wxWindow *) NULL;
 283   m_menu = gtk_menu_new();  // Do not show!
 284
 285   m_callback = func;
 286   m_eventHandler = this;
 287   m_clientData = (void*) NULL;
 288
 289   if (m_title.IsNull()) m_title = "";
 290   if (m_title != "")
 291   {
 292     Append(-2, m_title);
 293     AppendSeparator();
 294   }
 295 }
 296
 297 void wxMenu::SetTitle( const wxString& title )
 298 {
 299   // Waiting for something better.
 300   m_title = title;
 301 }
 302
 303 const wxString wxMenu::GetTitle() const
 304 {
 305   return m_title;
 306 }
 307
 308 void wxMenu::AppendSeparator()
 309 {
 310   wxMenuItem *mitem = new wxMenuItem();
 311   mitem->SetId(ID_SEPARATOR);
 312
 313   GtkWidget *menuItem = gtk_menu_item_new();
 314   gtk_menu_append( GTK_MENU(m_menu), menuItem );
 315   gtk_widget_show( menuItem );
 316   mitem->SetMenuItem(menuItem);
 317   m_items.Append( mitem );
 318 }
 319
 320 void wxMenu::Append( int id, const wxString &item, const wxString &helpStr, bool checkable )
 321 {
 322   wxMenuItem *mitem = new wxMenuItem();
 323   mitem->SetId(id);
 324   mitem->SetText(item);
 325   mitem->SetHelp(helpStr);
 326   mitem->SetCheckable(checkable);
 327   const char *text = mitem->GetText();
 328   GtkWidget *menuItem = checkable ? gtk_check_menu_item_new_with_label(text)
 329                                   : gtk_menu_item_new_with_label(text);
 330
 331   mitem->SetMenuItem(menuItem);
 332
 333   gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
 334                       GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
 335                       (gpointer*)this );
 336
 337   gtk_signal_connect( GTK_OBJECT(menuItem), "select",
 338                       GTK_SIGNAL_FUNC(gtk_menu_hilight_callback),
 339                       (gpointer*)this );
 340
 341   gtk_menu_append( GTK_MENU(m_menu), menuItem );
 342   gtk_widget_show( menuItem );
 343   m_items.Append( mitem );
 344 }
 345
 346 void wxMenu::Append( int id, const wxString &text, wxMenu *subMenu, const wxString &helpStr )
 347 {
 348   wxMenuItem *mitem = new wxMenuItem();
 349   mitem->SetId(id);
 350   mitem->SetText(text);
 351
 352   GtkWidget *menuItem = gtk_menu_item_new_with_label(mitem->GetText());
 353   mitem->SetHelp(helpStr);
 354   mitem->SetMenuItem(menuItem);
 355   mitem->SetSubMenu(subMenu);
 356
 357   gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem), subMenu->m_menu );
 358   gtk_menu_append( GTK_MENU(m_menu), menuItem );
 359   gtk_widget_show( menuItem );
 360   m_items.Append( mitem );
 361 }
 362
 363 int wxMenu::FindItem( const wxString itemString ) const
 364 {
 365   wxString s( itemString );
 366
 367   int pos;
 368   do {
 369     pos = s.First( '&' );
 370     if (pos != -1) s.Remove( pos, 1 );
 371   } while (pos != -1);
 372
 373   wxNode *node = m_items.First();
 374   while (node)
 375   {
 376     wxMenuItem *item = (wxMenuItem*)node->Data();
 377     if (item->GetText() == s)
 378       return item->GetId();
 379     node = node->Next();
 380   }
 381
 382   return -1;
 383 }
 384
 385 void wxMenu::Enable( int id, bool enable )
 386 {
 387   wxMenuItem *item = FindItem(id);
 388   if ( item )
 389     item->Enable(enable);
 390 }
 391
 392 bool wxMenu::IsEnabled( int id ) const
 393 {
 394   wxMenuItem *item = FindItem(id);
 395   if ( item )
 396     return item->IsEnabled();
 397   else
 398     return FALSE;
 399 }
 400
 401 void wxMenu::Check( int id, bool enable )
 402 {
 403   wxMenuItem *item = FindItem(id);
 404   if ( item )
 405     item->Check(enable);
 406 }
 407
 408 bool wxMenu::IsChecked( int id ) const
 409 {
 410   wxMenuItem *item = FindItem(id);
 411   if ( item )
 412     return item->IsChecked();
 413   else
 414     return FALSE;
 415 }
 416
 417 void wxMenu::SetLabel( int id, const wxString &label )
 418 {
 419   wxMenuItem *item = FindItem(id);
 420   if (item)
 421     item->SetText(label);
 422 }
 423
 424 wxString wxMenu::GetLabel( int id ) const
 425 {
 426   wxMenuItem *item = FindItem(id);
 427   if (item) return item->GetText();
 428   return "";
 429 }
 430
 431 void wxMenu::SetHelpString( int id, const wxString& helpString )
 432 {
 433   wxMenuItem *item = FindItem(id);
 434   if (item) item->SetHelp( helpString );
 435 }
 436
 437 wxString wxMenu::GetHelpString( int id ) const
 438 {
 439   wxMenuItem *item = FindItem(id);
 440   if (item) return item->GetHelp();
 441   return "";
 442 }
 443
 444 int wxMenu::FindMenuIdByMenuItem( GtkWidget *menuItem ) const
 445 {
 446   wxNode *node = m_items.First();
 447   while (node)
 448   {
 449     wxMenuItem *item = (wxMenuItem*)node->Data();
 450     if (item->GetMenuItem() == menuItem)
 451       return item->GetId();
 452     node = node->Next();
 453   }
 454
 455   return -1;
 456 }
 457
 458 wxMenuItem *wxMenu::FindItem(int id) const
 459 {
 460   wxNode *node = m_items.First();
 461   while (node) {
 462     wxMenuItem *item = (wxMenuItem*)node->Data();
 463     if ( item->GetId() == id )
 464       return item;
 465     node = node->Next();
 466   }
 467
 468   // Not finding anything here can be correct
 469   // when search the entire menu system for
 470   // an entry -> no error message.
 471
 472   return (wxMenuItem *) NULL;
 473 }
 474
 475 void wxMenu::SetInvokingWindow( wxWindow *win )
 476 {
 477   m_invokingWindow = win;
 478 }
 479
 480 wxWindow *wxMenu::GetInvokingWindow()
 481 {
 482   return m_invokingWindow;
 483 }
 484
 485