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) -> Self

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

pub fn modify<F>(self, f: F) -> Self

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

Mody the internal data of the view.

pub fn on_build<F>(self, callback: F) -> Self

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) -> Self

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: Into<AvatarVariant>>(self, variant: impl Res<U>) -> Self

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) -> Self

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: Into<BadgePlacement>>(self, placement: impl Res<U>) -> Self

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>) -> Self

Sets whether the button group is in vertical orientation.

impl Handle<'_, Checkbox>

pub fn on_toggle<F>(self, callback: F) -> Self

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 'static + Fn(&mut EventContext<'_>) + Send + Sync, ) -> Self

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: Into<ChipVariant>>(self, variant: impl Res<U>) -> Self

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>) -> Self

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) -> Self

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: 'static + Fn(&mut EventContext<'_>, NaiveDate)>( self, callback: F, ) -> Self

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

impl Handle<'_, Divider>

pub fn orientation(self, orientation: impl Res<Orientation>) -> Self

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>) -> Self

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) -> Self

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

pub fn arrow_size(self, size: impl Into<Length>) -> Self

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

pub fn should_reposition(self, flag: bool) -> Self

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

impl<L: Lens<Target = f32>> Handle<'_, Knob<L>>

pub fn on_change<F>(self, callback: F) -> Self

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

Sets the callback triggered when the knob value is changed.

impl Handle<'_, ArcTrack>

pub fn value<L: Lens<Target = f32>>(self, lens: L) -> Self

impl Handle<'_, TickKnob>

pub fn value<L: Lens<Target = f32>>(self, lens: L) -> Self

impl Handle<'_, Label>

pub fn describing(self, entity_identifier: impl Into<String>) -> Self

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: Lens>(self, selected: S) -> Self

where S::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) -> Self

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

Sets the callback triggered when a ListItem is selected.

pub fn selectable<U: Into<Selectable>>(self, selectable: impl Res<U>) -> Self

Set the selectable state of the List.

pub fn selection_follows_focus<U: Into<bool>>(self, flag: impl Res<U>) -> Self

Sets whether the selection should follow the focus.

pub fn horizontal<U: Into<bool>>(self, flag: impl Res<U>) -> Self

Sets the orientation of the list.

impl Handle<'_, PickList>

pub fn placeholder<P: ToStringLocalized>(self, placeholder: impl Res<P>) -> Self

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

pub fn on_select<F>(self, callback: F) -> Self

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>) -> Self

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>) -> Self

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

pub fn arrow_size<U: Into<Length>>(self, size: impl Res<U>) -> Self

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

pub fn should_reposition(self, should_reposition: impl Res<bool>) -> Self

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

pub fn on_blur<F>(self, f: F) -> Self

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) -> Self

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) -> Self

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

Set the callback which is triggered when the rating changes.

impl<L1: 'static + Lens<Target = f32>> Handle<'_, Scrollbar<L1>>

pub fn scroll_to_cursor(self, scroll_to_cursor: impl Res<bool>) -> Self

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) + 'static + Send + Sync, ) -> Self

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: bool) -> Self

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

pub fn scroll_x(self, scrollx: impl Res<f32>) -> Self

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>) -> Self

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>) -> Self

Sets whether the horizontal scrollbar should be visible.

pub fn show_vertical_scrollbar(self, flag: impl Res<bool>) -> Self

Sets whether the vertical scrollbar should be visible.

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

pub fn on_change<F>(self, callback: F) -> Self

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.

Example

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

pub fn range(self, range: Range<f32>) -> Self

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.

Example

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

pub fn step(self, step: f32) -> Self

Set the step value for the slider.

pub fn keyboard_fraction(self, keyboard_fraction: f32) -> Self

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

Example

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

impl Handle<'_, Spinbox>

pub fn on_increment<F>(self, callback: F) -> Self

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) -> Self

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>) -> Self

Sets the orientation of the Spinbox.

pub fn icons(self, icons: impl Res<SpinboxIcons>) -> Self

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) -> Self

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) -> Self

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

pub fn with_selected<U: Into<usize>>(self, selected: impl Res<U>) -> Self

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

pub fn on_edit<F>(self, callback: F) -> Self

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) -> Self

where F: 'static + Fn(&mut EventContext<'_>, L::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) -> Self

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) -> Self

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) -> Self

where F: 'static + Fn(&L::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: ToStringLocalized>(self, text: impl Res<P>) -> Self

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, ) -> Self

Sets the callback triggered when the ToggleButton is toggled.

impl Handle<'_, Tooltip>

pub fn placement<U: Into<Placement>>(self, placement: impl Res<U>) -> Self

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

pub fn arrow<U: Into<bool>>(self, show_arrow: impl Res<U>) -> Self

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

pub fn arrow_size<U: Into<Length>>(self, size: impl Res<U>) -> Self

Sets the size of the tooltip arrow if enabled.

impl Handle<'_, VirtualList>

pub fn scroll_to_cursor(self, flag: bool) -> Self

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

impl Handle<'_, XYPad>

pub fn on_change<F: Fn(&mut EventContext<'_>, f32, f32) + 'static>( self, callback: F, ) -> Self

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

Trait Implementations

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

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

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

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

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

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

Sets whether the view can be checked.

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

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

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

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

Sets the accessibility role of the view.

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

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: Into<bool>>(self, hidden: impl Res<U>) -> Self

Sets whether the view should be hidden from accessibility.

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

Sets the accessibility numeric value for the view.

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

Sets the accessibility text value for the view.

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

fn tooltip<C: Fn(&mut Context) -> Handle<'_, Tooltip> + 'static>( self, content: C, ) -> Self

Adds a popup tooltip to the view.

fn menu<C: FnOnce(&mut Context) -> Handle<'_, T>, T: View>( self, content: C, ) -> Self

Adds a popup menu to the view.

fn on_press<F>(self, action: F) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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: Into<ButtonVariant>>(self, variant: impl Res<U>) -> Self

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

impl ButtonModifiers for Handle<'_, ButtonGroup>

fn variant<U: Into<ButtonVariant>>(self, variant: impl Res<U>) -> Self

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

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

fn data<T: 'static>(&self) -> Option<&T>

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: View> LayoutModifiers for Handle<'_, V>

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

Sets the layout type of the view.

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

Sets the position type of the view.

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

Sets the space on the left side of the view.

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

Sets the space on the right side of the view.

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

Sets the space on the top side of the view.

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

Sets the space on the bottom side of the view.

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

Sets the space for all sides of the view.

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

Sets the width of the view.

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

Sets the height of the view.

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

Sets the width and height of the view.

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

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

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

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

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

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

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

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

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

Set the alignment of the view.

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

Sets the space between the vew and its children.

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

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

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

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

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

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

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

Set the vertical scroll position of the view.

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

Set the horizontal scroll position of the view.

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

Sets the minimum width of the view.

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

Sets the minimum height of the view.

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

Sets the minimum width and minimum height of the view.

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

Sets the maximum width of the view.

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

Sets the maximum height of the view.

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

Sets the maximum width and maximum height of the view.

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

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

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

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

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

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

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

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

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

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

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

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

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

Sets the grid columns for a grid layout.

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

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: View> StyleModifiers for Handle<'_, V>

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: Into<bool>>(self, state: impl Res<U>) -> Self

Sets the checked state of the view.

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

Sets the focused state of the view.

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

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

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

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

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

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

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

Sets the view to be disabled.

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

Sets whether the view should be positioned and rendered.

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

Sets whether the view should be rendered.

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

Sets the opacity of the view.

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

Sets the z-index of the view.

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

Sets the clip path for the the view.

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

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

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

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

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

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

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

Sets the backdrop filter for the view.

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

Add a shadow to the view.

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

Set the shadows of the view.

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

Set the background gradient of the view.

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

Sets the background color of the view.

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

Set the background image of the view.

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

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

Sets the border color of the view.

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

Sets the border color of the view.

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

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

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

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

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

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

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

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

fn corner_radius<U: Debug + Into<CornerRadius>>( self, value: impl Res<U>, ) -> Self

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

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

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

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

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

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

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

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

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

fn corner_shape<U: Debug + Into<Rect<CornerShape>>>( self, value: impl Res<U>, ) -> Self

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

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

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

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

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

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

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

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

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

fn corner_smoothing<U: Debug + Into<Rect<f32>>>( self, value: impl Res<U>, ) -> Self

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

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

Sets the outline width of the view.

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

Sets the outline color of the view.

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

Sets the outline offset of the view.

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

Sets the mouse cursor used when the view is hovered.

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

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

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

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

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

Sets the transform origin of the the view.

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

Sets the translation offset of the view.

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

Sets the angle of rotation for the view.

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

Sets the scale of the view.

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

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

Sets the text content of the view.

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

Sets the font that should be used by the view.

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

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

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

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

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

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

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

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

fn color<U: Clone + Into<Color>>(self, value: impl Res<U>) -> Self

Sets the text color of the view.

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

Sets the font size of the view.

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

Sets the ext caret color of the view.

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

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

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

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

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

Sets the horizontal alignment of text within the view.

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

Sets the text overflow.

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

Sets the max number of .

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

Sets the max number of .

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

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: Into<TextStrokeStyle>>(self, value: impl Res<U>) -> Self

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