| St Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | ||||
struct StTooltip; struct StTooltipClass; void (*StTooltipConstrainFunc) (StTooltip *tooltip,const ClutterGeometry *geometry,ClutterGeometry *adjusted_geometry,gpointer data); const gchar * st_tooltip_get_label (StTooltip *tooltip); const ClutterGeometry * st_tooltip_get_tip_area (StTooltip *tooltip); void st_tooltip_set_constrain_func (ClutterStage *stage,StTooltipConstrainFunc func,gpointer data,GDestroyNotify notify); void st_tooltip_set_label (StTooltip *tooltip,const gchar *text); void st_tooltip_set_tip_area (StTooltip *tooltip,const ClutterGeometry *area);
StTooltip implements ClutterContainer, ClutterScriptable, ClutterAnimatable and AtkImplementorIface.
StTooltip implements a single tooltip. It should not normally be created
by the application but by the widget implementing tooltip capabilities, for
example, #st_button_set_tooltip().
struct StTooltip;
The contents of this structure is private and should only be accessed using the provided API.
void (*StTooltipConstrainFunc) (StTooltip *tooltip,const ClutterGeometry *geometry,ClutterGeometry *adjusted_geometry,gpointer data);
|
the StTooltip that is being positioned |
|
size and position of the tooltip without any constraints |
|
new position of the tooltip. The width and height fields will be ignored. [out] |
|
user data passed to st_tooltip_set_constrain_func(). [closure]
|
const gchar * st_tooltip_get_label (StTooltip *tooltip);
Get the text displayed on the tooltip
|
a StTooltip |
Returns : |
the text for the tooltip. This must not be freed by the application |
const ClutterGeometry * st_tooltip_get_tip_area (StTooltip *tooltip);
Retrieve the area on the stage that the tooltip currently applies to
|
A StTooltip |
Returns : |
the ClutterGeometry, owned by the tooltip which must not be freed by the application. |
void st_tooltip_set_constrain_func (ClutterStage *stage,StTooltipConstrainFunc func,gpointer data,GDestroyNotify notify);
Sets a callback function that will be used to constrain the position
of tooltips within stage. This can be used, for example, if the stage
spans multiple monitors and tooltips should be positioned not to cross
monitors.
|
a ClutterStage |
|
function to be called to constrain tooltip position. [allow-none] |
|
user data to pass to func. [allow-none]
|
|
function to be called when data is no longer needed. [allow-none]
|
void st_tooltip_set_label (StTooltip *tooltip,const gchar *text);
Sets the text displayed on the tooltip
|
a StTooltip |
|
text to set the label to |