lv_obj_style.h
API reference for lv_obj_style.h
See Also: Private HeaderThis header has a companion private implementation with internal data structures.lv_obj_style_private.h
Summary
Functions
core/lv_obj_style.h:182function
lv_obj_style_set_disabled
Temporary disable a style for a selector. It will look like is the style wasn't added
void lv_obj_style_set_disabled(lv_obj_t *obj, const lv_style_t *style, lv_style_selector_t selector, bool dis)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to an object |
style | const lv_style_t * | pointer to a style |
selector | lv_style_selector_t | the selector of a style (e.g. LV_STATE_PRESSED | LV_PART_KNOB) |
dis | bool | true: disable the style, false: enable the style |
core/lv_obj_style.h:228function
lv_obj_set_local_style_prop
Set local style property on an object's part and state.
void lv_obj_set_local_style_prop(lv_obj_t *obj, lv_style_prop_t prop, lv_style_value_t value, lv_style_selector_t selector)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to an object |
prop | lv_style_prop_t | the property |
value | lv_style_value_t | value of the property. The correct element should be set according to the type of the property |
selector | lv_style_selector_t | OR-ed value of parts and state for which the style should be set |
core/lv_obj_style.h:276function
lv_obj_set_style_pad_all
static void lv_obj_set_style_pad_all(lv_obj_t *obj, int32_t value, lv_style_selector_t selector)| Name | Type |
|---|---|
obj | lv_obj_t * |
value | int32_t |
selector | lv_style_selector_t |
core/lv_obj_style.h:284function
lv_obj_set_style_pad_hor
static void lv_obj_set_style_pad_hor(lv_obj_t *obj, int32_t value, lv_style_selector_t selector)| Name | Type |
|---|---|
obj | lv_obj_t * |
value | int32_t |
selector | lv_style_selector_t |
core/lv_obj_style.h:290function
lv_obj_set_style_pad_ver
static void lv_obj_set_style_pad_ver(lv_obj_t *obj, int32_t value, lv_style_selector_t selector)| Name | Type |
|---|---|
obj | lv_obj_t * |
value | int32_t |
selector | lv_style_selector_t |
core/lv_obj_style.h:296function
lv_obj_set_style_margin_all
static void lv_obj_set_style_margin_all(lv_obj_t *obj, int32_t value, lv_style_selector_t selector)| Name | Type |
|---|---|
obj | lv_obj_t * |
value | int32_t |
selector | lv_style_selector_t |
core/lv_obj_style.h:304function
lv_obj_set_style_margin_hor
static void lv_obj_set_style_margin_hor(lv_obj_t *obj, int32_t value, lv_style_selector_t selector)| Name | Type |
|---|---|
obj | lv_obj_t * |
value | int32_t |
selector | lv_style_selector_t |
core/lv_obj_style.h:310function
lv_obj_set_style_margin_ver
static void lv_obj_set_style_margin_ver(lv_obj_t *obj, int32_t value, lv_style_selector_t selector)| Name | Type |
|---|---|
obj | lv_obj_t * |
value | int32_t |
selector | lv_style_selector_t |
core/lv_obj_style.h:316function
lv_obj_set_style_pad_gap
static void lv_obj_set_style_pad_gap(lv_obj_t *obj, int32_t value, lv_style_selector_t selector)| Name | Type |
|---|---|
obj | lv_obj_t * |
value | int32_t |
selector | lv_style_selector_t |
core/lv_obj_style.h:322function
lv_obj_set_style_size
static void lv_obj_set_style_size(lv_obj_t *obj, int32_t width, int32_t height, lv_style_selector_t selector)| Name | Type |
|---|---|
obj | lv_obj_t * |
width | int32_t |
height | int32_t |
selector | lv_style_selector_t |
core/lv_obj_style.h:329function
lv_obj_set_style_transform_scale
static void lv_obj_set_style_transform_scale(lv_obj_t *obj, int32_t value, lv_style_selector_t selector)| Name | Type |
|---|---|
obj | lv_obj_t * |
value | int32_t |
selector | lv_style_selector_t |
Enums
lv_state_t
Possible states of a widget. OR-ed values are possible
| Name | Value | Description |
|---|---|---|
LV_STATE_DEFAULT | 0 | |
LV_STATE_ALT | 1 << 0 | |
LV_STATE_CHECKED | 1 << 2 | |
LV_STATE_FOCUSED | 1 << 3 | |
LV_STATE_FOCUS_KEY | 1 << 4 | |
LV_STATE_EDITED | 1 << 5 | |
LV_STATE_HOVERED | 1 << 6 | |
LV_STATE_PRESSED | 1 << 7 | |
LV_STATE_SCROLLED | 1 << 8 | |
LV_STATE_DISABLED | 1 << 9 | |
LV_STATE_USER_1 | 1 << 12 | |
LV_STATE_USER_2 | 1 << 13 | |
LV_STATE_USER_3 | 1 << 14 | |
LV_STATE_USER_4 | 1 << 15 | |
LV_STATE_ANY | 0xFFFF | Special value can be used in some functions to target all states |
Used by 14 functions
lv_obj_add_state— paramstatelv_obj_remove_state— paramstatelv_obj_set_state— paramstatelv_obj_has_state— paramstatelv_obj_style_create_transition— paramprev_statelv_obj_style_create_transition— paramnew_statelv_obj_style_state_compare— paramstate1lv_obj_style_state_compare— paramstate2lv_obj_bind_state_if_eq— paramstatelv_obj_bind_state_if_not_eq— paramstatelv_obj_bind_state_if_gt— paramstatelv_obj_bind_state_if_ge— paramstatelv_obj_bind_state_if_lt— paramstatelv_obj_bind_state_if_le— paramstate
lv_part_t
The possible parts of widgets. The parts can be considered as the internal building block of the widgets. E.g. slider = background + indicator + knob Not all parts are used by every widget
| Name | Value | Description |
|---|---|---|
LV_PART_MAIN | 0x000000 | A background like rectangle |
LV_PART_SCROLLBAR | 0x010000 | The scrollbar(s) |
LV_PART_INDICATOR | 0x020000 | Indicator, e.g. for slider, bar, switch, or the tick box of the checkbox |
LV_PART_KNOB | 0x030000 | Like handle to grab to adjust the value |
LV_PART_SELECTED | 0x040000 | Indicate the currently selected option or section |
LV_PART_ITEMS | 0x050000 | Used if the widget has multiple similar elements (e.g. table cells) |
LV_PART_CURSOR | 0x060000 | Mark a specific place e.g. for text area's cursor or on a chart |
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 |
Used by 164 functions
lv_obj_init_draw_rect_dsc— parampartlv_obj_init_draw_label_dsc— parampartlv_obj_init_draw_image_dsc— parampartlv_obj_init_draw_line_dsc— parampartlv_obj_init_draw_arc_dsc— parampartlv_obj_init_draw_blur_dsc— parampartlv_obj_calculate_ext_draw_size— parampartlv_obj_get_style_property— parampartlv_obj_refresh_style— parampartlv_obj_get_style_prop— parampartlv_obj_style_apply_color_filter— parampartlv_obj_get_style_space_left— parampartlv_obj_get_style_space_right— parampartlv_obj_get_style_space_top— parampartlv_obj_get_style_space_bottom— parampartlv_obj_calculate_style_text_align— parampartlv_obj_get_style_transform_scale_x_safe— parampartlv_obj_get_style_transform_scale_y_safe— parampartlv_obj_get_style_opa_recursive— parampartlv_obj_style_apply_recolor— parampartlv_obj_get_style_recolor_recursive— parampartlv_obj_get_style_width— parampartlv_obj_get_style_min_width— parampartlv_obj_get_style_max_width— parampartlv_obj_get_style_height— parampartlv_obj_get_style_min_height— parampartlv_obj_get_style_max_height— parampartlv_obj_get_style_length— parampartlv_obj_get_style_x— parampartlv_obj_get_style_y— parampartlv_obj_get_style_align— parampartlv_obj_get_style_transform_width— parampartlv_obj_get_style_transform_height— parampartlv_obj_get_style_translate_x— parampartlv_obj_get_style_translate_y— parampartlv_obj_get_style_translate_radial— parampartlv_obj_get_style_transform_scale_x— parampartlv_obj_get_style_transform_scale_y— parampartlv_obj_get_style_transform_rotation— parampartlv_obj_get_style_transform_pivot_x— parampartlv_obj_get_style_transform_pivot_y— parampartlv_obj_get_style_transform_skew_x— parampartlv_obj_get_style_transform_skew_y— parampartlv_obj_get_style_pad_top— parampartlv_obj_get_style_pad_bottom— parampartlv_obj_get_style_pad_left— parampartlv_obj_get_style_pad_right— parampartlv_obj_get_style_pad_row— parampartlv_obj_get_style_pad_column— parampartlv_obj_get_style_pad_radial— parampartlv_obj_get_style_margin_top— parampartlv_obj_get_style_margin_bottom— parampartlv_obj_get_style_margin_left— parampartlv_obj_get_style_margin_right— parampartlv_obj_get_style_bg_color— parampartlv_obj_get_style_bg_color_filtered— parampartlv_obj_get_style_bg_opa— parampartlv_obj_get_style_bg_grad_color— parampartlv_obj_get_style_bg_grad_color_filtered— parampartlv_obj_get_style_bg_grad_dir— parampartlv_obj_get_style_bg_main_stop— parampartlv_obj_get_style_bg_grad_stop— parampartlv_obj_get_style_bg_main_opa— parampartlv_obj_get_style_bg_grad_opa— parampartlv_obj_get_style_bg_grad— parampartlv_obj_get_style_bg_image_src— parampartlv_obj_get_style_bg_image_opa— parampartlv_obj_get_style_bg_image_recolor— parampartlv_obj_get_style_bg_image_recolor_filtered— parampartlv_obj_get_style_bg_image_recolor_opa— parampartlv_obj_get_style_bg_image_tiled— parampartlv_obj_get_style_border_color— parampartlv_obj_get_style_border_color_filtered— parampartlv_obj_get_style_border_opa— parampartlv_obj_get_style_border_width— parampartlv_obj_get_style_border_side— parampartlv_obj_get_style_border_post— parampartlv_obj_get_style_outline_width— parampartlv_obj_get_style_outline_color— parampartlv_obj_get_style_outline_color_filtered— parampartlv_obj_get_style_outline_opa— parampartlv_obj_get_style_outline_pad— parampartlv_obj_get_style_shadow_width— parampartlv_obj_get_style_shadow_offset_x— parampartlv_obj_get_style_shadow_offset_y— parampartlv_obj_get_style_shadow_spread— parampartlv_obj_get_style_shadow_color— parampartlv_obj_get_style_shadow_color_filtered— parampartlv_obj_get_style_shadow_opa— parampartlv_obj_get_style_image_opa— parampartlv_obj_get_style_image_recolor— parampartlv_obj_get_style_image_recolor_filtered— parampartlv_obj_get_style_image_recolor_opa— parampartlv_obj_get_style_image_colorkey— parampartlv_obj_get_style_line_width— parampartlv_obj_get_style_line_dash_width— parampartlv_obj_get_style_line_dash_gap— parampartlv_obj_get_style_line_rounded— parampartlv_obj_get_style_line_color— parampartlv_obj_get_style_line_color_filtered— parampartlv_obj_get_style_line_opa— parampartlv_obj_get_style_arc_width— parampartlv_obj_get_style_arc_rounded— parampartlv_obj_get_style_arc_color— parampartlv_obj_get_style_arc_color_filtered— parampartlv_obj_get_style_arc_opa— parampartlv_obj_get_style_arc_image_src— parampartlv_obj_get_style_text_color— parampartlv_obj_get_style_text_color_filtered— parampartlv_obj_get_style_text_opa— parampartlv_obj_get_style_text_font— parampartlv_obj_get_style_text_letter_space— parampartlv_obj_get_style_text_line_space— parampartlv_obj_get_style_text_decor— parampartlv_obj_get_style_text_align— parampartlv_obj_get_style_text_outline_stroke_color— parampartlv_obj_get_style_text_outline_stroke_color_filtered— parampartlv_obj_get_style_text_outline_stroke_width— parampartlv_obj_get_style_text_outline_stroke_opa— parampartlv_obj_get_style_text_leading_trim— parampartlv_obj_get_style_blur_radius— parampartlv_obj_get_style_blur_backdrop— parampartlv_obj_get_style_blur_quality— parampartlv_obj_get_style_drop_shadow_radius— parampartlv_obj_get_style_drop_shadow_offset_x— parampartlv_obj_get_style_drop_shadow_offset_y— parampartlv_obj_get_style_drop_shadow_color— parampartlv_obj_get_style_drop_shadow_color_filtered— parampartlv_obj_get_style_drop_shadow_opa— parampartlv_obj_get_style_drop_shadow_quality— parampartlv_obj_get_style_radius— parampartlv_obj_get_style_radial_offset— parampartlv_obj_get_style_clip_corner— parampartlv_obj_get_style_opa— parampartlv_obj_get_style_opa_layered— parampartlv_obj_get_style_color_filter_dsc— parampartlv_obj_get_style_color_filter_opa— parampartlv_obj_get_style_recolor— parampartlv_obj_get_style_recolor_opa— parampartlv_obj_get_style_anim— parampartlv_obj_get_style_anim_duration— parampartlv_obj_get_style_transition— parampartlv_obj_get_style_blend_mode— parampartlv_obj_get_style_layout— parampartlv_obj_get_style_base_dir— parampartlv_obj_get_style_bitmap_mask_src— parampartlv_obj_get_style_rotary_sensitivity— parampartlv_obj_get_style_flex_flow— parampartlv_obj_get_style_flex_main_place— parampartlv_obj_get_style_flex_cross_place— parampartlv_obj_get_style_flex_track_place— parampartlv_obj_get_style_flex_grow— parampartlv_obj_get_style_grid_column_dsc_array— parampartlv_obj_get_style_grid_column_align— parampartlv_obj_get_style_grid_row_dsc_array— parampartlv_obj_get_style_grid_row_align— parampartlv_obj_get_style_grid_cell_column_pos— parampartlv_obj_get_style_grid_cell_x_align— parampartlv_obj_get_style_grid_cell_column_span— parampartlv_obj_get_style_grid_cell_row_pos— parampartlv_obj_get_style_grid_cell_y_align— parampartlv_obj_get_style_grid_cell_row_span— parampartlv_obj_style_create_transition— parampartlv_scale_section_set_style— parampart
lv_style_state_cmp_t
| Name | Description |
|---|---|
LV_STYLE_STATE_CMP_SAME | The style properties in the 2 states are identical |
LV_STYLE_STATE_CMP_DIFF_REDRAW | The differences can be shown with a simple redraw |
LV_STYLE_STATE_CMP_DIFF_DRAW_PAD | The differences can be shown with a simple redraw |
LV_STYLE_STATE_CMP_DIFF_LAYOUT | The differences can be shown with a simple redraw |
Typedefs
core/lv_obj_style.h:88typedef
lv_style_selector_t
typedef uint32_t lv_style_selector_tA joint type for lv_part_t and lv_state_t. Example values
0: meansLV_PART_MAIN | LV_STATE_DEFAULTLV_STATE_PRSSEDLV_PART_KNOBLV_PART_KNOB | LV_STATE_PRESSED | LV_STATE_CHECKED
Used by 152 functions
lv_obj_add_style— paramselectorlv_obj_replace_style— paramselectorlv_obj_remove_style— paramselectorlv_obj_remove_theme— paramselectorlv_obj_style_set_disabled— paramselectorlv_obj_style_get_disabled— paramselectorlv_obj_has_style_prop— paramselectorlv_obj_set_local_style_prop— paramselectorlv_obj_get_local_style_prop— paramselectorlv_obj_remove_local_style_prop— paramselectorlv_obj_style_get_selector_state— paramselectorlv_obj_style_get_selector_part— paramselectorlv_obj_set_style_pad_all— paramselectorlv_obj_set_style_pad_hor— paramselectorlv_obj_set_style_pad_ver— paramselectorlv_obj_set_style_margin_all— paramselectorlv_obj_set_style_margin_hor— paramselectorlv_obj_set_style_margin_ver— paramselectorlv_obj_set_style_pad_gap— paramselectorlv_obj_set_style_size— paramselectorlv_obj_set_style_transform_scale— paramselectorlv_obj_bind_style— paramselectorlv_obj_bind_style_prop— paramselectorlv_obj_set_style_width— paramselectorlv_obj_set_style_min_width— paramselectorlv_obj_set_style_max_width— paramselectorlv_obj_set_style_height— paramselectorlv_obj_set_style_min_height— paramselectorlv_obj_set_style_max_height— paramselectorlv_obj_set_style_length— paramselectorlv_obj_set_style_x— paramselectorlv_obj_set_style_y— paramselectorlv_obj_set_style_align— paramselectorlv_obj_set_style_transform_width— paramselectorlv_obj_set_style_transform_height— paramselectorlv_obj_set_style_translate_x— paramselectorlv_obj_set_style_translate_y— paramselectorlv_obj_set_style_translate_radial— paramselectorlv_obj_set_style_transform_scale_x— paramselectorlv_obj_set_style_transform_scale_y— paramselectorlv_obj_set_style_transform_rotation— paramselectorlv_obj_set_style_transform_pivot_x— paramselectorlv_obj_set_style_transform_pivot_y— paramselectorlv_obj_set_style_transform_skew_x— paramselectorlv_obj_set_style_transform_skew_y— paramselectorlv_obj_set_style_pad_top— paramselectorlv_obj_set_style_pad_bottom— paramselectorlv_obj_set_style_pad_left— paramselectorlv_obj_set_style_pad_right— paramselectorlv_obj_set_style_pad_row— paramselectorlv_obj_set_style_pad_column— paramselectorlv_obj_set_style_pad_radial— paramselectorlv_obj_set_style_margin_top— paramselectorlv_obj_set_style_margin_bottom— paramselectorlv_obj_set_style_margin_left— paramselectorlv_obj_set_style_margin_right— paramselectorlv_obj_set_style_bg_color— paramselectorlv_obj_set_style_bg_opa— paramselectorlv_obj_set_style_bg_grad_color— paramselectorlv_obj_set_style_bg_grad_dir— paramselectorlv_obj_set_style_bg_main_stop— paramselectorlv_obj_set_style_bg_grad_stop— paramselectorlv_obj_set_style_bg_main_opa— paramselectorlv_obj_set_style_bg_grad_opa— paramselectorlv_obj_set_style_bg_grad— paramselectorlv_obj_set_style_bg_image_src— paramselectorlv_obj_set_style_bg_image_opa— paramselectorlv_obj_set_style_bg_image_recolor— paramselectorlv_obj_set_style_bg_image_recolor_opa— paramselectorlv_obj_set_style_bg_image_tiled— paramselectorlv_obj_set_style_border_color— paramselectorlv_obj_set_style_border_opa— paramselectorlv_obj_set_style_border_width— paramselectorlv_obj_set_style_border_side— paramselectorlv_obj_set_style_border_post— paramselectorlv_obj_set_style_outline_width— paramselectorlv_obj_set_style_outline_color— paramselectorlv_obj_set_style_outline_opa— paramselectorlv_obj_set_style_outline_pad— paramselectorlv_obj_set_style_shadow_width— paramselectorlv_obj_set_style_shadow_offset_x— paramselectorlv_obj_set_style_shadow_offset_y— paramselectorlv_obj_set_style_shadow_spread— paramselectorlv_obj_set_style_shadow_color— paramselectorlv_obj_set_style_shadow_opa— paramselectorlv_obj_set_style_image_opa— paramselectorlv_obj_set_style_image_recolor— paramselectorlv_obj_set_style_image_recolor_opa— paramselectorlv_obj_set_style_image_colorkey— paramselectorlv_obj_set_style_line_width— paramselectorlv_obj_set_style_line_dash_width— paramselectorlv_obj_set_style_line_dash_gap— paramselectorlv_obj_set_style_line_rounded— paramselectorlv_obj_set_style_line_color— paramselectorlv_obj_set_style_line_opa— paramselectorlv_obj_set_style_arc_width— paramselectorlv_obj_set_style_arc_rounded— paramselectorlv_obj_set_style_arc_color— paramselectorlv_obj_set_style_arc_opa— paramselectorlv_obj_set_style_arc_image_src— paramselectorlv_obj_set_style_text_color— paramselectorlv_obj_set_style_text_opa— paramselectorlv_obj_set_style_text_font— paramselectorlv_obj_set_style_text_letter_space— paramselectorlv_obj_set_style_text_line_space— paramselectorlv_obj_set_style_text_decor— paramselectorlv_obj_set_style_text_align— paramselectorlv_obj_set_style_text_outline_stroke_color— paramselectorlv_obj_set_style_text_outline_stroke_width— paramselectorlv_obj_set_style_text_outline_stroke_opa— paramselectorlv_obj_set_style_text_leading_trim— paramselectorlv_obj_set_style_blur_radius— paramselectorlv_obj_set_style_blur_backdrop— paramselectorlv_obj_set_style_blur_quality— paramselectorlv_obj_set_style_drop_shadow_radius— paramselectorlv_obj_set_style_drop_shadow_offset_x— paramselectorlv_obj_set_style_drop_shadow_offset_y— paramselectorlv_obj_set_style_drop_shadow_color— paramselectorlv_obj_set_style_drop_shadow_opa— paramselectorlv_obj_set_style_drop_shadow_quality— paramselectorlv_obj_set_style_radius— paramselectorlv_obj_set_style_radial_offset— paramselectorlv_obj_set_style_clip_corner— paramselectorlv_obj_set_style_opa— paramselectorlv_obj_set_style_opa_layered— paramselectorlv_obj_set_style_color_filter_dsc— paramselectorlv_obj_set_style_color_filter_opa— paramselectorlv_obj_set_style_recolor— paramselectorlv_obj_set_style_recolor_opa— paramselectorlv_obj_set_style_anim— paramselectorlv_obj_set_style_anim_duration— paramselectorlv_obj_set_style_transition— paramselectorlv_obj_set_style_blend_mode— paramselectorlv_obj_set_style_layout— paramselectorlv_obj_set_style_base_dir— paramselectorlv_obj_set_style_bitmap_mask_src— paramselectorlv_obj_set_style_rotary_sensitivity— paramselectorlv_obj_set_style_flex_flow— paramselectorlv_obj_set_style_flex_main_place— paramselectorlv_obj_set_style_flex_cross_place— paramselectorlv_obj_set_style_flex_track_place— paramselectorlv_obj_set_style_flex_grow— paramselectorlv_obj_set_style_grid_column_dsc_array— paramselectorlv_obj_set_style_grid_column_align— paramselectorlv_obj_set_style_grid_row_dsc_array— paramselectorlv_obj_set_style_grid_row_align— paramselectorlv_obj_set_style_grid_cell_column_pos— paramselectorlv_obj_set_style_grid_cell_x_align— paramselectorlv_obj_set_style_grid_cell_column_span— paramselectorlv_obj_set_style_grid_cell_row_pos— paramselectorlv_obj_set_style_grid_cell_y_align— paramselectorlv_obj_set_style_grid_cell_row_span— paramselector
Dependencies
Indirect dependencies
How is this guide?
Last updated on