Enum nannou::ui::prelude::widget::MaybeParent

pub enum MaybeParent {
    None,
    Some(NodeIndex<u32>),
    Unspecified,
}

The builder argument for the Widget's parent.

Variants

None

The user specified the widget should not have any parents, so the Root will be used.

Some(NodeIndex<u32>)

The user gave a specific parent widget.

Unspecified

No parent widget was specified, so we will assume they want the last parent.

Methods

impl MaybeParent

pub fn get_unchecked(
    &self,
    ui: &Ui,
    x_pos: Position,
    y_pos: Position
) -> NodeIndex<u32>

Convert the MaybeParent into an Option.

If Unspecified, check the positioning to retrieve the Id from there.

If None, the Ui's window widget will be used.

Note: This method does not check whether or not using the window widget as the parent would cause a cycle. If it is important that the inferred parent should not cause a cycle, use get instead.

pub fn get(
    &self,
    id: NodeIndex<u32>,
    ui: &Ui,
    x_pos: Position,
    y_pos: Position
) -> Option<NodeIndex<u32>>

The same as get_unchecked, but checks whether or not the widget that we're inferring the parent for is the Ui's window (which cannot have a parent, without creating a cycle).

Trait Implementations

impl Debug for MaybeParent

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq<MaybeParent> for MaybeParent

fn eq(&self, other: &MaybeParent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MaybeParent) -> bool

This method tests for !=.

impl Copy for MaybeParent

impl Clone for MaybeParent

fn clone(&self) -> MaybeParent

Returns a copy of the value.

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

Performs copy-assignment from source.