Struct WindowAffordanceFrame

Source
pub struct WindowAffordanceFrame<A = ()> { /* private fields */ }
Expand description

Retained frame that paints client chrome and emits provider-neutral actions.

The default logical window id is "window-affordance"; movement, resizing, and the three chrome controls are enabled. The optional content is placed below the title bar.

§Examples

use ailloli_ui_widgets::chrome::WindowAffordanceFrame;
let frame: WindowAffordanceFrame<()> = WindowAffordanceFrame::new("Inspector");
let _ = frame;

Implementations§

Source§

impl<A: 'static> WindowAffordanceFrame<A>

Source

pub fn width(self, value: impl Into<Length>) -> Self

Sets preferred width from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().width(120.0);
let _ = widget;
Source

pub fn height(self, value: impl Into<Length>) -> Self

Sets preferred height from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().height(40.0);
let _ = widget;
Source

pub fn min_width(self, value: impl Into<Length>) -> Self

Sets the minimum width bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_width(40.0);
let _ = widget;
Source

pub fn max_width(self, value: impl Into<Length>) -> Self

Sets the maximum width bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_width(320.0);
let _ = widget;
Source

pub fn min_height(self, value: impl Into<Length>) -> Self

Sets the minimum height bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_height(24.0);
let _ = widget;
Source

pub fn max_height(self, value: impl Into<Length>) -> Self

Sets the maximum height bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_height(240.0);
let _ = widget;
Source

pub fn fill(self) -> Self

Sets both preferred axes to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill();
let _ = widget;
Source

pub fn fill_width(self) -> Self

Sets preferred width to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_width();
let _ = widget;
Source

pub fn fill_height(self) -> Self

Sets preferred height to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_height();
let _ = widget;
Source

pub fn margin(self, value: f32) -> Self

Sets uniform outer margin in logical pixels.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().margin(8.0);
let _ = widget;
Source

pub fn padding(self, value: f32) -> Self

Sets uniform inner padding in logical pixels.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().padding(8.0);
let _ = widget;
Source

pub fn flex_grow(self) -> Self

Sets flex-grow weight to one.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow();
let _ = widget;
Source

pub fn flex_grow_by(self, value: f32) -> Self

Sets a dimensionless flex-grow weight.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow_by(2.0);
let _ = widget;
Source

pub fn flex_shrink(self, value: f32) -> Self

Sets a dimensionless flex-shrink weight.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_shrink(1.0);
let _ = widget;
Source

pub fn flex_basis(self, value: impl Into<Length>) -> Self

Sets the preferred main-axis flex basis.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_basis(80.0);
let _ = widget;
Source

pub fn align_self(self, value: AlignItems) -> Self

Overrides cross-axis alignment for this flex item.

§Examples
use ailloli_ui_core::style::AlignItems;
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().align_self(AlignItems::Center);
let _ = widget;
Source§

impl<A: 'static> WindowAffordanceFrame<A>

Source

pub fn new(title: impl Into<String>) -> Self

Creates a default movable and resizable frame with title.

Empty titles are accepted and displayed as empty text.

§Examples
use ailloli_ui_widgets::chrome::WindowAffordanceFrame;
let frame: WindowAffordanceFrame<()> = WindowAffordanceFrame::new("Tools");
let _ = frame;
Source

pub fn logical_window_id(self, value: impl Into<String>) -> Self

Sets the host logical id used by built-in minimize requests.

§Examples
use ailloli_ui_widgets::chrome::WindowAffordanceFrame;
let frame: WindowAffordanceFrame<()> = WindowAffordanceFrame::new("Tools").logical_window_id("tools");
let _ = frame;
Source

pub fn content(self, content: impl IntoView<A>) -> Self

Installs the single child view below the title bar.

Repeated calls replace the previous child.

§Examples
use ailloli_ui_widgets::{chrome::WindowAffordanceFrame, text::Text};
let frame: WindowAffordanceFrame<()> = WindowAffordanceFrame::new("Tools").content(Text::new("Body"));
let _ = frame;
Source

pub fn movable(self, value: bool) -> Self

Enables or disables title-bar move hit testing.

§Examples
use ailloli_ui_widgets::chrome::WindowAffordanceFrame;
let frame: WindowAffordanceFrame<()> = WindowAffordanceFrame::new("Fixed").movable(false);
let _ = frame;
Source

pub fn resizable(self, value: bool) -> Self

Enables or disables edge and corner resize hit testing and handles.

§Examples
use ailloli_ui_widgets::chrome::WindowAffordanceFrame;
let frame: WindowAffordanceFrame<()> = WindowAffordanceFrame::new("Fixed").resizable(false);
let _ = frame;
Source

pub fn show_controls(self, value: bool) -> Self

Shows or hides close, minimize, and follow controls.

Hiding controls removes both paint and hit targets.

§Examples
use ailloli_ui_widgets::chrome::WindowAffordanceFrame;
let frame: WindowAffordanceFrame<()> = WindowAffordanceFrame::new("Bare").show_controls(false);
let _ = frame;
Source

pub fn window_affordance_style(self, style: WindowAffordanceStyle) -> Self

Replaces every chrome geometry and color token.

§Examples
use ailloli_ui_widgets::chrome::{WindowAffordanceFrame, WindowAffordanceStyle};
let style = WindowAffordanceStyle { titlebar_height: 42.0, ..Default::default() };
let frame: WindowAffordanceFrame<()> = WindowAffordanceFrame::new("Tools").window_affordance_style(style);
let _ = frame;
Source

pub fn on_affordance( self, f: impl Fn(WindowAffordanceEvent) -> A + 'static, ) -> Self

Maps each emitted event into an application action.

§Examples
use ailloli_ui_widgets::chrome::{WindowAffordanceEvent, WindowAffordanceFrame};
enum Action { Chrome(WindowAffordanceEvent) }
let frame = WindowAffordanceFrame::new("Tools").on_affordance(Action::Chrome);
let _: WindowAffordanceFrame<Action> = frame;
Source

pub fn on_affordance_ctx( self, f: impl Fn(&mut EventCtx<A>, WindowAffordanceEvent) + 'static, ) -> Self

Handles emitted events with mutable runtime event context access.

§Examples
use ailloli_ui_widgets::chrome::WindowAffordanceFrame;
let frame: WindowAffordanceFrame<()> = WindowAffordanceFrame::new("Tools")
    .on_affordance_ctx(|_ctx, _event| {});
let _ = frame;

Trait Implementations§

Source§

impl<A: 'static> IntoView<A> for WindowAffordanceFrame<A>

Converts the builder into its retained frame component.

Source§

fn into_view(self) -> View<A>

Consumes a builder/value and returns its declarative view tree. Read more
Source§

impl<A: 'static> LayoutExt for WindowAffordanceFrame<A>

Source§

fn layout_mut(&mut self) -> &mut LayoutStyle

Returns the widget’s mutable declarative size/inset state. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T, A> FlexItemExt<A> for T
where T: IntoView<A>,

Source§

fn flex_grow(self) -> View<A>

Sets flex-grow weight to one. Read more
Source§

fn flex_grow_by(self, value: f32) -> View<A>

Sets the dimensionless flex-grow weight. Read more
Source§

fn flex_shrink(self, value: f32) -> View<A>

Sets the dimensionless flex-shrink weight. Read more
Source§

fn flex_basis(self, value: impl Into<Length>) -> View<A>

Sets the preferred main-axis flex basis. Read more
Source§

fn align_self(self, value: AlignItems) -> View<A>

Overrides the parent cross-axis alignment for this view. Read more
Source§

fn fill_width(self) -> View<A>

Marks width as parent-fill in the view size hint. Read more
Source§

fn fill_height(self) -> View<A>

Marks height as parent-fill in the view size hint. Read more
Source§

fn fill(self) -> View<A>

Marks both axes as parent-fill in the view size hint. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T, A> IntoViewKeyExt<A> for T
where T: IntoView<A>,

§

fn key(self, key: impl Into<String>) -> View<A>

Converts self, assigns the owned key, and returns the view. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,