Tooltips

Description GtkTooltips has been deprecated in GTK+ 2.12, in favor of the new GtkTooltip API. 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. An individual tooltip belongs to a group of tooltips. A group is created with a call to gtk_tooltips_new(). Every tooltip in the group can then be turned off with a call to gtk_tooltips_disable() and enabled with gtk_tooltips_enable(). The length of time the user must keep the mouse over a widget before the tip is shown, can be altered with gtk_tooltips_set_delay(). This is set on a 'per group of tooltips' basis. To assign a tip to a particular GtkWidget, gtk_tooltips_set_tip() is used. Note Tooltips can only be set on widgets which have their own X window and receive enter and leave events. To check if a widget has its own window use GTK_WIDGET_NO_WINDOW(). To add a tooltip to a widget that doesn't have its own window, place the widget inside a GtkEventBox and add a tooltip to that instead. The default appearance of all tooltips in a program is determined by the current GTK+ theme that the user has selected. Information about the tooltip (if any) associated with an arbitrary widget can be retrieved using gtk_tooltips_data_get().

class Tooltips : ObjectGtk {

protected

GtkTooltips* gtkTooltips;

GtkTooltips* getTooltipsStruct();

void* getStruct();

this(GtkTooltips* gtkTooltips);

void setStruct(GObject* obj);

this();

void enable();

void disable();

void setDelay(uint delay);

void setTip(Widget widget, string tipText, string tipPrivate);

static GtkTooltipsData* dataGet(Widget widget);

void forceWindow();

static int getInfoFromTipWindow(Window tipWindow, GtkTooltips* tooltips, Widget currentWidget);

}

Constructors

this this(GtkTooltips* gtkTooltips): Sets our main struct and passes it to the parent class
this this(): Warning gtk_tooltips_new has been deprecated since version 2.12 and should not be used in newly-written code. Creates an empty group of tooltips. This function initialises a GtkTooltips structure. Without at least one such structure, you can not add tips to your application.

Members

Functions

disable void disable(): Warning gtk_tooltips_disable has been deprecated since version 2.12 and should not be used in newly-written code. Causes all tooltips in tooltips to become inactive. Any widgets that have tips associated with that group will no longer display their tips until they are enabled again with gtk_tooltips_enable().
enable void enable(): Warning gtk_tooltips_enable has been deprecated since version 2.12 and should not be used in newly-written code. Allows the user to see your tooltips as they navigate your application.
forceWindow void forceWindow(): Warning gtk_tooltips_force_window has been deprecated since version 2.12 and should not be used in newly-written code. Ensures that the window used for displaying the given tooltips is created. Applications should never have to call this function, since GTK+ takes care of this.
getStruct void* getStruct(): the main Gtk struct as a void*
getTooltipsStruct GtkTooltips* getTooltipsStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
setDelay void setDelay(uint delay): Warning gtk_tooltips_set_delay has been deprecated since version 2.12 and should not be used in newly-written code. Sets the time between the user moving the mouse over a widget and the widget's tooltip appearing.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
setTip void setTip(Widget widget, string tipText, string tipPrivate): Warning gtk_tooltips_set_tip has been deprecated since version 2.12 and should not be used in newly-written code. Adds a tooltip containing the message tip_text to the specified GtkWidget.

Static functions

dataGet GtkTooltipsData* dataGet(Widget widget): Warning gtk_tooltips_data_get has been deprecated since version 2.12 and should not be used in newly-written code. Retrieves any GtkTooltipsData previously associated with the given widget.
getInfoFromTipWindow int getInfoFromTipWindow(Window tipWindow, GtkTooltips* tooltips, Widget currentWidget): Warning gtk_tooltips_get_info_from_tip_window has been deprecated since version 2.12 and should not be used in newly-written code. Determines the tooltips and the widget they belong to from the window in which they are displayed. This function is mostly intended for use by accessibility technologies; applications should have little use for it. Since 2.4

Variables

gtkTooltips GtkTooltips* gtkTooltips;: the main Gtk struct

Inherited Members

From ObjectGtk

gtkObject GtkObject* gtkObject;: the main Gtk struct
getObjectGtkStruct GtkObject* getObjectGtkStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
getId string getId(StockID id)
connectedSignals int[string] connectedSignals;
onDestroyListeners void delegate(ObjectGtk)[] onDestroyListeners;: Undocumented in source.
addOnDestroy void addOnDestroy(void delegate(ObjectGtk) dlg, ConnectFlags connectFlags): Signals that all holders of a reference to the GtkObject should release the reference that they hold. May result in finalization of the object if all references are released. See Also GObject
callBackDestroy void callBackDestroy(GtkObject* objectStruct, ObjectGtk _objectGtk): Undocumented in source. Be warned that the author may not have intended to support it.
sink void sink(): Warning gtk_object_sink has been deprecated since version 2.10 and should not be used in newly-written code. Use g_object_ref_sink() instead Removes the floating reference from a GtkObject, if it exists; otherwise does nothing. See the GtkObject overview documentation at the top of the page.
weakref void weakref(GDestroyNotify notify, void* data): Warning gtk_object_weakref is deprecated and should not be used in newly-written code. Use g_object_weak_ref() instead. Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).
weakunref void weakunref(GDestroyNotify notify, void* data): Warning gtk_object_weakunref is deprecated and should not be used in newly-written code. Use g_object_weak_unref() instead. Removes a weak reference callback to an object.
destroy void destroy(): Warning gtk_object_destroy has been deprecated since version 2.24 and should not be used in newly-written code. Use gtk_widget_destroy() instead (if object is a widget) Emits the "destroy" signal notifying all reference holders that they should release the GtkObject. See the overview documentation at the top of the page for more details. The memory for the object itself won't be deleted until its reference count actually drops to 0; gtk_object_destroy() merely asks reference holders to release their references, it does not free the object.
removeNoNotify void removeNoNotify(string key): Warning gtk_object_remove_no_notify is deprecated and should not be used in newly-written code. Use g_object_steal_data() instead. Remove a specified datum from the object's data associations (the object_data), without invoking the association's destroy handler. Just like gtk_object_remove_data() except that any destroy handler will be ignored. Therefore this only affects data set using gtk_object_set_data_full().
setUserData void setUserData(void* data): Warning gtk_object_set_user_data is deprecated and should not be used in newly-written code. Use g_object_set_data() instead. For convenience, every object offers a generic user data pointer. This function sets it.
getUserData void* getUserData(): Warning gtk_object_get_user_data is deprecated and should not be used in newly-written code. Use g_object_get_data() instead. Get the object's user data pointer. This is intended to be a pointer for your convenience in writing applications.
addArgType void addArgType(string argName, GType argType, uint argFlags, uint argId): Warning gtk_object_add_arg_type is deprecated and should not be used in newly-written code. Deprecated in favor of the GObject property system including GParamSpec. Add a new type of argument to an object class. Usually this is called when registering a new type of object.
setDataById void setDataById(GQuark dataId, void* data): Warning gtk_object_set_data_by_id is deprecated and should not be used in newly-written code. Use g_object_set_qdata() instead. Just like gtk_object_set_data() except that it takes a GQuark instead of a string, so it is slightly faster. Use gtk_object_data_try_key() and gtk_object_data_force_id() to get an id from a string.
setDataByIdFull void setDataByIdFull(GQuark dataId, void* data, GDestroyNotify destroy): Warning gtk_object_set_data_by_id_full is deprecated and should not be used in newly-written code. Use g_object_set_qdata_full() instead. Just like gtk_object_set_data_full() except that it takes a GQuark instead of a string, so it is slightly faster. Use gtk_object_data_try_key() and gtk_object_data_force_id() to get an id from a string.
getDataById void* getDataById(GQuark dataId): Warning gtk_object_get_data_by_id is deprecated and should not be used in newly-written code. Use g_object_get_qdata() instead. Just like gtk_object_get_data() except that it takes a GQuark instead of a string, so it is slightly faster. Use gtk_object_data_try_key() and gtk_object_data_force_id() to get an id from a string.
removeDataById void removeDataById(GQuark dataId): Warning gtk_object_remove_data_by_id is deprecated and should not be used in newly-written code. Use g_object_set_qdata() with data of NULL instead. Just like gtk_object_remove_data() except that it takes a GQuark instead of a string, so it is slightly faster. Remove a specified datum from the object's data associations. Subsequent calls to gtk_object_get_data() will return NULL. Use gtk_object_data_try_key() and gtk_object_data_force_id() to get an id from a string.
removeNoNotifyById void removeNoNotifyById(GQuark keyId): Warning gtk_object_remove_no_notify_by_id is deprecated and should not be used in newly-written code. Use g_object_steal_qdata() instead. Just like gtk_object_remove_no_notify() except that it takes a GQuark instead of a string, so it is slightly faster. Use gtk_object_data_try_key() and gtk_object_data_force_id() to get an id from a string.