KeyMappings - PVRX2 - BaseButtonUIList

[psycik]

Hi

Got some info on the Ky mappings:

Here is some info about using the key mappings. Its pretty straight forward, but if you have any questions, just ask

Code:

Declare a variable of type GBPVR.Public.KeyCommandHelper:
    private KeyCommandHelper keyHelper;

Initialise that variable in your plugin's initialisation function:

Code:

keyHelper = new KeyCommandHelper("TVGuide.xml");

In OnKeyDown() check for commands:

Code:

public bool OnKeyDown(KeyEventArgs e)
    {
       ....
        switch (keyHelper.KeyMapping(e))
        {
             case "GUIDE_SEARCH":    
             .... do some processing
             break;

But on base button UI List, I'm not actually doing any keycode processing, since it's being handled but the base classes.

So my question is, will it use the keymapping file, and if so, how do I tell it to use it?

[sub]

The default handling for the base button UI List doesnt need to the key mappings since it doesnt do any special key handling. It only handles the up/down/left/right/enter/escape keys, which dont use the key mappings.

In your plugin though, you can still use the key mappings for any extra custom keys you want to handle. Pretty much as it says above, declare a member variable for the KeyCommandHelper, then when you override OnKeyDown to do any special keys use the key mapping stuff.

Code:

protected override void initialise()
        {
            keyHelper = new KeyCommandHelper("MyPlugin.xml");
            ...
            ... any other initialisation
            ...

            // allow base class to be initialised
            base.initialise();
        }

Code:

public override bool OnKeyDown(KeyEventArgs e)
        {
            ....
            switch (keyHelper.KeyMapping(e))
            {
               case "PLUGIN_SEARCH":    
               .... do some processing
               break;
            }

            // let base class handle other keystrokes
            return base.OnKeyDown(e);
        }