mirror of
https://github.com/lvgl/lvgl.git
synced 2025-01-21 06:53:01 +08:00
290 lines
6.9 KiB
C
290 lines
6.9 KiB
C
/**
|
|
* @file lv_btn.h
|
|
*
|
|
*/
|
|
|
|
#ifndef LV_BTN_H
|
|
#define LV_BTN_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*********************
|
|
* INCLUDES
|
|
*********************/
|
|
#include "../lv_conf_internal.h"
|
|
|
|
#if LV_USE_BTN != 0
|
|
|
|
/*Testing of dependencies*/
|
|
#if LV_USE_CONT == 0
|
|
#error "lv_btn: lv_cont is required. Enable it in lv_conf.h (LV_USE_CONT 1) "
|
|
#endif
|
|
|
|
#include "lv_cont.h"
|
|
#include "../lv_core/lv_indev.h"
|
|
|
|
/*********************
|
|
* DEFINES
|
|
*********************/
|
|
|
|
/**********************
|
|
* TYPEDEFS
|
|
**********************/
|
|
|
|
/** Possible states of a button.
|
|
* It can be used not only by buttons but other button-like objects too*/
|
|
enum {
|
|
/**Released*/
|
|
LV_BTN_STATE_REL,
|
|
|
|
/**Pressed*/
|
|
LV_BTN_STATE_PR,
|
|
|
|
/**Toggled released*/
|
|
LV_BTN_STATE_TGL_REL,
|
|
|
|
/**Toggled pressed*/
|
|
LV_BTN_STATE_TGL_PR,
|
|
|
|
/**Inactive*/
|
|
LV_BTN_STATE_INA,
|
|
|
|
/**Number of states*/
|
|
_LV_BTN_STATE_NUM,
|
|
};
|
|
typedef uint8_t lv_btn_state_t;
|
|
|
|
/** Extended data of button*/
|
|
typedef struct
|
|
{
|
|
/** Ext. of ancestor*/
|
|
lv_cont_ext_t cont;
|
|
|
|
/** 1: Toggle enabled*/
|
|
uint8_t toggle : 1;
|
|
} lv_btn_ext_t;
|
|
|
|
/**Styles*/
|
|
enum {
|
|
LV_BTN_PART_MAIN,
|
|
|
|
};
|
|
typedef uint8_t lv_btn_part_t;
|
|
|
|
/**********************
|
|
* GLOBAL PROTOTYPES
|
|
**********************/
|
|
|
|
/**
|
|
* Create a button object
|
|
* @param par pointer to an object, it will be the parent of the new button
|
|
* @param copy pointer to a button object, if not NULL then the new object will be copied from it
|
|
* @return pointer to the created button
|
|
*/
|
|
lv_obj_t * lv_btn_create(lv_obj_t * par, const lv_obj_t * copy);
|
|
|
|
/*=====================
|
|
* Setter functions
|
|
*====================*/
|
|
|
|
/**
|
|
* Enable the toggled states. On release the button will change from/to toggled state.
|
|
* @param btn pointer to a button object
|
|
* @param tgl true: enable toggled states, false: disable
|
|
*/
|
|
void lv_btn_set_toggle(lv_obj_t * btn, bool tgl);
|
|
|
|
/**
|
|
* Set the state of the button
|
|
* @param btn pointer to a button object
|
|
* @param state the new state of the button (from lv_btn_state_t enum)
|
|
*/
|
|
void lv_btn_set_state(lv_obj_t * btn, lv_btn_state_t state);
|
|
|
|
/**
|
|
* Toggle the state of the button (ON->OFF, OFF->ON)
|
|
* @param btn pointer to a button object
|
|
*/
|
|
void lv_btn_toggle(lv_obj_t * btn);
|
|
|
|
/**
|
|
* Set the layout on a button
|
|
* @param btn pointer to a button object
|
|
* @param layout a layout from 'lv_cont_layout_t'
|
|
*/
|
|
static inline void lv_btn_set_layout(lv_obj_t * btn, lv_layout_t layout)
|
|
{
|
|
lv_cont_set_layout(btn, layout);
|
|
}
|
|
|
|
/**
|
|
* Set the fit policy in all 4 directions separately.
|
|
* It tells how to change the button size automatically.
|
|
* @param btn pointer to a button object
|
|
* @param left left fit policy from `lv_fit_t`
|
|
* @param right right fit policy from `lv_fit_t`
|
|
* @param top top fit policy from `lv_fit_t`
|
|
* @param bottom bottom fit policy from `lv_fit_t`
|
|
*/
|
|
static inline void lv_btn_set_fit4(lv_obj_t * btn, lv_fit_t left, lv_fit_t right, lv_fit_t top, lv_fit_t bottom)
|
|
{
|
|
lv_cont_set_fit4(btn, left, right, top, bottom);
|
|
}
|
|
|
|
/**
|
|
* Set the fit policy horizontally and vertically separately.
|
|
* It tells how to change the button size automatically.
|
|
* @param btn pointer to a button object
|
|
* @param hor horizontal fit policy from `lv_fit_t`
|
|
* @param ver vertical fit policy from `lv_fit_t`
|
|
*/
|
|
static inline void lv_btn_set_fit2(lv_obj_t * btn, lv_fit_t hor, lv_fit_t ver)
|
|
{
|
|
lv_cont_set_fit2(btn, hor, ver);
|
|
}
|
|
|
|
/**
|
|
* Set the fit policy in all 4 direction at once.
|
|
* It tells how to change the button size automatically.
|
|
* @param btn pointer to a button object
|
|
* @param fit fit policy from `lv_fit_t`
|
|
*/
|
|
static inline void lv_btn_set_fit(lv_obj_t * btn, lv_fit_t fit)
|
|
{
|
|
lv_cont_set_fit(btn, fit);
|
|
}
|
|
|
|
/**
|
|
* Set time of the ink effect (draw a circle on click to animate in the new state)
|
|
* @param btn pointer to a button object
|
|
* @param time the time of the ink animation
|
|
*/
|
|
void lv_btn_set_ink_in_time(lv_obj_t * btn, uint16_t time);
|
|
|
|
/**
|
|
* Set the wait time before the ink disappears
|
|
* @param btn pointer to a button object
|
|
* @param time the time of the ink animation
|
|
*/
|
|
void lv_btn_set_ink_wait_time(lv_obj_t * btn, uint16_t time);
|
|
|
|
/**
|
|
* Set time of the ink out effect (animate to the released state)
|
|
* @param btn pointer to a button object
|
|
* @param time the time of the ink animation
|
|
*/
|
|
void lv_btn_set_ink_out_time(lv_obj_t * btn, uint16_t time);
|
|
|
|
/**
|
|
* Set a style of a button.
|
|
* @param btn pointer to button object
|
|
* @param type which style should be set
|
|
* @param style pointer to a style
|
|
* */
|
|
void lv_btn_set_style(lv_obj_t * btn, lv_btn_part_t type, const lv_style_t * style);
|
|
|
|
/*=====================
|
|
* Getter functions
|
|
*====================*/
|
|
|
|
/**
|
|
* Get the current state of the button
|
|
* @param btn pointer to a button object
|
|
* @return the state of the button (from lv_btn_state_t enum)
|
|
*/
|
|
lv_btn_state_t lv_btn_get_state(const lv_obj_t * btn);
|
|
|
|
/**
|
|
* Get the toggle enable attribute of the button
|
|
* @param btn pointer to a button object
|
|
* @return true: toggle enabled, false: disabled
|
|
*/
|
|
bool lv_btn_get_toggle(const lv_obj_t * btn);
|
|
|
|
/**
|
|
* Get the layout of a button
|
|
* @param btn pointer to button object
|
|
* @return the layout from 'lv_cont_layout_t'
|
|
*/
|
|
static inline lv_layout_t lv_btn_get_layout(const lv_obj_t * btn)
|
|
{
|
|
return lv_cont_get_layout(btn);
|
|
}
|
|
|
|
/**
|
|
* Get the left fit mode
|
|
* @param btn pointer to a button object
|
|
* @return an element of `lv_fit_t`
|
|
*/
|
|
static inline lv_fit_t lv_btn_get_fit_left(const lv_obj_t * btn)
|
|
{
|
|
return lv_cont_get_fit_left(btn);
|
|
}
|
|
|
|
/**
|
|
* Get the right fit mode
|
|
* @param btn pointer to a button object
|
|
* @return an element of `lv_fit_t`
|
|
*/
|
|
static inline lv_fit_t lv_btn_get_fit_right(const lv_obj_t * btn)
|
|
{
|
|
return lv_cont_get_fit_right(btn);
|
|
}
|
|
|
|
/**
|
|
* Get the top fit mode
|
|
* @param btn pointer to a button object
|
|
* @return an element of `lv_fit_t`
|
|
*/
|
|
static inline lv_fit_t lv_btn_get_fit_top(const lv_obj_t * btn)
|
|
{
|
|
return lv_cont_get_fit_top(btn);
|
|
}
|
|
|
|
/**
|
|
* Get the bottom fit mode
|
|
* @param btn pointer to a button object
|
|
* @return an element of `lv_fit_t`
|
|
*/
|
|
static inline lv_fit_t lv_btn_get_fit_bottom(const lv_obj_t * btn)
|
|
{
|
|
return lv_cont_get_fit_bottom(btn);
|
|
}
|
|
|
|
/**
|
|
* Get time of the ink in effect (draw a circle on click to animate in the new state)
|
|
* @param btn pointer to a button object
|
|
* @return the time of the ink animation
|
|
*/
|
|
uint16_t lv_btn_get_ink_in_time(const lv_obj_t * btn);
|
|
|
|
/**
|
|
* Get the wait time before the ink disappears
|
|
* @param btn pointer to a button object
|
|
* @return the time of the ink animation
|
|
*/
|
|
uint16_t lv_btn_get_ink_wait_time(const lv_obj_t * btn);
|
|
|
|
/**
|
|
* Get time of the ink out effect (animate to the releases state)
|
|
* @param btn pointer to a button object
|
|
* @return the time of the ink animation
|
|
*/
|
|
uint16_t lv_btn_get_ink_out_time(const lv_obj_t * btn);
|
|
|
|
lv_style_list_t * lv_btn_get_style(lv_obj_t * cont, uint8_t type);
|
|
|
|
/**********************
|
|
* MACROS
|
|
**********************/
|
|
|
|
#endif /*LV_USE_BUTTON*/
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /*LV_BTN_H*/
|