KeyMappings

[imilne]

I have existing code that does something in response to CTRL+B being pressed:

Code:

public override bool OnKeyDown(KeyEventArgs e)
{
  if (e.Control && e.KeyCode == Keys.B)
  {
    // do something...

But I was wondering; should I actually be doing something with the KeyMappings.xml stuff and responding to that instead (ShowOSD in this case):

Code:

<Key code="{CTRL}B" command="ShowOSD"/>

Obviously it must be better because then the user can change their mappings and have my plugin respond to some other key.

Is there an API trick to it (or even a C# one), or do I need to parse the XML and work it all out manually?

Iain

[sub]

I have a class that does this for me, but it's not in a module that is accessable to plugins.

In the attached patch I've made a slighty modified version of it in NUtility. Create an instance of the KeyCommandHelper object, passing in a path to your own keymappings.xml file (probably stored in with your plugin files), then for each key press you can do keyCommandHelper.GetCommand("General", theKeyEventArgs) and it'll return the command or null if unknown.

See my keymappings.xml for the format.

[imilne]

Works perfect, thanks.

Iain

[johnsonx42]

iain let me know if you plan to release a plugin that needs this functionality before the next NPVR release, and I'll include this update in the patch list.

[imilne]

Nah, I highly doubt it, so don't worry about it. One for the back burner for the time being...

Iain

[mvallevand]

I think the proper codes for colours are actually now Alt R,G,B,Y but sub also allows Ctrl-B as a kind of legacy mode.

Martin