Magnum::Platform::Sdl2Application::TextInputEvent class

Text input event.

Constructors, destructors, conversion operators

TextInputEvent(const TextInputEvent&) deleted
Copying is not allowed.
TextInputEvent(TextInputEvent&&) deleted
Moving is not allowed.

Public functions

auto operator=(const TextInputEvent&) -> TextInputEvent& deleted
Copying is not allowed.
auto operator=(TextInputEvent&&) -> TextInputEvent& deleted
Moving is not allowed.
auto isAccepted() const -> bool
Whether the event is accepted.
void setAccepted(bool accepted = true)
Set event as accepted.
auto text() const -> Containers::ArrayView<const char>
Input text in UTF-8.
auto event() const -> const SDL_Event&
Underlying SDL event.

Function documentation

void Magnum::Platform::Sdl2Application::TextInputEvent::setAccepted(bool accepted = true)

Set event as accepted.

If the event is ignored (i.e., not set as accepted), it might be propagated elsewhere, for example to another screen when using ScreenedApplication. By default is each event ignored and thus propagated.

const SDL_Event& Magnum::Platform::Sdl2Application::TextInputEvent::event() const

Underlying SDL event.

Of type SDL_TEXTINPUT.