File: key_event_to_name.py

package info (click to toggle)
python-traitsui 8.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 18,232 kB
  • sloc: python: 58,982; makefile: 113
file content (134 lines) | stat: -rw-r--r-- 3,622 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# (C) Copyright 2004-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!

""" Converts a wx.KeyEvent to a standardized "name".
"""


import wx


# Mapping from wxPython special key names to Enable key names
key_map = {
    wx.WXK_BACK: "Backspace",
    wx.WXK_TAB: "Tab",
    wx.WXK_RETURN: "Enter",
    wx.WXK_ESCAPE: "Esc",
    wx.WXK_DELETE: "Delete",
    wx.WXK_START: "Start",
    wx.WXK_LBUTTON: "Left Button",
    wx.WXK_RBUTTON: "Right Button",
    wx.WXK_CANCEL: "Cancel",
    wx.WXK_MBUTTON: "Middle Button",
    wx.WXK_CLEAR: "Clear",
    wx.WXK_SHIFT: "Shift",
    wx.WXK_CONTROL: "Control",
    wx.WXK_MENU: "Menu",
    wx.WXK_PAUSE: "Pause",
    wx.WXK_CAPITAL: "Capital",
    wx.WXK_PAGEUP: "Page Up",
    wx.WXK_PAGEDOWN: "Page Down",
    wx.WXK_END: "End",
    wx.WXK_HOME: "Home",
    wx.WXK_LEFT: "Left",
    wx.WXK_UP: "Up",
    wx.WXK_RIGHT: "Right",
    wx.WXK_DOWN: "Down",
    wx.WXK_SELECT: "Select",
    wx.WXK_PRINT: "Print",
    wx.WXK_EXECUTE: "Execute",
    wx.WXK_SNAPSHOT: "Snapshot",
    wx.WXK_INSERT: "Insert",
    wx.WXK_HELP: "Help",
    wx.WXK_NUMPAD0: "Numpad 0",
    wx.WXK_NUMPAD1: "Numpad 1",
    wx.WXK_NUMPAD2: "Numpad 2",
    wx.WXK_NUMPAD3: "Numpad 3",
    wx.WXK_NUMPAD4: "Numpad 4",
    wx.WXK_NUMPAD5: "Numpad 5",
    wx.WXK_NUMPAD6: "Numpad 6",
    wx.WXK_NUMPAD7: "Numpad 7",
    wx.WXK_NUMPAD8: "Numpad 8",
    wx.WXK_NUMPAD9: "Numpad 9",
    wx.WXK_MULTIPLY: "Multiply",
    wx.WXK_ADD: "Add",
    wx.WXK_SEPARATOR: "Separator",
    wx.WXK_SUBTRACT: "Subtract",
    wx.WXK_DECIMAL: "Decimal",
    wx.WXK_DIVIDE: "Divide",
    wx.WXK_F1: "F1",
    wx.WXK_F2: "F2",
    wx.WXK_F3: "F3",
    wx.WXK_F4: "F4",
    wx.WXK_F5: "F5",
    wx.WXK_F6: "F6",
    wx.WXK_F7: "F7",
    wx.WXK_F8: "F8",
    wx.WXK_F9: "F9",
    wx.WXK_F10: "F10",
    wx.WXK_F11: "F11",
    wx.WXK_F12: "F12",
    wx.WXK_F13: "F13",
    wx.WXK_F14: "F14",
    wx.WXK_F15: "F15",
    wx.WXK_F16: "F16",
    wx.WXK_F17: "F17",
    wx.WXK_F18: "F18",
    wx.WXK_F19: "F19",
    wx.WXK_F20: "F20",
    wx.WXK_F21: "F21",
    wx.WXK_F22: "F22",
    wx.WXK_F23: "F23",
    wx.WXK_F24: "F24",
    wx.WXK_NUMLOCK: "Num Lock",
    wx.WXK_SCROLL: "Scroll Lock",
}

# -------------------------------------------------------------------------
#  Converts a keystroke event into a corresponding key name:
# -------------------------------------------------------------------------


def key_event_to_name(event):
    """Converts a keystroke event into a corresponding key name."""
    key_code = event.GetKeyCode()
    if event.ControlDown() and (1 <= key_code <= 26):
        key = chr(key_code + 96)
    else:
        key = key_map.get(key_code)
        if key is None:
            try:
                key = chr(key_code)
            except:
                # Handle the case of strange keyboard codes (such as the Apple
                # keyboard 'apple' key):
                key = "unknown"

    name = ""
    if event.AltDown():
        name = "Alt"

    if event.ControlDown():
        name += "-Ctrl"

    if event.ShiftDown() and ((name != "") or (len(key) > 1)):
        name += "-Shift"

    if key == " ":
        key = "Space"

    if len(name) > 0:
        key = key.lower()

    name += "-" + key

    if name[:1] == "-":
        return name[1:]
    return name