Struct ComponentProbe

pub struct ComponentProbe<Component>
where
    Component: ComponentDefinition,
{ /* private fields */ }

A widget that provides access to a ComponentDefinition’s value through a Dynamic.

This widget enables access to runtime values provided by the theme without creating a custom widget. After creating a probe, value() can be used to observe and use the value.

The theme information retrieved will be the effective theme at the location the probe is inserted in the widget hierarchy.

Implementations

impl<Component> ComponentProbe<Component>

where Component: ComponentDefinition,

pub fn new( component: Component, initial_value: Component::ComponentType, ) -> Self

Returns a new probe that provides access to the runtime value of Component.

The initial contents of the dynamic will be initial_value.

pub fn new_wrapping( component: Component, initial_value: Component::ComponentType, child: impl MakeWidget, ) -> Self

Returns a new probe wrapping child that provides access to the runtime value of this component.

The initial contents of the dynamic will be initial_value.

pub fn default_for(component: Component) -> Self

where Component: ContextFreeComponent,

Returns a new probe that provides access to the runtime value of Component.

pub fn default_wrapping(component: Component, child: impl MakeWidget) -> Self

where Component: ContextFreeComponent,

Returns a new probe wrapping child that provides access to the runtime value of this component.

pub const fn value(&self) -> &Dynamic<Component::ComponentType>

Returns the dynamic that contains the component’s current value.

This dynamic’s contents will be updated whenever this probe is invalidated.

Trait Implementations

impl<Component> Debug for ComponentProbe<Component>

where Component: ComponentDefinition + Debug, Component::ComponentType: Debug,

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

Formats the value using the given formatter.

impl<Component> WrapperWidget for ComponentProbe<Component>

where Component: ComponentDefinition + Debug + Send + 'static, Component::ComponentType: PartialEq + Debug + Send + 'static,

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

Returns the child widget.

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 redraw_foreground(&mut self, context: &mut GraphicsContext<'_, '_, '_, '_>)

Draws the foreground of the widget.

fn align_child(&self) -> bool

If true, WrapperWidget::position_child will honor VerticalAlignment and HorizontalAlignment when positioning the child 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 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 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 mounted(&mut self, context: &mut EventContext<'_>)

The widget has been mounted into a parent 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.