Struct UiBuilder

pub struct UiBuilder {
    pub id_salt: Option<Id>,
    pub global_scope: bool,
    pub ui_stack_info: UiStackInfo,
    pub layer_id: Option<LayerId>,
    pub max_rect: Option<Rect>,
    pub layout: Option<Layout>,
    pub disabled: bool,
    pub invisible: bool,
    pub sizing_pass: bool,
    pub style: Option<Arc<Style>>,
    pub sense: Option<Sense>,
}

Build a Ui as the child of another Ui.

By default, everything is inherited from the parent, except for max_rect which by default is set to the parent Ui::available_rect_before_wrap.

Fields

id_salt: Option<Id>

global_scope: bool

ui_stack_info: UiStackInfo

layer_id: Option<LayerId>

max_rect: Option<Rect>

layout: Option<Layout>

disabled: bool

invisible: bool

sizing_pass: bool

style: Option<Arc<Style>>

sense: Option<Sense>

Implementations

impl UiBuilder

pub fn new() -> Self

pub fn id_salt(self, id_salt: impl Hash) -> Self

Seed the child Ui with this id_salt, which will be mixed with the Ui::id of the parent.

You should give each Ui an id_salt that is unique within the parent, or give it none at all.

pub fn id(self, id: impl Hash) -> Self

Set an id of the new Ui that is independent of the parent Ui. This way child widgets can be moved in the ui tree without losing state. You have to ensure that in a frame the child widgets do not get rendered in multiple places.

You should set the same unique id at every place in the ui tree where you want the child widgets to share state. If the child widgets are not moved in the ui tree, use UiBuilder::id_salt instead.

This is a shortcut for .id_salt(my_id).global_scope(true).

pub fn global_scope(self, global_scope: bool) -> Self

Make the new Ui child ids independent of the parent Ui. This way child widgets can be moved in the ui tree without losing state. You have to ensure that in a frame the child widgets do not get rendered in multiple places.

You should set the same globally unique id_salt at every place in the ui tree where you want the child widgets to share state.

pub fn ui_stack_info(self, ui_stack_info: UiStackInfo) -> Self

Provide some information about the new Ui being built.

pub fn layer_id(self, layer_id: LayerId) -> Self

Show the Ui in a different LayerId from its parent.

pub fn max_rect(self, max_rect: Rect) -> Self

Set the max rectangle, within which widgets will go.

New widgets will try to fit within this rectangle.

Text labels will wrap to fit within max_rect. Separator lines will span the max_rect.

If a new widget doesn’t fit within the max_rect then the Ui will make room for it by expanding both min_rect and

If not set, this will be set to the parent Ui::available_rect_before_wrap.

pub fn layout(self, layout: Layout) -> Self

Override the layout.

Will otherwise be inherited from the parent.

pub fn disabled(self) -> Self

Make the new Ui disabled, i.e. grayed-out and non-interactive.

Note that if the parent Ui is disabled, the child will always be disabled.

pub fn invisible(self) -> Self

Make the contents invisible.

Will also disable the Ui (see Self::disabled).

If the parent Ui is invisible, the child will always be invisible.

pub fn sizing_pass(self) -> Self

Set to true in special cases where we do one frame where we size up the contents of the Ui, without actually showing it.

If the sizing_pass flag is set on the parent, the child will inherit it automatically.

pub fn style(self, style: impl Into<Arc<Style>>) -> Self

Override the style.

Otherwise will inherit the style of the parent.

pub fn sense(self, sense: Sense) -> Self

Set if you want sense clicks and/or drags. Default is Sense::hover.

The sense will be registered below the Senses of any widgets contained in this Ui, so if the user clicks a button contained within this Ui, that button will receive the click instead.

The response can be read early with Ui::response.

pub fn closable(self) -> Self

Make this Ui closable.

Calling Ui::close in a child Ui will mark this Ui for closing. After Ui::close was called, Ui::should_close and crate::Response::should_close will return true (for this frame).

This works by adding a ClosableTag to the UiStackInfo.

pub fn accessibility_parent(self, parent_id: Id) -> Self

Set the accessibility parent for this Ui.

This will override the automatic parent assignment for accessibility purposes. If not set, the parent Ui’s ID will be used as the accessibility parent.

This does nothing if the accesskit feature is not enabled.

Trait Implementations

impl Clone for UiBuilder

fn clone(&self) -> UiBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for UiBuilder

fn default() -> UiBuilder

Returns the “default value” for a type.