Struct UiContainer

pub struct UiContainer { /* private fields */ }

Implementations

impl UiContainer

pub fn new() -> UiContainer

Creates a new user interface container.

pub fn new_with_ui(ui: UserInterface) -> UiContainer

Creates a new user interface container with the given user interface.

pub fn first(&self) -> &UserInterface

Returns a reference to the first user interface in the container. Panics, if the container is empty.

pub fn first_mut(&mut self) -> &mut UserInterface

Returns a reference to the first user interface in the container. Panics, if the container is empty.

pub fn is_valid_handle(&self, handle: Handle<UserInterface>) -> bool

Return true if given handle is valid and “points” to “alive” user interface.

pub fn pair_iter( &self, ) -> impl Iterator<Item = (Handle<UserInterface>, &UserInterface)>

Returns pair iterator which yields (handle, user_interface_ref) pairs.

pub fn pair_iter_mut( &mut self, ) -> impl Iterator<Item = (Handle<UserInterface>, &mut UserInterface)>

Returns pair iterator which yields (handle, user_interface_ref) pairs.

pub fn try_get(&self, handle: Handle<UserInterface>) -> Option<&UserInterface>

Tries to borrow a user interface using its handle.

pub fn try_get_mut( &mut self, handle: Handle<UserInterface>, ) -> Option<&mut UserInterface>

Tries to borrow a user interface using its handle.

pub fn iter(&self) -> impl Iterator<Item = &UserInterface>

Creates new iterator over user interfaces in container.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut UserInterface>

Creates new mutable iterator over user interfaces in container.

pub fn add(&mut self, scene: UserInterface) -> Handle<UserInterface>

Adds a new user interface into container.

pub fn clear(&mut self)

Removes all user interfaces from container.

pub fn remove(&mut self, handle: Handle<UserInterface>)

Removes the given user interface from container. The user interface will be destroyed immediately.

pub fn take_reserve( &mut self, handle: Handle<UserInterface>, ) -> (Ticket<UserInterface>, UserInterface)

Takes a user interface from the container and transfers ownership to caller. You must either put the user interface back using ticket or call forget_ticket to make memory used by the user interface vacant again.

pub fn put_back( &mut self, ticket: Ticket<UserInterface>, scene: UserInterface, ) -> Handle<UserInterface>

Puts a user interface back to the container using its ticket.

pub fn forget_ticket(&mut self, ticket: Ticket<UserInterface>)

Forgets ticket of a user interface, making place at which ticket points, vacant again.

Trait Implementations

impl Default for UiContainer

fn default() -> UiContainer

Returns the “default value” for a type.

impl Index<Handle<UserInterface>> for UiContainer

type Output = UserInterface

The returned type after indexing.

fn index( &self, index: Handle<UserInterface>, ) -> &<UiContainer as Index<Handle<UserInterface>>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<Handle<UserInterface>> for UiContainer

fn index_mut( &mut self, index: Handle<UserInterface>, ) -> &mut <UiContainer as Index<Handle<UserInterface>>>::Output

Performs the mutable indexing (container[index]) operation.