Support for getting and setting the hotkey of a shortcut?

[fgimian]

Hey again, I noticed that you have the function definitios for getting and setting Hotkeys in the ShellLinkV class.

After a little reading and experimenting, I think I've got some rough code for obtaining the hotkey:

    public sealed class WindowsShortcut : IDisposable
    {
...
        private const uint HOTKEYF_ALT = 0x04;
        private const uint HOTKEYF_CONTROL = 0x02;
        private const uint HOTKEYF_EXT = 0x08;
        private const uint HOTKEYF_SHIFT = 0x01;
...
        public string? HotKey
        {
            get
            {
                unsafe
                {
                    ushort hotkeyCode = 0;
                    this.inst->Vtbl->GetHotKey(this.inst, &hotkeyCode);

                    ushort upper = (ushort)(hotkeyCode >> 8);
                    ushort lower = (ushort)(hotkeyCode & 0xff);

                    string shortcut = "";

                    if ((upper & HOTKEYF_CONTROL) != 0)
                    {
                        shortcut += "CTRL + ";
                    }

                    if ((upper & HOTKEYF_SHIFT) != 0)
                    {
                        shortcut += "SHIFT + ";
                    }

                    if ((upper & HOTKEYF_ALT) != 0)
                    {
                        shortcut += "ALT + ";
                    }

                    if ((upper & HOTKEYF_EXT) != 0)
                    {
                        shortcut += "EXT + ";
                    }


                    shortcut += (char)lower;
                    return shortcut;
                }
            }

Note that the lower byte is a bit tricky when it comes to keys such as HOME, END, PGUP & PGDOWN etc. My code above doesn't deal with that properly just yet.

Of course, I'm just creating a string representation of the hotkey above, but perhaps we should have a class with booleans for each of the modifier keys and some clean way to specify the virtual key code, including those special keys.

Happy to assist further if you would like to provide a little guidance on how you would like a hotkey represented.

Huge thanks
Fotis

[gdivis]

I'm thinking a [Flags] enum would be good to represent modifier keys - could even reuse the same values as the upper byte here to make conversion easy. A Hotkey type could be something as simple as:

public readonly struct Hotkey
{
  public HotkeyModifier Modifiers { get; }
  public byte KeyCode { get; }
}

Note this is just a mockup, I'm not sure if it would work or need some tweaking. But I think using an immutable struct would make it easiest to create a hotkey "value". What do you think?

[fgimian]

Hey thanks so much for the reply and your feedback. I think your idea seems great. How about I give it a try and send you a pull request as a starting point? Happy to work through it with you from there to ensure you're happy with the solution. 😄

I think adding hotkey functionality to this library will make it a little more complete as this was the only aspect I found missing when working with shortcuts.

Cheers
Fotis

[gdivis]

Sounds good, thanks!

[fgimian]

I'll just leave some notes here for us to refer to as I work through this. There's a keys enum which could be very useful in converting the key to its respective key on the keyboard.