Package pyHook :: Module HookManager :: Class KeyboardEvent
[show private | hide private]
[frames | no frames]

Type KeyboardEvent

object --+    
         |    
 HookEvent --+
             |
            KeyboardEvent


Holds information about a mouse event.
Method Summary
  __init__(self, msg, vk_code, scan_code, ascii, flags, time, hwnd, window_name)
Initializes an instances of the class.
string GetKey(self)
Return name of the virtual keycode
boolean IsAlt(self)
Return was the alt key depressed?
boolean IsExtended(self)
Return is this an extended key?
boolean IsInjected(self)
Return was this event generated programmatically?
boolean IsTransition(self)
Return is this a transition from up to down or vice versa?
Inherited from HookEvent: GetMessageName
Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Property Summary
  Alt
  Extended
  Injected
  Key
  Transition
Inherited from HookEvent: MessageName

Instance Variable Summary
string Ascii: ASCII value, if one exists
integer KeyID: Virtual key code
integer ScanCode: Scan code
Inherited from HookEvent: Message, Time, Window, WindowName

Method Details

__init__(self, msg, vk_code, scan_code, ascii, flags, time, hwnd, window_name)
(Constructor)

Initializes an instances of the class.
Overrides:
pyHook.HookManager.HookEvent.__init__

GetKey(self)

Returns:
Name of the virtual keycode
           (type=string)

IsAlt(self)

Returns:
Was the alt key depressed?
           (type=boolean)

IsExtended(self)

Returns:
Is this an extended key?
           (type=boolean)

IsInjected(self)

Returns:
Was this event generated programmatically?
           (type=boolean)

IsTransition(self)

Returns:
Is this a transition from up to down or vice versa?
           (type=boolean)

Property Details

Alt

Get Method:
IsAlt(self)

Extended

Get Method:
IsExtended(self)

Injected

Get Method:
IsInjected(self)

Key

Get Method:
GetKey(self)

Transition

Get Method:
IsTransition(self)

Instance Variable Details

Ascii

ASCII value, if one exists
Type:
string

KeyID

Virtual key code
Type:
integer

ScanCode

Scan code
Type:
integer

Generated by Epydoc 2.1 on Wed Feb 23 16:53:22 2005 http://epydoc.sf.net