## FoColor

FoColor

## Synopsis

                        FoColor;
                        FoColorClass;
    FoDatatype*         fo_color_new_with_value             (guint red,
                                                             guint green,
                                                             guint blue);
    #define             FO_COLOR_COMPONENT_MAX
    guint16             fo_color_get_red                    (FoDatatype *color);
    guint16             fo_color_get_green                  (FoDatatype *color);
    guint16             fo_color_get_blue                   (FoDatatype *color);

    FoDatatype*         fo_color_get_color_black            (void);
    FoDatatype*         fo_color_get_color_silver           (void);
    FoDatatype*         fo_color_get_color_gray             (void);
    FoDatatype*         fo_color_get_color_white            (void);
    FoDatatype*         fo_color_get_color_maroon           (void);
    FoDatatype*         fo_color_get_color_red              (void);
    FoDatatype*         fo_color_get_color_purple           (void);
    FoDatatype*         fo_color_get_color_fuchsia          (void);
    FoDatatype*         fo_color_get_color_green            (void);
    FoDatatype*         fo_color_get_color_lime             (void);
    FoDatatype*         fo_color_get_color_olive            (void);
    FoDatatype*         fo_color_get_color_yellow           (void);
    FoDatatype*         fo_color_get_color_navy             (void);
    FoDatatype*         fo_color_get_color_blue             (void);
    FoDatatype*         fo_color_get_color_teal             (void);
    FoDatatype*         fo_color_get_color_aqua             (void);

    FoDatatype*         fo_color_get_color_one_quarter      (FoDatatype *color);
    FoDatatype*         fo_color_get_color_one_half         (FoDatatype *color);
    FoDatatype*         fo_color_get_color_three_quarter    (FoDatatype *color);

## Object Hierarchy

      GObject
       +----FoObject
             +----FoDatatype
                   +----FoColor

## Properties

      "blue"                     guint                 : Read / Write / Construct Only
      "green"                    guint                 : Read / Write / Construct Only
      "red"                      guint                 : Read / Write / Construct Only

## Description

## Details

### FoColor

    typedef struct _FoColor FoColor;

### FoColorClass

    typedef struct _FoColorClass FoColorClass;

### fo_color_new_with_value ()

    FoDatatype*         fo_color_new_with_value             (guint red,
                                                             guint green,
                                                             guint blue);

Creates a new FoColor with specified values.

`red` : | Red component of new FoColor.
`green` : | Green component of new FoColor.
`blue` : | Blue component of new FoColor.
Returns : | New FoColor.

### FO_COLOR_COMPONENT_MAX

    #define FO_COLOR_COMPONENT_MAX 65535

### fo_color_get_red ()

    guint16             fo_color_get_red                    (FoDatatype *color);

Gets the 'red' component of `color`.

`color` : | FoColor.
Returns : | 'red' component of `color`.

### fo_color_get_green ()

    guint16             fo_color_get_green                  (FoDatatype *color);

Gets the 'green' component of `color`.

`color` : | FoColor.
Returns : | 'green' component of `color`.

### fo_color_get_blue ()

    guint16             fo_color_get_blue                   (FoDatatype *color);

Gets the 'blue' component of `color`.

`color` : | FoColor.
Returns : | 'blue' component of `color`.

### fo_color_get_color_black ()

    FoDatatype*         fo_color_get_color_black            (void);

Get an FoColor with the well-known value for the color 'black'.

Returns : | The FoColor.

### fo_color_get_color_silver ()

    FoDatatype*         fo_color_get_color_silver           (void);

Get an FoColor with the well-known value for the color 'silver'.

Returns : | The FoColor.

### fo_color_get_color_gray ()

    FoDatatype*         fo_color_get_color_gray             (void);

Get an FoColor with the well-known value for the color 'gray'.

Returns : | The FoColor.

### fo_color_get_color_white ()

    FoDatatype*         fo_color_get_color_white            (void);

Get an FoColor with the well-known value for the color 'white'.

Returns : | The FoColor.

### fo_color_get_color_maroon ()

    FoDatatype*         fo_color_get_color_maroon           (void);

Get an FoColor with the well-known value for the color 'maroon'.

Returns : | The FoColor.

### fo_color_get_color_red ()

    FoDatatype*         fo_color_get_color_red              (void);

Get an FoColor with the well-known value for the color 'red'.

Returns : | The FoColor.

### fo_color_get_color_purple ()

    FoDatatype*         fo_color_get_color_purple           (void);

Get an FoColor with the well-known value for the color 'purple'.

Returns : | The FoColor.

### fo_color_get_color_fuchsia ()

    FoDatatype*         fo_color_get_color_fuchsia          (void);

Get an FoColor with the well-known value for the color 'fuchsia'.

Returns : | The FoColor.

### fo_color_get_color_green ()

    FoDatatype*         fo_color_get_color_green            (void);

Get an FoColor with the well-known value for the color 'green'.

Returns : | The FoColor.

### fo_color_get_color_lime ()

    FoDatatype*         fo_color_get_color_lime             (void);

Get an FoColor with the well-known value for the color 'lime'.

Returns : | The FoColor.

### fo_color_get_color_olive ()

    FoDatatype*         fo_color_get_color_olive            (void);

Get an FoColor with the well-known value for the color 'olive'.

Returns : | The FoColor.

### fo_color_get_color_yellow ()

    FoDatatype*         fo_color_get_color_yellow           (void);

Get an FoColor with the well-known value for the color 'yellow'.

Returns : | The FoColor.

### fo_color_get_color_navy ()

    FoDatatype*         fo_color_get_color_navy             (void);

Get an FoColor with the well-known value for the color 'navy'.

Returns : | The FoColor.

### fo_color_get_color_blue ()

    FoDatatype*         fo_color_get_color_blue             (void);

Get an FoColor with the well-known value for the color 'blue'.

Returns : | The FoColor.

### fo_color_get_color_teal ()

    FoDatatype*         fo_color_get_color_teal             (void);

Get an FoColor with the well-known value for the color 'teal'.

Returns : | The FoColor.

### fo_color_get_color_aqua ()

    FoDatatype*         fo_color_get_color_aqua             (void);

Get an FoColor with the well-known value for the color 'aqua'.

Returns : | The FoColor.

### fo_color_get_color_one_quarter ()

    FoDatatype*         fo_color_get_color_one_quarter      (FoDatatype *color);

Get an FoColor that is one-quarter the intensity of `color`.

`color` : | Original color.
Returns : | A color with one-quarter the intensity of `color`.

### fo_color_get_color_one_half ()

    FoDatatype*         fo_color_get_color_one_half         (FoDatatype *color);

Get an FoColor that is one-half the intensity of `color`.

`color` : | Original color.
Returns : | A color with one-half the intensity of `color`.

### fo_color_get_color_three_quarter ()

    FoDatatype*         fo_color_get_color_three_quarter    (FoDatatype *color);

Get an FoColor that is three-quarters of the intensity of `color`.

`color` : | Original color.
Returns : | A color with three-quarters of the intensity of `color`.

## Property Details

### The `"blue"` property

      "blue"                     guint                 : Read / Write / Construct Only

Color blue value.

Allowed values: <= 65535

Default value: 0

### The `"green"` property

      "green"                    guint                 : Read / Write / Construct Only

Color green value.

Allowed values: <= 65535

Default value: 0

### The `"red"` property

      "red"                      guint                 : Read / Write / Construct Only

Color red value.

Allowed values: <= 65535

Default value: 0