wxWidgets/wxPython/demo/KeyEvents.py

import  wx
import  wx.lib.mixins.listctrl  as  listmix

#----------------------------------------------------------------------

keyMap = {
    wx.WXK_BACK : "wx.WXK_BACK",
    wx.WXK_TAB : "wx.WXK_TAB",
    wx.WXK_RETURN : "wx.WXK_RETURN",
    wx.WXK_ESCAPE : "wx.WXK_ESCAPE",
    wx.WXK_SPACE : "wx.WXK_SPACE",
    wx.WXK_DELETE : "wx.WXK_DELETE",
    wx.WXK_START : "wx.WXK_START",
    wx.WXK_LBUTTON : "wx.WXK_LBUTTON",
    wx.WXK_RBUTTON : "wx.WXK_RBUTTON",
    wx.WXK_CANCEL : "wx.WXK_CANCEL",
    wx.WXK_MBUTTON : "wx.WXK_MBUTTON",
    wx.WXK_CLEAR : "wx.WXK_CLEAR",
    wx.WXK_SHIFT : "wx.WXK_SHIFT",
    wx.WXK_ALT : "wx.WXK_ALT",
    wx.WXK_CONTROL : "wx.WXK_CONTROL",
    wx.WXK_MENU : "wx.WXK_MENU",
    wx.WXK_PAUSE : "wx.WXK_PAUSE",
    wx.WXK_CAPITAL : "wx.WXK_CAPITAL",
    wx.WXK_PRIOR : "wx.WXK_PRIOR",
    wx.WXK_NEXT : "wx.WXK_NEXT",
    wx.WXK_END : "wx.WXK_END",
    wx.WXK_HOME : "wx.WXK_HOME",
    wx.WXK_LEFT : "wx.WXK_LEFT",
    wx.WXK_UP : "wx.WXK_UP",
    wx.WXK_RIGHT : "wx.WXK_RIGHT",
    wx.WXK_DOWN : "wx.WXK_DOWN",
    wx.WXK_SELECT : "wx.WXK_SELECT",
    wx.WXK_PRINT : "wx.WXK_PRINT",
    wx.WXK_EXECUTE : "wx.WXK_EXECUTE",
    wx.WXK_SNAPSHOT : "wx.WXK_SNAPSHOT",
    wx.WXK_INSERT : "wx.WXK_INSERT",
    wx.WXK_HELP : "wx.WXK_HELP",
    wx.WXK_NUMPAD0 : "wx.WXK_NUMPAD0",
    wx.WXK_NUMPAD1 : "wx.WXK_NUMPAD1",
    wx.WXK_NUMPAD2 : "wx.WXK_NUMPAD2",
    wx.WXK_NUMPAD3 : "wx.WXK_NUMPAD3",
    wx.WXK_NUMPAD4 : "wx.WXK_NUMPAD4",
    wx.WXK_NUMPAD5 : "wx.WXK_NUMPAD5",
    wx.WXK_NUMPAD6 : "wx.WXK_NUMPAD6",
    wx.WXK_NUMPAD7 : "wx.WXK_NUMPAD7",
    wx.WXK_NUMPAD8 : "wx.WXK_NUMPAD8",
    wx.WXK_NUMPAD9 : "wx.WXK_NUMPAD9",
    wx.WXK_MULTIPLY : "wx.WXK_MULTIPLY",
    wx.WXK_ADD : "wx.WXK_ADD",
    wx.WXK_SEPARATOR : "wx.WXK_SEPARATOR",
    wx.WXK_SUBTRACT : "wx.WXK_SUBTRACT",
    wx.WXK_DECIMAL : "wx.WXK_DECIMAL",
    wx.WXK_DIVIDE : "wx.WXK_DIVIDE",
    wx.WXK_F1 : "wx.WXK_F1",
    wx.WXK_F2 : "wx.WXK_F2",
    wx.WXK_F3 : "wx.WXK_F3",
    wx.WXK_F4 : "wx.WXK_F4",
    wx.WXK_F5 : "wx.WXK_F5",
    wx.WXK_F6 : "wx.WXK_F6",
    wx.WXK_F7 : "wx.WXK_F7",
    wx.WXK_F8 : "wx.WXK_F8",
    wx.WXK_F9 : "wx.WXK_F9",
    wx.WXK_F10 : "wx.WXK_F10",
    wx.WXK_F11 : "wx.WXK_F11",
    wx.WXK_F12 : "wx.WXK_F12",
    wx.WXK_F13 : "wx.WXK_F13",
    wx.WXK_F14 : "wx.WXK_F14",
    wx.WXK_F15 : "wx.WXK_F15",
    wx.WXK_F16 : "wx.WXK_F16",
    wx.WXK_F17 : "wx.WXK_F17",
    wx.WXK_F18 : "wx.WXK_F18",
    wx.WXK_F19 : "wx.WXK_F19",
    wx.WXK_F20 : "wx.WXK_F20",
    wx.WXK_F21 : "wx.WXK_F21",
    wx.WXK_F22 : "wx.WXK_F22",
    wx.WXK_F23 : "wx.WXK_F23",
    wx.WXK_F24 : "wx.WXK_F24",
    wx.WXK_NUMLOCK : "wx.WXK_NUMLOCK",
    wx.WXK_SCROLL : "wx.WXK_SCROLL",
    wx.WXK_PAGEUP : "wx.WXK_PAGEUP",
    wx.WXK_PAGEDOWN : "wx.WXK_PAGEDOWN",
    wx.WXK_NUMPAD_SPACE : "wx.WXK_NUMPAD_SPACE",
    wx.WXK_NUMPAD_TAB : "wx.WXK_NUMPAD_TAB",
    wx.WXK_NUMPAD_ENTER : "wx.WXK_NUMPAD_ENTER",
    wx.WXK_NUMPAD_F1 : "wx.WXK_NUMPAD_F1",
    wx.WXK_NUMPAD_F2 : "wx.WXK_NUMPAD_F2",
    wx.WXK_NUMPAD_F3 : "wx.WXK_NUMPAD_F3",
    wx.WXK_NUMPAD_F4 : "wx.WXK_NUMPAD_F4",
    wx.WXK_NUMPAD_HOME : "wx.WXK_NUMPAD_HOME",
    wx.WXK_NUMPAD_LEFT : "wx.WXK_NUMPAD_LEFT",
    wx.WXK_NUMPAD_UP : "wx.WXK_NUMPAD_UP",
    wx.WXK_NUMPAD_RIGHT : "wx.WXK_NUMPAD_RIGHT",
    wx.WXK_NUMPAD_DOWN : "wx.WXK_NUMPAD_DOWN",
    wx.WXK_NUMPAD_PRIOR : "wx.WXK_NUMPAD_PRIOR",
    wx.WXK_NUMPAD_PAGEUP : "wx.WXK_NUMPAD_PAGEUP",
    wx.WXK_NUMPAD_NEXT : "wx.WXK_NUMPAD_NEXT",
    wx.WXK_NUMPAD_PAGEDOWN : "wx.WXK_NUMPAD_PAGEDOWN",
    wx.WXK_NUMPAD_END : "wx.WXK_NUMPAD_END",
    wx.WXK_NUMPAD_BEGIN : "wx.WXK_NUMPAD_BEGIN",
    wx.WXK_NUMPAD_INSERT : "wx.WXK_NUMPAD_INSERT",
    wx.WXK_NUMPAD_DELETE : "wx.WXK_NUMPAD_DELETE",
    wx.WXK_NUMPAD_EQUAL : "wx.WXK_NUMPAD_EQUAL",
    wx.WXK_NUMPAD_MULTIPLY : "wx.WXK_NUMPAD_MULTIPLY",
    wx.WXK_NUMPAD_ADD : "wx.WXK_NUMPAD_ADD",
    wx.WXK_NUMPAD_SEPARATOR : "wx.WXK_NUMPAD_SEPARATOR",
    wx.WXK_NUMPAD_SUBTRACT : "wx.WXK_NUMPAD_SUBTRACT",
    wx.WXK_NUMPAD_DECIMAL : "wx.WXK_NUMPAD_DECIMAL",
    wx.WXK_NUMPAD_DIVIDE : "wx.WXK_NUMPAD_DIVIDE",
}


#----------------------------------------------------------------------

class KeySink(wx.Window):
    def __init__(self, parent):
        wx.Window.__init__(self, parent, -1, style=wx.WANTS_CHARS
                          #| wx.RAISED_BORDER
                          #| wx.SUNKEN_BORDER
                          )

        self.SetBackgroundColour(wx.BLUE)
        self.haveFocus = False
        self.callSkip = False
        self.logKeyDn = True
        self.logKeyUp = True
        self.logChar = True

        self.Bind(wx.EVT_PAINT, self.OnPaint)
        self.Bind(wx.EVT_SET_FOCUS, self.OnSetFocus)
        self.Bind(wx.EVT_KILL_FOCUS, self.OnKillFocus)
        self.Bind(wx.EVT_MOUSE_EVENTS, self.OnMouse)

        self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDown)
        self.Bind(wx.EVT_KEY_UP, self.OnKeyUp)
        self.Bind(wx.EVT_CHAR, self.OnChar)


    def SetCallSkip(self, skip):
        self.callSkip = skip

    def SetLogKeyUp(self, val):
        self.logKeyUp = val

    def SetLogKeyDn(self, val):
        self.logKeyDn = val

    def SetLogChar(self, val):
        self.logChar = val


    def OnPaint(self, evt):
        dc = wx.PaintDC(self)
        rect = self.GetClientRect()
        dc.SetTextForeground(wx.WHITE)
        dc.DrawLabel("Click here and then press some keys",
                     rect, wx.ALIGN_CENTER | wx.ALIGN_TOP)
        if self.haveFocus:
            dc.SetTextForeground(wx.GREEN)
            dc.DrawLabel("Have Focus", rect, wx.ALIGN_RIGHT | wx.ALIGN_BOTTOM)
        else:
            dc.SetTextForeground(wx.RED)
            dc.DrawLabel("Need Focus!", rect, wx.ALIGN_RIGHT | wx.ALIGN_BOTTOM)


    def OnSetFocus(self, evt):
        self.haveFocus = True
        self.Refresh()

    def OnKillFocus(self, evt):
        self.haveFocus = False
        self.Refresh()

    def OnMouse(self, evt):
        if evt.ButtonDown():
            self.SetFocus()


    def OnKeyDown(self, evt):
        if self.logKeyDn:
            self.GetParent().keylog.LogKeyEvent("KeyDown", evt)
        if self.callSkip:
            evt.Skip()

    def OnKeyUp(self, evt):
        if self.logKeyUp:
            self.GetParent().keylog.LogKeyEvent("KeyUp", evt)
        if self.callSkip:
            evt.Skip()

    def OnChar(self, evt):
        if self.logChar:
            self.GetParent().keylog.LogKeyEvent("Char", evt)


#----------------------------------------------------------------------

class KeyLog(wx.ListCtrl, listmix.ListCtrlAutoWidthMixin):

    def __init__(self, parent):
        wx.ListCtrl.__init__(self, parent, -1,
                            style = wx.LC_REPORT|wx.LC_VRULES|wx.LC_HRULES)
        listmix.ListCtrlAutoWidthMixin.__init__(self)

        self.InsertColumn(0, "Event Type")
        self.InsertColumn(1, "Key Name")
        self.InsertColumn(2, "Key Code")
        self.InsertColumn(3, "Modifiers")
        self.InsertColumn(4, "RawKeyCode")
        self.InsertColumn(5, "RawKeyFlags")
        self.InsertColumn(6, "")

        for x in range(6):
            self.SetColumnWidth(x, wx.LIST_AUTOSIZE_USEHEADER)

        self.SetColumnWidth(1, 125)


    def LogKeyEvent(self, evType, evt):
        keycode = evt.GetKeyCode()
        keyname = keyMap.get(keycode, None)
        if keyname is None:
            if keycode < 256:
                if keycode == 0:
                    keyname = "NUL"
                elif keycode < 27:
                    keyname = "Ctrl-%s" % chr(ord('A') + keycode-1)
                else:
                    keyname = "\"%s\"" % chr(keycode)
            else:
                keyname = "unknown (%s)" % keycode

        modifiers = ""
        for mod, ch in [(evt.ControlDown(), 'C'),
                        (evt.AltDown(),     'A'),
                        (evt.ShiftDown(),   'S'),
                        (evt.MetaDown(),    'M')]:
            if mod:
                modifiers += ch
            else:
                modifiers += '-'

        id = self.InsertStringItem(self.GetItemCount(), evType)
        self.SetStringItem(id, 1, keyname)
        self.SetStringItem(id, 2, str(keycode))
        self.SetStringItem(id, 3, modifiers)
        self.SetStringItem(id, 4, str(evt.GetRawKeyCode()))
        self.SetStringItem(id, 5, str(evt.GetRawKeyFlags()))

        #print ( id, evType, keyname, str(keycode), modifiers, str(evt.GetRawKeyCode()), str(evt.GetRawKeyFlags()))

        self.EnsureVisible(id)


    def ClearLog(self):
        self.DeleteAllItems()


#----------------------------------------------------------------------


class TestPanel(wx.Panel):
    def __init__(self, parent, log):
        self.log = log
        wx.Panel.__init__(self, parent, -1, style=0)
        self.keysink = KeySink(self)
        self.keysink.SetSizeHints((100, 65))
        self.keylog = KeyLog(self)

        btn = wx.Button(self, -1, "Clear Log")
        self.Bind(wx.EVT_BUTTON, self.OnClearBtn, btn)

        cb1 = wx.CheckBox(self, -1, "Call evt.Skip for Key Up/Dn events")
        self.Bind(wx.EVT_CHECKBOX, self.OnSkipCB, cb1)

        cb2 = wx.CheckBox(self, -1, "EVT_KEY_UP")
        self.Bind(wx.EVT_CHECKBOX, self.OnKeyUpCB, cb2)
        cb2.SetValue(True)

        cb3 = wx.CheckBox(self, -1, "EVT_KEY_DOWN")
        self.Bind(wx.EVT_CHECKBOX, self.OnKeyDnCB, cb3)
        cb3.SetValue(True)

        cb4 = wx.CheckBox(self, -1, "EVT_CHAR")
        self.Bind(wx.EVT_CHECKBOX, self.OnCharCB, cb4)
        cb4.SetValue(True)

        buttons = wx.BoxSizer(wx.HORIZONTAL)
        buttons.Add(btn, 0, wx.ALL, 4)
        buttons.Add(cb1, 0, wx.ALIGN_CENTER_VERTICAL|wx.LEFT|wx.RIGHT, 6)
        buttons.Add(cb2, 0, wx.ALIGN_CENTER_VERTICAL|wx.LEFT, 6)
        buttons.Add(cb3, 0, wx.ALIGN_CENTER_VERTICAL|wx.LEFT, 6)
        buttons.Add(cb4, 0, wx.ALIGN_CENTER_VERTICAL|wx.LEFT, 6)

        sizer = wx.BoxSizer(wx.VERTICAL)
        sizer.Add(self.keysink, 0, wx.GROW)
        sizer.Add(buttons)
        sizer.Add(self.keylog, 1, wx.GROW)

        self.SetSizer(sizer)


    def OnClearBtn(self, evt):
        self.keylog.ClearLog()

    def OnSkipCB(self, evt):
        self.keysink.SetCallSkip(evt.GetInt())

    def OnKeyUpCB(self, evt):
        self.keysink.SetLogKeyUp(evt.GetInt())

    def OnKeyDnCB(self, evt):
        self.keysink.SetLogKeyDn(evt.GetInt())

    def OnCharCB(self, evt):
        self.keysink.SetLogChar(evt.GetInt())


#----------------------------------------------------------------------

def runTest(frame, nb, log):
    win = TestPanel(nb, log)
    return win

#----------------------------------------------------------------------



overview = """<html><body>
<h2><center>wxKeyEvents</center></h2>

This demo simply catches all key events and prints info about them.
It is meant to be used as a compatibility test for cross platform work.

</body></html>
"""



if __name__ == '__main__':
    import sys,os
    import run
    run.main(['', os.path.basename(sys.argv[0])] + sys.argv[1:])