mirror of
https://github.com/DarkFlippers/unleashed-firmware
synced 2024-11-28 07:20:29 +00:00
052237f8c9
* IR: Doxygen docs, some rename * Rename irda -> infrared * Rollback collateral renames Co-authored-by: あく <alleteam@gmail.com>
68 lines
1.7 KiB
C
68 lines
1.7 KiB
C
/**
|
|
* @file infrared_progress_view.h
|
|
* Infrared: Custom Infrared view module.
|
|
* It shows popup progress bar during brute force.
|
|
*/
|
|
#pragma once
|
|
#include <gui/view.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Anonumous instance */
|
|
typedef struct InfraredProgressView InfraredProgressView;
|
|
|
|
/** Callback for back button handling */
|
|
typedef void (*InfraredProgressViewBackCallback)(void*);
|
|
|
|
/** Allocate and initialize Infrared view
|
|
*
|
|
* @retval new allocated instance
|
|
*/
|
|
InfraredProgressView* infrared_progress_view_alloc();
|
|
|
|
/** Free previously allocated Progress view module instance
|
|
*
|
|
* @param instance to free
|
|
*/
|
|
void infrared_progress_view_free(InfraredProgressView* instance);
|
|
|
|
/** Get progress view module view
|
|
*
|
|
* @param instance view module
|
|
* @retval view
|
|
*/
|
|
View* infrared_progress_view_get_view(InfraredProgressView* instance);
|
|
|
|
/** Increase progress on progress view module
|
|
*
|
|
* @param instance view module
|
|
* @retval true - value is incremented and maximum is reached,
|
|
* false - value is incremented and maximum is not reached
|
|
*/
|
|
bool infrared_progress_view_increase_progress(InfraredProgressView* instance);
|
|
|
|
/** Set maximum progress value
|
|
*
|
|
* @param instance - view module
|
|
* @param progress_max - maximum value of progress
|
|
*/
|
|
void infrared_progress_view_set_progress_total(
|
|
InfraredProgressView* instance,
|
|
uint16_t progress_max);
|
|
|
|
/** Set back button callback
|
|
*
|
|
* @param instance - view module
|
|
* @param callback - callback to call for back button
|
|
* @param context - context to pass to callback
|
|
*/
|
|
void infrared_progress_view_set_back_callback(
|
|
InfraredProgressView* instance,
|
|
InfraredProgressViewBackCallback callback,
|
|
void* context);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|