Struct LayoutContext

pub struct LayoutContext<'context, 'clip, 'gfx, 'pass> {
    pub graphics: GraphicsContext<'context, 'clip, 'gfx, 'pass>,
    /* private fields */
}

A context to a function that is rendering a widget.

Fields

graphics: GraphicsContext<'context, 'clip, 'gfx, 'pass>

The graphics context that this layout operation is being performed within.

Implementations

impl<'context, 'clip, 'gfx, 'pass> LayoutContext<'context, 'clip, 'gfx, 'pass>

pub fn as_temporary(self) -> Self

Returns a new layout context that does not persist any child layout operations.

This type of context is useful for asking widgets to measuree themselves in hypothetical layout conditions while trying to determine the best layout for a composite control.

pub fn for_other<'child, Widget>( &'child mut self, widget: &Widget, ) -> <Widget::Managed as MapManagedWidget<LayoutContext<'child, 'child, 'gfx, 'pass>>>::Result

where Widget: ManageWidget, Widget::Managed: MapManagedWidget<LayoutContext<'child, 'child, 'gfx, 'pass>>,

Returns a new LayoutContext that allows invoking layout functions for widget.

pub fn layout(&mut self, available_space: Size<ConstraintLimit>) -> Size<UPx>

Invokes Widget::layout() on this context’s widget and returns the result.

pub fn set_child_layout(&mut self, child: &MountedWidget, layout: Rect<Px>)

Sets the layout for child to layout.

layout is relative to the current widget’s controls.

Methods from Deref<Target = GraphicsContext<'context, 'clip, 'gfx, 'pass>>

pub fn borrowed(&mut self) -> GraphicsContext<'_, 'clip, 'gfx, 'pass>

Returns a new instance that borrows from self.

pub fn for_other<'child, Widget>( &'child mut self, widget: &Widget, ) -> <Widget::Managed as MapManagedWidget<GraphicsContext<'child, 'child, 'gfx, 'pass>>>::Result

where Widget: ManageWidget, Widget::Managed: MapManagedWidget<GraphicsContext<'child, 'child, 'gfx, 'pass>>,

Returns a new GraphicsContext that allows invoking graphics functions for widget.

pub fn set_font_family(&mut self, family: FamilyOwned)

Sets the current font family.

pub fn current_family_list(&mut self) -> FontFamilyList

Returns the currently set font family list.

pub fn find_available_font_family( &mut self, list: &FontFamilyList, ) -> Option<FamilyOwned>

Returns the first font family in list that is currently in the font system, or None if no font families match.

pub fn set_available_font_family(&mut self, list: &FontFamilyList)

Sets the font family to the first family in list.

pub fn apply_opacity(&mut self, opacity: impl Into<ZeroToOne>)

Updates self to have opacity.

This setting will be mixed with the current opacity value.

pub fn clipped_to( &mut self, clip: Rect<Px>, ) -> GraphicsContext<'_, '_, 'gfx, 'pass>

Returns a new graphics context that renders to the clip rectangle.

pub fn fill(&mut self, color: Color)

Fills the background of this widget with color, honoring the current CornerRadius setting.

If the alpha channel of color is 0, this function does nothing.

pub fn stroke_outline<Unit>( &mut self, color: Color, options: StrokeOptions<Unit>, )

where Unit: ScreenScale<Px = Px, Lp = Lp, UPx = UPx> + Zero,

Strokes an outline around this widget’s contents.

pub fn draw_focus_ring(&mut self)

Renders the default focus ring for this widget.

pub fn current_font_settings(&self) -> FontSettings

Returns the widget context’s current font settings.

The settings returned are from retrieving the values of these style components:

The returned settings are not necessarily what is currently applied to this graphics context. To apply these settings, consider using Self::apply_current_font_settings() or FontSettings::apply.

pub fn apply_current_font_settings(&mut self)

Applies the current style settings for font family, text size, font style, and font weight.

pub fn redraw(&mut self)

Invokes Widget::redraw() on this context’s widget.

Methods from Deref<Target = WidgetContext<'context>>

pub fn borrowed(&mut self) -> WidgetContext<'_>

Returns a new instance that borrows from self.

pub fn for_other<'child, Widget>( &'child mut self, widget: &Widget, ) -> <Widget::Managed as MapManagedWidget<WidgetContext<'child>>>::Result

where Widget: ManageWidget, Widget::Managed: MapManagedWidget<WidgetContext<'child>>,

Returns a new context representing widget.

pub fn is_child_of(&self, possible_parent: &WidgetInstance) -> bool

Returns true if possible_parent is in this widget’s parent list.

pub fn enabled(&self) -> bool

Returns true if this widget is enabled.

pub fn redraw_when_changed(&self, value: &impl Trackable)

Ensures that this widget will be redrawn when value has been updated.

pub fn invalidate_when_changed(&self, value: &impl Trackable)

Ensures that this widget will be redrawn when value has been updated.

pub fn last_layout(&self) -> Option<Rect<Px>>

Returns the last layout of this widget.

pub fn focus(&mut self)

Sets the currently focused widget to this widget.

Widget events relating to focus changes are deferred until after the all contexts for the currently firing event are dropped.

pub fn blur(&mut self) -> bool

Clears focus from this widget, if it is the focused widget.

Returns true if this function resulted in the focus being changed.

Widget events relating to focus changes are deferred until after the all contexts for the currently firing event are dropped.

pub fn focus_is_advancing(&mut self) -> bool

Returns true if the last focus event was an advancing motion, not a returning motion.

This value is meaningless outside of focus-related events.

pub fn activate(&mut self) -> bool

Activates this widget, if it is not already active.

Returns true if this function resulted in the currently active widget being changed.

Widget events relating to activation changes are deferred until after the all contexts for the currently firing event are dropped.

pub fn deactivate(&mut self) -> bool

Deactivates this widget, if it is the currently active widget.

Returns true if this function resulted in the active widget being changed.

Widget events relating to activation changes are deferred until after the all contexts for the currently firing event are dropped.

pub fn active(&self) -> bool

Returns true if this widget is currently the active widget.

pub fn hovered(&self) -> bool

Returns true if this widget is currently hovered, even if the cursor is over a child widget.

pub fn primary_hover(&self) -> bool

Returns true if this widget that is directly beneath the cursor.

pub fn focused(&self, check_window: bool) -> bool

Returns true if this widget is currently focused for user input.

pub fn is_default(&self) -> bool

Returns true if this widget is the target to activate when the user triggers a default action.

See MakeWidget::into_default() for more information.

pub fn is_escape(&self) -> bool

Returns true if this widget is the target to activate when the user triggers an escape action.

See MakeWidget::into_escape() for more information.

pub fn widget(&self) -> &MountedWidget

Returns the widget this context is for.

pub fn attach_styles(&self, styles: impl IntoValue<Styles>)

Attaches styles to the widget hierarchy for this widget.

Style queries for children will return any values matching this collection.

pub fn attach_theme(&self, theme: Value<ThemePair>)

Attaches theme to the widget hierarchy for this widget.

All children nodes will access this theme in their contexts.

pub fn attach_theme_mode(&mut self, theme_mode: Value<ThemeMode>)

Attaches theme_mode to the widget hierarchy for this widget.

All children nodes will use this theme mode.

pub fn attach_locale(&self, locale: Value<LanguageIdentifier>)

Attaches locale to the widget hierarchy for this widget.

All children nodes will access this theme in their contexts.

pub fn get<Component: ComponentDefinition>( &self, query: &Component, ) -> Component::ComponentType

Queries the widget hierarchy for a single style component.

This function traverses up the widget hierarchy looking for the component being requested. If a matching component is found, it will be returned. Otherwise, the default value will be returned.

pub fn try_get<Component: ComponentDefinition>( &self, query: &Component, ) -> Option<Component::ComponentType>

Queries the widget hierarchy for a single style component.

This function traverses up the widget hierarchy looking for the component being requested. If a matching component is found, it will be returned.

pub fn window(&self) -> &dyn PlatformWindow

Returns the window containing this widget.

pub fn locale(&self) -> &Value<LanguageIdentifier>

Returns the locale for this widget.

pub fn localizations(&self) -> &Localizations

Returns the localizations for this application.

pub fn window_mut(&mut self) -> &mut dyn PlatformWindow

Returns an exclusive reference to the window containing this widget.

pub fn theme_pair(&self) -> &ThemePair

Returns the theme pair for the window.

pub fn theme(&self) -> &Theme

Returns the current theme in either light or dark mode.

pub fn theme_mode(&self) -> ThemeMode

Returns the currently active theme mode.

pub fn inverse_theme(&self) -> &Theme

Returns the opposite theme of Self::theme().

pub fn cache_key(&self) -> WidgetCacheKey

Returns a key that can be checked to see if a widget should invalidate caches it stores.

pub fn loaded_font_faces(&self, font: &LoadedFont) -> &[LoadedFontFace]

Returns a list of faces that were loaded from font, or an empty slice if no faces were loaded.

Trait Implementations

impl AsEventContext for LayoutContext<'_, '_, '_, '_>

fn as_event_context(&mut self) -> EventContext<'_>

Returns this context as an EventContext.

fn push_child(&mut self, child: WidgetInstance) -> MountedWidget

Pushes a new child widget into the widget hierarchy beneathq the context’s widget.

fn remove_child(&mut self, child: &MountedWidget)

Removes a widget from the hierarchy.

impl<'context, 'clip, 'gfx, 'pass> Deref for LayoutContext<'context, 'clip, 'gfx, 'pass>

type Target = GraphicsContext<'context, 'clip, 'gfx, 'pass>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for LayoutContext<'_, '_, '_, '_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl LocalizationContext for LayoutContext<'_, '_, '_, '_>

fn locale(&self) -> LanguageIdentifier

Returns the current locale of this context.

fn localizations(&self) -> &Localizations

Returns the localizations for this context.

fn invalidate_when_changed(&self, trackable: &impl Trackable)

Invalidates trackable when changed.