MxLabel

## MxLabel MxLabel — Widget for displaying text |

## Synopsis

    struct              MxLabel;
    struct              MxLabelClass;
    ClutterActor *      mx_label_new                        (void);
    ClutterActor *      mx_label_new_with_text              (const gchar *text);
    const gchar *       mx_label_get_text                   (MxLabel *label);
    void                mx_label_set_text                   (MxLabel *label,
                                                             const gchar *text);
    gboolean            mx_label_get_use_markup             (MxLabel *label);
    void                mx_label_set_use_markup             (MxLabel *label,
                                                             gboolean use_markup);
    ClutterActor *      mx_label_get_clutter_text           (MxLabel *label);
    MxAlign             mx_label_get_x_align                (MxLabel *label);
    void                mx_label_set_x_align                (MxLabel *label,
                                                             MxAlign align);
    MxAlign             mx_label_get_y_align                (MxLabel *label);
    void                mx_label_set_y_align                (MxLabel *label,
                                                             MxAlign align);
    gboolean            mx_label_get_line_wrap              (MxLabel *label);
    void                mx_label_set_line_wrap              (MxLabel *label,
                                                             gboolean line_wrap);
    void                mx_label_set_fade_out               (MxLabel *label,
                                                             gboolean fade);
    gboolean            mx_label_get_fade_out               (MxLabel *label);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----ClutterActor
                   +----MxWidget
                         +----MxLabel

## Implemented Interfaces

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

## Properties

      "clutter-text"             ClutterText*          : Read
      "fade-out"                 gboolean              : Read / Write
      "line-wrap"                gboolean              : Read / Write
      "show-tooltip"             gboolean              : Read / Write
      "text"                     gchar*                : Read / Write
      "use-markup"               gboolean              : Read / Write
      "x-align"                  MxAlign               : Read / Write
      "y-align"                  MxAlign               : Read / Write

## Description

MxLabel is a simple widget for displaying one or more lines of text. It derives from MxWidget to add extra style and placement functionality over ClutterText. The internal ClutterText is publicly accessibly to allow applications to set further properties.

## Details

### struct MxLabel

    struct MxLabel;

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

### struct MxLabelClass

    struct MxLabelClass {
      MxWidgetClass 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_label_new ()

    ClutterActor *      mx_label_new                        (void);

Create a new MxLabel

Returns : | a new MxLabel

### mx_label_new_with_text ()

    ClutterActor *      mx_label_new_with_text              (const gchar *text);

Create a new MxLabel with the specified label

`text` : | text to set the label to
Returns : | a new MxLabel

### mx_label_get_text ()

    const gchar *       mx_label_get_text                   (MxLabel *label);

Get the text displayed on the label

`label` : | a MxLabel
Returns : | the text for the label. This must not be freed by the application

### mx_label_set_text ()

    void                mx_label_set_text                   (MxLabel *label,
                                                             const gchar *text);

Sets the text displayed on the label

`label` : | a MxLabel
`text` : | text to set the label to

### mx_label_get_use_markup ()

    gboolean            mx_label_get_use_markup             (MxLabel *label);

Determines whether the text of the label is being treated as Pango markup.

`label` : | a MxLabel
Returns : | `TRUE` if the text of the label is treated as Pango markup, `FALSE` otherwise.

Since 1.2

### mx_label_set_use_markup ()

    void                mx_label_set_use_markup             (MxLabel *label,
                                                             gboolean use_markup);

Sets whether the text of the label should be treated as Pango markup.

`label` : | a MxLabel
`use_markup` : | `TRUE` to use Pango markup, `FALSE` otherwise

### mx_label_get_clutter_text ()

    ClutterActor *      mx_label_get_clutter_text           (MxLabel *label);

Retrieve the internal ClutterText so that extra parameters can be set

`label` : | a MxLabel
Returns : | the ClutterText used by MxLabel. The label is owned by the MxLabel and should not be unref'ed by the application. [transfer none]

### mx_label_get_x_align ()

    MxAlign             mx_label_get_x_align                (MxLabel *label);

### mx_label_set_x_align ()

    void                mx_label_set_x_align                (MxLabel *label,
                                                             MxAlign align);

### mx_label_get_y_align ()

    MxAlign             mx_label_get_y_align                (MxLabel *label);

### mx_label_set_y_align ()

    void                mx_label_set_y_align                (MxLabel *label,
                                                             MxAlign align);

### mx_label_get_line_wrap ()

    gboolean            mx_label_get_line_wrap              (MxLabel *label);

Get the value of the "line-wrap" property.

`label` : | An MxLabel
Returns : | `TRUE` if the "line-wrap" property is set.

Since 1.2

### mx_label_set_line_wrap ()

    void                mx_label_set_line_wrap              (MxLabel *label,
                                                             gboolean line_wrap);

Set the value of the "line-wrap" property.

`label` : | An MxLabel
`line_wrap` : | new value of the line-wrap property.

Since 1.2

### mx_label_set_fade_out ()

    void                mx_label_set_fade_out               (MxLabel *label,
                                                             gboolean fade);

Set whether to fade out the end of the label, instead of ellipsizing. Enabling this mode will also set the "single-line-mode" and "ellipsize" properties.

`label` : | A MxLabel
`fade` : | `TRUE` to fade out, `FALSE` otherwise

Since 1.2

### mx_label_get_fade_out ()

    gboolean            mx_label_get_fade_out               (MxLabel *label);

Determines whether the label has been set to fade out when there isn't enough space allocated to display the entire label.

`label` : | A MxLabel
Returns : | `TRUE` if the label is set to fade out, `FALSE` otherwise

Since 1.2

## Property Details

### The `"clutter-text"` property

      "clutter-text"             ClutterText*          : Read

Internal ClutterText actor.

### The `"fade-out"` property

      "fade-out"                 gboolean              : Read / Write

Fade out the end of the label, instead of ellipsizing.

Default value: FALSE

### The `"line-wrap"` property

      "line-wrap"                gboolean              : Read / Write

Whether to wrap the lines of "text" if the contents exceed the available allocation.

Default value: FALSE

Since 1.2

### The `"show-tooltip"` property

      "show-tooltip"             gboolean              : Read / Write

Show a tooltip when there is not enough space to display the text. If set to `TRUE`, this will also cause the "reactive" property to be enabled.

Default value: FALSE

Since 1.4

### The `"text"` property

      "text"                     gchar*                : Read / Write

Text of the label.

Default value: NULL

### The `"use-markup"` property

      "use-markup"               gboolean              : Read / Write

Whether the text of the label should be treated as Pango markup.

Default value: FALSE

### The `"x-align"` property

      "x-align"                  MxAlign               : Read / Write

Horizontal position of the text layout.

Default value: MX_ALIGN_START

### The `"y-align"` property

      "y-align"                  MxAlign               : Read / Write

Vertical position of the text layout.

Default value: MX_ALIGN_START