rcbench/api/ui__setting__keypad_8h_source.html

#pragma once


#include <stdbool.h>

#include <stddef.h>


#include "gfx.h"

#include "settings.h"

#include "ui_keypad.h"


#ifdef __cplusplus

extern "C" {

#endif


int ui_setting_keypad_decimals(setting_id_t id);


bool ui_setting_keypad_offered(setting_id_t id);


bool ui_setting_keypad_signed(setting_id_t id);


void ui_setting_keypad_open(ui_keypad_t *k, gfx_rect_t area, setting_id_t id);


bool ui_setting_keypad_takes(setting_id_t id, float v);


const char *ui_setting_keypad_sda_pins(char *buf, size_t n);


const char *ui_setting_keypad_tap_pins(char *buf, size_t n);


const char *ui_setting_keypad_why(setting_id_t id, float v, char *buf,

                                  size_t n);


typedef enum {

    UI_SETKEY_SET = 0,

    UI_SETKEY_REFUSED,

    UI_SETKEY_LOCKED,

} ui_setkey_result_t;


ui_setkey_result_t ui_setting_keypad_ok(ui_keypad_t *k, setting_id_t id,

                                        float v);


#ifdef __cplusplus

}

#endif

gfx.h
gfx: an RGB565 (16-bit red, green, blue) rasteriser with no dependencies.

k
#define k
Short name for kst_panel_k inside the overlay's seven files.
Definition kst_panel_int.h:238

settings.h
Device settings: a typed schema, a value per entry, and a persistence seam.

setting_id_t
setting_id_t
Every setting's id, in schema order.
Definition settings.h:67

gfx_rect_t
Definition gfx.h:81

ui_keypad_t
A numeric keypad: what it was opened with, what is typed, and the press it holds.
Definition ui_keypad.h:61

ui_keypad.h
A numeric keypad over part of a screen, for a value a slider is too coarse to place.

ui_setting_keypad_takes
bool ui_setting_keypad_takes(setting_id_t id, float v)
Whether settings_set() takes v for id as a value the - and.
Definition ui_setting_keypad.c:109

ui_setting_keypad_decimals
int ui_setting_keypad_decimals(setting_id_t id)
The digits the keypad takes after the point for id.
Definition ui_setting_keypad.c:19

ui_setting_keypad_why
const char * ui_setting_keypad_why(setting_id_t id, float v, char *buf, size_t n)
The line a setting's keypad shows in place of the range after refusing v inside it.
Definition ui_setting_keypad.c:155

ui_setting_keypad_open
void ui_setting_keypad_open(ui_keypad_t *k, gfx_rect_t area, setting_id_t id)
Open k over area for setting id.
Definition ui_setting_keypad.c:41

ui_setting_keypad_tap_pins
const char * ui_setting_keypad_tap_pins(char *buf, size_t n)
The GPIOs Tap pin can have, from settings_tap_pin_valid().
Definition ui_setting_keypad.c:150

ui_setting_keypad_offered
bool ui_setting_keypad_offered(setting_id_t id)
Whether a tap on the value of id opens the keypad.
Definition ui_setting_keypad.c:24

ui_setting_keypad_sda_pins
const char * ui_setting_keypad_sda_pins(char *buf, size_t n)
The GPIOs Sensor SDA can have, from settings_sense_sda_valid().
Definition ui_setting_keypad.c:145

ui_setting_keypad_signed
bool ui_setting_keypad_signed(setting_id_t id)
Whether the keypad of id carries the +/- key.
Definition ui_setting_keypad.c:34

ui_setting_keypad_ok
ui_setkey_result_t ui_setting_keypad_ok(ui_keypad_t *k, setting_id_t id, float v)
Take the value an OK on k handed back for id.
Definition ui_setting_keypad.c:235

ui_setkey_result_t
ui_setkey_result_t
What an OK on a setting's keypad came to.
Definition ui_setting_keypad.h:128

UI_SETKEY_SET
@ UI_SETKEY_SET
Definition ui_setting_keypad.h:129

UI_SETKEY_REFUSED
@ UI_SETKEY_REFUSED
Definition ui_setting_keypad.h:130

UI_SETKEY_LOCKED
@ UI_SETKEY_LOCKED
Definition ui_setting_keypad.h:131