NbtkTooltip

NbtkTooltip — A tooltip widget

Synopsis

                    NbtkTooltip;
const gchar*        nbtk_tooltip_get_label              (NbtkTooltip *tooltip);
void                nbtk_tooltip_set_label              (NbtkTooltip *tooltip,
                                                         const gchar *text);
NbtkWidget*         nbtk_tooltip_get_widget             (NbtkTooltip *tooltip);
void                nbtk_tooltip_set_widget             (NbtkTooltip *tooltip,
                                                         NbtkWidget *widget);
void                nbtk_tooltip_show                   (NbtkTooltip *tooltip);
void                nbtk_tooltip_hide                   (NbtkTooltip *tooltip);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----NbtkWidget
                     +----NbtkTooltip

Implemented Interfaces

NbtkTooltip implements NbtkStylable and ClutterScriptable.

Properties

  "label"                    gchar*                : Read / Write
  "widget"                   gpointer              : Read / Write

Description

NbtkTooltip implements a single tooltip. It should not normally be created by the application but by the widget implementing tooltip capabilities, for example, #nbtk_button_set_tooltip().

Details

NbtkTooltip

typedef struct _NbtkTooltip NbtkTooltip;

The contents of this structure is private and should only be accessed using the provided API.

nbtk_tooltip_get_label ()

const gchar*        nbtk_tooltip_get_label              (NbtkTooltip *tooltip);

Get the text displayed on the tooltip

tooltip :

 a NbtkTooltip

Returns :

 the text for the tooltip. This must not be freed by the application

nbtk_tooltip_set_label ()

void                nbtk_tooltip_set_label              (NbtkTooltip *tooltip,
                                                         const gchar *text);

Sets the text displayed on the tooltip

tooltip :

 a NbtkTooltip

text :

 text to set the label to

nbtk_tooltip_get_widget ()

NbtkWidget*         nbtk_tooltip_get_widget             (NbtkTooltip *tooltip);

Get the widget associated with the tooltip

tooltip :

 a NbtkTooltip

Returns :

 the associated tooltip

nbtk_tooltip_set_widget ()

void                nbtk_tooltip_set_widget             (NbtkTooltip *tooltip,
                                                         NbtkWidget *widget);

Sets the text displayed on the tooltip

tooltip :

 a NbtkTooltip

widget :

 text to set the widget to

nbtk_tooltip_show ()

void                nbtk_tooltip_show                   (NbtkTooltip *tooltip);

Show the tooltip relative to the associated widget.

tooltip :

 a NbtkTooltip

nbtk_tooltip_hide ()

void                nbtk_tooltip_hide                   (NbtkTooltip *tooltip);

Hide the tooltip

tooltip :

 a NbtkTooltip

Property Details

The "label" property

  "label"                    gchar*                : Read / Write

Label of the tooltip.

Default value: NULL

The "widget" property

  "widget"                   gpointer              : Read / Write

Widget the tooltip is associated with.

Generated by GTK-Doc V1.10