Wt  3.3.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
Wt::WKeyEvent Class Reference

A class providing details for a keyboard event. More...

#include <Wt/WEvent>

Public Member Functions

 WKeyEvent ()
 Default constructor.
 
Key key () const
 Returns the key code key that was pressed or released. More...
 
WFlags< KeyboardModifiermodifiers () const
 Returns keyboard modifiers. More...
 
int charCode () const
 Returns the unicode character code. More...
 
WString text () const
 The (unicode) text that this key generated. More...
 
int keyCode () const
 Returns the raw key code (deprecated). More...
 
bool altKey () const
 Returns whether the alt key is pressed (deprecated). More...
 
bool metaKey () const
 Returns whether the meta key is pressed (deprecated). More...
 
bool ctrlKey () const
 Returns whether the control key is pressed (deprecated). More...
 
bool shiftKey () const
 Returns whether the shift key is pressed (deprecated). More...
 

Detailed Description

A class providing details for a keyboard event.

A key event is associated with the WInteractWidget::keyWentDown(), WInteractWidget::keyWentUp() and WInteractWidget::keyPressed() signals.

Member Function Documentation

bool Wt::WKeyEvent::altKey ( ) const

Returns whether the alt key is pressed (deprecated).

Deprecated:
Use modifiers() instead.
int Wt::WKeyEvent::charCode ( ) const

Returns the unicode character code.

This is only defined for a keyPressed event, and returns the unicode character code point of a character that is entered.

For the keyWentDown and keyWentUp events, '0' is returned.

The charCode() may be different from key(). For example, a Key_M key may correspond to 'm' or 'M' character, depending on whether the shift key is pressed simultaneously.

See Also
key(), text()
bool Wt::WKeyEvent::ctrlKey ( ) const

Returns whether the control key is pressed (deprecated).

Deprecated:
Use modifiers() instead.
Key Wt::WKeyEvent::key ( ) const

Returns the key code key that was pressed or released.

The key code corresponds to the actual key on the keyboard, rather than the generated character.

All three types of key events provide this information.

See Also
modifiers(), charCode()
int Wt::WKeyEvent::keyCode ( ) const

Returns the raw key code (deprecated).

Deprecated:
The value returned is somewhat browser-specific, and it is therefore recommended to use the key() method instead.
See Also
key()
bool Wt::WKeyEvent::metaKey ( ) const

Returns whether the meta key is pressed (deprecated).

Deprecated:
Use modifiers() instead.
WFlags<KeyboardModifier> Wt::WKeyEvent::modifiers ( ) const

Returns keyboard modifiers.

The result is a logical OR of KeyboardModifier flags.

All three types of key events provide this information.

See Also
key(), charCode()
bool Wt::WKeyEvent::shiftKey ( ) const

Returns whether the shift key is pressed (deprecated).

Deprecated:
Use modifiers() instead.
WString Wt::WKeyEvent::text ( ) const

The (unicode) text that this key generated.

This is only defined for a keyPressed event, and returns a string that holds exactly one unicode character, which corresponds to charCode().

For the keyWentDown and keyWentUp events, an empty string is returned.

See Also
charCode()

Generated on Mon Oct 20 2014 for the C++ Web Toolkit (Wt) by doxygen 1.8.4