Skip to main content

Tooltip

Struct Tooltip 

Source
pub struct Tooltip { /* private fields */ }
Expand description

A hover-triggered tooltip attached to a Response.

Construct with the body text and optionally layer on a heading or a keyboard-shortcut row, then call Tooltip::show immediately after rendering the trigger.

Implementations§

Source§

impl Tooltip

Source

pub fn new(body: impl Into<WidgetText>) -> Self

Create a tooltip with the given body text.

Defaults: anchored above the trigger, no heading, no shortcut row, arrow on, ~8 pt gap between trigger and tooltip.

Source

pub fn heading(self, heading: impl Into<WidgetText>) -> Self

Add a bold heading line above the body.

Source

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

Add a keyboard-shortcut row at the bottom of the tooltip.

The string is split on whitespace and each token is rendered as a small monospace chip, so "\u{2318} S" renders as two chips.

Source

pub fn shortcut_label(self, label: impl Into<String>) -> Self

Override the leading label on the shortcut row. Default: "Shortcut".

Source

pub fn side(self, side: TooltipSide) -> Self

Which side of the trigger to anchor on. Default: TooltipSide::Top.

Source

pub fn width(self, w: f32) -> Self

Fix the tooltip’s max content width, in points. Long body text wraps at this width. Default: 260.

Source

pub fn arrow(self, arrow: bool) -> Self

Toggle the small arrow that points at the trigger. Default: on.

Source

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

Gap between the trigger and the tooltip, in points. Default: 8.

Source

pub fn show(self, trigger: &Response) -> Option<Response>

Render the tooltip attached to trigger. Returns Some(response) while the tooltip is visible, None otherwise.

Trait Implementations§

Source§

impl Clone for Tooltip

Source§

fn clone(&self) -> Tooltip

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Tooltip

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,