Struct SideFnArgs 

#[non_exhaustive]
pub struct SideFnArgs {
    pub side: UiNode,
    pub side_extra: UiNode,
    pub background: UiNode,
    pub index: usize,
    pub pages_len: usize,
}

Arguments for a wizard side container builder.

See SIDE_FN_VAR for more details.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

side: UiNode

Page side content.

This is the Page::side instance.

This is never UiNode::nil as that is handled by Wizard!.

This can be UiNode::is_list, in this case a layout panel must be generated for the items, usually a vertical stack aligned to Align::BOTTOM.

side_extra: UiNode

Extra side content that is the same for all pages.

This is the side_extra_fn instance.

This can be UiNode::nil if no extra content is defined, otherwise it is like side a list or a single node, usually presented under the side list, with a separator.

background: UiNode

Background visual.

This is the SIDE_BACKGROUND_FN_VAR instance.

index: usize

Page index on the pages list.

Is usize::MAX if the page is a custom assign to WIZARD::selected_page that is not on the list.

pages_len: usize

Count of pages on the list.

Implementations

impl SideFnArgs

pub fn is_first(&self) -> bool

Is first page on the list.

pub fn is_last(&self) -> bool

Is last page on the list.

pub fn is_custom(&self) -> bool

Is custom page, not on the list.

pub fn wizard_id(&self) -> WidgetId

Get WIDGET.id().