added hotkeys to Rubberduck menu items

retailcoder · retailcoder · commit 76a2c1a4c513 · 2016-04-03T23:07:40.000-04:00
diff --git a/RetailCoder.VBE/Navigation/RegexSearchReplace/RegexSearchReplacePresenter.cs b/RetailCoder.VBE/Navigation/RegexSearchReplace/RegexSearchReplacePresenter.cs
@@ -27,12 +27,12 @@ public RegexSearchReplacePresenter(VBE vbe, IRubberduckParser parser/*, IRegexSe
 
         public void Show()
         {
-            _view.ShowDialog();
+            //_view.ShowDialog();
         }
 
         public void Hide()
         {
-            _view.Close();
+            //_view.Close();
         }
 
         public event EventHandler<IEnumerable<RegexSearchResult>> FindButtonResults;
@@ -65,7 +65,7 @@ private void _view_ReplaceAllButtonClicked(object sender, EventArgs e)
 
         private void _view_CancelButtonClicked(object sender, EventArgs e)
         {
-            _view.Close();
+            //_view.Close();
         }
     }
 }
diff --git a/RetailCoder.VBE/Rubberduck.csproj b/RetailCoder.VBE/Rubberduck.csproj
@@ -345,7 +345,6 @@
     <Compile Include="UI\About\AboutDialog.Designer.cs">
       <DependentUpon>AboutDialog.cs</DependentUpon>
     </Compile>
-    <Compile Include="UI\Command\IHotkeyCommand.cs" />
     <Compile Include="UI\Command\IndentCurrentModuleCommand.cs" />
     <Compile Include="UI\Command\MenuItems\InspectionResultsCommandMenuItem.cs" />
     <Compile Include="UI\Command\ShowParserErrorsCommand.cs" />
diff --git a/RetailCoder.VBE/Settings/ConfigurationLoader.cs b/RetailCoder.VBE/Settings/ConfigurationLoader.cs
@@ -89,16 +89,22 @@ private IDictionary<RubberduckHotkey, ICommand> GetCommandMappings()
         {
             return new Dictionary<RubberduckHotkey, ICommand>
             {
-                { RubberduckHotkey.CodeExplorer, _commands.SingleOrDefault(cmd => cmd is CodeExplorerCommand)},
-                { RubberduckHotkey.IndentModule, _commands.SingleOrDefault(cmd => cmd is IndentCurrentModuleCommand)},
-                { RubberduckHotkey.IndentProcedure, _commands.SingleOrDefault(cmd => cmd is IndentCurrentProcedureCommand)},
-                { RubberduckHotkey.InspectionResults, _commands.SingleOrDefault(cmd => cmd is InspectionResultsCommand)},
-                { RubberduckHotkey.RefactorExtractMethod, _commands.SingleOrDefault(cmd => cmd is RefactorExtractMethodCommand)},
-                { RubberduckHotkey.RefactorRename, _commands.SingleOrDefault(cmd => cmd is CodePaneRefactorRenameCommand)},
-                { RubberduckHotkey.TestExplorer, _commands.SingleOrDefault(cmd => cmd is TestExplorerCommand)}
+                { RubberduckHotkey.CodeExplorer, Command<CodeExplorerCommand>() },
+                { RubberduckHotkey.IndentModule, Command<IndentCurrentModuleCommand>() },
+                { RubberduckHotkey.IndentProcedure, Command<IndentCurrentProcedureCommand>() },
+                { RubberduckHotkey.FindSymbol, Command<FindSymbolCommand>() },
+                { RubberduckHotkey.InspectionResults, Command<InspectionResultsCommand>() },
+                { RubberduckHotkey.RefactorExtractMethod, Command<RefactorExtractMethodCommand>() },
+                { RubberduckHotkey.RefactorRename, Command<CodePaneRefactorRenameCommand>() },
+                { RubberduckHotkey.TestExplorer, Command<TestExplorerCommand>() }
             };
         }
 
+        private ICommand Command<TCommand>() where TCommand : ICommand
+        {
+            return _commands.OfType<TCommand>().SingleOrDefault();
+        }
+
         private void AssociateHotkeyCommands(Configuration config)
         {
             var mappings = GetCommandMappings();
@@ -108,6 +114,7 @@ private void AssociateHotkeyCommands(Configuration config)
                 if (Enum.TryParse(setting.Name, out hotkey))
                 {
                     setting.Command = mappings[hotkey];
+                    ((CommandBase)setting.Command).ShortcutText = setting.ToMenuHotkeyString(); // yuck
                 }
             }
         }
@@ -178,6 +185,7 @@ private GeneralSettings GetDefaultGeneralSettings()
                     new HotkeySetting{Name=RubberduckHotkey.IndentProcedure.ToString(), IsEnabled=true, HasCtrlModifier = true, Key1="P", Command = commandMappings[RubberduckHotkey.IndentProcedure]},
                     new HotkeySetting{Name=RubberduckHotkey.IndentModule.ToString(), IsEnabled=true, HasCtrlModifier = true, Key1="M", Command = commandMappings[RubberduckHotkey.IndentModule]},
                     new HotkeySetting{Name=RubberduckHotkey.CodeExplorer.ToString(), IsEnabled=true, HasCtrlModifier = true, Key1="R", Command = commandMappings[RubberduckHotkey.CodeExplorer]},
+                    new HotkeySetting{Name=RubberduckHotkey.FindSymbol.ToString(), IsEnabled=true, HasCtrlModifier = true, Key1="T", Command = commandMappings[RubberduckHotkey.InspectionResults]},
                     new HotkeySetting{Name=RubberduckHotkey.InspectionResults.ToString(), IsEnabled=true, HasCtrlModifier = true, HasShiftModifier = true, Key1="I", Command = commandMappings[RubberduckHotkey.InspectionResults]},
                     new HotkeySetting{Name=RubberduckHotkey.TestExplorer.ToString(), IsEnabled=true, HasCtrlModifier = true, HasShiftModifier = true, Key1="T", Command = commandMappings[RubberduckHotkey.TestExplorer]},
                     new HotkeySetting{Name=RubberduckHotkey.RefactorRename.ToString(), IsEnabled=true, HasCtrlModifier = true, HasShiftModifier = true, Key1="R", Command = commandMappings[RubberduckHotkey.RefactorRename]},
diff --git a/RetailCoder.VBE/Settings/HotkeySetting.cs b/RetailCoder.VBE/Settings/HotkeySetting.cs
@@ -31,6 +31,15 @@ public string Prompt
             get { return RubberduckUI.ResourceManager.GetString("HotkeyDescription_" + Name); } 
         }
 
+        public string ToMenuHotkeyString()
+        {
+            return string.Format("{0}{1}{2}+{3}",
+                HasShiftModifier ? "Shift" : string.Empty,
+                HasCtrlModifier ? (HasShiftModifier ? "+" : string.Empty) + "Ctrl" : string.Empty,
+                HasAltModifier ? (HasShiftModifier | HasCtrlModifier ? "+" : string.Empty) + "Alt" : string.Empty,
+                Key1);
+        }
+
         public override string ToString()
         {
             return string.Format("{0}{1}{2}{3}", 
diff --git a/RetailCoder.VBE/Settings/RubberduckHotkey.cs b/RetailCoder.VBE/Settings/RubberduckHotkey.cs
@@ -5,6 +5,7 @@ public enum RubberduckHotkey
         IndentProcedure,
         IndentModule,
         CodeExplorer,
+        FindSymbol,
         InspectionResults,
         TestExplorer,
         RefactorRename,
diff --git a/RetailCoder.VBE/UI/Command/CodeExplorerCommand.cs b/RetailCoder.VBE/UI/Command/CodeExplorerCommand.cs
@@ -7,7 +7,7 @@ namespace Rubberduck.UI.Command
     /// A command that displays the Code Explorer window.
     /// </summary>
     [ComVisible(false)]
-    public class CodeExplorerCommand : CommandBase, IHotkeyCommand
+    public class CodeExplorerCommand : CommandBase
     {
         private readonly IPresenter _presenter;
 
diff --git a/RetailCoder.VBE/UI/Command/CommandBase.cs b/RetailCoder.VBE/UI/Command/CommandBase.cs
@@ -14,6 +14,8 @@ public virtual bool CanExecute(object parameter)
 
         public abstract void Execute(object parameter);
 
+        public virtual string ShortcutText { get; set; }
+
         public event EventHandler CanExecuteChanged
         {
             add { CommandManager.RequerySuggested += value; }
diff --git a/RetailCoder.VBE/UI/Command/FindSymbolCommand.cs b/RetailCoder.VBE/UI/Command/FindSymbolCommand.cs
@@ -3,6 +3,7 @@
 using Microsoft.Vbe.Interop;
 using Rubberduck.Common;
 using Rubberduck.Parsing.VBA;
+using Rubberduck.Settings;
 using Rubberduck.UI.FindSymbol;
 
 namespace Rubberduck.UI.Command
@@ -34,5 +35,7 @@ public override void Execute(object parameter)
                 view.ShowDialog();
             }
         }
+
+        public RubberduckHotkey Hotkey { get { return RubberduckHotkey.FindSymbol; } }
     }
 }
diff --git a/RetailCoder.VBE/UI/Command/IHotkeyCommand.cs b/RetailCoder.VBE/UI/Command/IHotkeyCommand.cs
diff --git a/RetailCoder.VBE/UI/Command/IndentCurrentModuleCommand.cs b/RetailCoder.VBE/UI/Command/IndentCurrentModuleCommand.cs
@@ -5,7 +5,7 @@
 namespace Rubberduck.UI.Command
 {
     [ComVisible(false)]
-    public class IndentCurrentModuleCommand : CommandBase, IHotkeyCommand
+    public class IndentCurrentModuleCommand : CommandBase
     {
         private readonly IIndenter _indenter;
 
diff --git a/RetailCoder.VBE/UI/Command/IndentCurrentProcedureCommand.cs b/RetailCoder.VBE/UI/Command/IndentCurrentProcedureCommand.cs
@@ -5,7 +5,7 @@
 namespace Rubberduck.UI.Command
 {
     [ComVisible(false)]
-    public class IndentCurrentProcedureCommand : CommandBase, IHotkeyCommand
+    public class IndentCurrentProcedureCommand : CommandBase
     {
         private readonly IIndenter _indenter;
 
diff --git a/RetailCoder.VBE/UI/Command/InspectionResultsCommand.cs b/RetailCoder.VBE/UI/Command/InspectionResultsCommand.cs
@@ -7,7 +7,7 @@ namespace Rubberduck.UI.Command
     /// A command that runs all active code inspections for the active VBAProject.
     /// </summary>
     [ComVisible(false)]
-    public class InspectionResultsCommand : CommandBase, IHotkeyCommand
+    public class InspectionResultsCommand : CommandBase
     {
         private readonly IPresenter _presenter;
 
diff --git a/RetailCoder.VBE/UI/Command/MenuItems/ParentMenus/ParentMenuItemBase.cs b/RetailCoder.VBE/UI/Command/MenuItems/ParentMenus/ParentMenuItemBase.cs
@@ -40,11 +40,16 @@ public void Localize()
             {
                 return;
             }
-
+            
             Item.Caption = Caption.Invoke();
             foreach (var kvp in _items)
             {
                 kvp.Value.Caption = kvp.Key.Caption.Invoke();
+                var command = kvp.Key as CommandMenuItemBase;
+                if (command != null)
+                {
+                    ((CommandBarButton)kvp.Value).ShortcutText = ((CommandBase)command.Command).ShortcutText;
+                }
 
                 var childMenu = kvp.Key as ParentMenuItemBase;
                 if (childMenu != null)
@@ -119,6 +124,10 @@ private CommandBarControl InitializeChildControl(ICommandMenuItem item)
             child.BeginGroup = item.BeginGroup;
             child.Tag = item.GetType().FullName;
             child.Caption = item.Caption.Invoke();
+            var command = item.Command as CommandBase; // todo: add 'ShortcutText' to a new 'interface ICommand : System.Windows.Input.ICommand'
+            child.ShortcutText = command != null
+                ? command.ShortcutText
+                : string.Empty; 
 
             Debug.WriteLine("Menu item '{0}' created; hash code: {1} (command hash code {2})", child.Caption, child.GetHashCode(), item.Command.GetHashCode());
 
diff --git a/RetailCoder.VBE/UI/Command/Refactorings/CodePaneRefactorRenameCommand.cs b/RetailCoder.VBE/UI/Command/Refactorings/CodePaneRefactorRenameCommand.cs
@@ -12,7 +12,7 @@
 namespace Rubberduck.UI.Command.Refactorings
 {
     [ComVisible(false)]
-    public class CodePaneRefactorRenameCommand : RefactorCommandBase, IHotkeyCommand
+    public class CodePaneRefactorRenameCommand : RefactorCommandBase
     {
         private readonly RubberduckParserState _state;
         private readonly ICodePaneWrapperFactory _wrapperWrapperFactory;
diff --git a/RetailCoder.VBE/UI/Command/Refactorings/RefactorExtractMethodCommand.cs b/RetailCoder.VBE/UI/Command/Refactorings/RefactorExtractMethodCommand.cs
@@ -8,7 +8,7 @@
 namespace Rubberduck.UI.Command.Refactorings
 {
     [ComVisible(false)]
-    public class RefactorExtractMethodCommand : RefactorCommandBase, IHotkeyCommand
+    public class RefactorExtractMethodCommand : RefactorCommandBase
     {
         private readonly RubberduckParserState _state;
 
diff --git a/RetailCoder.VBE/UI/Command/TestExplorerCommand.cs b/RetailCoder.VBE/UI/Command/TestExplorerCommand.cs
@@ -4,7 +4,7 @@
 namespace Rubberduck.UI.Command
 {
     [ComVisible(false)]
-    public class TestExplorerCommand : CommandBase, IHotkeyCommand
+    public class TestExplorerCommand : CommandBase
     {
         private readonly IPresenter _presenter;
 
diff --git a/RetailCoder.VBE/UI/RubberduckUI.Designer.cs b/RetailCoder.VBE/UI/RubberduckUI.Designer.cs
diff --git a/RetailCoder.VBE/UI/RubberduckUI.resx b/RetailCoder.VBE/UI/RubberduckUI.resx

Original file line number	Diff line number	Diff line change
`@@ -27,12 +27,12 @@ public RegexSearchReplacePresenter(VBE vbe, IRubberduckParser parser/*, IRegexSe`
`27`	`27`
`28`	`28`	`public void Show()`
`29`	`29`	`{`
`30`		`- _view.ShowDialog();`
	`30`	`+ //_view.ShowDialog();`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`public void Hide()`
`34`	`34`	`{`
`35`		`- _view.Close();`
	`35`	`+ //_view.Close();`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`public event EventHandler<IEnumerable<RegexSearchResult>> FindButtonResults;`
`@@ -65,7 +65,7 @@ private void _view_ReplaceAllButtonClicked(object sender, EventArgs e)`
`65`	`65`
`66`	`66`	`private void _view_CancelButtonClicked(object sender, EventArgs e)`
`67`	`67`	`{`
`68`		`- _view.Close();`
	`68`	`+ //_view.Close();`
`69`	`69`	`}`
`70`	`70`	`}`
`71`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -89,16 +89,22 @@ private IDictionary<RubberduckHotkey, ICommand> GetCommandMappings()`
`89`	`89`	`{`
`90`	`90`	`return new Dictionary<RubberduckHotkey, ICommand>`
`91`	`91`	`{`
`92`		`- { RubberduckHotkey.CodeExplorer, _commands.SingleOrDefault(cmd => cmd is CodeExplorerCommand)},`
`93`		`- { RubberduckHotkey.IndentModule, _commands.SingleOrDefault(cmd => cmd is IndentCurrentModuleCommand)},`
`94`		`- { RubberduckHotkey.IndentProcedure, _commands.SingleOrDefault(cmd => cmd is IndentCurrentProcedureCommand)},`
`95`		`- { RubberduckHotkey.InspectionResults, _commands.SingleOrDefault(cmd => cmd is InspectionResultsCommand)},`
`96`		`- { RubberduckHotkey.RefactorExtractMethod, _commands.SingleOrDefault(cmd => cmd is RefactorExtractMethodCommand)},`
`97`		`- { RubberduckHotkey.RefactorRename, _commands.SingleOrDefault(cmd => cmd is CodePaneRefactorRenameCommand)},`
`98`		`- { RubberduckHotkey.TestExplorer, _commands.SingleOrDefault(cmd => cmd is TestExplorerCommand)}`
	`92`	`+ { RubberduckHotkey.CodeExplorer, Command<CodeExplorerCommand>() },`
	`93`	`+ { RubberduckHotkey.IndentModule, Command<IndentCurrentModuleCommand>() },`
	`94`	`+ { RubberduckHotkey.IndentProcedure, Command<IndentCurrentProcedureCommand>() },`
	`95`	`+ { RubberduckHotkey.FindSymbol, Command<FindSymbolCommand>() },`
	`96`	`+ { RubberduckHotkey.InspectionResults, Command<InspectionResultsCommand>() },`
	`97`	`+ { RubberduckHotkey.RefactorExtractMethod, Command<RefactorExtractMethodCommand>() },`
	`98`	`+ { RubberduckHotkey.RefactorRename, Command<CodePaneRefactorRenameCommand>() },`
	`99`	`+ { RubberduckHotkey.TestExplorer, Command<TestExplorerCommand>() }`
`99`	`100`	`};`
`100`	`101`	`}`
`101`	`102`
	`103`	`+ private ICommand Command<TCommand>() where TCommand : ICommand`
	`104`	`+ {`
	`105`	`+ return _commands.OfType<TCommand>().SingleOrDefault();`
	`106`	`+ }`
	`107`	`+`
`102`	`108`	`private void AssociateHotkeyCommands(Configuration config)`
`103`	`109`	`{`
`104`	`110`	`var mappings = GetCommandMappings();`
`@@ -108,6 +114,7 @@ private void AssociateHotkeyCommands(Configuration config)`
`108`	`114`	`if (Enum.TryParse(setting.Name, out hotkey))`
`109`	`115`	`{`
`110`	`116`	`setting.Command = mappings[hotkey];`
	`117`	`+ ((CommandBase)setting.Command).ShortcutText = setting.ToMenuHotkeyString(); // yuck`
`111`	`118`	`}`
`112`	`119`	`}`
`113`	`120`	`}`
`@@ -178,6 +185,7 @@ private GeneralSettings GetDefaultGeneralSettings()`
`178`	`185`	`new HotkeySetting{Name=RubberduckHotkey.IndentProcedure.ToString(), IsEnabled=true, HasCtrlModifier = true, Key1="P", Command = commandMappings[RubberduckHotkey.IndentProcedure]},`
`179`	`186`	`new HotkeySetting{Name=RubberduckHotkey.IndentModule.ToString(), IsEnabled=true, HasCtrlModifier = true, Key1="M", Command = commandMappings[RubberduckHotkey.IndentModule]},`
`180`	`187`	`new HotkeySetting{Name=RubberduckHotkey.CodeExplorer.ToString(), IsEnabled=true, HasCtrlModifier = true, Key1="R", Command = commandMappings[RubberduckHotkey.CodeExplorer]},`
	`188`	`+ new HotkeySetting{Name=RubberduckHotkey.FindSymbol.ToString(), IsEnabled=true, HasCtrlModifier = true, Key1="T", Command = commandMappings[RubberduckHotkey.InspectionResults]},`
`181`	`189`	`new HotkeySetting{Name=RubberduckHotkey.InspectionResults.ToString(), IsEnabled=true, HasCtrlModifier = true, HasShiftModifier = true, Key1="I", Command = commandMappings[RubberduckHotkey.InspectionResults]},`
`182`	`190`	`new HotkeySetting{Name=RubberduckHotkey.TestExplorer.ToString(), IsEnabled=true, HasCtrlModifier = true, HasShiftModifier = true, Key1="T", Command = commandMappings[RubberduckHotkey.TestExplorer]},`
`183`	`191`	`new HotkeySetting{Name=RubberduckHotkey.RefactorRename.ToString(), IsEnabled=true, HasCtrlModifier = true, HasShiftModifier = true, Key1="R", Command = commandMappings[RubberduckHotkey.RefactorRename]},`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ namespace Rubberduck.UI.Command`
`7`	`7`	`/// A command that displays the Code Explorer window.`
`8`	`8`	`/// </summary>`
`9`	`9`	`[ComVisible(false)]`
`10`		`- public class CodeExplorerCommand : CommandBase, IHotkeyCommand`
	`10`	`+ public class CodeExplorerCommand : CommandBase`
`11`	`11`	`{`
`12`	`12`	`private readonly IPresenter _presenter;`
`13`	`13`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@ public virtual bool CanExecute(object parameter)`
`14`	`14`
`15`	`15`	`public abstract void Execute(object parameter);`
`16`	`16`
	`17`	`+ public virtual string ShortcutText { get; set; }`
	`18`	`+`
`17`	`19`	`public event EventHandler CanExecuteChanged`
`18`	`20`	`{`
`19`	`21`	`add { CommandManager.RequerySuggested += value; }`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`using Microsoft.Vbe.Interop;`
`4`	`4`	`using Rubberduck.Common;`
`5`	`5`	`using Rubberduck.Parsing.VBA;`
	`6`	`+using Rubberduck.Settings;`
`6`	`7`	`using Rubberduck.UI.FindSymbol;`
`7`	`8`
`8`	`9`	`namespace Rubberduck.UI.Command`
`@@ -34,5 +35,7 @@ public override void Execute(object parameter)`
`34`	`35`	`view.ShowDialog();`
`35`	`36`	`}`
`36`	`37`	`}`
	`38`	`+`
	`39`	`+ public RubberduckHotkey Hotkey { get { return RubberduckHotkey.FindSymbol; } }`
`37`	`40`	`}`
`38`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`namespace Rubberduck.UI.Command`
`6`	`6`	`{`
`7`	`7`	`[ComVisible(false)]`
`8`		`- public class IndentCurrentModuleCommand : CommandBase, IHotkeyCommand`
	`8`	`+ public class IndentCurrentModuleCommand : CommandBase`
`9`	`9`	`{`
`10`	`10`	`private readonly IIndenter _indenter;`
`11`	`11`