docs(enum-naming): adjustments per conversation with Gábor

This commit is contained in:
Victor Wheeler
2025-06-06 12:41:47 -06:00
committed by Gabor Kiss-Vamosi
parent 3d1b5338cf
commit 5bc21a4b18
14 changed files with 23 additions and 23 deletions
+1 -1
View File
@@ -184,7 +184,7 @@ typedef enum {{
f" LV_PROPERTY_ID(STYLE, {name.upper() + ',' :25} {id_type+',' :28} LV_STYLE_{name.upper()}),\n" f" LV_PROPERTY_ID(STYLE, {name.upper() + ',' :25} {id_type+',' :28} LV_STYLE_{name.upper()}),\n"
) )
f.write('} _lv_property_style_id_t;\n\n') f.write('} lv_property_style_id_t;\n\n')
f.write('#endif\n') f.write('#endif\n')
f.write('#endif\n') f.write('#endif\n')
+2 -2
View File
@@ -59,7 +59,7 @@ typedef enum {
LV_STATE_USER_4 = 0x8000, LV_STATE_USER_4 = 0x8000,
LV_STATE_ANY = 0xFFFF, /**< Special value can be used in some functions to target all states*/ LV_STATE_ANY = 0xFFFF, /**< Special value can be used in some functions to target all states*/
} lv_state_t; } _lv_state_t;
/** /**
* The possible parts of widgets. * The possible parts of widgets.
@@ -80,7 +80,7 @@ typedef enum {
LV_PART_CUSTOM_FIRST = 0x080000, /**< Extension point for custom widgets*/ LV_PART_CUSTOM_FIRST = 0x080000, /**< Extension point for custom widgets*/
LV_PART_ANY = 0x0F0000, /**< Special value can be used in some functions to target all parts*/ LV_PART_ANY = 0x0F0000, /**< Special value can be used in some functions to target all parts*/
} lv_part_t; } _lv_part_t;
/** /**
* On/Off features controlling the object's behavior. * On/Off features controlling the object's behavior.
+1 -1
View File
@@ -348,7 +348,7 @@ typedef enum {
LV_STR_SYMBOL_SD_CARD, LV_STR_SYMBOL_SD_CARD,
LV_STR_SYMBOL_NEW_LINE, LV_STR_SYMBOL_NEW_LINE,
LV_STR_SYMBOL_DUMMY, LV_STR_SYMBOL_DUMMY,
} _lv_str_symbol_id_t; } lv_str_symbol_id_t;
#ifdef __cplusplus #ifdef __cplusplus
} /*extern "C"*/ } /*extern "C"*/
+8 -8
View File
@@ -150,30 +150,30 @@ typedef uint8_t lv_svg_transform_type_t;
typedef enum { typedef enum {
LV_SVG_ANIM_REMOVE = 0, LV_SVG_ANIM_REMOVE = 0,
LV_SVG_ANIM_FREEZE, LV_SVG_ANIM_FREEZE,
} _lv_svg_anim_action_t; } lv_svg_anim_action_t;
typedef enum { typedef enum {
LV_SVG_ANIM_RESTART_ALWAYS = 0, LV_SVG_ANIM_RESTART_ALWAYS = 0,
LV_SVG_ANIM_RESTART_WHEN_NOT_ACTIVE, LV_SVG_ANIM_RESTART_WHEN_NOT_ACTIVE,
LV_SVG_ANIM_RESTART_NEVER, LV_SVG_ANIM_RESTART_NEVER,
} _lv_svg_restart_type_t; } lv_svg_restart_type_t;
typedef enum { typedef enum {
LV_SVG_ANIM_CALC_MODE_LINEAR = 0, LV_SVG_ANIM_CALC_MODE_LINEAR = 0,
LV_SVG_ANIM_CALC_MODE_PACED, LV_SVG_ANIM_CALC_MODE_PACED,
LV_SVG_ANIM_CALC_MODE_SPLINE, LV_SVG_ANIM_CALC_MODE_SPLINE,
LV_SVG_ANIM_CALC_MODE_DISCRETE, LV_SVG_ANIM_CALC_MODE_DISCRETE,
} _lv_svg_anim_calc_mode_t; } lv_svg_anim_calc_mode_t;
typedef enum { typedef enum {
LV_SVG_ANIM_ADDITIVE_REPLACE = 0, LV_SVG_ANIM_ADDITIVE_REPLACE = 0,
LV_SVG_ANIM_ADDITIVE_SUM, LV_SVG_ANIM_ADDITIVE_SUM,
} _lv_svg_anim_additive_type_t; } lv_svg_anim_additive_type_t;
typedef enum { typedef enum {
LV_SVG_ANIM_ACCUMULATE_NONE = 0, LV_SVG_ANIM_ACCUMULATE_NONE = 0,
LV_SVG_ANIM_ACCUMULATE_SUM, LV_SVG_ANIM_ACCUMULATE_SUM,
} _lv_svg_accumulate_type_t; } lv_svg_accumulate_type_t;
#endif #endif
typedef enum { typedef enum {
@@ -188,12 +188,12 @@ typedef enum {
LV_SVG_ASPECT_RATIO_XMID_YMAX = (8 << 1), LV_SVG_ASPECT_RATIO_XMID_YMAX = (8 << 1),
LV_SVG_ASPECT_RATIO_XMAX_YMAX = (9 << 1), LV_SVG_ASPECT_RATIO_XMAX_YMAX = (9 << 1),
} _lv_svg_aspect_ratio_t; } _lv_svg_aspect_ratio_t;
typedef uint32_t lv_svg_aspect_ratio_t;
typedef enum { typedef enum {
LV_SVG_ASPECT_RATIO_OPT_MEET = 0, LV_SVG_ASPECT_RATIO_OPT_MEET = 0,
LV_SVG_ASPECT_RATIO_OPT_SLICE, LV_SVG_ASPECT_RATIO_OPT_SLICE,
} _lv_svg_aspect_ratio_opt_t; } lv_svg_aspect_ratio_opt_t;
typedef uint32_t lv_svg_aspect_ratio_t;
typedef struct { typedef struct {
float x; float x;
@@ -256,7 +256,7 @@ typedef enum {
LV_SVG_PATH_CMD_CURVE_TO = 67, LV_SVG_PATH_CMD_CURVE_TO = 67,
LV_SVG_PATH_CMD_QUAD_TO = 81, LV_SVG_PATH_CMD_QUAD_TO = 81,
LV_SVG_PATH_CMD_CLOSE = 90, LV_SVG_PATH_CMD_CLOSE = 90,
} _lv_svg_path_cmd_t; } lv_svg_path_cmd_t;
/* /*
* to simplify list buffer management, allocate enough memory for all path data and cmd. * to simplify list buffer management, allocate enough memory for all path data and cmd.
+1 -1
View File
@@ -290,7 +290,7 @@ typedef enum {
LV_STYLE_PROP_ANY = 0xFF, LV_STYLE_PROP_ANY = 0xFF,
LV_STYLE_PROP_CONST = 0xFF /* magic value for const styles */ LV_STYLE_PROP_CONST = 0xFF /* magic value for const styles */
} _lv_style_id_t; } lv_style_id_t;
typedef enum { typedef enum {
LV_STYLE_RES_NOT_FOUND, LV_STYLE_RES_NOT_FOUND,
+1 -1
View File
@@ -42,7 +42,7 @@ typedef enum {
LV_PROPERTY_ID(ANIMIMAGE, REPEAT_COUNT, LV_PROPERTY_TYPE_INT, 2), LV_PROPERTY_ID(ANIMIMAGE, REPEAT_COUNT, LV_PROPERTY_TYPE_INT, 2),
LV_PROPERTY_ID(ANIMIMAGE, SRC_COUNT, LV_PROPERTY_TYPE_INT, 3), LV_PROPERTY_ID(ANIMIMAGE, SRC_COUNT, LV_PROPERTY_TYPE_INT, 3),
LV_PROPERTY_ANIMIMAGE_END, LV_PROPERTY_ANIMIMAGE_END,
} _lv_property_animimage_id_t; } lv_property_animimage_id_t;
#endif #endif
LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_animimg_class; LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_animimg_class;
+1 -1
View File
@@ -44,7 +44,7 @@ typedef enum {
LV_PROPERTY_ID(DROPDOWN, LIST, LV_PROPERTY_TYPE_OBJ, 8), LV_PROPERTY_ID(DROPDOWN, LIST, LV_PROPERTY_TYPE_OBJ, 8),
LV_PROPERTY_ID(DROPDOWN, IS_OPEN, LV_PROPERTY_TYPE_BOOL, 9), LV_PROPERTY_ID(DROPDOWN, IS_OPEN, LV_PROPERTY_TYPE_BOOL, 9),
LV_PROPERTY_DROPDOWN_END, LV_PROPERTY_DROPDOWN_END,
} _lv_property_dropdown_id_t; } lv_property_dropdown_id_t;
#endif #endif
LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_dropdown_class; LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_dropdown_class;
+1 -1
View File
@@ -71,7 +71,7 @@ typedef enum {
LV_PROPERTY_ID(IMAGE, ANTIALIAS, LV_PROPERTY_TYPE_INT, 9), LV_PROPERTY_ID(IMAGE, ANTIALIAS, LV_PROPERTY_TYPE_INT, 9),
LV_PROPERTY_ID(IMAGE, INNER_ALIGN, LV_PROPERTY_TYPE_INT, 10), LV_PROPERTY_ID(IMAGE, INNER_ALIGN, LV_PROPERTY_TYPE_INT, 10),
LV_PROPERTY_IMAGE_END, LV_PROPERTY_IMAGE_END,
} _lv_property_image_id_t; } lv_property_image_id_t;
#endif #endif
/********************** /**********************
+1 -1
View File
@@ -57,7 +57,7 @@ typedef enum {
LV_PROPERTY_ID(KEYBOARD, POPOVERS, LV_PROPERTY_TYPE_INT, 2), LV_PROPERTY_ID(KEYBOARD, POPOVERS, LV_PROPERTY_TYPE_INT, 2),
LV_PROPERTY_ID(KEYBOARD, SELECTED_BUTTON, LV_PROPERTY_TYPE_INT, 3), LV_PROPERTY_ID(KEYBOARD, SELECTED_BUTTON, LV_PROPERTY_TYPE_INT, 3),
LV_PROPERTY_KEYBOARD_END, LV_PROPERTY_KEYBOARD_END,
} _lv_property_keyboard_id_t; } lv_property_keyboard_id_t;
#endif #endif
LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_keyboard_class; LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_keyboard_class;
+1 -1
View File
@@ -60,7 +60,7 @@ typedef enum {
LV_PROPERTY_ID(LABEL, TEXT_SELECTION_START, LV_PROPERTY_TYPE_INT, 2), LV_PROPERTY_ID(LABEL, TEXT_SELECTION_START, LV_PROPERTY_TYPE_INT, 2),
LV_PROPERTY_ID(LABEL, TEXT_SELECTION_END, LV_PROPERTY_TYPE_INT, 3), LV_PROPERTY_ID(LABEL, TEXT_SELECTION_END, LV_PROPERTY_TYPE_INT, 3),
LV_PROPERTY_LABEL_END, LV_PROPERTY_LABEL_END,
} _lv_property_label_id_t; } lv_property_label_id_t;
#endif #endif
LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_label_class; LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_label_class;
+1 -1
View File
@@ -132,7 +132,7 @@ typedef enum {
LV_PROPERTY_ID(STYLE, WIDTH, LV_PROPERTY_TYPE_INT, LV_STYLE_WIDTH), LV_PROPERTY_ID(STYLE, WIDTH, LV_PROPERTY_TYPE_INT, LV_STYLE_WIDTH),
LV_PROPERTY_ID(STYLE, X, LV_PROPERTY_TYPE_INT, LV_STYLE_X), LV_PROPERTY_ID(STYLE, X, LV_PROPERTY_TYPE_INT, LV_STYLE_X),
LV_PROPERTY_ID(STYLE, Y, LV_PROPERTY_TYPE_INT, LV_STYLE_Y), LV_PROPERTY_ID(STYLE, Y, LV_PROPERTY_TYPE_INT, LV_STYLE_Y),
} _lv_property_style_id_t; } lv_property_style_id_t;
#endif #endif
#endif #endif
+1 -1
View File
@@ -44,7 +44,7 @@ typedef enum {
LV_PROPERTY_ID2(ROLLER, SELECTED, LV_PROPERTY_TYPE_INT, LV_PROPERTY_TYPE_INT, 1), LV_PROPERTY_ID2(ROLLER, SELECTED, LV_PROPERTY_TYPE_INT, LV_PROPERTY_TYPE_INT, 1),
LV_PROPERTY_ID(ROLLER, VISIBLE_ROW_COUNT, LV_PROPERTY_TYPE_INT, 2), LV_PROPERTY_ID(ROLLER, VISIBLE_ROW_COUNT, LV_PROPERTY_TYPE_INT, 2),
LV_PROPERTY_ROLLER_END, LV_PROPERTY_ROLLER_END,
} _lv_property_roller_id_t; } lv_property_roller_id_t;
#endif #endif
LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_roller_class; LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_roller_class;
+1 -1
View File
@@ -54,7 +54,7 @@ typedef enum {
LV_PROPERTY_ID(SLIDER, IS_DRAGGED, LV_PROPERTY_TYPE_BOOL, 7), LV_PROPERTY_ID(SLIDER, IS_DRAGGED, LV_PROPERTY_TYPE_BOOL, 7),
LV_PROPERTY_ID(SLIDER, IS_SYMMETRICAL, LV_PROPERTY_TYPE_BOOL, 8), LV_PROPERTY_ID(SLIDER, IS_SYMMETRICAL, LV_PROPERTY_TYPE_BOOL, 8),
LV_PROPERTY_SLIDER_END, LV_PROPERTY_SLIDER_END,
} _lv_property_slider_id_t; } lv_property_slider_id_t;
#endif #endif
/********************** /**********************
* GLOBAL PROTOTYPES * GLOBAL PROTOTYPES
+2 -2
View File
@@ -51,14 +51,14 @@ typedef enum {
LV_PROPERTY_ID(TEXTAREA, TEXT_IS_SELECTED, LV_PROPERTY_TYPE_INT, 13), LV_PROPERTY_ID(TEXTAREA, TEXT_IS_SELECTED, LV_PROPERTY_TYPE_INT, 13),
LV_PROPERTY_ID(TEXTAREA, CURRENT_CHAR, LV_PROPERTY_TYPE_INT, 14), LV_PROPERTY_ID(TEXTAREA, CURRENT_CHAR, LV_PROPERTY_TYPE_INT, 14),
LV_PROPERTY_TEXTAREA_END, LV_PROPERTY_TEXTAREA_END,
} _lv_property_textarea_id_t; } lv_property_textarea_id_t;
#endif #endif
LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_textarea_class; LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_textarea_class;
typedef enum { typedef enum {
LV_PART_TEXTAREA_PLACEHOLDER = LV_PART_CUSTOM_FIRST, LV_PART_TEXTAREA_PLACEHOLDER = LV_PART_CUSTOM_FIRST,
} _lv_textarea_part_id_t; } lv_textarea_part_id_t;
/********************** /**********************
* GLOBAL PROTOTYPES * GLOBAL PROTOTYPES