improve MainMenu

tools/gui/UnitEditor/UnitEditor/MainMenu.cs

@@ -1,37 +1,161 @@
 using System;
 using Gtk;
+using System.Xml;
+using System.Xml.Linq;
+using System.Collections.Generic;
 
 namespace UnitEditor
 {
 	[System.ComponentModel.ToolboxItem (true)]
-	public partial class MainMenu : Gtk.EventBox
+	public partial class MainMenu : Gtk.Bin
 	{
-		public MenuBar instance;
+		public Gtk.UIManager uim = null;
+		public Gtk.MenuBar instance;
+		/*
+         The first required piece is the XML definition.
 
-		public MainMenu ()
+         The following is a hard-coded definition of a Gtk.MenuBar control (widget).
+         However, automation can come into play here by constructing the inner-XElements and building out.
+         Consider using a string formatting function to take a name in a list like "Zoom In", using that as-is
+         for the name of the Gtk.MenuItem, and using it again (after removing spaces) for the action name.
+     	*/
+		private XDocument UI = new XDocument (
+			new XElement ("ui",
+				new XElement ("menubar",
+					new XElement ("menu", new XAttribute ("action", "FileMenu"),
+						new XElement ("menuitem", new XAttribute ("action", "New")),
+						new XElement ("menuitem", new XAttribute ("action", "Open")),
+						new XElement ("separator"),
+						new XElement ("menuitem", new XAttribute ("action", "Save")),
+						new XElement ("menuitem", new XAttribute ("action", "SaveAs")),
+						new XElement ("menuitem", new XAttribute ("action", "SaveAll")),
+						new XElement ("separator"),
+						new XElement ("menuitem", new XAttribute ("action", "Close")),
+						new XElement ("menuitem", new XAttribute ("action", "CloseAll")),
+						new XElement ("menuitem", new XAttribute ("action", "Quit"))
+					),
+					new XElement ("menu", new XAttribute ("action", "EditMenu"),
+						new XElement ("menuitem", new XAttribute ("action", "Undo")),
+						new XElement ("menuitem", new XAttribute ("action", "Redo")),
+						new XElement ("separator"),
+						new XElement ("menuitem", new XAttribute ("action", "Cut")),
+						new XElement ("menuitem", new XAttribute ("action", "Copy")),
+						new XElement ("menuitem", new XAttribute ("action", "Paste")),
+						new XElement ("menuitem", new XAttribute ("action", "Delete")),
+						new XElement ("separator"),
+						new XElement ("menuitem", new XAttribute ("action", "SelectAll"))
+					),
+					new XElement ("menu", new XAttribute ("action", "ViewMenu"),
+						new XElement ("menuitem", new XAttribute ("action", "ZoomIn")),
+						new XElement ("menuitem", new XAttribute ("action", "ZoomOut")),
+						new XElement ("separator"),
+						new XElement ("menuitem", new XAttribute ("action", "Fullscreen"))
+					),
+					new XElement ("menu", new XAttribute ("action", "SearchMenu"),
+						new XElement ("menuitem", new XAttribute ("action", "Find")),
+						new XElement ("menuitem", new XAttribute ("action", "Replace")),
+						new XElement ("separator"),
+						new XElement ("menuitem", new XAttribute ("action", "GoToLine"))
+					)
+				)
+			)
+		);
+
+		private Dictionary<string, string> keys = new Dictionary<string, string> () {
+			{"New", "<Control>n"},
+			{"Open", "<Control>o"},
+			{"Save", "<Control>s"},
+			{"SaveAs", "<Control><Alt>s"},
+			{"SaveAll", "<Control><Shift>s"},
+			{"Close", "<Control>w"},
+			{"CloseAll", "<Control><Shift>w"},
+			{"Quit", "<Alt>F4"},
+
+			{"Undo", "<Control>z"},
+			{"Redo", "<Control>y"},
+			{"Cut", "<Control>x"},
+			{"Copy", "<Control>c"},
+			{"Paste", "<Control>v"},
+			{"SelectAll", "<Control>a"},
+
+			{"ZoomIn", "<Control>KP_Add"},
+			{"ZoomOut", "<Control>KP_Subtract"},
+			{"Fullscreen", "F11"},
+
+			{"Find", "<Control>f"},
+			{"Replace", "<Control>h"},
+			{"GoToLine", "<Control>g"}
+		};
+
+		public Gtk.ActionEntry[] getActionEntries ()
 		{
-			instance = new MenuBar ();
+			return new Gtk.ActionEntry[] {
+				new Gtk.ActionEntry ("FileMenu", null, "_File", null, null, null),
+				new Gtk.ActionEntry ("New", null, "New", (keys.ContainsKey ("New")) ? keys ["New"] : null, null, null),
+				new Gtk.ActionEntry ("Open", null, "Open...", (keys.ContainsKey ("Open")) ? keys ["Open"] : null, null, (EventHandler)open_cb),
+				new Gtk.ActionEntry ("Save", null, "Save", (keys.ContainsKey ("Save")) ? keys ["Save"] : null, null, null),
+				new Gtk.ActionEntry ("SaveAs", null, "Save As...", (keys.ContainsKey ("SaveAs")) ? keys ["SaveAs"] : null, null, null),
+				new Gtk.ActionEntry ("SaveAll", null, "Save All", (keys.ContainsKey ("SaveAll")) ? keys ["SaveAll"] : null, null, null),
+				new Gtk.ActionEntry ("Close", null, "Close", (keys.ContainsKey ("Close")) ? keys ["Close"] : null, null, null),
+				new Gtk.ActionEntry ("CloseAll", null, "Close All", (keys.ContainsKey ("CloseAll")) ? keys ["CloseAll"] : null, null, null),
+				new Gtk.ActionEntry ("Quit", null, "Quit", (keys.ContainsKey ("Quit")) ? keys ["Quit"] : null, null, null),
 
-			Menu file_menu = new Menu ();
+				new Gtk.ActionEntry ("EditMenu", null, "_Edit", null, null, null),
+				new Gtk.ActionEntry ("Undo", null, "Undo", (keys.ContainsKey ("Undo")) ? keys ["Undo"] : null, null, null),
+				new Gtk.ActionEntry ("Redo", null, "Redo", (keys.ContainsKey ("Redo")) ? keys ["Redo"] : null, null, null),
+				new Gtk.ActionEntry ("Cut", null, "Cut", (keys.ContainsKey ("Cut")) ? keys ["Cut"] : null, null, null),
+				new Gtk.ActionEntry ("Copy", null, "Copy", (keys.ContainsKey ("Copy")) ? keys ["Copy"] : null, null, null),
+				new Gtk.ActionEntry ("Paste", null, "Paste", (keys.ContainsKey ("Paste")) ? keys ["Paste"] : null, null, null),
+				new Gtk.ActionEntry ("Delete", null, "Delete", (keys.ContainsKey ("Delete")) ? keys ["Delete"] : null, null, null),
+				new Gtk.ActionEntry ("SelectAll", null, "Select All", (keys.ContainsKey ("SelectAll")) ? keys ["SelectAll"] : null, null, null),
 
-			MenuItem file_item = new MenuItem("File");
-			file_item.Submenu = file_menu;
+				new Gtk.ActionEntry ("ViewMenu", null, "_View", null, null, null),
+				new Gtk.ActionEntry ("ZoomIn", null, "Zoom In", (keys.ContainsKey ("ZoomIn")) ? keys ["ZoomIn"] : null, null, null),
+				new Gtk.ActionEntry ("ZoomOut", null, "Zoom Out", (keys.ContainsKey ("ZoomOut")) ? keys ["ZoomOut"] : null, null, null),
+				new Gtk.ActionEntry ("Fullscreen", null, "Fullscreen", (keys.ContainsKey ("Fullscreen")) ? keys ["Fullscreen"] : null, null, null),
 
-			MenuItem exit_item = new MenuItem("Exit");
-			exit_item.Activated += new EventHandler (file_chooser_cb);
-			file_menu.Append (exit_item);
+				new Gtk.ActionEntry ("SearchMenu", null, "_Search", null, null, null),
+				new Gtk.ActionEntry ("Find", null, "Find...", (keys.ContainsKey ("Find")) ? keys ["Find"] : null, null, null),
+				new Gtk.ActionEntry ("Replace", null, "Find & Replace...", (keys.ContainsKey ("Replace")) ? keys ["Replace"] : null, null, null),
+				new Gtk.ActionEntry ("GoToLine", null, "Go To Line...", (keys.ContainsKey ("GoToLine")) ? keys ["GoToLine"] : null, null, null)
+			};
+		}
 
-			instance.Append (file_item);
+		public MainMenu ()
+		{
+			Build ();
+			// Create a random string to attach to our base action group name (see WARNING).
+			Guid guid = Guid.NewGuid ();
+			// Recreate the UIManager that links the action entries with controls (widgets) created from an XML definition.
+			uim = new Gtk.UIManager ();
+			// Create a blank action group.
+			/*			 WARNING:
 
-			ShowAll ();
+            You cannot use the same name for a new Gtk.ActionGroup if you intend on pushing changes to keys;
+            it will use your previous keys everytime except where null exists on your Gtk.ActionEntry.
+            Clearly a bug.
+          */
+			Gtk.ActionGroup actions = new Gtk.ActionGroup ("MenuBarActions" + guid.ToString ());
+			// Get all the action entries (that is, actions for menu items, toggled menu items, radio menu items).
+			actions.Add (getActionEntries ());
+			// Put the action entry definitions into the UIManager's buffer.
+			uim.InsertActionGroup (actions, 0);
+			// Put the XML definition of the controls (widgets) into the UIManager's buffer -and- create controls (widgets).
+			uim.AddUiFromString (UI.ToString ());
+			// Get the menubar created in the previous space.
+			instance = (Gtk.MenuBar)uim.GetWidget ("/menubar");
+			// Mark everything on the menubar to be shown.
+			instance.ShowAll ();
 		}
 
+		// ACTIONS CALLBACKS
+
 		static void exit_cb (object o, EventArgs args)
 		{
 			Application.Quit ();
 		}
 
-		static void file_chooser_cb(object sender, System.EventArgs e)
+		static void open_cb(object sender, System.EventArgs e)
 		{
 			Gtk.FileChooserDialog fc = new Gtk.FileChooserDialog("Open file", null, FileChooserAction.Open);
 			fc.AddButton(Stock.Cancel, ResponseType.Cancel);

tools/gui/UnitEditor/UnitEditor/MainWindow.cs

@@ -11,6 +11,7 @@ public partial class MainWindow: Gtk.Window
 		VBox box = new VBox (false, 2);
 
 		UnitEditor.MainMenu mb = new UnitEditor.MainMenu ();
+		this.AddAccelGroup (mb.uim.AccelGroup);
 		box.PackStart(mb.instance, false, false, 0);
 
 		List<UnitEditor.Renderable> renderables = new List<UnitEditor.Renderable> ();

tools/gui/UnitEditor/UnitEditor/UnitEditor.csproj

@@ -55,6 +55,8 @@
       <Private>False</Private>
       <Package>monodevelop</Package>
     </Reference>
+    <Reference Include="System.Xml" />
+    <Reference Include="System.Xml.Linq" />
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="gtk-gui\gui.stetic">