docs/html/ui__control__event_8h_source.html

#pragma once


enum class UIControlEvent

{


    NONE,

    PUSH,

    DOUBLE_PUSH,

    LONG_PUSH,

    RELEASED_AFTER_LONG_TIME,

    RELEASED_AFTER_SHORT_TIME,

    INCREMENT,

    DECREMENT,

    TIME_OUT

};


struct struct_ControlEventData

{

    UIControlEvent event;

    int gpio_number;

};


enum class ControlledObjectStatus

{

    IS_IDLE,

    IS_WAITING,


    HAS_FOCUS,


    IS_ACTIVE

};


enum class ControlledObjectStatusTimeOutReason

{

    NO_TIME_OUT,

    MANAGER_INACTIVE,

    MANAGED_OBJECT_INACTIVE

};


struct_ControlEventData
this is the structure used to transmit control event through a RTOS queue
Definition ui_control_event.h:46

struct_ControlEventData::gpio_number
int gpio_number
the gpio that receive the IRQ
Definition ui_control_event.h:50

struct_ControlEventData::event
UIControlEvent event
the control event computed by the IRQ processing task
Definition ui_control_event.h:48

ControlledObjectStatusTimeOutReason
ControlledObjectStatusTimeOutReason
The list of reason of manager time out report. (0) NO_TIME_OUT (1) MANAGER_INACTIVE (3) MANAGED_OBJEC...
Definition ui_control_event.h:76

ControlledObjectStatusTimeOutReason::NO_TIME_OUT
@ NO_TIME_OUT
no time out
Definition ui_control_event.h:78

ControlledObjectStatusTimeOutReason::MANAGER_INACTIVE
@ MANAGER_INACTIVE
The object is inactive, nothing to do.
Definition ui_control_event.h:80

ControlledObjectStatusTimeOutReason::MANAGED_OBJECT_INACTIVE
@ MANAGED_OBJECT_INACTIVE
The widget or object manager is pointing to this model.
Definition ui_control_event.h:82

UIControlEvent
UIControlEvent
The list of predefined events that a button, or more generally an User Interface Controller,...
Definition ui_control_event.h:18

UIControlEvent::LONG_PUSH
@ LONG_PUSH
event triggered when a button is held more than a configurable duration.
Definition ui_control_event.h:28

UIControlEvent::PUSH
@ PUSH
event triggered when a button is pushed
Definition ui_control_event.h:23

UIControlEvent::DOUBLE_PUSH
@ DOUBLE_PUSH
event triggered when a button is double-pushed
Definition ui_control_event.h:26

UIControlEvent::INCREMENT
@ INCREMENT
event that signals the user trig an increment order.
Definition ui_control_event.h:34

UIControlEvent::TIME_OUT
@ TIME_OUT
event that signals nothing happens after a configurable period of time.
Definition ui_control_event.h:38

UIControlEvent::NONE
@ NONE
null event, no operation expected.
Definition ui_control_event.h:21

UIControlEvent::DECREMENT
@ DECREMENT
event that signals the user trig an decrement order.
Definition ui_control_event.h:36

UIControlEvent::RELEASED_AFTER_SHORT_TIME
@ RELEASED_AFTER_SHORT_TIME
event triggered when a button is released before a configurable duration.
Definition ui_control_event.h:32

UIControlEvent::RELEASED_AFTER_LONG_TIME
@ RELEASED_AFTER_LONG_TIME
event triggered when a button is released after a configurable duration.
Definition ui_control_event.h:30

ControlledObjectStatus
ControlledObjectStatus
The list of status that a Model can have. (0) IS_WAITING (1) HAS_FOCUS (2) IS_ACTIVE.
Definition ui_control_event.h:58

ControlledObjectStatus::IS_WAITING
@ IS_WAITING
the object has done its job and is waiting for the next activation
Definition ui_control_event.h:62

ControlledObjectStatus::IS_ACTIVE
@ IS_ACTIVE
The user has selected (clicked) on this model. ControlEvent are then passed to this model in order to...
Definition ui_control_event.h:68

ControlledObjectStatus::HAS_FOCUS
@ HAS_FOCUS
The widget or object manager is pointing to this model.
Definition ui_control_event.h:65

ControlledObjectStatus::IS_IDLE
@ IS_IDLE
The object is in idle state, waiting to be activated.
Definition ui_control_event.h:60