Struct gtk4::Tooltip [−][src]
pub struct Tooltip(_);
Expand description
Tooltip
is an object representing a widget 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
property::Widget::has-tooltip
property totrue
. 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
signal::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 aTooltip
object. This is the object that we are about to display as a tooltip, and can be manipulated in your callback using functions likeset_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 returnfalse
, it will not be shown.
Implements
Implementations
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 set_markup()
and set_icon()
.
custom_widget
Sets the text of the tooltip to be text
.
If text
is None
, the label will be hidden.
See also set_markup()
.
text
a text string
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
Trait Implementations
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Returns the type identifier of Self
.
Auto Trait Implementations
impl RefUnwindSafe for Tooltip
impl UnwindSafe for Tooltip
Blanket Implementations
Mutably borrows from an owned value. Read more
Upcasts an object to a superclass or interface T
. Read more
Upcasts an object to a reference of its superclass or interface T
. Read more
Tries to downcast to a subclass or interface implementor T
. Read more
Tries to downcast to a reference of its subclass or interface implementor T
. Read more
Tries to cast to an object of type T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read more
Tries to cast to reference to an object of type T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read more
Casts to T
unconditionally. Read more
Casts to &T
unconditionally. Read more
Returns true
if the object is an instance of (can be cast to) T
.
pub fn set_property<'a, N, V>(
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
N: Into<&'a str>,
V: ToValue,
pub fn set_property_from_value<'a, N>(
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>,
pub fn set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>
pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>,
pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>,
Safety Read more
Safety Read more
Safety Read more
Safety Read more
pub fn connect<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
N: Into<&'a str>,
F: 'static + Fn(&[Value]) -> Option<Value> + Send + Sync,
Same as connect
but takes a SignalId
instead of a signal name.
pub fn connect_local<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
N: Into<&'a str>,
F: 'static + Fn(&[Value]) -> Option<Value>,
Same as connect_local
but takes a SignalId
instead of a signal name.
pub unsafe fn connect_unsafe<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
N: Into<&'a str>,
F: Fn(&[Value]) -> Option<Value>,
Same as connect_unsafe
but takes a SignalId
instead of a signal name.
Emit signal by signal id.
Same as emit
but takes Value
for the arguments.
Emit signal by its name.
Same as emit_by_name
but takes Value
for the arguments.
Emit signal with details by signal id.
Same as emit_with_details
but takes Value
for the arguments.
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
pub fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>,
Returns a SendValue
clone of self
.