Struct cushy::widgets::container::Container

pub struct Container {
    pub background: Value<ContainerBackground>,
    pub padding: Option<Value<Edges<Dimension>>>,
    pub shadow: Value<ContainerShadow>,
    /* private fields */
}

A visual container widget, optionally applying padding and a background color.

Background Color Selection

This widget has three different modes for coloring its background:

• ContainerBackground::Auto: The background color is automatically selected by using the next level from the next parent container in the hierarchy.

  If the previous container is ContainerLevel::Highest or the previous parent container uses a color instead of a level, ContainerLevel::Lowest will be used.

• ContainerBackground::Color: The specified color will be drawn.

• SurfaceTheme container color associated with the given level will be used.

Fields

background: Value<ContainerBackground>

The configured background selection.

padding: Option<Value<Edges<Dimension>>>

Padding to surround the contained widget.

If this is None, a uniform surround of IntrinsicPadding will be applied.

shadow: Value<ContainerShadow>

The shadow to apply behind the container’s background.

Implementations

impl Container

pub fn new(child: impl MakeWidget) -> Self

Returns a new container wrapping child with default padding and a background color automatically selected by the theme.

See ContainerBackground::Auto for more information about automatic coloring.

pub fn pad_by(self, padding: impl IntoValue<Edges<Dimension>>) -> Self

Pads the contained widget with padding, returning the updated container.

pub fn transparent(self) -> Self

Sets this container to render no background color, and then returns the updated container.

pub fn contain_level(self, level: impl IntoValue<ContainerLevel>) -> Container

Sets this container to use the specific container level, and then returns the updated container.

pub fn background_color(self, color: impl IntoValue<Color>) -> Self

Sets this container to render the specified color background, and then returns the updated container.

pub fn shadow(self, shadow: impl IntoValue<ContainerShadow>) -> Self

Renders shadow behind the container’s background.

Trait Implementations

impl Debug for Container

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

Formats the value using the given formatter.

impl Widget for Container

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

Writes a summary of this widget into fmt.

fn unmounted(&mut self, context: &mut EventContext<'_>)

The widget has been removed from its parent widget.

fn full_control_redraw(&self) -> bool

Returns true if this widget handles all built-in style components that apply.

fn redraw(&mut self, context: &mut GraphicsContext<'_, '_, '_, '_>)

Redraw the contents of this widget.

fn layout( &mut self, available_space: Size<ConstraintLimit>, context: &mut LayoutContext<'_, '_, '_, '_>, ) -> Size<UPx>

Layout this widget and returns the ideal size based on its contents and the available_space.

fn root_behavior( &mut self, context: &mut EventContext<'_>, ) -> Option<(RootBehavior, WidgetInstance)>

Returns a reference to a single child widget if this widget is a widget that primarily wraps a single other widget to customize its behavior.

fn mounted(&mut self, context: &mut EventContext<'_>)

The widget has been mounted into a parent widget.

fn hit_test( &mut self, location: Point<Px>, context: &mut EventContext<'_>, ) -> bool

Returns true if this widget should respond to mouse input at location.

fn hover( &mut self, location: Point<Px>, context: &mut EventContext<'_>, ) -> Option<CursorIcon>

The widget is currently has a cursor hovering it at location.

fn unhover(&mut self, context: &mut EventContext<'_>)

The widget is no longer being hovered.

fn accept_focus(&mut self, context: &mut EventContext<'_>) -> bool

This widget has been targeted to be focused. If this function returns true, the widget will be focused. If false, Cushy will continue searching for another focus target.

fn focus(&mut self, context: &mut EventContext<'_>)

The widget has received focus for user input.

fn advance_focus( &mut self, direction: VisualOrder, context: &mut EventContext<'_>, ) -> EventHandling

The widget should switch to the next focusable area within this widget, honoring direction in a consistent manner. Returning HANDLED will cause the search for the next focus widget stop.

fn allow_blur(&mut self, context: &mut EventContext<'_>) -> bool

The widget is about to lose focus. Returning true allows the focus to switch away from this widget.

fn blur(&mut self, context: &mut EventContext<'_>)

The widget is no longer focused for user input.

fn activate(&mut self, context: &mut EventContext<'_>)

The widget has become the active widget.

fn deactivate(&mut self, context: &mut EventContext<'_>)

The widget is no longer active.

fn mouse_down( &mut self, location: Point<Px>, device_id: DeviceId, button: MouseButton, context: &mut EventContext<'_>, ) -> EventHandling

A mouse button event has occurred at location. Returns whether the event has been handled or not.

fn mouse_drag( &mut self, location: Point<Px>, device_id: DeviceId, button: MouseButton, context: &mut EventContext<'_>, )

A mouse button is being held down as the cursor is moved across the widget.

fn mouse_up( &mut self, location: Option<Point<Px>>, device_id: DeviceId, button: MouseButton, context: &mut EventContext<'_>, )

A mouse button is no longer being pressed.

fn keyboard_input( &mut self, device_id: DeviceId, input: KeyEvent, is_synthetic: bool, context: &mut EventContext<'_>, ) -> EventHandling

A keyboard event has been sent to this widget. Returns whether the event has been handled or not.

fn ime(&mut self, ime: Ime, context: &mut EventContext<'_>) -> EventHandling

An input manager event has been sent to this widget. Returns whether the event has been handled or not.

fn mouse_wheel( &mut self, device_id: DeviceId, delta: MouseScrollDelta, phase: TouchPhase, context: &mut EventContext<'_>, ) -> EventHandling

A mouse wheel event has been sent to this widget. Returns whether the event has been handled or not.