## FoText

FoText —

## Synopsis

                FoText;
                FoTextClass;
    FoFo*       fo_text_new                     (void);
    void        fo_text_set_color               (FoFo *fo_fo,
                                                 FoProperty *new_color);
    FoProperty* fo_text_get_color               (FoFo *fo_fo);
    void        fo_text_set_font_family         (FoFo *fo_fo,
                                                 FoProperty *new_font_family);
    FoProperty* fo_text_get_font_family         (FoFo *fo_fo);
    void        fo_text_set_font_size           (FoFo *fo_fo,
                                                 FoProperty *new_font_size);
    FoProperty* fo_text_get_font_size           (FoFo *fo_fo);
    void        fo_text_set_font_stretch        (FoFo *fo_fo,
                                                 FoProperty *new_font_stretch);
    FoProperty* fo_text_get_font_stretch        (FoFo *fo_fo);
    void        fo_text_set_font_style          (FoFo *fo_fo,
                                                 FoProperty *new_font_style);
    FoProperty* fo_text_get_font_style          (FoFo *fo_fo);
    void        fo_text_set_font_variant        (FoFo *fo_fo,
                                                 FoProperty *new_font_variant);
    FoProperty* fo_text_get_font_variant        (FoFo *fo_fo);
    void        fo_text_set_font_weight         (FoFo *fo_fo,
                                                 FoProperty *new_font_weight);
    FoProperty* fo_text_get_font_weight         (FoFo *fo_fo);
    void        fo_text_set_score_spaces        (FoFo *fo_fo,
                                                 FoProperty *new_score_spaces);
    FoProperty* fo_text_get_score_spaces        (FoFo *fo_fo);
    void        fo_text_set_value               (FoFo *fo_fo,
                                                 const gchar *new_value);
    const gchar* fo_text_get_value              (FoFo *fo_fo);
    gboolean    fo_text_get_whitespace_only     (FoFo *fo_fo);

## Object Hierarchy

      GObject
       +----FoObject
             +----FoNode
                   +----FoFo
                         +----FoText

## Implemented Interfaces

FoText implements FoInlineFoIface.

## Properties

      "color"                FoProperty            : Read
      "font-family"          FoProperty            : Read
      "font-size"            FoProperty            : Read
      "font-stretch"         FoProperty            : Read
      "font-style"           FoProperty            : Read
      "font-variant"         FoProperty            : Read
      "font-weight"          FoProperty            : Read
      "score-spaces"         FoProperty            : Read
      "value"                gchararray            : Read
      "whitespace-only"      gboolean              : Read

## Description

## Details

### FoText

    typedef struct _FoText FoText;

### FoTextClass

    typedef struct _FoTextClass FoTextClass;

### fo_text_new ()

    FoFo*       fo_text_new                     (void);

Creates a new FoText initialized to default value.

Returns : | the new FoText

### fo_text_set_color ()

    void        fo_text_set_color               (FoFo *fo_fo,
                                                 FoProperty *new_color);

Sets the color property of `text` to `new_color`

`fo_fo` : | The `FoFo` object
`new_color` : | The new "color" property value

### fo_text_get_color ()

    FoProperty* fo_text_get_color               (FoFo *fo_fo);

Gets the color property of `text`

`fo_fo` : | The `FoFo` object
Returns : | The "color" property value

### fo_text_set_font_family ()

    void        fo_text_set_font_family         (FoFo *fo_fo,
                                                 FoProperty *new_font_family);

Sets the font-family property of `text` to `new_font_family`

`fo_fo` : | The `FoFo` object
`new_font_family` : | The new "font-family" property value

### fo_text_get_font_family ()

    FoProperty* fo_text_get_font_family         (FoFo *fo_fo);

Gets the font-family property of `text`

`fo_fo` : | The `FoFo` object
Returns : | The "font-family" property value

### fo_text_set_font_size ()

    void        fo_text_set_font_size           (FoFo *fo_fo,
                                                 FoProperty *new_font_size);

Sets the font-size property of `text` to `new_font_size`

`fo_fo` : | The `FoFo` object
`new_font_size` : | The new "font-size" property value

### fo_text_get_font_size ()

    FoProperty* fo_text_get_font_size           (FoFo *fo_fo);

Gets the font-size property of `text`

`fo_fo` : | The `FoFo` object
Returns : | The "font-size" property value

### fo_text_set_font_stretch ()

    void        fo_text_set_font_stretch        (FoFo *fo_fo,
                                                 FoProperty *new_font_stretch);

Sets the font-stretch property of `text` to `new_font_stretch`

`fo_fo` : | The `FoFo` object
`new_font_stretch` : | The new "font-stretch" property value

### fo_text_get_font_stretch ()

    FoProperty* fo_text_get_font_stretch        (FoFo *fo_fo);

Gets the font-stretch property of `text`

`fo_fo` : | The `FoFo` object
Returns : | The "font-stretch" property value

### fo_text_set_font_style ()

    void        fo_text_set_font_style          (FoFo *fo_fo,
                                                 FoProperty *new_font_style);

Sets the font-style property of `text` to `new_font_style`

`fo_fo` : | The `FoFo` object
`new_font_style` : | The new "font-style" property value

### fo_text_get_font_style ()

    FoProperty* fo_text_get_font_style          (FoFo *fo_fo);

Gets the font-style property of `text`

`fo_fo` : | The `FoFo` object
Returns : | The "font-style" property value

### fo_text_set_font_variant ()

    void        fo_text_set_font_variant        (FoFo *fo_fo,
                                                 FoProperty *new_font_variant);

Sets the font-variant property of `text` to `new_font_variant`

`fo_fo` : | The `FoFo` object
`new_font_variant` : | The new "font-variant" property value

### fo_text_get_font_variant ()

    FoProperty* fo_text_get_font_variant        (FoFo *fo_fo);

Gets the font-variant property of `text`

`fo_fo` : | The `FoFo` object
Returns : | The "font-variant" property value

### fo_text_set_font_weight ()

    void        fo_text_set_font_weight         (FoFo *fo_fo,
                                                 FoProperty *new_font_weight);

Sets the font-weight property of `text` to `new_font_weight`

`fo_fo` : | The `FoFo` object
`new_font_weight` : | The new "font-weight" property value

### fo_text_get_font_weight ()

    FoProperty* fo_text_get_font_weight         (FoFo *fo_fo);

Gets the font-weight property of `text`

`fo_fo` : | The `FoFo` object
Returns : | The "font-weight" property value

### fo_text_set_score_spaces ()

    void        fo_text_set_score_spaces        (FoFo *fo_fo,
                                                 FoProperty *new_score_spaces);

Sets the score-spaces property of `text` to `new_score_spaces`

`fo_fo` : | The `FoFo` object
`new_score_spaces` : | The new "score-spaces" property value

### fo_text_get_score_spaces ()

    FoProperty* fo_text_get_score_spaces        (FoFo *fo_fo);

Gets the score-spaces property of `text`

`fo_fo` : | The `FoFo` object
Returns : | The "score-spaces" property value

### fo_text_set_value ()

    void        fo_text_set_value               (FoFo *fo_fo,
                                                 const gchar *new_value);

Sets the value property of `fo_fo` to `new_value`

`fo_fo` : | The FoText object
`new_value` : | The new "value" property value

### fo_text_get_value ()

    const gchar* fo_text_get_value              (FoFo *fo_fo);

Gets the "value" property of `fo_text`

`fo_fo` : | The FoText object
Returns : | The "value" property value

### fo_text_get_whitespace_only ()

    gboolean    fo_text_get_whitespace_only     (FoFo *fo_fo);

Gets the "whitespace_only" property of `fo_fo`

`fo_fo` : | The FoText object
Returns : | The "whitespace_only" property value

## Property Details

### The "`color`" property

      "color"                FoProperty            : Read

Color property.

### The "`font-family`" property

      "font-family"          FoProperty            : Read

Font Family property.

### The "`font-size`" property

      "font-size"            FoProperty            : Read

Font Size property.

### The "`font-stretch`" property

      "font-stretch"         FoProperty            : Read

Font Stretch property.

### The "`font-style`" property

      "font-style"           FoProperty            : Read

Font Style property.

### The "`font-variant`" property

      "font-variant"         FoProperty            : Read

Font Variant property.

### The "`font-weight`" property

      "font-weight"          FoProperty            : Read

Font Weight property.

### The "`score-spaces`" property

      "score-spaces"         FoProperty            : Read

Score Spaces property.

### The "`value`" property

      "value"                gchararray            : Read

String value property.

Default value: NULL

### The "`whitespace-only`" property

      "whitespace-only"      gboolean              : Read

Whether or not the text object contains only whitespace characters.

Default value: FALSE