Wt  4.0.2
Public Member Functions | List of all members
Wt::WKeyEvent Class Reference

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

#include <Wt/WEvent.h>

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...
 

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

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()
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()
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()
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 Fri Nov 24 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11