shortcut editor, replace the shortcut catcher by the one used in an object inspector

docs/options_shortcuts_editor.md

@@ -1 +1,18 @@
- 
+---
+title: Options - shortcuts
+---
+
+{% include xstyle.css %}
+
+### Shortcuts editor
+
+This category exposes all the shortcuts, sorted by category.
+
+![](img/options/shortcuts.png)
+
+Each item is editable.
+
+- <img src="{%include icurl%}other/clean.png" class="tlbric"/>: Deletes the current assignation.
+- <img src="{%include icurl%}other/keyboard_pencil.png" class="tlbric"/>: Displays the editor. The shortcut can also be selected in the combo menu.
+
+After an assignation attempt and if the selected combination is already used the new shortcut is not validated and a warning is displayed.

src/ce_shortcutseditor.lfm

@@ -62,54 +62,42 @@ object CEShortcutEditor: TCEShortcutEditor
       ClientHeight = 26
       ClientWidth = 420
       TabOrder = 2
-      object schrtText: TStaticText
-        Left = 0
-        Height = 22
-        Top = 2
-        Width = 247
-        Align = alClient
-        Alignment = taCenter
-        BorderSpacing.Top = 2
-        BorderSpacing.Bottom = 2
-        BorderStyle = sbsSunken
-        TabOrder = 0
-      end
-      object shortcutCatcher: TEdit
-        Left = 299
-        Height = 22
-        Hint = 'type a key combination while active'
-        Top = 2
-        Width = 120
-        Align = alRight
-        BorderSpacing.Top = 1
-        BorderSpacing.Bottom = 1
-        BorderSpacing.Around = 1
-        Enabled = False
-        OnExit = shortcutCatcherExit
-        OnKeyDown = LabeledEdit1KeyDown
-        OnMouseLeave = shortcutCatcherMouseLeave
-        TabOrder = 1
-      end
-      object btnActivate: TSpeedButton
-        Left = 274
-        Height = 22
-        Hint = 'enable shortcut capture'
-        Top = 2
-        Width = 23
-        Align = alRight
-        BorderSpacing.Around = 2
-        OnClick = btnActivateClick
-      end
       object btnClear: TSpeedButton
-        Left = 249
+        Left = 2
         Height = 22
         Hint = 'clear shortcut'
         Top = 2
         Width = 23
-        Align = alRight
+        Align = alLeft
         BorderSpacing.Around = 2
+        Flat = True
         OnClick = btnClearClick
       end
+      object propedit: TTIPropertyGrid
+        Left = 52
+        Height = 26
+        Top = 0
+        Width = 368
+        Align = alClient
+        CheckboxForBoolean = False
+        DefaultValueFont.Color = clWindowText
+        Filter = [tkInteger, tkChar, tkEnumeration, tkFloat, tkSet, tkMethod, tkSString, tkLString, tkAString, tkWString, tkVariant, tkArray, tkRecord, tkInterface, tkClass, tkObject, tkWChar, tkBool, tkInt64, tkQWord, tkDynArray, tkInterfaceRaw, tkProcVar, tkUString, tkUChar, tkHelper, tkFile, tkClassRef, tkPointer]
+        Indent = 10
+        NameFont.Color = clWindowText
+        OnModified = propeditModified
+        ValueFont.Color = clMaroon
+      end
+      object btnEdit: TSpeedButton
+        Left = 27
+        Height = 22
+        Hint = 'edit selected shortcut'
+        Top = 2
+        Width = 23
+        Align = alLeft
+        BorderSpacing.Around = 2
+        Flat = True
+        OnClick = btnEditClick
+      end
     end
   end
 end

src/ce_shortcutseditor.pas

@@ -6,9 +6,9 @@ interface
 
 uses
   Classes, SysUtils, FileUtil, TreeFilterEdit, Forms, Controls, Menus, Graphics,
-  ExtCtrls, LCLProc, ComCtrls, StdCtrls, Buttons, LCLType, PropEdits, strutils,
+  ExtCtrls, LCLProc, ComCtrls, Buttons, LCLType, PropEdits, RTTIGrids,
-  ce_sharedres, ce_observer, ce_interfaces, ce_common, ce_writableComponent,
+  strutils, ce_sharedres, ce_observer, ce_interfaces, ce_common,
-  ce_dialogs, EditBtn;
+  ce_writableComponent, ce_dialogs, EditBtn;
 
 type
 
@@ -46,29 +46,36 @@ type
     property item[index: Integer]: TShortcutItem read getItem; default;
   end;
 
+  TEditableShortcut = class(TPersistent)
+  public
+    value: TShortCut;
+  published
+    property shortcut: TShortCut read value write value;
+  end;
+
   { TCEShortcutEditor }
 
   TCEShortcutEditor = class(TFrame, ICEEditableOptions)
     btnClear: TSpeedButton;
-    shortcutCatcher: TEdit;
+    btnEdit: TSpeedButton;
     Panel1: TPanel;
     fltItems: TTreeFilterEdit;
     Panel2: TPanel;
-    schrtText: TStaticText;
+    propedit: TTIPropertyGrid;
-    btnActivate: TSpeedButton;
     tree: TTreeView;
-    procedure btnActivateClick(Sender: TObject);
     procedure btnClearClick(Sender: TObject);
+    procedure btnEditClick(Sender: TObject);
     function fltItemsFilterItem(Item: TObject; out Done: Boolean): Boolean;
-    procedure LabeledEdit1KeyDown(Sender: TObject; var Key: Word;Shift: TShiftState);
     procedure shortcutCatcherExit(Sender: TObject);
     procedure shortcutCatcherMouseLeave(Sender: TObject);
+    procedure propeditModified(Sender: TObject);
     procedure treeSelectionChanged(Sender: TObject);
   private
     fObservers: TCEEditableShortCutSubject;
     fShortcuts: TShortCutCollection;
     fBackup: TShortCutCollection;
     fHasChanged: boolean;
+    propvalue: TEditableShortcut;
     //
     function optionedWantCategory(): string;
     function optionedWantEditorKind: TOptionEditorKind;
@@ -82,8 +89,7 @@ type
     procedure receiveShortcuts;
     procedure updateEditCtrls;
     procedure sendShortcuts;
-  protected
+    function anItemIsSelected: boolean;
-    procedure UpdateShowing; override;
   public
     constructor create(TheOwner: TComponent); override;
     destructor destroy; override;
@@ -175,25 +181,29 @@ end;
 constructor TCEShortcutEditor.create(TheOwner: TComponent);
 begin
   inherited;
+  propvalue := TEditableShortcut.Create;
   fObservers := TCEEditableShortCutSubject.create;
   fShortcuts := TShortCutCollection.create(self);
   fBackup := TShortCutCollection.create(self);
   AssignPng(btnClear, 'CLEAN');
+  AssignPng(btnEdit, 'KEYBOARD_PENCIL');
   EntitiesConnector.addObserver(self);
+  propedit.TIObject := propvalue;
+  propedit.PropertyEditorHook.AddHandlerModified(@propeditModified);
 end;
 
 destructor TCEShortcutEditor.destroy;
 begin
+  propvalue.Free;
   fObservers.Free;
   inherited;
 end;
 
-procedure TCEShortcutEditor.UpdateShowing;
+function TCEShortcutEditor.anItemIsSelected: boolean;
 begin
-  inherited;
+  result := true;
-  if not visible then exit;
+  if tree.Selected.isNil or (tree.Selected.Level = 0) or tree.Selected.Data.isNil then
-  //
+    result := false;
-  AssignPng(btnActivate, 'KEYBOARD_PENCIL');
 end;
 {$ENDREGION}
 
@@ -247,43 +257,62 @@ end;
 
 procedure TCEShortcutEditor.shortcutCatcherExit(Sender: TObject);
 begin
-  shortcutCatcher.Enabled := false;
   updateEditCtrls;
 end;
 
 procedure TCEShortcutEditor.shortcutCatcherMouseLeave(Sender: TObject);
 begin
-  shortcutCatcher.Enabled := false;
   updateEditCtrls;
 end;
 
-procedure TCEShortcutEditor.btnActivateClick(Sender: TObject);
+procedure TCEShortcutEditor.propeditModified(Sender: TObject);
+var
+  i: integer;
+  sh: TShortCut;
+  sht: string;
+  dup: TShortcutItem = nil;
+const
+  msg = '"%s" is already assigned in the same category by "%s". The new shortcut will be ignored';
 begin
-  if tree.Selected.isNil then exit;
+  if not anItemIsSelected then
-  if tree.Selected.Level = 0 then exit;
+    exit;
-  if tree.Selected.Data.isNil then exit;
+  sh := propvalue.value;
-  //
+  sht := shortCutToText(sh);
-  shortcutCatcher.Enabled := not shortcutCatcher.Enabled;
+  if sht.isEmpty then
-  if shortcutCatcher.Enabled then
+    exit;
-    shortcutCatcher.SetFocus;
+  for i:= 0 to tree.Selected.Parent.Count-1 do
+    if i <> tree.Selected.Index then
+      if TShortcutItem(tree.Selected.Parent.Items[i].Data).data = sh then
+        dup := TShortcutItem(tree.Selected.Parent.Items[i].Data);
+  if dup.isNotNil then
+    dlgOkInfo(format(msg,[ShortCutToText(sh), dup.identifier]))
+  else if TShortcutItem(tree.Selected.Data).data <> sh then
+  begin
+    TShortcutItem(tree.Selected.Data).data := sh;
+    fHasChanged := true;
+  end;
+  updateEditCtrls;
 end;
 
 procedure TCEShortcutEditor.btnClearClick(Sender: TObject);
 begin
-  if tree.Selected.isNil then exit;
+  if not anItemIsSelected then
-  if tree.Selected.Level = 0 then exit;
+    exit;
-  if tree.Selected.Data.isNil then exit;
-  //
   if TShortcutItem(tree.Selected.Data).data <> 0 then
   begin
     TShortcutItem(tree.Selected.Data).data := 0;
     fHasChanged := true;
   end;
-  //
-  shortcutCatcher.Enabled := false;
   updateEditCtrls;
 end;
 
+procedure TCEShortcutEditor.btnEditClick(Sender: TObject);
+begin
+  if not anItemIsSelected then
+    exit;
+  propedit.Rows[0].Editor.Edit;
+end;
+
 function TCEShortcutEditor.fltItemsFilterItem(Item: TObject; out Done: Boolean): Boolean;
 var
   shc: TShortcutItem;
@@ -306,56 +335,18 @@ begin
   end;
 end;
 
-procedure TCEShortcutEditor.LabeledEdit1KeyDown(Sender: TObject; var Key: Word; Shift: TShiftState);
-var
-  i: integer;
-  sh: TShortCut;
-  sht: string;
-  dup: TShortcutItem = nil;
-const
-  msg = '"%s" is already assigned in the same category by "%s". The new shortcut will be ignored';
-begin
-  if tree.Selected.isNil then exit;
-  if tree.Selected.Level = 0 then exit;
-  if tree.Selected.Data.isNil then exit;
-  //
-  if Key = VK_RETURN then
-    shortcutCatcher.Enabled := false
-  else
-  begin
-    sh := Shortcut(Key, Shift);
-    sht := shortCutToText(sh);
-    if sht.isEmpty then
-      exit;
-    for i:= 0 to tree.Selected.Parent.Count-1 do
-      if i <> tree.Selected.Index then
-        if TShortcutItem(tree.Selected.Parent.Items[i].Data).data = sh then
-          dup := TShortcutItem(tree.Selected.Parent.Items[i].Data);
-    if dup.isNotNil then
-      dlgOkInfo(format(msg,[ShortCutToText(sh), dup.identifier]))
-    else if TShortcutItem(tree.Selected.Data).data <> sh then
-    begin
-      TShortcutItem(tree.Selected.Data).data := sh;
-      fHasChanged := true;
-    end;
-  end;
-  //
-  updateEditCtrls;
-end;
-
 procedure TCEShortcutEditor.updateEditCtrls;
+var
+  shc: TShortcutItem;
 begin
-  schrtText.Caption := '';
+  if not anItemIsSelected then
-  shortcutCatcher.TextHint := '(Enter shortcut)';
+    exit;
-  //
+  shc := TShortcutItem(tree.Selected.Data);
-  if tree.Selected.isNil then exit;
+  if propvalue.value <> shc.data then
-  if tree.Selected.Level = 0 then exit;
+  begin
-  if tree.Selected.Data.isNil then exit;
+    propvalue.value := shc.data;
-  //
+    propedit.Update;
-  schrtText.Caption := TShortcutItem(tree.Selected.Data).combination;
+  end;
-  shortcutCatcher.Text := '';
-  if schrtText.Caption <> '' then
-    shortcutCatcher.TextHint := '(' + schrtText.Caption + ')';
 end;
 
 function TCEShortcutEditor.findCategory(const aName: string; aData: Pointer): TTreeNode;