mirror of
https://github.com/DarkFlippers/unleashed-firmware
synced 2024-11-26 22:40:25 +00:00
ee36c66572
* fbt: doxygen target * github: adjustments for doxygen * github: always generate docs, only upload for dev * doxygen: fixed exclusion path for awesome-css * github: stricter check for push ref * github: bumped action version to fix node.js deprecation * github: added PVS report url to workflow summary * github: pvs: reworked report URL handling * github: added size report to summary * docs: added `doxygen` target * fbt: common naming scheme for COMSTR * Documentation: fix warnings and errors * Doxygen: stricter warning checks * fbt: "doxy" target, opens generated doxygen documentation in browser * github: doxygen: now using edge (1.10) version Co-authored-by: あく <alleteam@gmail.com>
105 lines
2.2 KiB
C
105 lines
2.2 KiB
C
/**
|
|
* @file view_holder.h
|
|
* @brief GUI: ViewHolder API
|
|
*
|
|
* @warning View added to a ViewHolder MUST NOT be in a ViewStack at the same time.
|
|
*/
|
|
#pragma once
|
|
|
|
#include <gui/view.h>
|
|
#include <gui/gui.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef struct ViewHolder ViewHolder;
|
|
|
|
/**
|
|
* @brief Free callback type
|
|
*/
|
|
typedef void (*FreeCallback)(void* free_context);
|
|
|
|
/**
|
|
* @brief Back callback type
|
|
* @warning comes from GUI thread
|
|
*/
|
|
typedef void (*BackCallback)(void* back_context);
|
|
|
|
/**
|
|
* @brief Allocate ViewHolder
|
|
* @return pointer to ViewHolder instance
|
|
*/
|
|
ViewHolder* view_holder_alloc(void);
|
|
|
|
/**
|
|
* @brief Free ViewHolder and call Free callback
|
|
* @param view_holder pointer to ViewHolder
|
|
*/
|
|
void view_holder_free(ViewHolder* view_holder);
|
|
|
|
/**
|
|
* @brief Set view for ViewHolder
|
|
*
|
|
* @param view_holder ViewHolder instance
|
|
* @param view View instance
|
|
*/
|
|
void view_holder_set_view(ViewHolder* view_holder, View* view);
|
|
|
|
/**
|
|
* @brief Set Free callback
|
|
*
|
|
* @param view_holder ViewHolder instance
|
|
* @param free_callback callback pointer
|
|
* @param free_context callback context
|
|
*/
|
|
void view_holder_set_free_callback(
|
|
ViewHolder* view_holder,
|
|
FreeCallback free_callback,
|
|
void* free_context);
|
|
|
|
/**
|
|
* @brief Free callback context getter. Useful if your Free callback is a module destructor, so you can get an instance of the module using this method.
|
|
*
|
|
* @param view_holder ViewHolder instance
|
|
* @return void* free callback context
|
|
*/
|
|
void* view_holder_get_free_context(ViewHolder* view_holder);
|
|
|
|
void view_holder_set_back_callback(
|
|
ViewHolder* view_holder,
|
|
BackCallback back_callback,
|
|
void* back_context);
|
|
|
|
/**
|
|
* @brief Attach ViewHolder to GUI
|
|
*
|
|
* @param view_holder ViewHolder instance
|
|
* @param gui GUI instance to attach to
|
|
*/
|
|
void view_holder_attach_to_gui(ViewHolder* view_holder, Gui* gui);
|
|
|
|
/**
|
|
* @brief Enable view processing
|
|
*
|
|
* @param view_holder
|
|
*/
|
|
void view_holder_start(ViewHolder* view_holder);
|
|
|
|
/**
|
|
* @brief Disable view processing
|
|
*
|
|
* @param view_holder
|
|
*/
|
|
void view_holder_stop(ViewHolder* view_holder);
|
|
|
|
/** View Update Handler
|
|
*
|
|
* @param view View Instance
|
|
* @param context ViewHolder instance
|
|
*/
|
|
void view_holder_update(View* view, void* context);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|