DISTRHO Plugin Framework
Public Member Functions | Public Attributes | List of all members
Widget::CharacterInputEvent Struct Reference

#include <Widget.hpp>

Inheritance diagram for Widget::CharacterInputEvent:
Widget::BaseEvent

Public Member Functions

 CharacterInputEvent () noexcept
 
- Public Member Functions inherited from Widget::BaseEvent
 BaseEvent () noexcept
 
virtual ~BaseEvent () noexcept
 

Public Attributes

uint keycode
 
uint character
 
char string [8]
 
- Public Attributes inherited from Widget::BaseEvent
uint mod
 
uint flags
 
uint time
 

Detailed Description

Special keyboard event.

DEPRECATED This used to be part of DPF due to pugl, but now deprecated and simply non-functional. All events go through KeyboardEvent or CharacterInputEvent, use those instead. Character input event.

This event represents text input, usually as the result of a key press. The text is given both as a Unicode character code and a UTF-8 string.

Note that this event is generated by the platform's input system, so there is not necessarily a direct correspondence between text events and physical key presses. For example, with some input methods a sequence of several key presses will generate a single character.

See also
onCharacterInput

Constructor & Destructor Documentation

◆ CharacterInputEvent()

Widget::CharacterInputEvent::CharacterInputEvent ( )
inlinenoexcept

Constructor for default/null values

Member Data Documentation

◆ keycode

uint Widget::CharacterInputEvent::keycode

Raw key code.

◆ character

uint Widget::CharacterInputEvent::character

Unicode character code.

◆ string

char Widget::CharacterInputEvent::string[8]

UTF-8 string.


The documentation for this struct was generated from the following file: