203 lines
4.9 KiB
C
203 lines
4.9 KiB
C
/**
|
|
* @file lv_slider.h
|
|
*
|
|
*/
|
|
|
|
#ifndef LV_SLIDER_H
|
|
#define LV_SLIDER_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*********************
|
|
* INCLUDES
|
|
*********************/
|
|
#ifdef LV_CONF_INCLUDE_SIMPLE
|
|
#include "lv_conf.h"
|
|
#else
|
|
#include "../../lv_conf.h"
|
|
#endif
|
|
|
|
#if USE_LV_SLIDER != 0
|
|
|
|
/*Testing of dependencies*/
|
|
#if USE_LV_BAR == 0
|
|
#error "lv_slider: lv_bar is required. Enable it in lv_conf.h (USE_LV_BAR 1) "
|
|
#endif
|
|
|
|
#include "../lv_core/lv_obj.h"
|
|
#include "lv_bar.h"
|
|
|
|
/*********************
|
|
* DEFINES
|
|
*********************/
|
|
|
|
/**********************
|
|
* TYPEDEFS
|
|
**********************/
|
|
/*Data of slider*/
|
|
typedef struct
|
|
{
|
|
lv_bar_ext_t bar; /*Ext. of ancestor*/
|
|
/*New data for this type */
|
|
lv_action_t action; /*Function to call when a new value is set*/
|
|
lv_style_t *style_knob; /*Style of the knob*/
|
|
int16_t drag_value; /*Store a temporal value during press until release (Handled by the library)*/
|
|
uint8_t knob_in :1; /*1: Draw the knob inside the bar*/
|
|
} lv_slider_ext_t;
|
|
|
|
/*Built-in styles of slider*/
|
|
enum
|
|
{
|
|
LV_SLIDER_STYLE_BG,
|
|
LV_SLIDER_STYLE_INDIC,
|
|
LV_SLIDER_STYLE_KNOB,
|
|
};
|
|
typedef uint8_t lv_slider_style_t;
|
|
|
|
/**********************
|
|
* GLOBAL PROTOTYPES
|
|
**********************/
|
|
|
|
/**
|
|
* Create a slider objects
|
|
* @param par pointer to an object, it will be the parent of the new slider
|
|
* @param copy pointer to a slider object, if not NULL then the new object will be copied from it
|
|
* @return pointer to the created slider
|
|
*/
|
|
lv_obj_t * lv_slider_create(lv_obj_t * par, const lv_obj_t * copy);
|
|
|
|
/*=====================
|
|
* Setter functions
|
|
*====================*/
|
|
|
|
/**
|
|
* Set a new value on the slider
|
|
* @param slider pointer to a slider object
|
|
* @param value new value
|
|
*/
|
|
static inline void lv_slider_set_value(lv_obj_t * slider, int16_t value)
|
|
{
|
|
lv_bar_set_value(slider, value);
|
|
}
|
|
|
|
/**
|
|
* Set a new value with animation on a slider
|
|
* @param slider pointer to a slider object
|
|
* @param value new value
|
|
* @param anim_time animation time in milliseconds
|
|
*/
|
|
static inline void lv_slider_set_value_anim(lv_obj_t * slider, int16_t value, uint16_t anim_time)
|
|
{
|
|
lv_bar_set_value_anim(slider, value, anim_time);
|
|
}
|
|
|
|
/**
|
|
* Set minimum and the maximum values of a bar
|
|
* @param slider pointer to the slider object
|
|
* @param min minimum value
|
|
* @param max maximum value
|
|
*/
|
|
static inline void lv_slider_set_range(lv_obj_t *slider, int16_t min, int16_t max)
|
|
{
|
|
lv_bar_set_range(slider, min, max);
|
|
}
|
|
|
|
/**
|
|
* Set a function which will be called when a new value is set on the slider
|
|
* @param slider pointer to slider object
|
|
* @param action a callback function
|
|
*/
|
|
void lv_slider_set_action(lv_obj_t * slider, lv_action_t action);
|
|
|
|
/**
|
|
* Set the 'knob in' attribute of a slider
|
|
* @param slider pointer to slider object
|
|
* @param in true: the knob is drawn always in the slider;
|
|
* false: the knob can be out on the edges
|
|
*/
|
|
void lv_slider_set_knob_in(lv_obj_t * slider, bool in);
|
|
|
|
/**
|
|
* Set a style of a slider
|
|
* @param slider pointer to a slider object
|
|
* @param type which style should be set
|
|
* @param style pointer to a style
|
|
*/
|
|
void lv_slider_set_style(lv_obj_t *slider, lv_slider_style_t type, lv_style_t *style);
|
|
|
|
/*=====================
|
|
* Getter functions
|
|
*====================*/
|
|
|
|
/**
|
|
* Get the value of a slider
|
|
* @param slider pointer to a slider object
|
|
* @return the value of the slider
|
|
*/
|
|
int16_t lv_slider_get_value(const lv_obj_t * slider);
|
|
|
|
/**
|
|
* Get the minimum value of a slider
|
|
* @param slider pointer to a slider object
|
|
* @return the minimum value of the slider
|
|
*/
|
|
static inline int16_t lv_slider_get_min_value(const lv_obj_t * slider)
|
|
{
|
|
return lv_bar_get_min_value(slider);
|
|
}
|
|
|
|
/**
|
|
* Get the maximum value of a slider
|
|
* @param slider pointer to a slider object
|
|
* @return the maximum value of the slider
|
|
*/
|
|
static inline int16_t lv_slider_get_max_value(const lv_obj_t * slider)
|
|
{
|
|
return lv_bar_get_max_value(slider);
|
|
}
|
|
|
|
/**
|
|
* Get the slider action function
|
|
* @param slider pointer to slider object
|
|
* @return the callback function
|
|
*/
|
|
lv_action_t lv_slider_get_action(const lv_obj_t * slider);
|
|
|
|
/**
|
|
* Give the slider is being dragged or not
|
|
* @param slider pointer to a slider object
|
|
* @return true: drag in progress false: not dragged
|
|
*/
|
|
bool lv_slider_is_dragged(const lv_obj_t * slider);
|
|
|
|
/**
|
|
* Get the 'knob in' attribute of a slider
|
|
* @param slider pointer to slider object
|
|
* @return true: the knob is drawn always in the slider;
|
|
* false: the knob can be out on the edges
|
|
*/
|
|
bool lv_slider_get_knob_in(const lv_obj_t * slider);
|
|
|
|
|
|
/**
|
|
* Get a style of a slider
|
|
* @param slider pointer to a slider object
|
|
* @param type which style should be get
|
|
* @return style pointer to a style
|
|
*/
|
|
lv_style_t * lv_slider_get_style(const lv_obj_t *slider, lv_slider_style_t type);
|
|
|
|
/**********************
|
|
* MACROS
|
|
**********************/
|
|
|
|
#endif /*USE_LV_SLIDER*/
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /*LV_SLIDER_H*/
|