lv_spinbox.h

Go to the documentation of this file.

 
#ifndef LV_SPINBOX_H
#define LV_SPINBOX_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../../../lvgl.h"
 
#if LV_USE_SPINBOX
 
/*Testing of dependencies*/
#if LV_USE_TEXTAREA == 0
#error "lv_spinbox: lv_ta is required. Enable it in lv_conf.h (LV_USE_TEXTAREA  1) "
#endif
 
/*********************
 *      DEFINES
 *********************/
#define LV_SPINBOX_MAX_DIGIT_COUNT 10
 
/**********************
 *      TYPEDEFS
 **********************/
 
/*Data of spinbox*/
typedef struct {
    lv_textarea_t ta;   /*Ext. of ancestor*/
    /*New data for this type*/
    int32_t value;
    int32_t range_max;
    int32_t range_min;
    int32_t step;
    uint16_t digit_count : 4;
    uint16_t dec_point_pos : 4; /*if 0, there is no separator and the number is an integer*/
    uint16_t rollover : 1;   // Set to true for rollover functionality
    uint16_t digit_step_dir : 2; // the direction the digit will step on encoder button press when editing
} lv_spinbox_t;
 
extern const lv_obj_class_t lv_spinbox_class;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
lv_obj_t * lv_spinbox_create(lv_obj_t * parent);
 
/*=====================
 * Setter functions
 *====================*/
 
void lv_spinbox_set_value(lv_obj_t * obj, int32_t i);
 
void lv_spinbox_set_rollover(lv_obj_t * obj, bool b);
 
void lv_spinbox_set_digit_format(lv_obj_t * obj, uint8_t digit_count, uint8_t separator_position);
 
void lv_spinbox_set_step(lv_obj_t * obj, uint32_t step);
 
void lv_spinbox_set_range(lv_obj_t * obj, int32_t range_min, int32_t range_max);
 
void lv_spinbox_set_cursor_pos(lv_obj_t * obj, uint8_t pos);
 
void lv_spinbox_set_digit_step_direction(lv_obj_t * obj, lv_dir_t direction);
 
/*=====================
 * Getter functions
 *====================*/
 
bool lv_spinbox_get_rollover(lv_obj_t * obj);
 
int32_t lv_spinbox_get_value(lv_obj_t * obj);
 
int32_t lv_spinbox_get_step(lv_obj_t * obj);
 
/*=====================
 * Other functions
 *====================*/
 
void lv_spinbox_step_next(lv_obj_t * obj);
 
void lv_spinbox_step_prev(lv_obj_t * obj);
 
void lv_spinbox_increment(lv_obj_t * obj);
 
void lv_spinbox_decrement(lv_obj_t * obj);
 
/**********************
 *      MACROS
 **********************/
 
/* It was ambiguous in MicroPython. See https://github.com/lvgl/lvgl/issues/3301
 * TODO remove in v9*/
#define lv_spinbox_set_pos lv_spinbox_set_cursor_pos
 
#endif /*LV_USE_SPINBOX*/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
#endif /*LV_SPINBOX_H*/