Struct zng::widget::builder::NestGroup

pub struct NestGroup(/* private fields */);

Property nest position group.

Each group has u16::MAX / 9 in between, custom groups can be created using the +/- operations, SIZE+1 is still outside BORDER, but slightly inside SIZE.

See NestPosition for more details.

Implementations

impl NestGroup

pub const WIDGET: NestGroup = _

Minimal nest position, property is outside even context properties and is only inside the widget node.

This is rarely used, prefer using CONTEXT-n if you must have a property outside the widget context.

pub const CONTEXT: NestGroup = _

Property defines a contextual value or variable.

Usually these properties don’t define behavior, they just configure the widget. A common pattern is defining all widget config as context vars, that are all used by a widget intrinsic node.

These properties are not expected to affect layout or render, if they do some errors may be logged by the default widget base.

pub const EVENT: NestGroup = _

Property defines an event handler, or state monitor, they are placed inside all context properties, so can be configured by context, but are still outside of the layout and render nodes.

Event handlers can be notified before or after the inner child delegation, if handled before the event is said to be preview. Implementers can use this intrinsic feature of the UI tree to interrupt notification for child properties and widgets.

These properties are not expected to affect layout or render, if they do some errors may be logged by the default widget base.

pub const LAYOUT: NestGroup = _

Property defines the position and size of the widget inside the space made available by the parent widget.

These properties must accumulatively affect the measure and layout, they must avoid rendering. The computed layout is usually rendered by the widget as a single transform, the layout properties don’t need to render transforms.

pub const SIZE: NestGroup = _

Property strongly enforces a widget size.

Usually the widget final size is a side-effect of all the layout properties, but some properties may enforce a size, they can use this group to ensure that they are inside the other layout properties.

pub const WIDGET_INNER: NestGroup = _

Minimal widget visual position, any property or node can render, but usually only properties inside this position render. For example, borders will only render correctly inside this nest position.

This is rarely used, prefer using BORDER-n to declare properties that are visually outside the bounds, only use this node for intrinsics that define some inner context or service for the visual properties.

pub const BORDER: NestGroup = _

Property renders a border visual.

Borders are strictly coordinated, see the border module for more details. All nodes of this group may render at will, the renderer is already configured to apply the final layout and size.

pub const FILL: NestGroup = _

Property defines a visual of the widget.

This is the main render group, it usually defines things like a background fill, but it can render over child nodes simply by choosing to render after the render is delegated to the inner child.

pub const CHILD_CONTEXT: NestGroup = _

Property defines contextual value or variable for the inner child or children widgets. Config set here does not affect the widget where it is set, it only affects the descendants.

pub const CHILD_LAYOUT: NestGroup = _

Property defines the layout and size of the child or children widgets. These properties don’t affect the layout of the widget where they are set. Some properties are functionally the same, only changing their effect depending on their group, the margin and padding properties are like this, margin is LAYOUT and padding is CHILD_LAYOUT.

pub const CHILD: NestGroup = _

Maximum nest position, property is inside all others and only wraps the widget child node.

Properties that insert child nodes may use this group, properties that only affect the child layout and want to be inside other child layout should use CHILD_LAYOUT+n instead.

pub const ITEMS: [NestGroup; 11] = _

All groups, from outermost(WIDGET) to innermost(CHILD).

pub fn name(self) -> Txt

Group name.

Trait Implementations

impl Add<i16> for NestGroup

type Output = NestGroup

The resulting type after applying the + operator.

fn add(self, rhs: i16) -> <NestGroup as Add<i16>>::Output

Performs the + operation.

impl AddAssign<i16> for NestGroup

fn add_assign(&mut self, rhs: i16)

Performs the += operation.

impl Clone for NestGroup

fn clone(&self) -> NestGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NestGroup

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NestGroup

fn deserialize<D>( deserializer: D, ) -> Result<NestGroup, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NestGroup

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

Formats the value using the given formatter.

impl FromStr for NestGroup

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<NestGroup, <NestGroup as FromStr>::Err>

Parses a string s to return a value of this type.

impl Ord for NestGroup

fn cmp(&self, other: &NestGroup) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for NestGroup

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for NestGroup

fn partial_cmp(&self, other: &NestGroup) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for NestGroup

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<i16> for NestGroup

type Output = NestGroup

The resulting type after applying the - operator.

fn sub(self, rhs: i16) -> <NestGroup as Sub<i16>>::Output

Performs the - operation.

impl SubAssign<i16> for NestGroup

fn sub_assign(&mut self, rhs: i16)

Performs the -= operation.

impl Copy for NestGroup

impl Eq for NestGroup

impl StructuralPartialEq for NestGroup