gtk.Tooltips.Tooltips Class Reference

Inheritance diagram for gtk.Tooltips.Tooltips:

gtk.ObjectGtk.ObjectGtk gobject.ObjectG.ObjectG List of all members.

Public Member Functions

GtkTooltipsgetTooltipsStruct ()
 this (GtkTooltips *gtkTooltips)
 Sets our main struct and passes it to the parent class.
 this ()
 Creates an empty group of tooltips.
void enable ()
 Allows the user to see your tooltips as they navigate your application.
void disable ()
 Causes all tooltips in tooltips to become inactive.
void setDelay (uint delay)
 Warning gtk_tooltips_set_delay is deprecated and should not be used in newly-written code.
void setTip (Widget widget, char[] tipText, char[] tipPrivate)
 Adds a tooltip containing the message tip_text to the specified GtkWidget.
void forceWindow ()
 Ensures that the window used for displaying the given tooltips is created.

Static Public Member Functions

static GtkTooltipsDatadataGet (Widget widget)
 Retrieves any GtkTooltipsData previously associated with the given widget.
static int getInfoFromTipWindow (Window tipWindow, GtkTooltips **tooltips, GtkWidget **currentWidget)
 Determines the tooltips and the widget they belong to from the window in which they are displayed.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

GtkTooltipsgtkTooltips
 the main Gtk struct

Constructor & Destructor Documentation

gtk.Tooltips.Tooltips.this ( GtkTooltips gtkTooltips  ) 

Sets our main struct and passes it to the parent class.

gtk.Tooltips.Tooltips.this (  ) 

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. Returns: a new GtkTooltips group for you to use.


Member Function Documentation

static GtkTooltipsData* gtk.Tooltips.Tooltips.dataGet ( Widget  widget  )  [static]

Retrieves any GtkTooltipsData previously associated with the given widget.

widget: a GtkWidget. Returns: a GtkTooltipsData struct, or NULL if the widget has no tooltip.

void gtk.Tooltips.Tooltips.disable (  ) 

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(). tooltips: a GtkTooltips.

void gtk.Tooltips.Tooltips.enable (  ) 

Allows the user to see your tooltips as they navigate your application.

tooltips: a GtkTooltips.

void gtk.Tooltips.Tooltips.forceWindow (  ) 

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. tooltips: a GtkToolTips

static int gtk.Tooltips.Tooltips.getInfoFromTipWindow ( Window  tipWindow,
GtkTooltips **  tooltips,
GtkWidget **  currentWidget 
) [static]

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. tip_window: a GtkWindow tooltips: the return location for the tooltips which are displayed in tip_window, or NULL current_widget: the return location for the widget whose tooltips are displayed, or NULL Returns: TRUE if tip_window is displaying tooltips, otherwise FALSE. Since 2.4 See Also GtkToolbar Create groups of widgets with their own tooltips. GtkTipsQuery Query tooltips to create context-sensitive help.

void* gtk.Tooltips.Tooltips.getStruct (  )  [protected]

the main Gtk struct as a void*

Reimplemented from gtk.ObjectGtk.ObjectGtk.

GtkTooltips* gtk.Tooltips.Tooltips.getTooltipsStruct (  ) 

void gtk.Tooltips.Tooltips.setDelay ( uint  delay  ) 

Warning gtk_tooltips_set_delay is deprecated 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. tooltips: a GtkTooltips. delay: an integer value representing milliseconds.

void gtk.Tooltips.Tooltips.setTip ( Widget  widget,
char[]  tipText,
char[]  tipPrivate 
)

Adds a tooltip containing the message tip_text to the specified GtkWidget.

tooltips: a GtkTooltips. widget: the GtkWidget you wish to associate the tip with. tip_text: a string containing the tip itself. tip_private: a string of any further information that may be useful if the user gets stuck.


Member Data Documentation

GtkTooltips* gtk.Tooltips.Tooltips.gtkTooltips [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo