ui_control_event.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	struct_ControlEventData
	this is the structure used to transmit control event through a RTOS queue More...

Enumerations
enum class	UIControlEvent {   NONE , PUSH , DOUBLE_PUSH , LONG_PUSH ,   RELEASED_AFTER_LONG_TIME , RELEASED_AFTER_SHORT_TIME , INCREMENT , DECREMENT ,   TIME_OUT }
	The list of predefined events that a button, or more generally an User Interface Controller, can return, leaving to the application the responsibility to act as required by its specification. More...
enum class	ControlledObjectStatus { IS_IDLE , IS_WAITING , HAS_FOCUS , IS_ACTIVE }
	The list of status that a Model can have. (0) IS_WAITING (1) HAS_FOCUS (2) IS_ACTIVE. More...
enum class	ControlledObjectStatusTimeOutReason { NO_TIME_OUT , MANAGER_INACTIVE , MANAGED_OBJECT_INACTIVE }
	The list of reason of manager time out report. (0) NO_TIME_OUT (1) MANAGER_INACTIVE (3) MANAGED_OBJECT_INACTIVE. More...

Detailed Description

Author

xiansnn (xians.nosp@m.nn@h.nosp@m.otmai.nosp@m.l.co.nosp@m.m)

Version

0.1

Date

2025-01-11

Copyright

Copyright (c) 2025

Enumeration Type Documentation

ControlledObjectStatus

enum class ControlledObjectStatus

strong

The list of status that a Model can have. (0) IS_WAITING (1) HAS_FOCUS (2) IS_ACTIVE.

Enumerator
IS_IDLE	The object is in idle state, waiting to be activated.
IS_WAITING	the object has done its job and is waiting for the next activation
HAS_FOCUS	The widget or object manager is pointing to this model.
IS_ACTIVE	The user has selected (clicked) on this model. ControlEvent are then passed to this model in order to be processed.

ControlledObjectStatusTimeOutReason

enum class ControlledObjectStatusTimeOutReason

strong

The list of reason of manager time out report. (0) NO_TIME_OUT (1) MANAGER_INACTIVE (3) MANAGED_OBJECT_INACTIVE.

Enumerator
NO_TIME_OUT	no time out
MANAGER_INACTIVE	The object is inactive, nothing to do.
MANAGED_OBJECT_INACTIVE	The widget or object manager is pointing to this model.

UIControlEvent

enum class UIControlEvent

strong

The list of predefined events that a button, or more generally an User Interface Controller, can return, leaving to the application the responsibility to act as required by its specification.

Enumerator
NONE	null event, no operation expected.
PUSH	event triggered when a button is pushed
DOUBLE_PUSH	event triggered when a button is double-pushed Todo Not implemented. To find a way to do "DOUBLE_PUSH"
LONG_PUSH	event triggered when a button is held more than a configurable duration.
RELEASED_AFTER_LONG_TIME	event triggered when a button is released after a configurable duration.
RELEASED_AFTER_SHORT_TIME	event triggered when a button is released before a configurable duration.
INCREMENT	event that signals the user trig an increment order.
DECREMENT	event that signals the user trig an decrement order.
TIME_OUT	event that signals nothing happens after a configurable period of time.