MxTooltip

MxTooltip — A tooltip widget

Synopsis

struct              MxTooltip;
struct              MxTooltipClass;
const gchar *       mx_tooltip_get_text                 (MxTooltip *tooltip);
void                mx_tooltip_set_text                 (MxTooltip *tooltip,
                                                         const gchar *text);
void                mx_tooltip_show                     (MxTooltip *tooltip);
void                mx_tooltip_hide                     (MxTooltip *tooltip);
void                mx_tooltip_set_tip_area             (MxTooltip *tooltip,
                                                         const ClutterGeometry *area);
const ClutterGeometry * mx_tooltip_get_tip_area         (MxTooltip *tooltip);
gboolean            mx_tooltip_is_in_browse_mode        (void);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----MxWidget
                     +----MxFloatingWidget
                           +----MxTooltip

Implemented Interfaces

MxTooltip implements ClutterContainer, ClutterScriptable, ClutterAnimatable, AtkImplementorIface and MxStylable.

Properties

  "text"                     gchar*                : Read / Write
  "tip-area"                 ClutterGeometry*      : Read / Write

Description

MxTooltip implements a single tooltip. It should not normally be created by the application but by the widget implementing tooltip capabilities, for example, mx_widget_set_tooltip_text.

Details

struct MxTooltip

struct MxTooltip;

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


struct MxTooltipClass

struct MxTooltipClass {
  MxFloatingWidgetClass parent_class;

  /* padding for future expansion */
  void (*_padding_0) (void);
  void (*_padding_1) (void);
  void (*_padding_2) (void);
  void (*_padding_3) (void);
  void (*_padding_4) (void);
};

mx_tooltip_get_text ()

const gchar *       mx_tooltip_get_text                 (MxTooltip *tooltip);

Get the text displayed on the tooltip

tooltip :

a MxTooltip

Returns :

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

mx_tooltip_set_text ()

void                mx_tooltip_set_text                 (MxTooltip *tooltip,
                                                         const gchar *text);

Sets the text displayed on the tooltip

tooltip :

a MxTooltip

text :

text to set the label to

mx_tooltip_show ()

void                mx_tooltip_show                     (MxTooltip *tooltip);

Show the tooltip relative to the associated widget.

tooltip :

a MxTooltip

mx_tooltip_hide ()

void                mx_tooltip_hide                     (MxTooltip *tooltip);

Hide the tooltip

tooltip :

a MxTooltip

mx_tooltip_set_tip_area ()

void                mx_tooltip_set_tip_area             (MxTooltip *tooltip,
                                                         const ClutterGeometry *area);

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

tooltip :

A MxTooltip

area :

A ClutterGeometry

mx_tooltip_get_tip_area ()

const ClutterGeometry * mx_tooltip_get_tip_area         (MxTooltip *tooltip);

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

tooltip :

A MxTooltip

Returns :

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

mx_tooltip_is_in_browse_mode ()

gboolean            mx_tooltip_is_in_browse_mode        (void);

Browse mode is entered whenever a tooltip is displayed and it is left after a short delay when a tooltip is hidden. This is used to make tooltips display quicker when a previous tooltip is already displayed.

Returns :

TRUE if the app is in tooltip browse mode or FALSE otherwise.

Since 1.2

Property Details

The "text" property

  "text"                     gchar*                : Read / Write

Text of the tooltip.

Default value: NULL


The "tip-area" property

  "tip-area"                 ClutterGeometry*      : Read / Write

Area on the stage the tooltip applies to.