Struct cushy::widgets::Style

pub struct Style { /* private fields */ }

A widget that applies a set of Styles to all contained widgets.

Implementations

impl Style

pub fn new(styles: impl IntoValue<Styles>, child: impl MakeWidget) -> Self

Returns a new widget that applies styles to child and any children it may have.

pub fn with<C: ComponentDefinition>( self, name: &C, component: impl IntoValue<C::ComponentType>, ) -> Style

where Value<C::ComponentType>: IntoComponentValue,

Associates a style component with self.

pub fn with_local<C: ComponentDefinition>( self, name: &C, component: impl IntoValue<C::ComponentType>, ) -> Style

where Value<C::ComponentType>: IntoComponentValue,

Associates a style component with self, preventing the value from being inherited by child widgets.

pub fn with_dynamic<C: ComponentDefinition>( self, name: &C, dynamic: impl IntoDynamicComponentValue, ) -> Style

where Value<C::ComponentType>: IntoComponentValue,

Associates a style component with self, resolving its value using dynamic at runtime.

pub fn with_local_dynamic<C: ComponentDefinition>( self, name: &C, dynamic: impl IntoDynamicComponentValue, ) -> Style

where Value<C::ComponentType>: IntoComponentValue,

Associates a style component with self, resolving its value using dynamic at runtime. This value will not be inherited by child widgets.

pub fn h1(self) -> Style

Styles self with the largest of 6 heading styles.

pub fn h2(self) -> Style

Styles self with the second largest of 6 heading styles.

pub fn h3(self) -> Style

Styles self with the third largest of 6 heading styles.

pub fn h4(self) -> Style

Styles self with the third smallest of 6 heading styles.

pub fn h5(self) -> Style

Styles self with the second smallest of 6 heading styles.

pub fn h6(self) -> Style

Styles self with the smallest of 6 heading styles.

pub fn xxxx_large(self) -> Style

Styles self with the largest text size.

pub fn xxx_large(self) -> Style

Styles self with the second largest text size.

pub fn xx_large(self) -> Style

Styles self with the third largest text size.

pub fn x_large(self) -> Style

Styles self with the fourth largest text size.

pub fn large(self) -> Style

Styles self with the fifth largest text size.

pub fn default_size(self) -> Style

Styles self with the third smallest text size.

pub fn small(self) -> Style

Styles self with the second smallest text size.

pub fn x_small(self) -> Style

Styles self with the smallest text size.

pub fn hint(self) -> Style

Styles self as an informational hint message.

Trait Implementations

impl Debug for Style

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

Formats the value using the given formatter.

impl WrapperWidget for Style

fn child_mut(&mut self) -> &mut WidgetRef

Returns the child widget.

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

The widget has been mounted into a parent widget.

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

Writes a summary of this widget into fmt.

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

Returns the behavior this widget should apply when positioned at the root of the window.

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

Draws the background of the widget.

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

Draws the foreground of the widget.

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

Returns the rectangle that the child widget should occupy given available_space.

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

Returns the adjusted contraints to use when laying out the child.

fn position_child( &mut self, size: Size<Px>, available_space: Size<ConstraintLimit>, context: &mut LayoutContext<'_, '_, '_, '_>, ) -> WrappedLayout

Returns the layout after positioning the child that occupies size.

fn background_color(&mut self, context: &WidgetContext<'_>) -> Option<Color>

Returns the background color to render behind the wrapped widget.

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

The widget has been removed from its 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 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 focus(&mut self, context: &mut EventContext<'_>)

The widget has received focus for user input.

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.