summaryrefslogtreecommitdiff
path: root/lib/lvgl/src/widgets/lv_roller.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/lvgl/src/widgets/lv_roller.h')
m---------lib/lvgl0
-rw-r--r--lib/lvgl/src/widgets/lv_roller.h138
2 files changed, 138 insertions, 0 deletions
diff --git a/lib/lvgl b/lib/lvgl
deleted file mode 160000
-Subproject 0732400e7b564dd0e7dc4a924619d8e19c5b23a
diff --git a/lib/lvgl/src/widgets/lv_roller.h b/lib/lvgl/src/widgets/lv_roller.h
new file mode 100644
index 00000000..14411dea
--- /dev/null
+++ b/lib/lvgl/src/widgets/lv_roller.h
@@ -0,0 +1,138 @@
+/**
+ * @file lv_roller.h
+ *
+ */
+
+#ifndef LV_ROLLER_H
+#define LV_ROLLER_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*********************
+ * INCLUDES
+ *********************/
+#include "../lv_conf_internal.h"
+
+#if LV_USE_ROLLER != 0
+
+/*Testing of dependencies*/
+#if LV_USE_LABEL == 0
+#error "lv_roller: lv_label is required. Enable it in lv_conf.h (LV_USE_ROLLER 1)"
+#endif
+
+#include "../core/lv_obj.h"
+#include "lv_label.h"
+
+/*********************
+ * DEFINES
+ *********************/
+
+/**********************
+ * TYPEDEFS
+ **********************/
+
+/** Roller mode.*/
+enum {
+ LV_ROLLER_MODE_NORMAL, /**< Normal mode (roller ends at the end of the options).*/
+ LV_ROLLER_MODE_INFINITE, /**< Infinite mode (roller can be scrolled forever).*/
+};
+
+typedef uint8_t lv_roller_mode_t;
+
+typedef struct {
+ lv_obj_t obj;
+ uint16_t option_cnt; /**< Number of options*/
+ uint16_t sel_opt_id; /**< Index of the current option*/
+ uint16_t sel_opt_id_ori; /**< Store the original index on focus*/
+ lv_roller_mode_t mode : 1;
+ uint32_t moved : 1;
+} lv_roller_t;
+
+extern const lv_obj_class_t lv_roller_class;
+
+
+/**********************
+ * GLOBAL PROTOTYPES
+ **********************/
+
+/**
+ * Create a roller object
+ * @param parent pointer to an object, it will be the parent of the new roller.
+ * @return pointer to the created roller
+ */
+lv_obj_t * lv_roller_create(lv_obj_t * parent);
+
+/*=====================
+ * Setter functions
+ *====================*/
+
+/**
+ * Set the options on a roller
+ * @param obj pointer to roller object
+ * @param options a string with '\n' separated options. E.g. "One\nTwo\nThree"
+ * @param mode `LV_ROLLER_MODE_NORMAL` or `LV_ROLLER_MODE_INFINITE`
+ */
+void lv_roller_set_options(lv_obj_t * obj, const char * options, lv_roller_mode_t mode);
+
+/**
+ * Set the selected option
+ * @param obj pointer to a roller object
+ * @param sel_opt index of the selected option (0 ... number of option - 1);
+ * @param anim_en LV_ANIM_ON: set with animation; LV_ANOM_OFF set immediately
+ */
+void lv_roller_set_selected(lv_obj_t * obj, uint16_t sel_opt, lv_anim_enable_t anim);
+
+/**
+ * Set the height to show the given number of rows (options)
+ * @param obj pointer to a roller object
+ * @param row_cnt number of desired visible rows
+ */
+void lv_roller_set_visible_row_count(lv_obj_t * obj, uint8_t row_cnt);
+
+/*=====================
+ * Getter functions
+ *====================*/
+
+/**
+ * Get the index of the selected option
+ * @param obj pointer to a roller object
+ * @return index of the selected option (0 ... number of option - 1);
+ */
+uint16_t lv_roller_get_selected(const lv_obj_t * obj);
+
+/**
+ * Get the current selected option as a string.
+ * @param obj pointer to ddlist object
+ * @param buf pointer to an array to store the string
+ * @param buf_size size of `buf` in bytes. 0: to ignore it.
+ */
+void lv_roller_get_selected_str(const lv_obj_t * obj, char * buf, uint32_t buf_size);
+
+
+/**
+ * Get the options of a roller
+ * @param obj pointer to roller object
+ * @return the options separated by '\n'-s (E.g. "Option1\nOption2\nOption3")
+ */
+const char * lv_roller_get_options(const lv_obj_t * obj);
+
+/**
+ * Get the total number of options
+ * @param obj pointer to a roller object
+ * @return the total number of options
+ */
+uint16_t lv_roller_get_option_cnt(const lv_obj_t * obj);
+
+/**********************
+ * MACROS
+ **********************/
+
+#endif /*LV_USE_ROLLER*/
+
+#ifdef __cplusplus
+} /*extern "C"*/
+#endif
+
+#endif /*LV_ROLLER_H*/