[−]Struct gtk::Tooltip

pub struct Tooltip(_, _);

Basic tooltips can be realized simply by using WidgetExt::set_tooltip_text or WidgetExt::set_tooltip_markup without any explicit tooltip object.

When you need a tooltip with a little more fancy contents, like adding an image, or you want the tooltip to have different contents per TreeView row or cell, you will have to do a little more work:

Set the Widget:has-tooltip property to true, this will make GTK+ monitor the widget for motion and related events which are needed to determine when and where to show a tooltip.
Connect to the Widget::query-tooltip signal. This signal will be emitted when a tooltip is supposed to be shown. One of the arguments passed to the signal handler is a Tooltip object. This is the object that we are about to display as a tooltip, and can be manipulated in your callback using functions like Tooltip::set_icon. There are functions for setting the tooltip’s markup, setting an image from a named icon, or even putting in a custom widget.

Return true from your query-tooltip handler. This causes the tooltip to be show. If you return false, it will not be shown.

In the probably rare case where you want to have even more control over the tooltip that is about to be shown, you can set your own Window which will be used as tooltip window. This works as follows:

Set Widget:has-tooltip and connect to Widget::query-tooltip as before. Use WidgetExt::set_tooltip_window to set a Window created by you as tooltip window.
In the Widget::query-tooltip callback you can access your window using WidgetExt::get_tooltip_window and manipulate as you wish. The semantics of the return value are exactly as before, return true to show the window, false to not show it.

Implements

glib::object::ObjectExt

Implementations

`impl Tooltip`[src]

`pub fn set_custom<P: IsA<Widget>>(&self, custom_widget: Option<&P>)`[src]

Replaces the widget packed into the tooltip with custom_widget. custom_widget does not get destroyed when the tooltip goes away. By default a box with a Image and Label is embedded in the tooltip, which can be configured using Tooltip::set_markup and Tooltip::set_icon.

`custom_widget`

a Widget, or None to unset the old custom widget.

`pub fn set_icon(&self, pixbuf: Option<&Pixbuf>)`[src]

Sets the icon of the tooltip (which is in front of the text) to be pixbuf. If pixbuf is None, the image will be hidden.

`pixbuf`

a gdk_pixbuf::Pixbuf, or None

`pub fn set_icon_from_gicon<P: IsA<Icon>>( &self, gicon: Option<&P>, size: IconSize )`[src]

Sets the icon of the tooltip (which is in front of the text) to be the icon indicated by gicon with the size indicated by size. If gicon is None, the image will be hidden.

`gicon`

a gio::Icon representing the icon, or None

`size`

a stock icon size (IconSize)

`pub fn set_icon_from_icon_name(&self, icon_name: Option<&str>, size: IconSize)`[src]

Sets the icon of the tooltip (which is in front of the text) to be the icon indicated by icon_name with the size indicated by size. If icon_name is None, the image will be hidden.

`icon_name`

an icon name, or None

`size`

a stock icon size (IconSize)

`pub fn set_markup(&self, markup: Option<&str>)`[src]

Sets the text of the tooltip to be markup, which is marked up with the [Pango text markup language][PangoMarkupFormat]. If markup is None, the label will be hidden.

`markup`

a markup string (see [Pango markup format][PangoMarkupFormat]) or None

`pub fn set_text(&self, text: Option<&str>)`[src]

Sets the text of the tooltip to be text. If text is None, the label will be hidden. See also Tooltip::set_markup.

`text`

a text string or None

`pub fn set_tip_area(&self, rect: &Rectangle)`[src]

Sets the area of the widget, where the contents of this tooltip apply, to be rect (in widget coordinates). This is especially useful for properly setting tooltips on TreeView rows and cells, GtkIconViews, etc.

For setting tooltips on TreeView, please refer to the convenience functions for this: TreeViewExt::set_tooltip_row and TreeViewExt::set_tooltip_cell.

`rect`

a gdk::Rectangle

`pub fn trigger_tooltip_query(display: &Display)`[src]

Triggers a new tooltip query on display, in order to update the current visible tooltip, or to show/hide the current tooltip. This function is useful to call when, for example, the state of the widget changed by a key press.

`display`

a gdk::Display

Trait Implementations

`impl Clone for Tooltip`

`fn clone(&self) -> Tooltip`

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for Tooltip`

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

`impl Display for Tooltip`[src]

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

`impl Eq for Tooltip`

`impl Hash for Tooltip`

`fn hash<H: Hasher>(&self, state: &mut H)`

`fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,` 1.3.0[src]

`impl Ord for Tooltip`

`fn cmp(&self, other: &Tooltip) -> Ordering`

`#[must_use]fn max(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn min(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn clamp(self, min: Self, max: Self) -> Self`[src]

`impl<T: ObjectType> PartialEq<T> for Tooltip`

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

`#[must_use]fn ne(&self, other: &Rhs) -> bool`1.0.0[src]

`impl<T: ObjectType> PartialOrd<T> for Tooltip`

`fn partial_cmp(&self, other: &T) -> Option<Ordering>`

`#[must_use]fn lt(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn le(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn gt(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn ge(&self, other: &Rhs) -> bool`1.0.0[src]

`impl StaticType for Tooltip`

`fn static_type() -> Type`

Auto Trait Implementations

`impl RefUnwindSafe for Tooltip`

`impl !Send for Tooltip`

`impl !Sync for Tooltip`

`impl Unpin for Tooltip`

`impl UnwindSafe for Tooltip`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<Super, Sub> CanDowncast for Super where Sub: IsA<Super>, Super: IsA<Super>,`

`impl<T> Cast for T where T: ObjectType,`

`fn upcast<T>(self) -> T where Self: IsA<T>, T: ObjectType,`

`fn upcast_ref<T>(&self) -> &T where Self: IsA<T>, T: ObjectType,`

`fn downcast<T>(self) -> Result<T, Self> where Self: CanDowncast<T>, T: ObjectType,`

`fn downcast_ref<T>(&self) -> Option<&T> where Self: CanDowncast<T>, T: ObjectType,`

`fn dynamic_cast<T>(self) -> Result<T, Self> where T: ObjectType,`

`fn dynamic_cast_ref<T>(&self) -> Option<&T> where T: ObjectType,`

`unsafe fn unsafe_cast<T>(self) -> T where T: ObjectType,`

`unsafe fn unsafe_cast_ref<T>(&self) -> &T where T: ObjectType,`

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ObjectExt for T where T: ObjectType,`

`fn is(&self) -> bool where U: StaticType,`

`fn get_type(&self) -> Type`

`fn get_object_class(&self) -> &ObjectClass`

`fn set_properties( &self, property_values: &[(&str, &dyn ToValue)] ) -> Result<(), BoolError>`

`fn set_property<'a, N>( &self, property_name: N, value: &dyn ToValue ) -> Result<(), BoolError> where N: Into<&'a str>,`

`fn get_property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where N: Into<&'a str>,`

`unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where QD: 'static,`

`unsafe fn get_qdata<QD>(&self, key: Quark) -> Option<&QD> where QD: 'static,`

`unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where QD: 'static,`

`unsafe fn set_data<QD>(&self, key: &str, value: QD) where QD: 'static,`

`unsafe fn get_data<QD>(&self, key: &str) -> Option<&QD> where QD: 'static,`

`unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where QD: 'static,`

`fn block_signal(&self, handler_id: &SignalHandlerId)`

`fn unblock_signal(&self, handler_id: &SignalHandlerId)`

`fn stop_signal_emission(&self, signal_name: &str)`

`fn disconnect(&self, handler_id: SignalHandlerId)`

`fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where F: 'static + Send + Sync + Fn(&T, &ParamSpec),`

`unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F ) -> SignalHandlerId where F: Fn(&T, &ParamSpec),`

`fn notify<'a, N>(&self, property_name: N) where N: Into<&'a str>,`

`fn notify_by_pspec(&self, pspec: &ParamSpec)`

`fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where N: Into<&'a str>,`

`fn get_property_type<'a, N>(&self, property_name: N) -> Option<Type> where N: Into<&'a str>,`

`fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where N: Into<&'a str>,`

`fn list_properties(&self) -> Vec<ParamSpec>`

`fn connect<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static, N: Into<&'a str>,`

`fn connect_local<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value> + 'static, N: Into<&'a str>,`

`unsafe fn connect_unsafe<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value>, N: Into<&'a str>,`

`fn emit<'a, N>( &self, signal_name: N, args: &[&dyn ToValue] ) -> Result<Option<Value>, BoolError> where N: Into<&'a str>,`

`fn downgrade(&self) -> WeakRef<T>`

`fn bind_property<'a, O, N, M>( &'a self, source_property: N, target: &'a O, target_property: M ) -> BindingBuilder<'a> where M: Into<&'a str>, N: Into<&'a str>, O: ObjectType,`

`fn ref_count(&self) -> u32`

`impl<'a, T> ToGlibContainerFromSlice<'a, *const GList> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (const GList, <T as ToGlibContainerFromSlice<'a, const GList>>::Storage)`

`fn to_glib_container_from_slice( _t: &'a [T] ) -> (const GList, <T as ToGlibContainerFromSlice<'a, const GList>>::Storage)`

`fn to_glib_full_from_slice(_t: &[T]) -> *const GList`

`impl<'a, T> ToGlibContainerFromSlice<'a, *const GPtrArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (const GPtrArray, <T as ToGlibContainerFromSlice<'a, const GPtrArray>>::Storage)`

`fn to_glib_container_from_slice( _t: &'a [T] ) -> (const GPtrArray, <T as ToGlibContainerFromSlice<'a, const GPtrArray>>::Storage)`

`fn to_glib_full_from_slice(_t: &[T]) -> *const GPtrArray`

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<Array>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GArray, <T as ToGlibContainerFromSlice<'a, mut GArray>>::Storage)`

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GArray, <T as ToGlibContainerFromSlice<'a, mut GArray>>::Storage)`

`fn to_glib_full_from_slice(t: &[T]) -> *mut GArray`

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GList> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GList, <T as ToGlibContainerFromSlice<'a, mut GList>>::Storage)`

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GList, <T as ToGlibContainerFromSlice<'a, mut GList>>::Storage)`

`fn to_glib_full_from_slice(t: &[T]) -> *mut GList`

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GPtrArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GPtrArray, <T as ToGlibContainerFromSlice<'a, mut GPtrArray>>::Storage)`

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GPtrArray, <T as ToGlibContainerFromSlice<'a, mut GPtrArray>>::Storage)`

`fn to_glib_full_from_slice(t: &[T]) -> *mut GPtrArray`

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> ToSendValue for T where T: ToValue + SetValue + Send + ?Sized,`

`fn to_send_value(&self) -> SendValue`

`impl<T> ToString for T where T: Display + ?Sized,` [src]

`default fn to_string(&self) -> String`[src]

`impl<T> ToValue for T where T: SetValue + ?Sized,`

`fn to_value(&self) -> Value`

`fn to_value_type(&self) -> Type`

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

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

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

[−]Struct gtk::Tooltip

Implementations

impl Tooltip[src]

pub fn set_custom<P: IsA<Widget>>(&self, custom_widget: Option<&P>)[src]

pub fn set_icon(&self, pixbuf: Option<&Pixbuf>)[src]

pub fn set_icon_from_gicon<P: IsA<Icon>>( &self, gicon: Option<&P>, size: IconSize)[src]

pub fn set_icon_from_icon_name(&self, icon_name: Option<&str>, size: IconSize)[src]

pub fn set_markup(&self, markup: Option<&str>)[src]

pub fn set_text(&self, text: Option<&str>)[src]

pub fn set_tip_area(&self, rect: &Rectangle)[src]

pub fn trigger_tooltip_query(display: &Display)[src]

Trait Implementations

impl Clone for Tooltip

fn clone(&self) -> Tooltip

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for Tooltip

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

impl Display for Tooltip[src]

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

impl Eq for Tooltip

impl Hash for Tooltip

fn hash<__H: Hasher>(&self, state: &mut __H)

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher, 1.3.0[src]

impl Ord for Tooltip

fn cmp(&self, other: &Tooltip) -> Ordering

#[must_use]fn max(self, other: Self) -> Self1.21.0[src]

#[must_use]fn min(self, other: Self) -> Self1.21.0[src]

#[must_use]fn clamp(self, min: Self, max: Self) -> Self[src]

impl<T: ObjectType> PartialEq<T> for Tooltip

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

#[must_use]fn ne(&self, other: &Rhs) -> bool1.0.0[src]

impl<T: ObjectType> PartialOrd<T> for Tooltip

fn partial_cmp(&self, other: &T) -> Option<Ordering>

#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn gt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn ge(&self, other: &Rhs) -> bool1.0.0[src]

impl StaticType for Tooltip

fn static_type() -> Type

Auto Trait Implementations

impl RefUnwindSafe for Tooltip

impl !Send for Tooltip

impl !Sync for Tooltip

impl Unpin for Tooltip

impl UnwindSafe for Tooltip

Blanket Implementations

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

fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

fn borrow_mut(&mut self) -> &mut T[src]

impl<Super, Sub> CanDowncast<Sub> for Super where Sub: IsA<Super>, Super: IsA<Super>,

impl<T> Cast for T where T: ObjectType,

fn upcast<T>(self) -> T where Self: IsA<T>, T: ObjectType,

fn upcast_ref<T>(&self) -> &T where Self: IsA<T>, T: ObjectType,

fn downcast<T>(self) -> Result<T, Self> where Self: CanDowncast<T>, T: ObjectType,

fn downcast_ref<T>(&self) -> Option<&T> where Self: CanDowncast<T>, T: ObjectType,

fn dynamic_cast<T>(self) -> Result<T, Self> where T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T> where T: ObjectType,

unsafe fn unsafe_cast<T>(self) -> T where T: ObjectType,

unsafe fn unsafe_cast_ref<T>(&self) -> &T where T: ObjectType,

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T> ObjectExt for T where T: ObjectType,

fn is<U>(&self) -> bool where U: StaticType,

fn get_type(&self) -> Type

fn get_object_class(&self) -> &ObjectClass

fn set_properties( &self, property_values: &[(&str, &dyn ToValue)]) -> Result<(), BoolError>

fn set_property<'a, N>( &self, property_name: N, value: &dyn ToValue) -> Result<(), BoolError> where N: Into<&'a str>,

fn get_property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where N: Into<&'a str>,

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where QD: 'static,

unsafe fn get_qdata<QD>(&self, key: Quark) -> Option<&QD> where QD: 'static,

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where QD: 'static,

unsafe fn set_data<QD>(&self, key: &str, value: QD) where QD: 'static,

unsafe fn get_data<QD>(&self, key: &str) -> Option<&QD> where QD: 'static,

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where QD: 'static,

fn block_signal(&self, handler_id: &SignalHandlerId)