ClutterLabel

typedef struct _ClutterLabel ClutterLabel;

ClutterLabelClass

typedef struct {
} ClutterLabelClass;

clutter_label_new ()

ClutterActor*       clutter_label_new                   (void);

Creates a new, empty ClutterLabel.

clutter_label_new_with_text ()

ClutterActor*       clutter_label_new_with_text         (const gchar *font_name,
                                                         const gchar *text);

Creates a new ClutterLabel displaying text using font_name.

clutter_label_new_full ()

ClutterActor*       clutter_label_new_full              (const gchar *font_name,
                                                         const gchar *text,
                                                         const ClutterColor *color);

Creates a new ClutterLabel displaying text with color using font_name.

clutter_label_set_text ()

void                clutter_label_set_text              (ClutterLabel *label,
                                                         const gchar *text);

Sets text as the text to be displayed by label.

clutter_label_get_text ()

const gchar*        clutter_label_get_text              (ClutterLabel *label);

Retrieves the text displayed by label

clutter_label_set_font_name ()

void                clutter_label_set_font_name         (ClutterLabel *label,
                                                         const gchar *font_name);

Sets font_name as the font used by label.

font_name must be a string containing the font name and its size, similarly to what you would feed to the pango_font_description_from_string() function.

clutter_label_get_font_name ()

const gchar*        clutter_label_get_font_name         (ClutterLabel *label);

Retrieves the font used by label.

clutter_label_set_color ()

void                clutter_label_set_color             (ClutterLabel *label,
                                                         const ClutterColor *color);

Sets the color of label.

clutter_label_get_color ()

void                clutter_label_get_color             (ClutterLabel *label,
                                                         ClutterColor *color);

Retrieves the color of label.

clutter_label_set_ellipsize ()

void                clutter_label_set_ellipsize         (ClutterLabel *label,
                                                         PangoEllipsizeMode mode);

Sets the mode used to ellipsize (add an ellipsis: "...") to the text if there is not enough space to render the entire string.

Since 0.2

clutter_label_get_ellipsize ()

PangoEllipsizeMode  clutter_label_get_ellipsize         (ClutterLabel *label);

Returns the ellipsizing position of the label. See clutter_label_set_ellipsize().

Since 0.2

clutter_label_set_line_wrap ()

void                clutter_label_set_line_wrap         (ClutterLabel *label,
                                                         gboolean wrap);

Toggles line wrapping within the ClutterLabel widget. TRUE makes it break lines if text exceeds the widget's size. FALSE lets the text get cut off by the edge of the widget if it exceeds the widget size.

Since 0.2

clutter_label_get_line_wrap ()

gboolean            clutter_label_get_line_wrap         (ClutterLabel *label);

Returns whether lines in the label are automatically wrapped. See clutter_label_set_line_wrap().

Since 0.2

clutter_label_set_line_wrap_mode ()

void                clutter_label_set_line_wrap_mode    (ClutterLabel *label,
                                                         PangoWrapMode wrap_mode);

If line wrapping is on (see clutter_label_set_line_wrap()) this controls how the line wrapping is done. The default is PANGO_WRAP_WORD which means wrap on word boundaries.

Since 0.2

clutter_label_get_line_wrap_mode ()

PangoWrapMode       clutter_label_get_line_wrap_mode    (ClutterLabel *label);

Returns line wrap mode used by the label. See clutter_label_set_line_wrap_mode().

Since 0.2

clutter_label_get_layout ()

PangoLayout*        clutter_label_get_layout            (ClutterLabel *label);

Gets the PangoLayout used to display the label. The layout is useful to e.g. convert text positions to pixel positions. The returned layout is owned by the label so need not be freed by the caller.

Since 0.2

clutter_label_set_attributes ()

void                clutter_label_set_attributes        (ClutterLabel *label,
                                                         PangoAttrList *attrs);

Sets a PangoAttrList; the attributes in the list are applied to the label text. The attributes set with this function will be ignored if the "use_markup" property is TRUE.

Since 0.2

clutter_label_get_attributes ()

PangoAttrList*      clutter_label_get_attributes        (ClutterLabel *label);

Gets the attribute list that was set on the label using clutter_label_set_attributes(), if any.

Since 0.2

clutter_label_set_use_markup ()

void                clutter_label_set_use_markup        (ClutterLabel *label,
                                                         gboolean setting);

Sets whether the text of the label contains markup in Pango's text markup language.

clutter_label_get_use_markup ()

gboolean            clutter_label_get_use_markup        (ClutterLabel *label);

Returns whether the label's text is interpreted as marked up with the Pango text markup language. See clutter_label_set_use_markup().

clutter_label_set_alignment ()

void                clutter_label_set_alignment         (ClutterLabel *label,
                                                         PangoAlignment alignment);

Sets text alignment of the label.

The alignment will only be used when the contents of the label are enough to wrap, and the "wrap" property is set to TRUE.

clutter_label_get_alignment ()

PangoAlignment      clutter_label_get_alignment         (ClutterLabel *label);

Returns the label's text alignment

clutter_label_get_justify ()

gboolean            clutter_label_get_justify           (ClutterLabel *label);

Retrieves whether the label should justify the text on both margins.

Since 0.6

clutter_label_set_justify ()

void                clutter_label_set_justify           (ClutterLabel *label,
                                                         gboolean justify);

Sets whether the text of the label actor should be justified on both margins. This setting is ignored if Clutter is compiled against Pango < 1.18.

Since 0.6

The "alignment" property

  "alignment"                PangoAlignment        : Read / Write

The preferred alignment for the string.

Default value: PANGO_ALIGN_LEFT

The "attributes" property

  "attributes"               PangoAttrList*        : Read / Write

A list of style attributes to apply to the text of the label.

The "color" property

  "color"                    ClutterColor*         : Read / Write

Font Colour.

The "ellipsize" property

  "ellipsize"                PangoEllipsizeMode    : Read / Write

The preferred place to ellipsize the string, if the label does not have enough room to display the entire string.

Default value: PANGO_ELLIPSIZE_NONE

The "font-name" property

  "font-name"                gchar*                : Read / Write

Pango font description.

Default value: NULL

The "justify" property

  "justify"                  gboolean              : Read / Write

Whether the contents of the label should be justified on both margins.

Default value: FALSE

Since 0.6

The "text" property

  "text"                     gchar*                : Read / Write

Text to render.

Default value: NULL

The "use-markup" property

  "use-markup"               gboolean              : Read / Write

The text of the label includes XML markup. See pango_parse_markup().

Default value: FALSE

The "wrap" property

  "wrap"                     gboolean              : Read / Write

If set, wrap lines if the text becomes too wide.

Default value: FALSE

The "wrap-mode" property

  "wrap-mode"                PangoWrapMode         : Read / Write

If wrap is set, controls how line-wrapping is done.

Default value: PANGO_WRAP_WORD