unleashed-firmware/applications/services/gui/modules/dialog_ex.h
Maksim Derbasov e121e6a287
Fix for spelling ()
* Fix for spelling
* Review iteration

Co-authored-by: あく <alleteam@gmail.com>
2022-11-29 01:51:51 +09:00

168 lines
4.1 KiB
C

/**
* @file dialog_ex.h
* GUI: DialogEx view module API
*/
#pragma once
#include <gui/view.h>
#ifdef __cplusplus
extern "C" {
#endif
/** Dialog anonymous structure */
typedef struct DialogEx DialogEx;
/** DialogEx result */
typedef enum {
DialogExResultLeft,
DialogExResultCenter,
DialogExResultRight,
DialogExPressLeft,
DialogExPressCenter,
DialogExPressRight,
DialogExReleaseLeft,
DialogExReleaseCenter,
DialogExReleaseRight,
} DialogExResult;
/** DialogEx result callback type
* @warning comes from GUI thread
*/
typedef void (*DialogExResultCallback)(DialogExResult result, void* context);
/** Allocate and initialize dialog
*
* This dialog used to ask simple questions
*
* @return DialogEx instance
*/
DialogEx* dialog_ex_alloc();
/** Deinitialize and free dialog
*
* @param dialog_ex DialogEx instance
*/
void dialog_ex_free(DialogEx* dialog_ex);
/** Get dialog view
*
* @param dialog_ex DialogEx instance
*
* @return View instance that can be used for embedding
*/
View* dialog_ex_get_view(DialogEx* dialog_ex);
/** Set dialog result callback
*
* @param dialog_ex DialogEx instance
* @param callback result callback function
*/
void dialog_ex_set_result_callback(DialogEx* dialog_ex, DialogExResultCallback callback);
/** Set dialog context
*
* @param dialog_ex DialogEx instance
* @param context context pointer, will be passed to result callback
*/
void dialog_ex_set_context(DialogEx* dialog_ex, void* context);
/** Set dialog header text
*
* If text is null, dialog header will not be rendered
*
* @param dialog_ex DialogEx instance
* @param text text to be shown, can be multiline
* @param x x position
* @param y y position
* @param horizontal horizontal text alignment
* @param vertical vertical text alignment
*/
void dialog_ex_set_header(
DialogEx* dialog_ex,
const char* text,
uint8_t x,
uint8_t y,
Align horizontal,
Align vertical);
/** Set dialog text
*
* If text is null, dialog text will not be rendered
*
* @param dialog_ex DialogEx instance
* @param text text to be shown, can be multiline
* @param x x position
* @param y y position
* @param horizontal horizontal text alignment
* @param vertical vertical text alignment
*/
void dialog_ex_set_text(
DialogEx* dialog_ex,
const char* text,
uint8_t x,
uint8_t y,
Align horizontal,
Align vertical);
/** Set dialog icon
*
* If x or y is negative, dialog icon will not be rendered
*
* @param dialog_ex DialogEx instance
* @param x x position
* @param y y position
* @param icon The icon
* @param name icon to be shown
*/
void dialog_ex_set_icon(DialogEx* dialog_ex, uint8_t x, uint8_t y, const Icon* icon);
/** Set left button text
*
* If text is null, left button will not be rendered and processed
*
* @param dialog_ex DialogEx instance
* @param text text to be shown
*/
void dialog_ex_set_left_button_text(DialogEx* dialog_ex, const char* text);
/** Set center button text
*
* If text is null, center button will not be rendered and processed
*
* @param dialog_ex DialogEx instance
* @param text text to be shown
*/
void dialog_ex_set_center_button_text(DialogEx* dialog_ex, const char* text);
/** Set right button text
*
* If text is null, right button will not be rendered and processed
*
* @param dialog_ex DialogEx instance
* @param text text to be shown
*/
void dialog_ex_set_right_button_text(DialogEx* dialog_ex, const char* text);
/** Clean dialog
*
* @param dialog_ex DialogEx instance
*/
void dialog_ex_reset(DialogEx* dialog_ex);
/** Enable press/release events
*
* @param dialog_ex DialogEx instance
*/
void dialog_ex_enable_extended_events(DialogEx* dialog_ex);
/** Disable press/release events
*
* @param dialog_ex DialogEx instance
*/
void dialog_ex_disable_extended_events(DialogEx* dialog_ex);
#ifdef __cplusplus
}
#endif