module timelinelib.config.shortcut

Naming and other conventions: All data needed for configuration of shortcuts are collected in metadata objects wich are of type Metadata. The text in a menu item to the right of the character is called shortcut. Examples of shortcuts: Ctrl+N, PgUp, Shift+Ctrl+X The shortcut, if it exists, consists of an optional modifier and a shortcut key. So the format of a shortcut is: [modifier +] shortcut_key. The text in a menu item describing the action is called function. wxid is the ID associated with the menu item. cfgid is the ID used in the configuration file associated with a shortcut.

class timelinelib.config.shortcut.Metadata

Bases: object

__init__(wxid, cfgid, function, modifier, key)

Initialize self. See help(type(self)) for accurate signature.

timelinelib.config.shortcut.SHIFT_CTRL_MODIFIER = 'Shift+Ctrl'

timelinelib.config.shortcut.CTRL_MODIFIER = 'Ctrl'

timelinelib.config.shortcut.ALT_MODIFIER = 'Alt'

timelinelib.config.shortcut.NO_MODIFIER = ''

timelinelib.config.shortcut.LABEL = '%s->%%s'

timelinelib.config.shortcut.LABEL_FILE = 'File->%s'

timelinelib.config.shortcut.LABEL_EDIT = 'Edit->%s'

timelinelib.config.shortcut.LABEL_VIEW = 'View->%s'

timelinelib.config.shortcut.LABEL_TIMELINE = 'Timeline->%s'

timelinelib.config.shortcut.LABEL_NAVIGATE = 'Navigate->%s'

timelinelib.config.shortcut.LABEL_HELP = 'Help->%s'

timelinelib.config.shortcut.NAVLABEL = '%s(%s)->%%s'

timelinelib.config.shortcut.LABEL_NAVIGATE_TIME = 'Navigate(tm)->%s'

timelinelib.config.shortcut.LABEL_NAVIGATE_NUM = 'Navigate(num)->%s'

timelinelib.config.shortcut.METADATA = [<timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>, <timelinelib.config.shortcut.Metadata object>]

timelinelib.config.shortcut.FUNCTION_KEYS = ['PgDn', 'PgUp', 'F1', 'F2', 'F3', 'F4', 'F5', 'F6', 'F7', 'F8', 'F9']

timelinelib.config.shortcut.SHORTCUT_KEYS = ['', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '-', 'PgDn', 'PgUp', 'F1', 'F2', 'F3', 'F4', 'F5', 'F6', 'F7', 'F8', 'F9']

timelinelib.config.shortcut.NON_EMPTY_MODIFIERS = ['Ctrl', 'Alt', 'Shift+Ctrl', 'Shift+Alt', 'Alt+Ctrl', 'Shift+Alt+Ctrl']

timelinelib.config.shortcut.MODIFIERS = ['', 'Ctrl', 'Alt', 'Shift+Ctrl', 'Shift+Alt', 'Alt+Ctrl', 'Shift+Alt+Ctrl']

class timelinelib.config.shortcut.ShortcutController

Bases: object

__init__(shortcut_config)

Initialize self. See help(type(self)) for accurate signature.

add_shortcut_item(key, item)

load_config_settings()

get_functions()

get_modifiers()

get_shortcuts()

get_function(shortcut)

get_modifier_and_key(function)

is_valid(modifier, shortcut_key)

exists(shortcut, wxid=None, function=None)

wxid_exists(wxid)

is_function_key(shortcut)

add_navigation_functions()

edit(function, new_shortcut)