mirror of
https://github.com/lvgl/lvgl.git
synced 2025-01-14 06:42:58 +08:00
140 lines
4.2 KiB
C
140 lines
4.2 KiB
C
/**
|
|
* @file lv_btnm.h
|
|
*
|
|
*/
|
|
|
|
|
|
#ifndef LV_BTNM_H
|
|
#define LV_BTNM_H
|
|
|
|
/*********************
|
|
* INCLUDES
|
|
*********************/
|
|
#include "lv_conf.h"
|
|
#if USE_LV_BTNM != 0
|
|
|
|
/*Testing of dependencies*/
|
|
#if USE_LV_RECT == 0
|
|
#error "lv_btnm: lv_rect is required. Enable it in lv_conf.h (USE_LV_RECT 1) "
|
|
#endif
|
|
|
|
#if USE_LV_BTN == 0
|
|
#error "lv_btnm: lv_btn is required. Enable it in lv_conf.h (USE_LV_BTN 1) "
|
|
#endif
|
|
|
|
#include "../lv_obj/lv_obj.h"
|
|
#include "lv_rect.h"
|
|
#include "lv_label.h"
|
|
#include "lv_btn.h"
|
|
|
|
/*********************
|
|
* DEFINES
|
|
*********************/
|
|
|
|
/**********************
|
|
* TYPEDEFS
|
|
**********************/
|
|
|
|
/* Type of callback function which is called when a button is released on the button matrix
|
|
* Parameters: button matrix, released button index in the map string
|
|
* return LV_ACTION_RES_INV: the button matrix is deleted else LV_ACTION_RES_OK*/
|
|
typedef lv_action_res_t (*lv_btnm_callback_t) (lv_obj_t *, uint16_t);
|
|
|
|
/*Data of button matrix*/
|
|
typedef struct
|
|
{
|
|
lv_rect_ext_t bg; /*Ext. of ancestor*/
|
|
/*New data for this type */
|
|
const char ** map_p; /*Pointer to the current map*/
|
|
area_t * btn_areas; /*Array of areas for the buttons (Handled by the library)*/
|
|
uint16_t btn_cnt; /*Number of button in 'map_p'(Handled by the library)*/
|
|
uint16_t btn_pr; /*Index of the currently pressed button or LV_BTNM_PR_NONE (Handled by the library)*/
|
|
lv_btnm_callback_t cb; /*A function to call when a button is releases*/
|
|
}lv_btnm_ext_t;
|
|
|
|
/*Style of button matrix*/
|
|
typedef struct
|
|
{
|
|
lv_rects_t bg; /*Style of ancestor*/
|
|
/*New style element for this type */
|
|
lv_btns_t btn; /*Style of the buttons*/
|
|
lv_labels_t label; /*Style of the labels on the buttons*/
|
|
}lv_btnms_t;
|
|
|
|
/*Built-in styles of button matrix*/
|
|
typedef enum
|
|
{
|
|
LV_BTNMS_DEF,
|
|
}lv_btnms_builtin_t;
|
|
|
|
|
|
/**********************
|
|
* GLOBAL PROTOTYPES
|
|
**********************/
|
|
|
|
/**
|
|
* Create a button matrix objects
|
|
* @param par pointer to an object, it will be the parent of the new button matrix
|
|
* @param copy pointer to a button matrix object, if not NULL then the new object will be copied from it
|
|
* @return pointer to the created button matrix
|
|
*/
|
|
lv_obj_t * lv_btnm_create(lv_obj_t * par, lv_obj_t * copy);
|
|
|
|
/**
|
|
* Signal function of the button matrix
|
|
* @param btnm pointer to a button matrix object
|
|
* @param sign a signal type from lv_signal_t enum
|
|
* @param param pointer to a signal specific variable
|
|
* @return true: the object is still valid (not deleted), false: the object become invalid
|
|
*/
|
|
bool lv_btnm_signal(lv_obj_t * btnm, lv_signal_t sign, void * param);
|
|
|
|
/**
|
|
* Set a new map. Buttons will be created/deleted according to the map.
|
|
* @param btnm pointer to a button matrix object
|
|
* @param map pointer a string array. The last string has to be: "".
|
|
* Use "\n" to begin a new line.
|
|
* Use octal numbers (e.g. "\003") to set the relative
|
|
* width of a button. (max. 9 -> \011)
|
|
* (e.g. const char * str[] = {"a", "b", "\n", "\004c", "d", ""}).
|
|
* The button do not copy the array so it can not be a local variable.
|
|
*/
|
|
void lv_btnm_set_map(lv_obj_t * btnm, const char ** map);
|
|
|
|
/**
|
|
* Set a new callback function for the buttons (It will be called when a button is released)
|
|
* @param btnm: pointer to button matrix object
|
|
* @param cb pointer to a callback function
|
|
*/
|
|
void lv_btnm_set_action(lv_obj_t * btnm, lv_btnm_callback_t cb);
|
|
|
|
/**
|
|
* Get the current map of a button matrix
|
|
* @param btnm pointer to a button matrix object
|
|
* @return the current map
|
|
*/
|
|
const char ** lv_btnm_get_map(lv_obj_t * btnm);
|
|
|
|
/**
|
|
* Get a the callback function of the buttons on a button matrix
|
|
* @param btnm: pointer to button matrix object
|
|
* @return pointer to the callback function
|
|
*/
|
|
lv_btnm_callback_t lv_btnm_get_cb(lv_obj_t * btnm);
|
|
|
|
/**
|
|
* Return with a pointer to a built-in style and/or copy it to a variable
|
|
* @param style a style name from lv_btnms_builtin_t enum
|
|
* @param copy copy the style to this variable. (NULL if unused)
|
|
* @return pointer to an lv_btnms_t style
|
|
*/
|
|
lv_btnms_t * lv_btnms_get(lv_btnms_builtin_t style, lv_btnms_t * copy);
|
|
|
|
/**********************
|
|
* MACROS
|
|
**********************/
|
|
|
|
#endif /*USE_LV_BTNM*/
|
|
|
|
#endif /*LV_BTNM_H*/
|