Struct Handle

pub struct Handle<'a, V> { /* private fields */ }

A handle to a view which has been built into the tree.

Implementations

impl<V> Handle<'_, V>

pub fn entity(&self) -> Entity

Returns the [Entity] id of the view.

pub fn context(&mut self) -> &mut Context

Returns a mutable reference to the context.

pub fn parent(&self) -> Entity

Returns the entity id of the parent view.

pub fn lock_focus_to_within(self) -> Handle<'_, V>

Stop the user from tabbing out of a subtree, which is useful for modal dialogs.

pub fn modify<F>(self, f: F) -> Handle<'_, V>

where F: FnOnce(&mut V), V: 'static,

Mody the internal data of the view.

pub fn on_build<F>(self, callback: F) -> Handle<'_, V>

where F: Fn(&mut EventContext<'_>),

Callback which is run when the view is built/rebuilt.

pub fn bind<R, T, F>(self, res: R, closure: F) -> Handle<'_, V>

where R: Res<T>, F: 'static + Fn(Handle<'_, V>, R),

Creates a binding to the given lens and provides a closure which can be used to mutate the view through a handle.

pub fn needs_relayout(&mut self)

Marks the view as needing a relayout.

pub fn needs_restyle(&mut self)

Marks the view as needing a restyle.

pub fn needs_redraw(&mut self)

Marks the view as needing a redraw.

pub fn bounds(&self) -> BoundingBox

Returns the bounding box of the view.

pub fn scale_factor(&self) -> f32

Returns the scale factor of the device.

impl Handle<'_, Avatar>

pub fn variant<U>(self, variant: impl Res<U>) -> Handle<'_, Avatar>

where U: Into<AvatarVariant>,

Selects the geometric variant of the Avatar. Accepts a value of, or lens to, an AvatarVariant.

Avatar::new(cx, |cx|{
    Svg::new(cx, ICON_USER);
})
.variant(AvatarVariant::Rounded);

pub fn badge<F>(self, content: F) -> Handle<'_, Avatar>

where F: FnOnce(&mut Context) -> Handle<'_, Badge>,

Adds a badge to the Avatar.

Avatar::new(cx, |cx|{
    Svg::new(cx, ICON_USER);
})
.badge(|cx| Badge::empty(cx).class("error"));

impl Handle<'_, Badge>

pub fn placement<U>(self, placement: impl Res<U>) -> Handle<'_, Badge>

where U: Into<BadgePlacement>,

Sets the placement of a badge relative to its parent. Accepts a value of, or lens to, a BadgePlacement.

impl Handle<'_, ButtonGroup>

pub fn vertical(self, is_vertical: impl Res<bool>) -> Handle<'_, ButtonGroup>

Sets whether the button group is in vertical orientation.

impl Handle<'_, Checkbox>

pub fn on_toggle<F>(self, callback: F) -> Handle<'_, Checkbox>

where F: 'static + Fn(&mut EventContext<'_>),

Set the callback triggered when the checkbox is pressed.

Examples

Checkbox::new(cx, AppData::value)
    .on_toggle(|cx| cx.emit(AppEvent::ToggleValue));

impl Handle<'_, Chip>

pub fn on_close( self, callback: impl Fn(&mut EventContext<'_>) + Send + Sync + 'static, ) -> Handle<'_, Chip>

Set the callback triggered when the close button of the chip is pressed. The chip close button is not displayed by default. Setting this callback causes the close button to be displayed.

pub fn variant<U>(self, variant: impl Res<U>) -> Handle<'_, Chip>

where U: Into<ChipVariant>,

Selects the style variant to be used by the chip. Accepts a value of, or lens to, a ChipVariant.

Example

Chip::new(cx, "Chip")
    .variant(ChipVariant::Filled);

impl Handle<'_, Collapsible>

pub fn open(self, open: impl Res<bool>) -> Handle<'_, Collapsible>

Set the open state of the collapsible view.

impl<L1, L2, T> Handle<'_, ComboBox<L1, L2, T>>

where L1: Lens<Target = Vec<T>>, T: 'static + Data + ToString, L2: Lens<Target = usize>,

pub fn on_select<F>(self, callback: F) -> Handle<'_, ComboBox<L1, L2, T>>

where F: 'static + Fn(&mut EventContext<'_>, usize),

Set the callback triggered when an item is selected from the ComboBox dropdown list.

impl Handle<'_, Datepicker>

pub fn on_select<F>(self, callback: F) -> Handle<'_, Datepicker>

where F: 'static + Fn(&mut EventContext<'_>, NaiveDate),

Set the callback triggered when a date is selected from the Datepicker view.

impl Handle<'_, Divider>

pub fn orientation( self, orientation: impl Res<Orientation>, ) -> Handle<'_, Divider>

Set the orientation of the divider. Accepts a value or a lens to an Orientation.

impl Handle<'_, Dropdown>

pub fn placement(self, placement: impl Res<Placement>) -> Handle<'_, Dropdown>

Sets the position where the tooltip should appear relative to its parent element. Defaults to Placement::Bottom.

pub fn show_arrow(self, show_arrow: bool) -> Handle<'_, Dropdown>

Sets whether the popup should include an arrow. Defaults to true.

pub fn arrow_size(self, size: impl Into<Length>) -> Handle<'_, Dropdown>

Sets the size of the popup arrow, or gap if the arrow is hidden.

pub fn should_reposition(self, flag: bool) -> Handle<'_, Dropdown>

Set to whether the popup should reposition to always be visible.

impl<L> Handle<'_, Knob<L>>

where L: Lens<Target = f32>,

pub fn on_change<F>(self, callback: F) -> Handle<'_, Knob<L>>

where F: 'static + Fn(&mut EventContext<'_>, f32),

Sets the callback triggered when the knob value is changed.

impl Handle<'_, ArcTrack>

pub fn value<L>(self, lens: L) -> Handle<'_, ArcTrack>

where L: Lens<Target = f32>,

impl Handle<'_, TickKnob>

pub fn value<L>(self, lens: L) -> Handle<'_, TickKnob>

where L: Lens<Target = f32>,

impl Handle<'_, Label>

pub fn describing( self, entity_identifier: impl Into<String>, ) -> Handle<'_, Label>

Which form element does this label describe.

Examples

Checkbox::new(cx, AppData::value).on_toggle(|cx| cx.emit(AppEvent::ToggleValue)).id("checkbox_identifier");
Label::new(cx, "hello").describing("checkbox_identifier");

impl Handle<'_, List>

pub fn selected<S>(self, selected: S) -> Handle<'_, List>

where S: Lens, <S as Lens>::Target: Deref<Target = [usize]> + Data,

Sets the selected items of the list. Takes a lens to a list of indices.

pub fn on_select<F>(self, callback: F) -> Handle<'_, List>

where F: 'static + Fn(&mut EventContext<'_>, usize),

Sets the callback triggered when a ListItem is selected.

pub fn selectable<U>(self, selectable: impl Res<U>) -> Handle<'_, List>

where U: Into<Selectable>,

Set the selectable state of the List.

pub fn selection_follows_focus<U>(self, flag: impl Res<U>) -> Handle<'_, List>

where U: Into<bool>,

Sets whether the selection should follow the focus.

pub fn orientation<U>(self, orientation: impl Res<U>) -> Handle<'_, List>

where U: Into<Orientation>,

Sets the orientation of the list.

pub fn scroll_to_cursor(self, flag: bool) -> Handle<'_, List>

Sets whether the scrollbar should move to the cursor when pressed.

pub fn on_scroll( self, callback: impl Fn(&mut EventContext<'_>, f32, f32) + Send + Sync + 'static, ) -> Handle<'_, List>

Sets a callback which will be called when a scrollview is scrolled, either with the mouse wheel, touchpad, or using the scroll bars.

pub fn scroll_x(self, scrollx: impl Res<f32>) -> Handle<'_, List>

Set the horizontal scroll position of the ScrollView. Accepts a value or lens to an ‘f32’ between 0 and 1.

pub fn scroll_y(self, scrollx: impl Res<f32>) -> Handle<'_, List>

Set the vertical scroll position of the ScrollView. Accepts a value or lens to an ‘f32’ between 0 and 1.

pub fn show_horizontal_scrollbar(self, flag: impl Res<bool>) -> Handle<'_, List>

Sets whether the horizontal scrollbar should be visible.

pub fn show_vertical_scrollbar(self, flag: impl Res<bool>) -> Handle<'_, List>

Sets whether the vertical scrollbar should be visible.

impl Handle<'_, PickList>

pub fn placeholder<P>(self, placeholder: impl Res<P>) -> Handle<'_, PickList>

where P: ToStringLocalized,

Sets the placeholder text that appears when the textbox has no value.

pub fn on_select<F>(self, callback: F) -> Handle<'_, PickList>

where F: 'static + Fn(&mut EventContext<'_>, usize),

Sets the callback triggered when an option is selected.

impl Handle<'_, Popup>

pub fn placement(self, placement: impl Res<Placement>) -> Handle<'_, Popup>

Sets the position where the popup should appear relative to its parent element. Defaults to Placement::Bottom.

pub fn show_arrow(self, show_arrow: impl Res<bool>) -> Handle<'_, Popup>

Sets whether the popup should include an arrow. Defaults to true.

pub fn arrow_size<U>(self, size: impl Res<U>) -> Handle<'_, Popup>

where U: Into<Length>,

Sets the size of the popup arrow, or gap if the arrow is hidden.

pub fn should_reposition( self, should_reposition: impl Res<bool>, ) -> Handle<'_, Popup>

Set to whether the popup should reposition to always be visible.

pub fn on_blur<F>(self, f: F) -> Handle<'_, Popup>

where F: 'static + Fn(&mut EventContext<'_>),

Registers a callback for when the user clicks off of the popup, usually with the intent of closing it.

impl Handle<'_, RadioButton>

pub fn on_select<F>(self, callback: F) -> Handle<'_, RadioButton>

where F: 'static + Fn(&mut EventContext<'_>),

Set the callback triggered when the radio button is selected.

Examples

RadioButton::new(cx, AppData::value)
    .on_select(|cx| cx.emit(AppEvent::ToggleValue));

impl Handle<'_, Rating>

pub fn on_change<F>(self, callback: F) -> Handle<'_, Rating>

where F: 'static + Fn(&mut EventContext<'_>, u32),

Set the callback which is triggered when the rating changes.

impl Handle<'_, ResizableStack>

pub fn on_reset<F>(self, on_reset: F) -> Handle<'_, ResizableStack>

where F: Fn(&mut EventContext<'_>) + 'static,

Sets a callback to be called when the stack is reset, i.e. when the resize handle is double-clicked.

impl<L1> Handle<'_, Scrollbar<L1>>

where L1: 'static + Lens<Target = f32>,

pub fn scroll_to_cursor( self, scroll_to_cursor: impl Res<bool>, ) -> Handle<'_, Scrollbar<L1>>

Sets whether the scrollbar should move to the cursor when pressed.

impl Handle<'_, ScrollView>

pub fn on_scroll( self, callback: impl Fn(&mut EventContext<'_>, f32, f32) + Send + Sync + 'static, ) -> Handle<'_, ScrollView>

Sets a callback which will be called when a scrollview is scrolled, either with the mouse wheel, touchpad, or using the scroll bars.

pub fn scroll_to_cursor( self, scroll_to_cursor: impl Res<bool>, ) -> Handle<'_, ScrollView>

Sets whether the scrollbar should move to the cursor when pressed.

pub fn scroll_x(self, scrollx: impl Res<f32>) -> Handle<'_, ScrollView>

Set the horizontal scroll position of the ScrollView. Accepts a value or lens to an ‘f32’ between 0 and 1.

pub fn scroll_y(self, scrollx: impl Res<f32>) -> Handle<'_, ScrollView>

Set the vertical scroll position of the ScrollView. Accepts a value or lens to an ‘f32’ between 0 and 1.

pub fn show_horizontal_scrollbar( self, flag: impl Res<bool>, ) -> Handle<'_, ScrollView>

Sets whether the horizontal scrollbar should be visible.

pub fn show_vertical_scrollbar( self, flag: impl Res<bool>, ) -> Handle<'_, ScrollView>

Sets whether the vertical scrollbar should be visible.

impl<L> Handle<'_, Slider<L>>

where L: Lens,

pub fn on_change<F>(self, callback: F) -> Handle<'_, Slider<L>>

where F: 'static + Fn(&mut EventContext<'_>, f32),

Sets the callback triggered when the slider value is changed.

Takes a closure which triggers when the slider value is changed, either by pressing the track or dragging the thumb along the track.

Slider::new(cx, AppData::value)
    .on_change(|cx, value| {
        debug!("Slider on_change: {}", value);
    });

pub fn range<U>(self, range: impl Res<U>) -> Handle<'_, Slider<L>>

where U: Into<Range<f32>>,

Sets the range of the slider.

If the bound data is outside of the range then the slider will clip to min/max of the range.

Slider::new(cx, AppData::value)
    .range(-20.0..50.0)
    .on_change(|cx, value| {
        debug!("Slider on_change: {}", value);
    });

pub fn orientation<U>(self, orientation: impl Res<U>) -> Handle<'_, Slider<L>>

where U: Into<Orientation>,

Sets the orientation of the slider.

Slider::new(cx, AppData::value)
    .orientation(Orientation::Vertical)
    .on_change(|cx, value| {
        debug!("Slider on_change: {}", value);
    });

pub fn step<U>(self, step: impl Res<U>) -> Handle<'_, Slider<L>>

where U: Into<f32>,

Set the step value for the slider.

Slider::new(cx, AppData::value)
    .step(0.1)
    .on_change(|cx, value| {
        debug!("Slider on_change: {}", value);
    });

pub fn keyboard_fraction<U>( self, keyboard_fraction: impl Res<U>, ) -> Handle<'_, Slider<L>>

where U: Into<f32>,

Sets the fraction of a slider that a press of an arrow key will change.

Slider::new(cx, AppData::value)
    .keyboard_fraction(0.05)
    .on_change(|cx, value| {
        debug!("Slider on_change: {}", value);
    });

impl Handle<'_, Spinbox>

pub fn on_increment<F>(self, callback: F) -> Handle<'_, Spinbox>

where F: 'static + Fn(&mut EventContext<'_>) + Send + Sync,

Sets the callback which is triggered when the Spinbox value is incremented.

pub fn on_decrement<F>(self, callback: F) -> Handle<'_, Spinbox>

where F: 'static + Fn(&mut EventContext<'_>) + Send + Sync,

Sets the callback which is triggered when the Spinbox value is decremented.

pub fn orientation( self, orientation: impl Res<Orientation>, ) -> Handle<'_, Spinbox>

Sets the orientation of the Spinbox.

pub fn icons(self, icons: impl Res<SpinboxIcons>) -> Handle<'_, Spinbox>

Set the icons which should be used for the increment and decrement buttons of the Spinbox

impl Handle<'_, Switch>

pub fn on_toggle<F>(self, callback: F) -> Handle<'_, Switch>

where F: 'static + Fn(&mut EventContext<'_>),

Set the callback triggered when the Switch is pressed.

Examples

Switch::new(cx, AppData::value)
    .on_toggle(|cx| cx.emit(AppEvent::ToggleValue));

impl Handle<'_, TabView>

pub fn vertical(self) -> Handle<'_, TabView>

pub fn on_select( self, callback: impl Fn(&mut EventContext<'_>, usize) + 'static, ) -> Handle<'_, TabView>

pub fn with_selected<U>(self, selected: impl Res<U>) -> Handle<'_, TabView>

where U: Into<usize>,

impl<L> Handle<'_, Textbox<L>>

where L: Lens,

pub fn on_edit<F>(self, callback: F) -> Handle<'_, Textbox<L>>

where F: 'static + Fn(&mut EventContext<'_>, String) + Send + Sync,

Sets the callback triggered when a textbox is edited, i.e. text is inserted/deleted.

Callback provides the current text of the textbox.

pub fn on_submit<F>(self, callback: F) -> Handle<'_, Textbox<L>>

where F: 'static + Fn(&mut EventContext<'_>, <L as Lens>::Target, bool) + Send + Sync,

Sets the callback triggered when a textbox is submitted, i.e. when the enter key is pressed with a single-line textbox or the textbox loses focus.

Callback provides the text of the textbox and a flag to indicate if the submit was due to a key press or a loss of focus.

pub fn on_blur<F>(self, callback: F) -> Handle<'_, Textbox<L>>

where F: 'static + Fn(&mut EventContext<'_>) + Send + Sync,

Sets the callback triggered when a textbox is blurred, i.e. the mouse is pressed outside of the textbox.

pub fn on_cancel<F>(self, callback: F) -> Handle<'_, Textbox<L>>

where F: 'static + Fn(&mut EventContext<'_>) + Send + Sync,

Sets the callback triggered when a textbox edit is cancelled, i.e. the escape key is pressed while editing.

pub fn validate<F>(self, is_valid: F) -> Handle<'_, Textbox<L>>

where F: 'static + Fn(&<L as Lens>::Target) -> bool + Send + Sync,

Sets a validation closure which is called when the textbox is edited and sets the validity attribute to the output of the closure.

If a textbox is modified with the validate modifier then the on_submit will not be called if the text is invalid.

pub fn placeholder<P>(self, text: impl Res<P>) -> Handle<'_, Textbox<L>>

where P: ToStringLocalized,

Sets the placeholder text that appears when the textbox has no value.

impl Handle<'_, ToggleButton>

pub fn on_toggle( self, callback: impl Fn(&mut EventContext<'_>) + 'static, ) -> Handle<'_, ToggleButton>

Sets the callback triggered when the ToggleButton is toggled.

impl Handle<'_, Tooltip>

pub fn placement<U>(self, placement: impl Res<U>) -> Handle<'_, Tooltip>

where U: Into<Placement>,

Sets the position where the tooltip should appear relative to its parent element. Defaults to Placement::Bottom.

pub fn arrow<U>(self, show_arrow: impl Res<U>) -> Handle<'_, Tooltip>

where U: Into<bool>,

Sets whether the tooltip should include an arrow. Defaults to true.

pub fn arrow_size<U>(self, size: impl Res<U>) -> Handle<'_, Tooltip>

where U: Into<Length>,

Sets the size of the tooltip arrow if enabled.

impl Handle<'_, VirtualList>

pub fn selected<S>(self, selected: S) -> Handle<'_, VirtualList>

where S: Lens, <S as Lens>::Target: Deref<Target = [usize]> + Data,

Sets the selected items of the list. Takes a lens to a list of indices.

pub fn on_select<F>(self, callback: F) -> Handle<'_, VirtualList>

where F: 'static + Fn(&mut EventContext<'_>, usize),

Sets the callback triggered when a ListItem is selected.

pub fn selectable<U>(self, selectable: impl Res<U>) -> Handle<'_, VirtualList>

where U: Into<Selectable>,

Set the selectable state of the List.

pub fn selection_follows_focus<U>( self, flag: impl Res<U>, ) -> Handle<'_, VirtualList>

where U: Into<bool>,

Sets whether the selection should follow the focus.

pub fn scroll_to_cursor(self, flag: bool) -> Handle<'_, VirtualList>

Sets whether the scrollbar should move to the cursor when pressed.

pub fn on_scroll( self, callback: impl Fn(&mut EventContext<'_>, f32, f32) + Send + Sync + 'static, ) -> Handle<'_, VirtualList>

Sets a callback which will be called when a scrollview is scrolled, either with the mouse wheel, touchpad, or using the scroll bars.

pub fn scroll_x(self, scrollx: impl Res<f32>) -> Handle<'_, VirtualList>

Set the horizontal scroll position of the ScrollView. Accepts a value or lens to an ‘f32’ between 0 and 1.

pub fn scroll_y(self, scrollx: impl Res<f32>) -> Handle<'_, VirtualList>

Set the vertical scroll position of the ScrollView. Accepts a value or lens to an ‘f32’ between 0 and 1.

pub fn show_horizontal_scrollbar( self, flag: impl Res<bool>, ) -> Handle<'_, VirtualList>

Sets whether the horizontal scrollbar should be visible.

pub fn show_vertical_scrollbar( self, flag: impl Res<bool>, ) -> Handle<'_, VirtualList>

Sets whether the vertical scrollbar should be visible.

impl Handle<'_, XYPad>

pub fn on_change<F>(self, callback: F) -> Handle<'_, XYPad>

where F: Fn(&mut EventContext<'_>, f32, f32) + 'static,

Set the callback which will be triggered when the XYPad is manipulated.

Trait Implementations

impl<V> AbilityModifiers for Handle<'_, V>

fn hoverable<U>(self, state: impl Res<U>) -> Self

where U: Into<bool>,

Sets whether the view can be hovered by the mouse and receive mouse events.

fn focusable<U>(self, state: impl Res<U>) -> Self

where U: Into<bool>,

Sets whether the view can be focused to receive keyboard input events.

fn checkable<U>(self, state: impl Res<U>) -> Self

where U: Into<bool>,

Sets whether the view can be checked.

fn navigable<U>(self, state: impl Res<U>) -> Self

where U: Into<bool>,

Sets whether the view can be navigated to, i.e. focused, by the keyboard.

impl<V> AccessibilityModifiers for Handle<'_, V>

where V: View,

fn role(self, role: Role) -> Self

Sets the accessibility role of the view.

fn name<U>(self, name: impl Res<U>) -> Self

where U: ToStringLocalized,

Sets the accessibility name of the view.

fn live(self, live: Live) -> Self

Sets whether the view should act as an accessibility live region.

fn hidden<U>(self, hidden: impl Res<U>) -> Self

where U: Into<bool>,

Sets whether the view should be hidden from accessibility.

fn numeric_value<U>(self, value: impl Res<U>) -> Self

where U: Into<f64>,

Sets the accessibility numeric value for the view.

fn text_value<U>(self, value: impl Res<U>) -> Self

where U: ToStringLocalized,

Sets the accessibility text value for the view.

impl<V> ActionModifiers<V> for Handle<'_, V>

where V: View,

fn tooltip<C>(self, content: C) -> Handle<'_, V>

where C: Fn(&mut Context) -> Handle<'_, Tooltip> + 'static,

Adds a popup tooltip to the view.

fn menu<C, T>(self, content: C) -> Handle<'_, V>

where C: FnOnce(&mut Context) -> Handle<'_, T>, T: View,

Adds a popup menu to the view.

fn on_press<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>) + Send + Sync,

Adds a callback which is performed when the the view receives the Press event. By default a view receives the Press event when the left mouse button is pressed and then released on the view, or when the space or enter keys are pressed and then released while the view is focused.

fn on_press_down<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>) + Send + Sync,

Adds a callback which is performed when the the view receives the PressDown event. or when the space or enter keys are pressed while the view is focused.

fn on_double_click<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>, MouseButton) + Send + Sync,

Adds a callback which is performed when the the view receives the MouseDoubleClick event.

fn on_hover<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>) + Send + Sync,

Adds a callback which is performed when the mouse pointer moves over a view. This callback is not triggered when the mouse pointer moves over an overlapping child of the view.

fn on_hover_out<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>) + Send + Sync,

Adds a callback which is performed when the mouse pointer moves away from a view. This callback is not triggered when the mouse pointer moves away from an overlapping child of the view.

fn on_over<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>) + Send + Sync,

Adds a callback which is performed when the mouse pointer moves over the bounds of a view, including any overlapping children.

fn on_over_out<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>) + Send + Sync,

Adds a callback which is performed when the mouse pointer moves away from the bounds of a view, including any overlapping children.

fn on_mouse_move<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>, f32, f32) + Send + Sync,

Adds a callback which is performed when the mouse pointer moves within the bounds of a view.

fn on_mouse_down<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>, MouseButton) + Send + Sync,

Adds a callback which is performed when a mouse button is pressed on the view. Unlike the on_press callback, this callback is triggered for all mouse buttons and not for any keyboard keys.

fn on_mouse_up<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>, MouseButton) + Send + Sync,

Adds a callback which is performed when a mouse button is released on the view. Unlike the on_release callback, this callback is triggered for all mouse buttons and not for any keyboard keys.

fn on_focus_in<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>) + Send + Sync,

Adds a callback which is performed when the view gains keyboard focus.

fn on_focus_out<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>) + Send + Sync,

Adds a callback which is performed when the view loses keyboard focus.

fn on_geo_changed<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>, GeoChanged) + Send + Sync,

Adds a callback which is performed when the the view changes size or position after layout.

fn on_drag<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>) + Send + Sync,

Adds a callback which is performed when the view is dragged during a drag and drop operation.

fn on_drop<F>(self, action: F) -> Handle<'_, V>

where F: 'static + Fn(&mut EventContext<'_>, DropData) + Send + Sync,

Adds a callback which is performed when data is dropped on the view during a drag and drop operation.

impl<V> AsMut<Context> for Handle<'_, V>

fn as_mut(&mut self) -> &mut Context

Converts this type into a mutable reference of the (usually inferred) input type.

impl ButtonModifiers for Handle<'_, Button>

fn variant<U>(self, variant: impl Res<U>) -> Handle<'_, Button>

where U: Into<ButtonVariant>,

Selects the style variant to be used by the button or button group.

impl ButtonModifiers for Handle<'_, ButtonGroup>

fn variant<U>(self, variant: impl Res<U>) -> Handle<'_, ButtonGroup>

where U: Into<ButtonVariant>,

Selects the style variant to be used by the button or button group.

impl<V> DataContext for Handle<'_, V>

fn data<T>(&self) -> Option<&T>

where T: 'static,

Get model/view data from the context. Returns None if the data does not exist.

fn localization_context(&self) -> Option<LocalizationContext<'_>>

Convert the current context into a LocalizationContext.

impl<V> LayoutModifiers for Handle<'_, V>

where V: View,

fn layout_type<U>(self, value: impl Res<U>) -> Self

where U: Into<LayoutType>,

Sets the layout type of the view.

fn position_type<U>(self, value: impl Res<U>) -> Self

where U: Into<PositionType>,

Sets the position type of the view.

fn left<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the space on the left side of the view.

fn right<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the space on the right side of the view.

fn top<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the space on the top side of the view.

fn bottom<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the space on the bottom side of the view.

fn space<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the space for all sides of the view.

fn width<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the width of the view.

fn height<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the height of the view.

fn size<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the width and height of the view.

fn padding_left<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the space between the left side of the view and the left side of its children.

fn padding_right<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the space between the right side of the view and the right side of its children.

fn padding_top<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the space between the top side of the view and the top side of its children.

fn padding_bottom<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the space between the bottom side of the view and the bottom side of its children.

fn alignment<U>(self, value: impl Res<U>) -> Self

where U: Into<Alignment>,

Set the alignment of the view.

fn padding<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the space between the vew and its children.

fn vertical_gap<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the space between the views children in the vertical direction.

fn horizontal_gap<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the space between the views children in the horizontal direction.

fn gap<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the space between the views children in both the horizontal and vertical directions.

fn vertical_scroll<U>(self, value: impl Res<U>) -> Self

where U: Into<f32>,

Set the vertical scroll position of the view.

fn horizontal_scroll<U>(self, value: impl Res<U>) -> Self

where U: Into<f32>,

Set the horizontal scroll position of the view.

fn min_width<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the minimum width of the view.

fn min_height<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the minimum height of the view.

fn min_size<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the minimum width and minimum height of the view.

fn max_width<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the maximum width of the view.

fn max_height<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the maximum height of the view.

fn max_size<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the maximum width and maximum height of the view.

fn min_horizontal_gap<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the minimum horizontal space between the children of the view.

fn min_vertical_gap<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the minimum vertical space between the children of the view.

fn min_gap<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the minimum horizontal and minimum vertical space between the children of the view.

fn max_horizontal_gap<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the maximum horizontal space between the children of the view.

fn max_vertical_gap<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the maximum vertical space between the children of the view.

fn max_gap<U>(self, value: impl Res<U>) -> Self

where U: Into<Units>,

Sets the maximum horizontal and maximum vertical space between the children of the view.

fn grid_columns<U>(self, value: impl Res<U>) -> Self

where U: Into<Vec<Units>>,

Sets the grid columns for a grid layout.

fn grid_rows<U>(self, value: impl Res<U>) -> Self

where U: Into<Vec<Units>>,

Sets the grid rows for a grid layout.

fn column_start(self, value: impl Res<usize>) -> Self

fn column_span(self, value: impl Res<usize>) -> Self

fn row_start(self, value: impl Res<usize>) -> Self

fn row_span(self, value: impl Res<usize>) -> Self

impl<V> StyleModifiers for Handle<'_, V>

where V: View,

fn id(self, id: impl Into<String>) -> Self

Sets the ID name of the view.

fn class(self, name: &str) -> Self

Adds a class name to the view.

fn toggle_class(self, name: &str, applied: impl Res<bool>) -> Self

Sets whether a view should have the given class name.

fn checked<U>(self, state: impl Res<U>) -> Self

where U: Into<bool>,

Sets the checked state of the view.

fn focused<U>(self, state: impl Res<U>) -> Self

where U: Into<bool>,

Sets the focused state of the view.

fn focused_with_visibility<U>( self, focus: impl Res<U> + Copy + 'static, visibility: impl Res<U> + Copy + 'static, ) -> Self

where U: Into<bool>,

Sets the focused state of the view as well as the focus visibility.

fn read_only<U>(self, state: impl Res<U>) -> Self

where U: Into<bool>,

Sets whether the view should be in a read-only state.

fn read_write<U>(self, state: impl Res<U>) -> Self

where U: Into<bool>,

Sets whether the view should be in a read-write state.

fn placeholder_shown<U>(self, state: impl Res<U>) -> Self

where U: Into<bool>,

Sets whether the view is showing a placeholder.

fn disabled<U>(self, value: impl Res<U>) -> Self

where U: Into<bool>,

Sets the view to be disabled.

fn display<U>(self, value: impl Res<U>) -> Self

where U: Into<Display>,

Sets whether the view should be positioned and rendered.

fn visibility<U>(self, value: impl Res<U>) -> Self

where U: Into<Visibility>,

Sets whether the view should be rendered.

fn opacity<U>(self, value: impl Res<U>) -> Self

where U: Into<Opacity>,

Sets the opacity of the view.

fn z_index<U>(self, value: impl Res<U>) -> Self

where U: Into<i32>,

Sets the z-index of the view.

fn clip_path<U>(self, value: impl Res<U>) -> Self

where U: Into<ClipPath>,

Sets the clip path for the the view.

fn overflow<U>(self, value: impl Res<U>) -> Self

where U: Into<Overflow>,

Sets the overflow behavior of the view in the horizontal and vertical directions simultaneously.

fn overflowx<U>(self, value: impl Res<U>) -> Self

where U: Into<Overflow>,

Sets the overflow behavior of the view in the horizontal direction.

fn overflowy<U>(self, value: impl Res<U>) -> Self

where U: Into<Overflow>,

Sets the overflow behavior of the view in the vertical direction.

fn backdrop_filter<U>(self, value: impl Res<U>) -> Self

where U: Into<Filter>,

Sets the backdrop filter for the view.

fn shadow<U>(self, value: impl Res<U>) -> Self

where U: Into<Shadow>,

Add a shadow to the view.

fn shadows<U>(self, value: impl Res<U>) -> Self

where U: Into<Vec<Shadow>>,

Set the shadows of the view.

fn background_gradient<U>(self, value: impl Res<U>) -> Self

where U: Into<Gradient>,

Set the background gradient of the view.

fn background_color<U>(self, value: impl Res<U>) -> Self

where U: Into<Color>,

Sets the background color of the view.

fn background_image<'i, U>(self, value: impl Res<U>) -> Self

where U: Into<BackgroundImage<'i>>,

Set the background image of the view.

fn border_width<U>(self, value: impl Res<U>) -> Self

where U: Into<LengthOrPercentage>,

fn border_color<U>(self, value: impl Res<U>) -> Self

where U: Into<Color>,

Sets the border color of the view.

fn border_style<U>(self, value: impl Res<U>) -> Self

where U: Into<BorderStyleKeyword>,

Sets the border color of the view.

fn corner_top_left_radius<U>(self, value: impl Res<U>) -> Self

where U: Into<LengthOrPercentage>,

Sets the corner radius for the top-left corner of the view.

fn corner_top_right_radius<U>(self, value: impl Res<U>) -> Self

where U: Into<LengthOrPercentage>,

Sets the corner radius for the top-right corner of the view.

fn corner_bottom_left_radius<U>(self, value: impl Res<U>) -> Self

where U: Into<LengthOrPercentage>,

Sets the corner radius for the bottom-left corner of the view.

fn corner_bottom_right_radius<U>(self, value: impl Res<U>) -> Self

where U: Into<LengthOrPercentage>,

Sets the corner radius for the bottom-right corner of the view.

fn corner_radius<U>(self, value: impl Res<U>) -> Self

where U: Debug + Into<CornerRadius>,

Sets the corner radius for all four corners of the view.

fn corner_top_left_shape<U>(self, value: impl Res<U>) -> Self

where U: Into<CornerShape>,

Sets the corner corner shape for the top-left corner of the view.

fn corner_top_right_shape<U>(self, value: impl Res<U>) -> Self

where U: Into<CornerShape>,

Sets the corner corner shape for the top-right corner of the view.

fn corner_bottom_left_shape<U>(self, value: impl Res<U>) -> Self

where U: Into<CornerShape>,

Sets the corner corner shape for the bottom-left corner of the view.

fn corner_bottom_right_shape<U>(self, value: impl Res<U>) -> Self

where U: Into<CornerShape>,

Sets the corner corner shape for the bottom-right corner of the view.

fn corner_shape<U>(self, value: impl Res<U>) -> Self

where U: Debug + Into<Rect<CornerShape>>,

Sets the corner shape for all four corners of the view.

fn corner_top_left_smoothing<U>(self, value: impl Res<U>) -> Self

where U: Into<f32>,

Sets the corner smoothing for the top-left corner of the view.

fn corner_top_right_smoothing<U>(self, value: impl Res<U>) -> Self

where U: Into<f32>,

Sets the corner smoothing for the top-right corner of the view.

fn corner_bottom_left_smoothing<U>(self, value: impl Res<U>) -> Self

where U: Into<f32>,

Sets the corner smoothing for the bottom-left corner of the view.

fn corner_bottom_right_smoothing<U>(self, value: impl Res<U>) -> Self

where U: Into<f32>,

Sets the corner smoothing for the bottom-right corner of the view.

fn corner_smoothing<U>(self, value: impl Res<U>) -> Self

where U: Debug + Into<Rect<f32>>,

Sets the corner smoothing for all four corners of the view.

fn outline_width<U>(self, value: impl Res<U>) -> Self

where U: Into<LengthOrPercentage>,

Sets the outline width of the view.

fn outline_color<U>(self, value: impl Res<U>) -> Self

where U: Into<Color>,

Sets the outline color of the view.

fn outline_offset<U>(self, value: impl Res<U>) -> Self

where U: Into<LengthOrPercentage>,

Sets the outline offset of the view.

fn fill<U>(self, value: impl Res<U>) -> Self

where U: Into<Color>,

Overrides the fill color of SVG images.

fn cursor<U>(self, value: impl Res<U>) -> Self

where U: Into<CursorIcon>,

Sets the mouse cursor used when the view is hovered.

fn pointer_events<U>(self, value: impl Res<U>) -> Self

where U: Into<PointerEvents>,

Sets whether the view can be become the target of pointer events.

fn transform<U>(self, value: impl Res<U>) -> Self

where U: Into<Vec<Transform>>,

Sets the transform of the view with a list of transform functions.

fn transform_origin<U>(self, value: impl Res<U>) -> Self

where U: Into<Position>,

Sets the transform origin of the the view.

fn translate<U>(self, value: impl Res<U>) -> Self

where U: Into<Translate>,

Sets the translation offset of the view.

fn rotate<U>(self, value: impl Res<U>) -> Self

where U: Into<Angle>,

Sets the angle of rotation for the view.

fn scale<U>(self, value: impl Res<U>) -> Self

where U: Into<Scale>,

Sets the scale of the view.

impl<V> TextModifiers for Handle<'_, V>

fn text<T>(self, value: impl Res<T>) -> Self

where T: ToStringLocalized,

Sets the text content of the view.

fn font_family<U>(self, value: impl Res<U>) -> Self

where U: Into<Vec<FamilyOwned>>,

Sets the font that should be used by the view.

fn font_weight<U>(self, value: impl Res<U>) -> Self

where U: Into<FontWeight>,

Sets the font weight that should be used by the view.

fn font_slant<U>(self, value: impl Res<U>) -> Self

where U: Into<FontSlant>,

Sets the font style that should be used by the view.

fn font_width<U>(self, value: impl Res<U>) -> Self

where U: Into<FontWidth>,

Sets the font stretch that should be used by the view if the font supports it.

fn font_variation_settings<U>(self, value: impl Res<U>) -> Self

where U: Into<Vec<FontVariation>>,

Sets the font variation settings that should be used by the view.

fn color<U>(self, value: impl Res<U>) -> Self

where U: Clone + Into<Color>,

Sets the text color of the view.

fn font_size<U>(self, value: impl Res<U>) -> Self

where U: Into<FontSize>,

Sets the font size of the view.

fn caret_color<U>(self, value: impl Res<U>) -> Self

where U: Into<Color>,

Sets the ext caret color of the view.

fn selection_color<U>(self, value: impl Res<U>) -> Self

where U: Into<Color>,

Sets the color used to highlight selected text within the view.

fn text_wrap<U>(self, value: impl Res<U>) -> Self

where U: Into<bool>,

Sets whether the text of the view should be allowed to wrap.

fn text_align<U>(self, value: impl Res<U>) -> Self

where U: Into<TextAlign>,

Sets the horizontal alignment of text within the view.

fn text_overflow<U>(self, value: impl Res<U>) -> Self

where U: Into<TextOverflow>,

Sets the text overflow.

fn line_clamp<U>(self, value: impl Res<U>) -> Self

where U: Into<LineClamp>,

Sets the max number of .

fn text_decoration_line<U>(self, value: impl Res<U>) -> Self

where U: Into<TextDecorationLine>,

Sets the max number of .

fn text_stroke_width<U>(self, value: impl Res<U>) -> Self

where U: Into<Length>,

Sets the width of the text stroke. This sets Skia’s skia_safe::textlayout::TextStyle’s foreground skia_safe::Paint to draw a stroke on the text.

fn text_stroke_style<U>(self, value: impl Res<U>) -> Self

where U: Into<TextStrokeStyle>,

Sets the paint style of the text stroke. You can either draw text with a stroke, or just the stroke outline.

impl WindowModifiers for Handle<'_, Window>

fn on_close( self, callback: impl Fn(&mut EventContext<'_>) + 'static, ) -> Handle<'_, Window>

fn on_create( self, callback: impl Fn(&mut EventContext<'_>) + 'static, ) -> Handle<'_, Window>

fn title<T>(self, title: impl Res<T>) -> Handle<'_, Window>

where T: ToString,

Sets the title of the window to the given value. Accepts a type, or lens to a type, which implements ToString.

fn inner_size<S>(self, size: impl Res<S>) -> Handle<'_, Window>

where S: Into<WindowSize>,

Sets the inner size of the window to the given value. Accepts a value, or lens, which can be converted to a WindowSize.

fn min_inner_size<S>(self, size: impl Res<Option<S>>) -> Handle<'_, Window>

where S: Into<WindowSize>,

Sets the minimum inner size of the window to the given value. Accepts an optional value, or lens, which can be converted to a WindowSize.

fn max_inner_size<S>(self, size: impl Res<Option<S>>) -> Handle<'_, Window>

where S: Into<WindowSize>,

Sets the maximum inner size of the window to the given value. Accepts an optional value, or lens, which can be converted to a WindowSize.

fn position<P>(self, position: impl Res<P>) -> Handle<'_, Window>

where P: Into<WindowPosition>,

Sets the position of the window to the given value. Accepts a value, or lens, which can be converted to a [Position].

fn offset<P>(self, offset: impl Res<P>) -> Handle<'_, Window>

where P: Into<WindowPosition>,

fn anchor<P>(self, anchor: impl Res<P>) -> Handle<'_, Window>

where P: Into<Anchor>,

fn anchor_target<P>(self, anchor_target: impl Res<P>) -> Handle<'_, Window>

where P: Into<AnchorTarget>,

fn parent_anchor<P>(self, parent_anchor: impl Res<P>) -> Handle<'_, Window>

where P: Into<Anchor>,

fn resizable(self, flag: impl Res<bool>) -> Handle<'_, Window>

Sets whether the window can be resized. Accepts a boolean value, or lens to a boolean value.

fn minimized(self, flag: impl Res<bool>) -> Handle<'_, Window>

Sets whether the window is minimized. Accepts a boolean value, or lens to a boolean value.

fn maximized(self, flag: impl Res<bool>) -> Handle<'_, Window>

Sets whether the window is maximized. Accepts a boolean value, or lens to a boolean value.

fn visible(self, flag: impl Res<bool>) -> Handle<'_, Window>

Sets whether the window is visible. Accepts a boolean value, or lens to a boolean value.

fn transparent(self, flag: bool) -> Handle<'_, Window>

Sets whether the window is transparent. Accepts a boolean value, or lens to a boolean value.

fn decorations(self, flag: bool) -> Handle<'_, Window>

Sets whether the window has decorations. Accepts a boolean value, or lens to a boolean value.

fn always_on_top(self, flag: bool) -> Handle<'_, Window>

Sets whether the window should be on top of other windows. Accepts a boolean value, or lens to a boolean value.

fn vsync(self, flag: bool) -> Handle<'_, Window>

Sets whether the window has vsync enabled.

fn icon(self, width: u32, height: u32, image: Vec<u8>) -> Handle<'_, Window>

Sets the icon used for the window.

fn enabled_window_buttons( self, window_buttons: WindowButtons, ) -> Handle<'_, Window>