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);
void                nbtk_tooltip_show                   (NbtkTooltip *tooltip);
void                nbtk_tooltip_hide                   (NbtkTooltip *tooltip);
void                nbtk_tooltip_set_tip_area           (NbtkTooltip *tooltip,
                                                         const ClutterGeometry *area);
const ClutterGeometry* nbtk_tooltip_get_tip_area        (NbtkTooltip *tooltip);

Object Hierarchy

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

Implemented Interfaces

NbtkTooltip implements ClutterScriptable, ClutterAnimatable, AtkImplementorIface and NbtkStylable.

Properties

  "label"                    gchar*                : Read / Write
  "tip-area"                 ClutterGeometry*      : 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_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

nbtk_tooltip_set_tip_area ()

void                nbtk_tooltip_set_tip_area           (NbtkTooltip *tooltip,
                                                         const ClutterGeometry *area);

Set the area on the stage that the tooltip applies to.

tooltip :

A NbtkTooltip

area :

A ClutterGeometry

nbtk_tooltip_get_tip_area ()

const ClutterGeometry* nbtk_tooltip_get_tip_area        (NbtkTooltip *tooltip);

Retrieve the area on the stage that the tooltip currently applies to

tooltip :

A NbtkTooltip

Returns :

the ClutterGeometry, owned by the tooltip which must not be freed by the application.

Property Details

The "label" property

  "label"                    gchar*                : Read / Write

Label of the tooltip.

Default value: NULL


The "tip-area" property

  "tip-area"                 ClutterGeometry*      : Read / Write

Area on the stage the tooltip applies to.