unleashed-firmware/applications/services/gui/view_stack.h
Georgii Surkov 7987917d85
[FL-3496, FL-3523, FL-3767, FL-3790] Infrared fixes and more (#3515)
* FL-3496: do not hardcode universal library names in CLI
* FL-3523: remove TODO, no changes necessary
* FL-3767: remove TODO, no changes necessary
* FL-3790: fix laggy TextInput by not adding it into a ViewStack
* Improve documentation
* Fix logical error in documentation

Co-authored-by: あく <alleteam@gmail.com>
2024-03-20 23:54:07 +09:00

64 lines
1.4 KiB
C

/**
* @file view_stack.h
* @brief GUI: ViewStack API
*
* ViewStack accumulates several Views in one stack.
* Draw callbacks are called sequentially starting from
* first added. Input callbacks are called in reverse order.
* Consumed input is not passed on underlying layers.
*
* @warning Views added to a ViewStack MUST NOT be in a ViewDispatcher or a ViewHolder at the same time.
*/
#pragma once
#include <stdbool.h>
#include "view.h"
#ifdef __cplusplus
extern "C" {
#endif
/** ViewStack, anonymous type. */
typedef struct ViewStack ViewStack;
/** Allocate and init ViewStack
*
* @return ViewStack instance
*/
ViewStack* view_stack_alloc(void);
/** Free ViewStack instance
*
* @param view_stack instance
*/
void view_stack_free(ViewStack* view_stack);
/** Get View of ViewStack.
* Should this View to any view manager such as
* ViewDispatcher or ViewHolder.
*
* @param view_stack instance
*/
View* view_stack_get_view(ViewStack* view_stack);
/** Add View to ViewStack.
* Adds View on top of ViewStack.
*
* @param view_stack instance
* @param view view to add
*/
void view_stack_add_view(ViewStack* view_stack, View* view);
/** Remove any View in ViewStack.
* If no View to remove found - ignore.
*
* @param view_stack instance
* @param view view to remove
*/
void view_stack_remove_view(ViewStack* view_stack, View* view);
#ifdef __cplusplus
}
#endif