CtkTooltip

CtkTooltip — Provides a way to show tooltips in Clutk

Synopsis

                    CtkTooltip;
                    CtkTooltipClass;
                    CtkTooltipPrivate;
ClutterActor *      ctk_tooltip_new                     (ClutterActor *actor);
void                ctk_tooltip_set_actor               (CtkTooltip *self,
                                                         ClutterActor *actor);
ClutterActor *      ctk_tooltip_get_actor               (CtkTooltip *self);
void                ctk_tooltip_set_label               (CtkTooltip *self,
                                                         const gchar *label);
const gchar *       ctk_tooltip_get_label               (CtkTooltip *self);
void                ctk_tooltip_show                    (CtkTooltip *self,
                                                         gint x,
                                                         gint y);
void                ctk_tooltip_hide                    (CtkTooltip *self);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----CtkActor
                     +----CtkTooltip

Implemented Interfaces

CtkTooltip implements ClutterScriptable and CtkFocusable.

Properties

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

Description

CtkTooltip Provides a widget to show a tooltip on a given ClutterActor object

Details

CtkTooltip

typedef struct _CtkTooltip CtkTooltip;


CtkTooltipClass

typedef struct {
  /* signals, not vfuncs */

  /* vtable */
} CtkTooltipClass;


CtkTooltipPrivate

typedef struct _CtkTooltipPrivate CtkTooltipPrivate;


ctk_tooltip_new ()

ClutterActor *      ctk_tooltip_new                     (ClutterActor *actor);

Creates a new ctk_tooltip object thats attached to actor

actor :

a ClutterActor

Returns :

A CtkTooltip object

ctk_tooltip_set_actor ()

void                ctk_tooltip_set_actor               (CtkTooltip *self,
                                                         ClutterActor *actor);

sets self to use actor as the ClutterActor its attached to

self :

a Ctktooltip object

actor :

a ClutterActor

ctk_tooltip_get_actor ()

ClutterActor *      ctk_tooltip_get_actor               (CtkTooltip *self);

Retrives the actor self is attached to

self :

a CtkTooltip object

Returns :

a ClutterActor

ctk_tooltip_set_label ()

void                ctk_tooltip_set_label               (CtkTooltip *self,
                                                         const gchar *label);

Sets the tooltip self to use the text label for its label

self :

A CtkTooltip object

label :

a string for the label

ctk_tooltip_get_label ()

const gchar *       ctk_tooltip_get_label               (CtkTooltip *self);

Retrives the label set previously by ctk_tooltip_set_label()

self :

a CtkTooltip object

Returns :

a string

ctk_tooltip_show ()

void                ctk_tooltip_show                    (CtkTooltip *self,
                                                         gint x,
                                                         gint y);

self :

x :

y :


ctk_tooltip_hide ()

void                ctk_tooltip_hide                    (CtkTooltip *self);

Hides the tooltip self - animating it as it goes

self :

A CtkTooltip object

Property Details

The "actor" property

  "actor"                    gpointer              : Read / Write

Actor the tooltip is associated with.


The "label" property

  "label"                    gchar*                : Read / Write

The contents of the tooltip.

Default value: NULL