Ardour  9.0-pre0-582-g084a23a80d
Gtk::Tooltips Class Reference

#include <tooltips.h>

Inheritance diagram for Gtk::Tooltips:
[legend]

Public Member Functions

virtual ~Tooltips ()
 
GtkTooltipsgobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkTooltipsgobj () const
 Provides access to the underlying C GtkObject. More...
 
 Tooltips ()
 
void enable ()
 
void disable ()
 
void set_tip (Widget &widget, const Glib::ustring &tip_text, const Glib::ustring &tip_private)
 
void set_tip (Widget &widget, const Glib::ustring &tip_text)
 
void unset_tip (Widget &widget)
 
void force_window ()
 
- Public Member Functions inherited from Gtk::Object
virtual ~Object ()
 
GtkObjectgobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkObjectgobj () const
 Provides access to the underlying C GtkObject. More...
 
Glib::PropertyProxy< void * > property_user_data ()
 
Glib::PropertyProxy_ReadOnly< void * > property_user_data () const
 

Static Protected Member Functions

static GtkTooltipsDatadata_get (Widget &widget)
 

Related Functions

(Note that these are not member functions.)

Gtk::Tooltipswrap (GtkTooltips *object, bool take_copy=false)
 

Detailed Description

Tooltips are the messages that appear next to a widget when the mouse pointer is held over it for a short amount of time. They are especially helpful for adding more verbose descriptions of things such as buttons in a toolbar.

This widget holds tooltips for other widgets. You should only need one Tooltip widget for all widgets you wish to add tips to.

Definition at line 67 of file tk/ytkmm/ytkmm/gtkmm/tooltips.h.

Constructor & Destructor Documentation

◆ ~Tooltips()

virtual Gtk::Tooltips::~Tooltips ( )
virtual

◆ Tooltips()

Gtk::Tooltips::Tooltips ( )

Member Function Documentation

◆ data_get()

static GtkTooltipsData* Gtk::Tooltips::data_get ( Widget widget)
staticprotected

◆ disable()

void Gtk::Tooltips::disable ( )

◆ enable()

void Gtk::Tooltips::enable ( )

◆ force_window()

void Gtk::Tooltips::force_window ( )

◆ gobj() [1/2]

GtkTooltips* Gtk::Tooltips::gobj ( )
inline

Provides access to the underlying C GtkObject.

Definition at line 104 of file tk/ytkmm/ytkmm/gtkmm/tooltips.h.

◆ gobj() [2/2]

const GtkTooltips* Gtk::Tooltips::gobj ( ) const
inline

Provides access to the underlying C GtkObject.

Definition at line 107 of file tk/ytkmm/ytkmm/gtkmm/tooltips.h.

◆ set_tip() [1/2]

void Gtk::Tooltips::set_tip ( Widget widget,
const Glib::ustring &  tip_text 
)

◆ set_tip() [2/2]

void Gtk::Tooltips::set_tip ( Widget widget,
const Glib::ustring &  tip_text,
const Glib::ustring &  tip_private 
)

Adds a tooltip containing the message tip_text to the specified Gtk::Widget. Deprecated: 2.12:

Parameters
widgetThe Gtk::Widget you wish to associate the tip with.
tip_textA string containing the tip itself.
tip_privateA string of any further information that may be useful if the user gets stuck.

◆ unset_tip()

void Gtk::Tooltips::unset_tip ( Widget widget)

Friends And Related Function Documentation

◆ wrap()

Gtk::Tooltips * wrap ( GtkTooltips object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file: