Struct Tip

pub struct Tip(/* private fields */);

W A tooltip popup.

Can be set on the tooltip property.

Properties

pub hit_test_mode(mode: impl IntoVar<HitTestMode>);

If the tooltip can be interacted with the mouse.

This is disabled by default.

pub style_fn(style_fn: impl IntoVar<StyleFn>);

Extends or replaces the widget style.

Properties and when conditions in the style are applied to the widget. Style instances extend the contextual style by default, you can set replace on a style to true to fully replace.

Properties from Popup

pub focus_click_behavior(behavior: impl IntoVar<FocusClickBehavior>);

Popup focus behavior when it or a descendant receives a click.

Is FocusClickBehavior::ExitEnabled by default.

pub close_delay(delay: impl IntoVar<Duration>);

Delay awaited before actually closing when popup close is requested.

You can use this delay to await a closing animation for example. This property sets is_close_delaying while awaiting the delay.

pub is_close_delaying(state: impl IntoVar<bool>);

If close was requested for this layered widget and it is just awaiting for the close_delay.

Properties from Container

pub clip_to_bounds(clip: impl IntoVar<bool>);

Content overflow clipping.

pub child(child: impl UiNode);

The widget’s child.

Can be any type that implements UiNode, any widget.

In Container! derived widgets or similar this property is captured and used as the actual child, in other widgets this property is an alias for child_under.

pub padding(padding: impl IntoVar<SideOffsets>);

Margin space around the content of a widget.

This property is margin with nest group CHILD_LAYOUT.

pub child_align(alignment: impl IntoVar<Align>);

Aligns the widget content within the available space.

This property is align with nest group CHILD_LAYOUT.

pub child_insert( &self, placement: impl IntoVar<ChildInsert>, node: impl UiNode, spacing: impl IntoVar<Length>, );

Insert node in the placement relative to the widget’s child.

This property disables inline layout for the widget.

pub child_out_insert( &self, placement: impl IntoVar<ChildInsert>, node: impl UiNode, spacing: impl IntoVar<Length>, );

Insert node in the placement relative to the widget’s child, outside of the child layout.

This is still inside the parent widget, but outside of properties like padding.

This property disables inline layout for the widget.

pub child_left(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the left of the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

pub child_right(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the right of the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

pub child_top(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node above the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

pub child_bottom(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node below the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

pub child_start(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the left of the widget’s child in LTR contexts or to the right in RTL contexts.

This property disables inline layout for the widget. See child_insert for more details.

pub child_end(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the right of the widget’s child in LTR contexts or to the right of the widget’s child in RTL contexts.

This property disables inline layout for the widget. See child_insert for more details.

pub child_over(node: impl UiNode);

Insert node over the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

pub child_under(node: impl UiNode);

Insert node under the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

pub child_out_left(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the left of the widget’s child, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_right(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the right of the widget’s child, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_top(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node above the widget’s child, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_bottom(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node below the widget’s child, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_start(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the left of the widget’s child in LTR contexts or to the right in RTL contexts, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_end(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the right of the widget’s child in LTR contexts or to the right of the widget’s child in RTL contexts, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_over(node: impl UiNode);

Insert node over the widget’s child, not affected by child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_under(node: impl UiNode);

Insert node under the widget’s child, not affected by child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

Properties from WidgetBase

pub id(id: impl IntoValue<WidgetId>);

Unique ID of the widget instance.

Note that the id can convert from a &'static str unique name.

Implementations

impl Tip

pub fn widget_new() -> Tip

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

Loading...

pub fn focusable(&self, focusable: impl IntoVar<bool>)

P Makes the widget focusable when set to true.

pub fn is_focused(&self, state: impl IntoVar<bool>)

P If the widget has keyboard focus.

This is only true if the widget itself is focused. Use is_focus_within to include focused widgets inside this one.

Highlighting

This property is always true when the widget has focus, independent of what device moved the focus, usually when the keyboard is used a special visual indicator is rendered, a dotted line border is common, this state is called highlighting and is tracked by the focus manager. To implement such a visual you can use the is_focused_hgl property.

Return Focus

Usually widgets that have a visual state for this property also have one for is_return_focus, a common example is the text-input widget that shows an emphasized border and blinking cursor when focused and still shows the emphasized border without cursor when a menu is open and it is only the return focus.

pub fn is_focus_within(&self, state: impl IntoVar<bool>)

P If the widget or one of its descendants has keyboard focus.

To check if only the widget has keyboard focus use is_focused.

To track highlighted focus within use is_focus_within_hgl property.

pub fn is_focused_hgl(&self, state: impl IntoVar<bool>)

P If the widget has keyboard focus and the user is using the keyboard to navigate.

This is only true if the widget itself is focused and the focus was acquired by keyboard navigation. You can use is_focus_within_hgl to include widgets inside this one.

Highlighting

Usually when the keyboard is used to move the focus a special visual indicator is rendered, a dotted line border is common, this state is called highlighting and is tracked by the focus manager, this property is only true.

pub fn is_focus_within_hgl(&self, state: impl IntoVar<bool>)

P If the widget or one of its descendants has keyboard focus and the user is using the keyboard to navigate.

To check if only the widget has keyboard focus use is_focused_hgl.

Also see is_focus_within to check if the widget has focus within regardless of highlighting.

pub fn is_return_focus(&self, state: impl IntoVar<bool>)

P If the widget will be focused when a parent scope is focused.

Focus scopes can remember the last focused widget inside, the focus returns to this widget when the scope receives focus. Alt scopes also remember the widget from which the alt focus happened and can also return focus back to that widget.

Usually input widgets that have a visual state for is_focused also have a visual for this, a common example is the text-input widget that shows an emphasized border and blinking cursor when focused and still shows the emphasized border without cursor when a menu is open and it is only the return focus.

Note that a widget can be is_focused and is_return_focus, this property is true if any focus scope considers the widget its return focus, you probably want to declare the widget visual states in such a order that is_focused overrides the state of this property.

pub fn is_return_focus_within(&self, state: impl IntoVar<bool>)

P If the widget or one of its descendants will be focused when a focus scope is focused.

To check if only the widget is the return focus use is_return_focus.

pub fn focus_on_init(&self, enabled: impl IntoVar<bool>)

P If the widget is focused on info init.

When the widget is inited and present in the info tree a FOCUS.focus_widget_or_related request is made for the widget.

pub fn return_focus_on_deinit(&self, enabled: impl IntoVar<bool>)

P If the widget return focus to the previous focus when it inited.

This can be used with the modal property to declare modal dialogs that return the focus to the widget that opens the dialog.

Consider using focus_click_behavior if the widget is also an ALT focus scope.

pub fn focus_highlight( &self, offsets: impl IntoVar<SideOffsets>, widths: impl IntoVar<SideOffsets>, sides: impl IntoVar<BorderSides>, )

P Sets the foreground highlight values used when the widget is focused and highlighted.

Trait Implementations

impl Deref for Tip

type Target = Popup

The resulting type after dereferencing.

fn deref(&self) -> &<Tip as Deref>::Target

Dereferences the value.

impl DerefMut for Tip

fn deref_mut(&mut self) -> &mut <Tip as Deref>::Target

Mutably dereferences the value.