st-label

st-label — Widget for displaying text

Functions

StWidget * st_label_new ()
const gchar * st_label_get_text ()
void st_label_set_text ()
ClutterActor * st_label_get_clutter_text ()

Types and Values

Description

StLabel is a simple widget for displaying text. It derives from StWidget to add extra style and placement functionality over ClutterText. The internal ClutterText is publicly accessibly to allow applications to set further properties.

Functions

st_label_new ()

StWidget *
st_label_new (const gchar *text);

Create a new StLabel with the label specified by text .

Parameters

text

text to set the label to.

[nullable]

Returns

a new StLabel


st_label_get_text ()

const gchar *
st_label_get_text (StLabel *label);

Get the text displayed on the label.

Parameters

label

a StLabel

 

Returns

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

[transfer none]


st_label_set_text ()

void
st_label_set_text (StLabel *label,
                   const gchar *text);

Sets the text displayed by the label.

Parameters

label

a StLabel

 

text

text to set the label to.

[nullable]

st_label_get_clutter_text ()

ClutterActor *
st_label_get_clutter_text (StLabel *label);

Retrieve the internal ClutterText used by label so that extra parameters can be set.

Parameters

label

a StLabel

 

Returns

the ClutterText used by StLabel. The actor is owned by the StLabel and should not be destroyed by the application.

[transfer none]

Types and Values

ST_TYPE_LABEL

#define ST_TYPE_LABEL                (st_label_get_type ())

struct StLabel

struct StLabel {
};

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


StLabelPrivate

typedef struct _StLabelPrivate StLabelPrivate;