## fo-length-conditional

fo-length-conditional —

## Synopsis

    struct      FoLengthCond;
    struct      FoLengthCondClass;
    FoDatatype* fo_length_cond_new              (void);
    FoDatatype* fo_length_cond_new_with_value   (gdouble length,
                                                 gboolean condity);
    FoDatatype* fo_length_cond_new_from_length  (FoDatatype *length);
    gdouble     fo_length_cond_get_length       (FoDatatype *datatype);
    void        fo_length_cond_set_length       (FoDatatype *datatype,
                                                 gdouble new_length);
    gboolean    fo_length_cond_get_condity      (FoDatatype *datatype);
    void        fo_length_cond_set_condity      (FoDatatype *datatype,
                                                 gboolean new_condity);
    FoDatatype* fo_length_cond_get_length_cond_zero
                                                (void);
    FoDatatype* fo_length_cond_resolve          (FoDatatype *shortform,
                                                 FoDatatype *length,
                                                 FoDatatype *condity,
                                                 GError **error);

## Object Hierarchy

      GObject
       +----FoObject
             +----FoDatatype
                   +----FoLengthCond

## Properties

      "conditionality"       gboolean             : Read / Write / Construct Only
      "length"               gdouble              : Read / Write / Construct Only

## Description

## Details

### struct FoLengthCond

    struct FoLengthCond;

### struct FoLengthCondClass

    struct FoLengthCondClass;

### fo_length_cond_new ()

    FoDatatype* fo_length_cond_new              (void);

Creates a new FoLengthCond initialized to default value.

Returns : | the new FoLengthCond

### fo_length_cond_new_with_value ()

    FoDatatype* fo_length_cond_new_with_value   (gdouble length,
                                                 gboolean condity);

Creates a new FoLengthCond set to `length` and `condity`

`length` : | Length component of the new FoLengthCond
`condity` : | Conditionality component of the new FoLengthCond
Returns : | The new FoLengthCond

### fo_length_cond_new_from_length ()

    FoDatatype* fo_length_cond_new_from_length  (FoDatatype *length);

Creates a new FoLengthCond with .length component set to `length` and .conditionality component set to default value.

`length` : | FoLength to use as initial value.
Returns : | New FoLengthCond.

### fo_length_cond_get_length ()

    gdouble     fo_length_cond_get_length       (FoDatatype *datatype);

Gets the .length component value of `datatype`

`datatype` : | FoLengthCond
Returns : | The .length value of `datatype`

### fo_length_cond_set_length ()

    void        fo_length_cond_set_length       (FoDatatype *datatype,
                                                 gdouble new_length);

Sets the .length component of `datatype`

`datatype` : | FoLengthCond
`new_length` : | New .length value

### fo_length_cond_get_condity ()

    gboolean    fo_length_cond_get_condity      (FoDatatype *datatype);

Gets the .conditionality component value of `datatype`

`datatype` : | FoLengthCond
Returns : | The .conditionality component value of `datatype`

### fo_length_cond_set_condity ()

    void        fo_length_cond_set_condity      (FoDatatype *datatype,
                                                 gboolean new_condity);

Sets the .condity component of `datatype`

`datatype` : | FoLengthCond
`new_condity` : | New .condity value

### fo_length_cond_get_length_cond_zero ()

    FoDatatype* fo_length_cond_get_length_cond_zero
                                                (void);

Get an FoLengthCond with the well-known value of 0pt/discard.

Returns : | The FoLengthCond.

### fo_length_cond_resolve ()

    FoDatatype* fo_length_cond_resolve          (FoDatatype *shortform,
                                                 FoDatatype *length,
                                                 FoDatatype *condity,
                                                 GError **error);

Resolve the shortform and components of the length-conditional in accordance with Section 5.11, Datatypes, of the XSL 1.0 Recommendation.

`shortform` : | Single-value short form of the length-conditional, or NULL
`length` : | .length component of the space, or NULL
`condity` : | .conditionality component of the space, or NULL
`error` : | GError used for reporting errors
Returns : | Compound space datatype, or NULL if an error occurred

## Properties

"`conditionality`" (gboolean : Read / Write / Construct Only) | Whether or not the space must always be retained.
"`length`" (gdouble : Read / Write / Construct Only) | Length_Cond length.