lv_obj_private.h

API reference for lv_obj_private.h

Summary

Functions

private/core/lv_obj_private.h:178function

lv_obj_allocate_spec_attr

Allocate special data for an object if not allocated yet.

lv_obj_spec_attr_t * lv_obj_allocate_spec_attr(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an object

Returns: lv_obj_spec_attr_t * — the spec_attr created or NULL if something went wrong

private/core/lv_obj_private.h:180function

lv_obj_add_child

lv_result_t lv_obj_add_child(lv_obj_t *parent, lv_obj_t *child)

Name	Type
`parent`	`lv_obj_t *`
`child`	`lv_obj_t *`

private/core/lv_obj_private.h:181function

lv_obj_remove_child

void lv_obj_remove_child(lv_obj_t *parent, lv_obj_t *child)

Name	Type
`parent`	`lv_obj_t *`
`child`	`lv_obj_t *`

private/core/lv_obj_private.h:191function

Expand the display's invalidated areas to cover blur objects whose background changed. It's called once per frame and invalidates the full extent of every blur object that overlaps an invalidated area, repeating the walk until a pass adds no new areas to cover transitive blur-over-blur cases. Does nothing while no widget has blur (blur_obj_cnt in lv_global_t is zero).

void lv_obj_invalidate_expand_blur(lv_display_t *disp)

Name	Type	Description
`disp`	`lv_display_t *`	pointer to a display

Structs

struct

_lv_obj_spec_attr_t

Special, rarely used attributes. They are allocated automatically if any elements is set.

Member	Type	Description
`children`	`lv_obj_t **`	Store the pointer of the children in an array.
`group_p`	`lv_group_t *`
`event_list`	`lv_event_list_t`
`name`	`const char *`	Pointer to the name
`scroll`	`lv_point_t`	The current X/Y scroll offset
`ext_click_pad`	`int32_t`	Extra click padding in all direction
`ext_draw_size`	`int32_t`	EXTend the size in every direction for drawing.
`child_cnt`	`uint16_t`	Number of children
`scrollbar_mode`	`uint16_t`	How to display scrollbars, see `lv_scrollbar_mode_t`
`scroll_snap_x`	`uint16_t`	Where to align the snappable children horizontally, see `lv_scroll_snap_t`
`scroll_snap_y`	`uint16_t`	Where to align the snappable children vertically
`scroll_dir`	`uint16_t`	The allowed scroll direction(s), see `lv_dir_t`
`layer_type`	`uint16_t`	Cache the layer type here. Element of lv_intermediate_layer_type_t
`name_static`	`uint16_t`	1: `name` was not dynamically allocated
`user_flags`	`uint16_t`	Store custom flags

struct

_lv_obj_t

Member	Type	Description
`ext_data`	`lv_ext_data_t`
`class_p`	`const lv_obj_class_t *`
`parent`	`lv_obj_t *`
`spec_attr`	`lv_obj_spec_attr_t *`
`styles`	`lv_obj_style_t *`
`style_main_prop_is_set`	`uint32_t`
`style_other_prop_is_set`	`uint32_t`
`user_data`	`void *`
`id`	`void *`
`coords`	`lv_area_t`
`hidden`	`uint32_t`	Make the object hidden. (Like it wasn't there at all)
`clickable`	`uint32_t`	Make the object clickable by the input devices
`click_focusable`	`uint32_t`	Add focused state to the object when clicked
`checkable`	`uint32_t`	Toggle checked state when the object is clicked
`scrollable`	`uint32_t`	Make the object scrollable
`scroll_elastic`	`uint32_t`	Allow scrolling inside but with slower speed
`scroll_momentum`	`uint32_t`	Make the object scroll further when "thrown"
`scroll_one`	`uint32_t`	Allow scrolling only one snappable child
`scroll_chain_hor`	`uint32_t`	Allow propagating the horizontal scroll to a parent
`scroll_chain_ver`	`uint32_t`	Allow propagating the vertical scroll to a parent
`scroll_on_focus`	`uint32_t`	Automatically scroll object to make it visible when focused
`scroll_with_arrow`	`uint32_t`	Allow scrolling the focused object with arrow keys
`snappable`	`uint32_t`	If scroll snap is enabled on the parent it can snap to this object
`press_lock`	`uint32_t`	Keep the object pressed even if the press slid from the object
`event_bubble`	`uint32_t`	Propagate the events to the parent too
`gesture_bubble`	`uint32_t`	Propagate the gestures to the parent
`adv_hittest`	`uint32_t`	Allow performing more accurate hit (click) test
`ignore_layout`	`uint32_t`	Make the object not positioned by the layouts
`floating`	`uint32_t`	Do not scroll the object when the parent scrolls and ignore layout
`send_draw_task_events`	`uint32_t`	Send LV_EVENT_DRAW_TASK_ADDED events
`overflow_visible`	`uint32_t`	Do not clip the children to the parent's ext draw size
`event_trickle`	`uint32_t`	Propagate the events to the children too
`state_trickle`	`uint32_t`	Propagate the states to the children too
`radio_button`	`uint32_t`	Allow only one RADIO_BUTTON sibling to be checked
`state`	`uint16_t`
`layout_inv`	`uint16_t`
`readjust_scroll_after_layout`	`uint16_t`
`scr_layout_inv`	`uint16_t`
`skip_trans`	`uint16_t`
`style_cnt`	`uint16_t`
`h_layout`	`uint16_t`
`w_layout`	`uint16_t`
`h_ignore_size`	`uint16_t`
`w_ignore_size`	`uint16_t`
`is_deleting`	`uint16_t`
`rendered`	`uint16_t`	The widget is rendered at least once already. It's used to skip initial animations and transitions.
`has_blur`	`uint16_t`	The widget has blur or a drop shadow in its current state, so a change behind it must invalidate its full extent. It's updated by `lv_obj_update_blur_status()` and counted in blur_obj_cnt in lv_global_t.

Typedefs

private/core/lv_obj_private.h:55typedef

lv_obj_spec_attr_t

typedef struct _lv_obj_spec_attr_t lv_obj_spec_attr_t