guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
guillaume::systems::TextInput Class Reference

Adds typed text to editable text. More...

#include <headers/guillaume/systems/text_input.hpp>

Inheritance diagram for guillaume::systems::TextInput:
Collaboration diagram for guillaume::systems::TextInput:

Public Member Functions

 TextInput (event::EventBus &eventBus)
 Create the system, in the Event phase, and subscribe it to text input events.
 ~TextInput (void)=default
 Default destructor.
void prepare (void) override
 Take the next pending text input event, once per frame.
void cleanup (void) override
 Does nothing.
virtual void update (const ecs::Entity::Identifier &entityIdentifier) override
 Append the text of the current text input event to the content of one entity.
Public Member Functions inherited from guillaume::ecs::SystemFiller< components::Text, components::Focus >
 SystemFiller (Phase phase)
 Create the system and set its signature from ComponentTypes.
virtual ~SystemFiller (void)=default
 Virtual destructor.
Public Member Functions inherited from guillaume::ecs::System
 System (Phase phase)
 Create a system that runs in a given phase, with an empty signature.
virtual ~System (void)=default
 Virtual destructor.
Phase getPhase (void) const noexcept
 Get the phase of the frame in which the system runs.
Entity::Signature getSignature (void) const noexcept
 Get the component types an entity must declare to be visited by this system.
void routine (ecs::ComponentRegistry &componentRegistry, ecs::EntityRegistry &entityRegistry, const ecs::EntityTreeTraveler &traveler)
 Run the system once over a scene: prepare(), update() on each matching entity, cleanup().
void bindComponentRegistry (ecs::ComponentRegistry &componentRegistry)
 Bind a component registry so update() can be called directly, without routine().
void unbindComponentRegistry (void)
 Drop the binding made by bindComponentRegistry().
Public Member Functions inherited from guillaume::event::EventManager< utility::event::TextInputEvent >
 EventManager (EventBus &eventBus)
 Subscribe to a bus; events of type EventType published after this call are queued.
virtual ~EventManager (void)=default
 Virtual destructor.
bool hasPendingEvents (void) const
 Tell whether at least one event is queued, waiting for consumeNextEvent().

Additional Inherited Members

Protected Member Functions inherited from guillaume::ecs::System
template<InheritFromComponent... ComponentTypes>
void setSignature (void)
 Replace the signature by the one made of the given component types.
ecs::EntityRegistry & getEntityRegistry (void)
 Get the entity registry of the scene being processed.
const ecs::EntityRegistry & getEntityRegistry (void) const
 Get the entity registry of the scene being processed, read-only.
ecs::ComponentRegistry & getComponentRegistry (void)
 Get the component registry of the scene being processed.
const ecs::ComponentRegistry & getComponentRegistry (void) const
 Get the component registry of the scene being processed, read-only.
template<InheritFromComponent ComponentType>
bool hasComponent (const ecs::Entity::Identifier &entityIdentifier) const
 Tell whether an entity has a component, in the bound registry.
template<InheritFromComponent ComponentType>
ComponentType & getComponent (const ecs::Entity::Identifier &entityIdentifier)
 Get a component of an entity from the bound registry, to read or modify it.
template<InheritFromComponent ComponentType>
const ComponentType & getComponent (const ecs::Entity::Identifier &entityIdentifier) const
 Get a component of an entity from the bound registry, read-only.
template<InheritFromComponent ComponentType>
bool requireComponent (const ecs::Entity::Identifier &entityIdentifier)
 Tell whether an entity has a component, and log a warning naming the entity and the component when it does not.
Protected Member Functions inherited from guillaume::event::EventManager< utility::event::TextInputEvent >
void consumeNextEvent (void)
 Take the oldest queued event and make it the last event.
std::shared_ptr< EventType > getLastEvent (void)
 Get the event taken by the most recent consumeNextEvent() that found one.

Detailed Description

Adds typed text to editable text.

Runs in the Event phase on entities that have a components::Text and a components::Focus. It reads the text of the current text input event (the characters committed by the keyboard or the input method) and appends it to the content of components::Text.

Note
The text is appended at the end of the content, whatever the cursor position.
The components::Focus is only required to be present: the system does not test whether the entity is the focused one, so every matching entity receives the text.
See also
components::Text
systems::KeyboardControl

Definition at line 55 of file text_input.hpp.

Constructor & Destructor Documentation

◆ TextInput()

guillaume::systems::TextInput::TextInput ( event::EventBus & eventBus)

Create the system, in the Event phase, and subscribe it to text input events.

Parameters
eventBusThe event bus delivering the text input events.

Definition at line 28 of file text_input.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ cleanup()

void guillaume::systems::TextInput::cleanup ( void )
overridevirtual

Does nothing.

Reimplemented from guillaume::ecs::System.

Definition at line 40 of file text_input.cpp.

◆ prepare()

void guillaume::systems::TextInput::prepare ( void )
overridevirtual

Take the next pending text input event, once per frame.

When none is pending, the previous event stays the current one.

Reimplemented from guillaume::ecs::System.

Definition at line 35 of file text_input.cpp.

Here is the call graph for this function:

◆ update()

void guillaume::systems::TextInput::update ( const ecs::Entity::Identifier & entityIdentifier)
overridevirtual

Append the text of the current text input event to the content of one entity.

Parameters
entityIdentifierThe entity holding the components::Text.

Implements guillaume::ecs::System.

Definition at line 44 of file text_input.cpp.

Here is the call graph for this function:

The documentation for this class was generated from the following files: