Struct native_windows_gui::Tooltip

pub struct Tooltip {
    pub handle: ControlHandle,
}

Tooltips appear automatically, or pop up, when the user pauses the mouse pointer over a tool or some other UI element. The tooltip appears near the pointer and disappears when the user clicks a mouse button, moves the pointer away from the tool, or simply waits for a few seconds.

A tooltip can be applied to multiple controls, each with their own custom text. This is done/undone using the register/unregister functions. So do not think as Tooltip as a standalone toolip, but more like a manager.

A tooltip can support static text using register and dynamic text using register_callback.

Tooltip requires the tooltip features

Example:

use native_windows_gui as nwg;

/// Building a tooltip and add tooltips at the same time
fn build_tooltip(tt: &mut nwg::Tooltip, btn1: &nwg::Button, btn2: &nwg::Button) {
    nwg::Tooltip::builder()
        .register(btn1, "A test button")
        .register_callback(btn2)
        .build(tt);
}

/// Adding/Updating a tooltip after the initial tooltip creation
fn add_tooltip(btn: &nwg::Button, tt: &nwg::Tooltip) {
    tt.register(btn, "This is a button!");
}

/// Dynamic tooltip callback setup
fn add_dynamic_tooltip(tt: &nwg::Tooltip, btn: &nwg::Button) {
    tt.register_callback(btn);
}


struct GuiStruct {
    // Skipping other members
    tt: nwg::Tooltip,
    button: nwg::Button
}

impl GuiStruct {
    /// The dynamic tooltip callback, triggered by the event loop
    fn events_callback(&self, evt: nwg::Event, evt_data: &nwg::EventData, handle: nwg::ControlHandle) {
        match evt {
            nwg::Event::OnTooltipText => {
                // Compare the handle to check which control will display the tooltip
                if &handle == &self.button {
                    let tooltip_data = evt_data.on_tooltip_text();
                    tooltip_data.set_text(&format!("Button text: \"{}\"", self.button.text()));
                }
            },
            _ => {}
        }
    }
}

Fields

handle: ControlHandle

Implementations

impl Tooltip

pub fn builder<'a>() -> TooltipBuilder<'a>

pub fn text(&self, owner: &ControlHandle, buffer_size: Option<usize>) -> String

Return the current text of the tooltip. There is no way to know the size of the text so you have to pass the buffer size. The default buffer size is 200 characters.

pub fn set_text<'a>(&self, owner: &ControlHandle, text: &'a str)

Change the text of a previously registered control Use the register function is associate a control with this tooltip

pub fn set_decoration<'a>(&self, title: &'a str, ico: &Icon)

Set the icon and the title of a tooltip. This method use custom icon defined by user resources

pub fn set_default_decoration<'a>(&self, title: &'a str, icon: TooltipIcon)

Set the icon and the title of a tooltip. This method use built-in icon defined by TooltipIcon

pub fn hide(&self)

Hide the tooltip popup

pub fn count(&self) -> usize

Return the number of controls registered by the tooltip

pub fn set_delay_time(&self, delay: Option<u16>)

Set the delay time for the tooltip to spawn in milliseconds Set the value to None to reset the value to default

pub fn delay_time(&self) -> u16

Return the delay time of the tooltip in milliseconds

pub fn set_enabled(&self, v: bool)

Enable or disable the control Windows does not support reading the enabled state of a tooltip btw.

pub fn register<'a, W: Into<ControlHandle>>(&self, owner: W, text: &'a str)

Register the tooltip under a control. owner must be a window control.

pub fn register_callback<W: Into<ControlHandle>>(&self, owner: W)

Register the tooltip under a control. owner must be a window control. When the user trigger the tooltip, the application receives a OnTooltipText event

pub fn unregister<W: Into<ControlHandle>>(&self, owner: W)

Remove the tooltip from a control

pub fn class_name(&self) -> &'static str

Winapi class name used during control creation

pub fn flags(&self) -> u32

Winapi base flags used during window creation

pub fn forced_flags(&self) -> u32

Winapi flags required by the control

Trait Implementations

impl Default for Tooltip

fn default() -> Tooltip

Returns the “default value” for a type.

impl Drop for Tooltip

fn drop(&mut self)

Executes the destructor for this type.

impl From<&Tooltip> for ControlHandle

fn from(control: &Tooltip) -> Self

Converts to this type from the input type.

impl From<&mut Tooltip> for ControlHandle

fn from(control: &mut Tooltip) -> Self

Converts to this type from the input type.

impl PartialEq<ControlHandle> for Tooltip

fn eq(&self, other: &ControlHandle) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Tooltip> for ControlHandle

fn eq(&self, other: &Tooltip) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Tooltip> for Tooltip

fn eq(&self, other: &Tooltip) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Tooltip

impl StructuralEq for Tooltip

impl StructuralPartialEq for Tooltip