Struct kas_core::layout::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 SizeMgr
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 CENTER: AlignHints = _

Center on both axes

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

Examples found in repository

src/layout/align.rs (line 40)

    pub const NONE: AlignHints = AlignHints::new(None, None);

    /// Center on both axes
    pub const CENTER: AlignHints = AlignHints::new(Some(Align::Center), Some(Align::Center));

    /// Stretch on both axes
    pub const STRETCH: AlignHints = AlignHints::new(Some(Align::Stretch), Some(Align::Stretch));

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

Take horizontal/vertical component

Examples found in repository

src/layout/mod.rs (line 94)

    pub fn with_align_hints(mut self, hints: AlignHints) -> Self {
        self.align = hints.extract(self).or(self.align);
        self
    }

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 via default alignments

Trait Implementations

impl Clone for AlignHints

fn clone(&self) -> AlignHints

Returns a copy 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 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<AlignHints> for AlignHints

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

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

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

This method 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 StructuralEq for AlignHints

impl StructuralPartialEq for AlignHints