首页 > 代码库 > wxPython 键盘事件列表

wxPython 键盘事件列表

 

 

wx.KeyEvent

 

Package wx :: Class KeyEvent
[frames | no frames]

Type KeyEvent

object --+                 |            Object --+                 |             Event --+                 |                KeyEvent

 


This event class contains information about keypress and character events. These events are only sent to the widget that currently has the keyboard focus.

Notice that there are three different kinds of keyboard events in wxWidgets: key down and up events and char events. The difference between the first two is clear - the first corresponds to a key press and the second to a key release - otherwise they are identical. Just note that if the key is maintained in a pressed state you will typically get a lot of (automatically generated) down events but only one up so it is wrong to assume that there is one up event corresponding to each down one.

Both key events provide untranslated key codes while the char event carries the translated one. The untranslated code for alphanumeric keys is always an upper case value. For the other keys it is one of WXK_XXX values from the keycodes table. The translated key is, in general, the character the user expects to appear as the result of the key combination when typing the text into a text entry zone, for example.

A few examples to clarify this (all assume that CAPS LOCK is unpressed and the standard US keyboard): when the ‘A‘ key is pressed, the key down event key code is equal to ASCII A == 65. But the char event key code is ASCII a == 97. On the other hand, if you press both SHIFT and ‘A‘ keys simultaneously , the key code in key down event will still be just ‘A‘ while the char event key code parameter will now be ‘A‘ as well.

Although in this simple case it is clear that the correct key code could be found in the key down event handler by checking the value returned by ShiftDown, in general you should use EVT_CHAR for this as for non alphanumeric keys or non-US keyboard layouts the translation is keyboard-layout dependent and can only be done properly by the system itself.

Another kind of translation is done when the control key is pressed: for example, for CTRL-A key press the key down event still carries the same key code ‘A‘ as usual but the char event will have key code of 1, the ASCII value of this key combination.

You may discover how the other keys on your system behave interactively by running the KeyEvents sample in the wxPython demo and pressing some keys while the blue box at the top has the keyboard focus.

Note: If a key down event is caught and the event handler does not call event.Skip() then the coresponding char event will not happen. This is by design and enables the programs that handle both types of events to be a bit simpler.

Note for Windows programmers: The key and char events in wxWidgets are similar to but slightly different from Windows WM_KEYDOWN and WM_CHAR events. In particular, Alt-x combination will generate a char event in wxWidgets (unless it is used as an accelerator).

Tip: be sure to call event.Skip() for events that you don‘t process in key event function, otherwise menu shortcuts may cease to work under Windows.

Events

wx.EVT_KEY_DOWNSent when a keyboard key has been pressed
wx.EVT_KEY_UPSent when a keyboard key has been released
wx.EVT_CHARSent for translated character events.

Keycode Table

WXK_BACKWXK_EXECUTEWXK_F1WXK_NUMPAD_SPACEWXK_WINDOWS_LEFT
WXK_TABWXK_SNAPSHOTWXK_F2WXK_NUMPAD_TABWXK_WINDOWS_RIGHT
WXK_RETURNWXK_INSERTWXK_F3WXK_NUMPAD_ENTERWXK_WINDOWS_MENU
WXK_ESCAPEWXK_HELPWXK_F4WXK_NUMPAD_F1WXK_SPECIAL1
WXK_SPACEWXK_NUMPAD0WXK_F5WXK_NUMPAD_F2WXK_SPECIAL2
WXK_DELETEWXK_NUMPAD1WXK_F6WXK_NUMPAD_F3WXK_SPECIAL3
WXK_LBUTTONWXK_NUMPAD2WXK_F7WXK_NUMPAD_F4WXK_SPECIAL4
WXK_RBUTTONWXK_NUMPAD3WXK_F8WXK_NUMPAD_HOMEWXK_SPECIAL5
WXK_CANCELWXK_NUMPAD4WXK_F9WXK_NUMPAD_LEFTWXK_SPECIAL6
WXK_MBUTTONWXK_NUMPAD5WXK_F10WXK_NUMPAD_UPWXK_SPECIAL7
WXK_CLEARWXK_NUMPAD6WXK_F11WXK_NUMPAD_RIGHTWXK_SPECIAL8
WXK_SHIFTWXK_NUMPAD7WXK_F12WXK_NUMPAD_DOWNWXK_SPECIAL9
WXK_ALTWXK_NUMPAD8WXK_F13WXK_NUMPAD_PRIORWXK_SPECIAL10
WXK_CONTROLWXK_NUMPAD9WXK_F14WXK_NUMPAD_PAGEUPWXK_SPECIAL11
WXK_MENUWXK_MULTIPLYWXK_F15WXK_NUMPAD_NEXTWXK_SPECIAL12
WXK_PAUSEWXK_ADDWXK_F16WXK_NUMPAD_PAGEDOWNWXK_SPECIAL13
WXK_CAPITALWXK_SEPARATORWXK_F17WXK_NUMPAD_ENDWXK_SPECIAL14
WXK_PRIORWXK_SUBTRACTWXK_F18WXK_NUMPAD_BEGINWXK_SPECIAL15
WXK_NEXTWXK_DECIMALWXK_F19WXK_NUMPAD_INSERTWXK_SPECIAL16
WXK_ENDWXK_DIVIDEWXK_F20WXK_NUMPAD_DELETEWXK_SPECIAL17
WXK_HOMEWXK_NUMLOCKWXK_F21WXK_NUMPAD_EQUALWXK_SPECIAL18
WXK_LEFTWXK_SCROLLWXK_F22WXK_NUMPAD_MULTIPLYWXK_SPECIAL19
WXK_UPWXK_PAGEUPWXK_F23WXK_NUMPAD_ADDWXK_SPECIAL20
WXK_RIGHTWXK_PAGEDOWNWXK_F24WXK_NUMPAD_SEPARATOR 
WXK_DOWN  WXK_NUMPAD_SUBTRACT 
WXK_SELECT  WXK_NUMPAD_DECIMAL 
WXK_PRINT  WXK_NUMPAD_DIVIDE 

 

Method Summary
KeyEvent__init__(self, eventType)
boolAltDown(self)
Returns True if the Alt key was down at the time of the event.
boolCmdDown(self)
"Cmd" is a pseudo key which is the same as Control for PC and Unixplatforms but the special "Apple" (a.k.a as "Command") key onMacs.
boolControlDown(self)
Returns True if the Control key was down at the time of the event.
intGetKeyCode(self)
Returns the virtual key code.
intGetModifiers(self)
Returns a bitmask of the current modifier settings.
PointGetPosition(self)
Find the position of the event, if applicable.
(x,y)GetPositionTuple()
Find the position of the event, if applicable.
unsigned intGetRawKeyCode(self)
Returns the raw key code for this event.
unsigned intGetRawKeyFlags(self)
Returns the low level key flags for this event.
intGetUniChar(self)
Returns the Unicode character corresponding to this key event.
intGetUnicodeKey(self)
Returns the Unicode character corresponding to this key event.
intGetX(self)
Returns the X position (in client coordinates) of the event, ifapplicable.
intGetY(self)
Returns the Y position (in client coordinates) of the event, ifapplicable.
boolHasModifiers(self)
Returns true if either CTRL or ALT keys was down at the time of thekey event.
boolMetaDown(self)
Returns True if the Meta key was down at the time of the event.
 SetUnicodeKey(self, uniChar)
Set the Unicode value of the key event, but only if this is a Unicodebuild of wxPython.
boolShiftDown(self)
Returns True if the Shift key was down at the time of the event.


 

 

Property Summary
 KeyCode: See GetKeyCode
 m_altDown
 m_controlDown
 m_keyCode
 m_metaDown
 m_rawCode
 m_rawFlags
 m_scanCode
 m_shiftDown
 m_x
 m_y
 Modifiers: See GetModifiers
 Position: See GetPosition
 RawKeyCode: See GetRawKeyCode
 RawKeyFlags: See GetRawKeyFlags
 thisown: The membership flag
 UnicodeKey: See GetUnicodeKey and SetUnicodeKey
 X: See GetX
 Y: See GetY


 

 

Method Details

__init__(self, eventType=wxEVT_NULL)
(Constructor)

Construct a new wx.KeyEvent. Valid event types are:
Parameters:
eventType
           (type=EventType)

 

Returns:
KeyEvent
Overrides:
wx.Event.__init__

AltDown(self)

Returns True if the Alt key was down at the time of the event.

Returns:
bool

CmdDown(self)

"Cmd" is a pseudo key which is the same as Control for PC and Unixplatforms but the special "Apple" (a.k.a as "Command") key onMacs. It makes often sense to use it instead of, say, ControlDownbecause Cmd key is used for the same thing under Mac as Ctrlelsewhere. The Ctrl still exists, it‘s just not used for thispurpose. So for non-Mac platforms this is the same as ControlDownand Macs this is the same as MetaDown.

Returns:
bool

ControlDown(self)

Returns True if the Control key was down at the time of the event.

Returns:
bool

GetKeyCode(self)

Returns the virtual key code. ASCII events return normal ASCII values,while non-ASCII events return values such as WXK_LEFT for the leftcursor key. See wx.KeyEvent for a full list of the virtual keycodes.

Note that in Unicode build, the returned value is meaningful only ifthe user entered a character that can be represented in currentlocale‘s default charset. You can obtain the corresponding Unicodecharacter using GetUnicodeKey.

Returns:
int

GetModifiers(self)

Returns a bitmask of the current modifier settings. Can be used tocheck if the key event has exactly the given modifiers without havingto explicitly check that the other modifiers are not down. Forexample:

if event.GetModifers() == wx.MOD_CONTROL:    DoSomething()
Returns:
int

GetPosition(self)

Find the position of the event, if applicable.

Returns:
Point

GetPositionTuple()

Find the position of the event, if applicable.

Returns:
(x,y)

GetRawKeyCode(self)

Returns the raw key code for this event. This is a platform-dependent scan code which should only be used in advanced applications. Currently the raw key codes are not supported by all ports.

Returns:
unsigned int

GetRawKeyFlags(self)

Returns the low level key flags for this event. The flags are platform-dependent and should only be used in advanced applications. Currently the raw key flags are not supported by all ports.

Returns:
unsigned int

GetUniChar(self)

Returns the Unicode character corresponding to this key event. This function is only meaningfule in a Unicode build of wxPython.

Returns:
int

GetUnicodeKey(self)

Returns the Unicode character corresponding to this key event. This function is only meaningfule in a Unicode build of wxPython.

Returns:
int

GetX(self)

Returns the X position (in client coordinates) of the event, if applicable.

Returns:
int

GetY(self)

Returns the Y position (in client coordinates) of the event, if applicable.

Returns:
int

HasModifiers(self)

Returns true if either CTRL or ALT keys was down at the time of the key event. Note that this function does not take into account neither SHIFT nor META key states (the reason for ignoring the latter is that it is common for NUMLOCK key to be configured as META under X but the key presses even while NUMLOCK is on should be still processed normally).

Returns:
bool

MetaDown(self)

Returns True if the Meta key was down at the time of the event.

Returns:
bool

SetUnicodeKey(self, uniChar)

Set the Unicode value of the key event, but only if this is a Unicode build of wxPython.

Parameters:
uniChar
           (type=int)

 

ShiftDown(self)

Returns True if the Shift key was down at the time of the event.

Returns:
bool


 

 

Property Details

KeyCode

See GetKeyCode

Get Method:
GetKeyCode(self)

Modifiers

See GetModifiers

Get Method:
GetModifiers(self)

Position

See GetPosition

Get Method:
GetPosition(self)

RawKeyCode

See GetRawKeyCode

Get Method:
GetRawKeyCode(self)

RawKeyFlags

See GetRawKeyFlags

Get Method:
GetRawKeyFlags(self)

thisown

The membership flag

UnicodeKey

See GetUnicodeKey and SetUnicodeKey

Get Method:
GetUnicodeKey(self)
Set Method:
SetUnicodeKey(self, uniChar)

X

See GetX

Get Method:
GetX(self)

Y

See GetY

Get Method:
GetY(self)


 

 

Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:52:31 2009http://epydoc.sf.net