unleashed-firmware/applications/main/infrared/views/infrared_progress_view.h

/**
  * @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

/** Anonymous 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