Struct AlignHints

pub struct AlignHints {
    pub horiz: Option<Align>,
    pub vert: Option<Align>,
}

Partial alignment information provided by the parent

Hints are optional. Widgets are expected to substitute default values where hints are not provided.

The AlignHints::complete method is provided to conveniently apply alignment to a widget within crate::Layout::set_rect:

let pref_size = Size(30, 20); // usually size comes from SizeCx
let rect = align
    .complete(Align::Stretch, Align::Center)
    .aligned_rect(pref_size, rect);
// self.core.rect = rect;

Fields

horiz: Option<Align>

vert: Option<Align>

Implementations

impl AlignHints

pub const NONE: AlignHints

No hints

pub const TOP: AlignHints

Top, no horizontal hint

pub const BOTTOM: AlignHints

Bottom, no horizontal hint

pub const LEFT: AlignHints

Left, no vertical hint

pub const RIGHT: AlignHints

Right, no vertical hint

pub const TOP_LEFT: AlignHints

Top, left

pub const TOP_RIGHT: AlignHints

Top, right

pub const BOTTOM_LEFT: AlignHints

Bottom, left

pub const BOTTOM_RIGHT: AlignHints

Bottom, right

pub const CENTER: AlignHints

Center on both axes

pub const TOP_CENTER: AlignHints

Top, center

pub const BOTTOM_CENTER: AlignHints

Bottom, center

pub const CENTER_LEFT: AlignHints

Center, left

pub const CENTER_RIGHT: AlignHints

Center, right

pub const STRETCH: AlignHints

Stretch on both axes

pub const fn new(horiz: Option<Align>, vert: Option<Align>) -> Self

Construct with optional horiz. and vert. alignment

pub fn extract(self, dir: impl Directional) -> Option<Align>

Take horizontal/vertical component

pub fn set_component<D: Directional>(&mut self, dir: D, align: Option<Align>)

Set one component of self, based on a direction

pub fn combine(self, rhs: AlignHints) -> Self

Combine two hints (first takes priority)

pub fn unwrap_or(self, horiz: Align, vert: Align) -> (Align, Align)

Unwrap type’s alignments or substitute parameters

pub fn complete(&self, horiz: Align, vert: Align) -> AlignPair

Complete, using specified alignments as defaults

pub fn complete_default(&self) -> AlignPair

Complete, using Align::Default as defaults

pub fn complete_center(&self) -> AlignPair

Complete, using Align::Center as defaults

Trait Implementations

impl Clone for AlignHints

fn clone(&self) -> AlignHints

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlignHints

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

Formats the value using the given formatter.

impl Default for AlignHints

fn default() -> AlignHints

Returns the “default value” for a type.

impl From<(Align, Align)> for AlignHints

fn from((h, v): (Align, Align)) -> Self

Converts to this type from the input type.

impl Hash for AlignHints

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AlignHints

fn eq(&self, other: &AlignHints) -> 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 Copy for AlignHints

impl Eq for AlignHints

impl StructuralPartialEq for AlignHints