Package plugins :: Package core :: Package keycodes :: Module main :: Class XYZPlugin |
[hide private]
[frames] | no frames]

# Class XYZPlugin

source code

    libxyz.core.plugins.BasePlugin --+
                                     |
                                    XYZPlugin

Terminal keycodes handling

Instance Methods | [hide private]
__init__(self, xyz) | source code
prepare(self) | source code
learn_keys(self) Show LearnKeys dialog | source code
delete_keys(self, all=False) Delete learned keycodes data. | source code
get_keys(self, all=False) Return saved keycodes data as dictionary. | source code
_save_data(self, data) Store learned keycodes | source code
_load_data(self) Load stored keycodes | source code

Class Variables | [hide private]
| NAME = `u"keycodes"`
| AUTHOR = `u"Max E. Kuznecov ~syhpoon <syhpoon@syhpoon.name>"`
| VERSION = `u"0.1"`
| NAMESPACE = `u"core"`
| BRIEF_DESCRIPTION = `u"Setup terminal keycodes"`
| FULL_DESCRIPTION = `u"keycodes plugin is used to properly " u"c`...``
| HOMEPAGE = `u"xyzcmd.syhpoon.name"`
| EVENTS = `[("show", "Fires upon showing dialog"),]`

Method Details | [hide private]

### delete_keys(self, all=False) | source code
Delete learned keycodes data. If all is True, delete all saved data for all terminal types, otherwise delete only current terminal type data.

### get_keys(self, all=False) | source code
Return saved keycodes data as dictionary. If all is True, return all saved data for all terminal types, otherwise return only current terminal type data.

Class Variable Details | [hide private]

  ### FULL_DESCRIPTION Value:
      u"keycodes plugin is used to properly " u"configure terminal keycodes.
      \n" u"For each terminal type keycodes are stored " u"independently. Te
      rminal type determined by examining " u"TERM environment variable."