tooltips

tooltips — Manage customized tooltips.

Synopsis

void                uc_tooltips_main_set_display        (const gboolean value);
gboolean            uc_tooltips_main_get_display        (void);
void                uc_tooltips_init                    (void);
void                uc_tooltips_main_set_mouse_coord    (const gint32 x,
                                                         const gint32 y);
guint32             uc_tooltips_main_get_current_id     (void);
void                uc_tooltips_main_set_current_id     (const guint32 id);
guint32             uc_tooltips_main_get_last_id        (void);
void                uc_tooltips_main_set_last_id        (const guint32 id);
void                uc_tooltips_main_get_mouse_coord    (gint32 *x,
                                                         gint32 *y);
void                uc_tooltips_main_set_frozen         (const gboolean value);
gboolean            uc_tooltips_main_get_frozen         (void);
void                uc_tooltips_main_destroy            (void);
gboolean            uc_tooltips_main_get_active         (void);
void                uc_tooltips_main_set_active         (const gboolean value);
gboolean            uc_tooltips_get_frozen              (void);

Description

Details

uc_tooltips_main_set_display ()

void                uc_tooltips_main_set_display        (const gboolean value);

Set it user want that tooltips be displayed or not.

value :

TRUE if we must display tooltips.

uc_tooltips_main_get_display ()

gboolean            uc_tooltips_main_get_display        (void);

Check if we can display tooltips.

Returns :

TRUE if we must display tooltips.

uc_tooltips_init ()

void                uc_tooltips_init                    (void);

Initialize tooltips object.


uc_tooltips_main_set_mouse_coord ()

void                uc_tooltips_main_set_mouse_coord    (const gint32 x,
                                                         const gint32 y);

Set the current mouse coord.

x :

X mouse coord.

y :

Y mouse coord.

uc_tooltips_main_get_current_id ()

guint32             uc_tooltips_main_get_current_id     (void);

Get the current id of a UCLinkProperties object currently displayed in a tooltip.

Returns :

Id of the UCLinkProperties object currently displayed in the tooltip.

uc_tooltips_main_set_current_id ()

void                uc_tooltips_main_set_current_id     (const guint32 id);

Tell the id of the UCLinkProperties object currently displayed in the tooltip.

id :

Id of the UCLinkProperties object currently displayed in the tooltip.

uc_tooltips_main_get_last_id ()

guint32             uc_tooltips_main_get_last_id        (void);

Get the id of the UCLinkProperties object previously displayed in the tooltip.

Returns :

The last UCLinkProperties id.

uc_tooltips_main_set_last_id ()

void                uc_tooltips_main_set_last_id        (const guint32 id);

Set the id of the UCLinkProperties object previously displayed in the tooltip.

id :

UCLinkProperties id to set.

uc_tooltips_main_get_mouse_coord ()

void                uc_tooltips_main_get_mouse_coord    (gint32 *x,
                                                         gint32 *y);

Get the mouse coord. X and Y parameters are modified.

x :

X mouse coord. to be set.

y :

Y mouse coord. to be set.

uc_tooltips_main_set_frozen ()

void                uc_tooltips_main_set_frozen         (const gboolean value);

The tooltips display is "frozen" when the mouse is out of the main tree view.

value :

TRUE is the mouse is out of the main tree view.

uc_tooltips_main_get_frozen ()

gboolean            uc_tooltips_main_get_frozen         (void);

The tooltips display is "frozen" when the mouse is out of the main tree view.

Returns :

TRUE if tooltips display must be "frozen".

uc_tooltips_main_destroy ()

void                uc_tooltips_main_destroy            (void);

Destroy a tooltip window.


uc_tooltips_main_get_active ()

gboolean            uc_tooltips_main_get_active         (void);

Check if a tooltip is being displayed.

Returns :

TRUE if a tooltip is being displayed.

uc_tooltips_main_set_active ()

void                uc_tooltips_main_set_active         (const gboolean value);

Tell if a tooltip is active or not.

value :

TRUE if a tooltip is active.

uc_tooltips_get_frozen ()

gboolean            uc_tooltips_get_frozen              (void);

Returns :