GWeatherInfo

## GWeatherInfo GWeatherInfo |

## Synopsis

    struct              GWeatherInfo;
    void                (*GWeatherInfoFunc)                 (GWeatherInfo *info,
                                                             gpointer data);
    GWeatherInfo *      gweather_info_new                   (GWeatherLocation *location,
                                                             GWeatherForecastType forecast_type);
    void                gweather_info_update                (GWeatherInfo *info);
    void                gweather_info_abort                 (GWeatherInfo *info);
    gboolean            gweather_info_is_valid              (GWeatherInfo *info);
    gboolean            gweather_info_network_error         (GWeatherInfo *info);
    const GWeatherLocation * gweather_info_get_location     (GWeatherInfo *info);
    gchar *             gweather_info_get_location_name     (GWeatherInfo *info);
    gchar *             gweather_info_get_update            (GWeatherInfo *info);
    gchar *             gweather_info_get_sky               (GWeatherInfo *info);
    gchar *             gweather_info_get_conditions        (GWeatherInfo *info);
    gchar *             gweather_info_get_temp              (GWeatherInfo *info);
    gchar *             gweather_info_get_temp_min          (GWeatherInfo *info);
    gchar *             gweather_info_get_temp_max          (GWeatherInfo *info);
    gchar *             gweather_info_get_dew               (GWeatherInfo *info);
    gchar *             gweather_info_get_humidity          (GWeatherInfo *info);
    gchar *             gweather_info_get_wind              (GWeatherInfo *info);
    gchar *             gweather_info_get_pressure          (GWeatherInfo *info);
    gchar *             gweather_info_get_visibility        (GWeatherInfo *info);
    gchar *             gweather_info_get_apparent          (GWeatherInfo *info);
    gchar *             gweather_info_get_sunrise           (GWeatherInfo *info);
    gchar *             gweather_info_get_sunset            (GWeatherInfo *info);
    gchar *             gweather_info_get_forecast          (GWeatherInfo *info);
    GSList *            gweather_info_get_forecast_list     (GWeatherInfo *info);
    GdkPixbufAnimation * gweather_info_get_radar            (GWeatherInfo *info);
    gchar *             gweather_info_get_temp_summary      (GWeatherInfo *info);
    gchar *             gweather_info_get_weather_summary   (GWeatherInfo *info);
    const gchar *       gweather_info_get_icon_name         (GWeatherInfo *info);
    gint                gweather_info_next_sun_event        (GWeatherInfo *info);
    gboolean            gweather_info_get_value_update      (GWeatherInfo *info,
                                                             time_t *value);
    gboolean            gweather_info_get_value_sky         (GWeatherInfo *info,
                                                             GWeatherSky *sky);
    gboolean            gweather_info_get_value_conditions  (GWeatherInfo *info,
                                                             GWeatherConditionPhenomenon *phenomenon,
                                                             GWeatherConditionQualifier *qualifier);
    gboolean            gweather_info_get_value_temp        (GWeatherInfo *info,
                                                             GWeatherTemperatureUnit unit,
                                                             gdouble *value);
    gboolean            gweather_info_get_value_temp_min    (GWeatherInfo *info,
                                                             GWeatherTemperatureUnit unit,
                                                             gdouble *value);
    gboolean            gweather_info_get_value_temp_max    (GWeatherInfo *info,
                                                             GWeatherTemperatureUnit unit,
                                                             gdouble *value);
    gboolean            gweather_info_get_value_dew         (GWeatherInfo *info,
                                                             GWeatherTemperatureUnit unit,
                                                             gdouble *value);
    gboolean            gweather_info_get_value_apparent    (GWeatherInfo *info,
                                                             GWeatherTemperatureUnit unit,
                                                             gdouble *value);
    gboolean            gweather_info_get_value_wind        (GWeatherInfo *info,
                                                             GWeatherSpeedUnit unit,
                                                             gdouble *speed,
                                                             GWeatherWindDirection *direction);
    gboolean            gweather_info_get_value_pressure    (GWeatherInfo *info,
                                                             GWeatherPressureUnit unit,
                                                             gdouble *value);
    gboolean            gweather_info_get_value_visibility  (GWeatherInfo *info,
                                                             GWeatherDistanceUnit unit,
                                                             gdouble *value);
    gboolean            gweather_info_get_value_sunrise     (GWeatherInfo *info,
                                                             time_t *value);
    gboolean            gweather_info_get_value_sunset      (GWeatherInfo *info,
                                                             time_t *value);
    gboolean            gweather_info_get_value_moonphase   (GWeatherInfo *info,
                                                             GWeatherMoonPhase *value,
                                                             GWeatherMoonLatitude *lat);
    gboolean            gweather_info_get_upcoming_moonphases
                                                            (GWeatherInfo *info,
                                                             time_t *phases);

## Description

## Details

### struct GWeatherInfo

    struct GWeatherInfo {
    };

### GWeatherInfoFunc ()

    void                (*GWeatherInfoFunc)                 (GWeatherInfo *info,
                                                             gpointer data);

### gweather_info_new ()

    GWeatherInfo *      gweather_info_new                   (GWeatherLocation *location,
                                                             GWeatherForecastType forecast_type);

Builds a new GWeatherInfo that will provide weather information about `location`. The returned info will not be ready until the ::updated signal is emitted.

`location` : | the desidered GWeatherLocation (NULL for default). [allow-none]
`forecast_type` : | the type of forecast requested
Returns : | a new GWeatherInfo. [transfer full]

### gweather_info_update ()

    void                gweather_info_update                (GWeatherInfo *info);

### gweather_info_abort ()

    void                gweather_info_abort                 (GWeatherInfo *info);

### gweather_info_is_valid ()

    gboolean            gweather_info_is_valid              (GWeatherInfo *info);

### gweather_info_network_error ()

    gboolean            gweather_info_network_error         (GWeatherInfo *info);

### gweather_info_get_location ()

    const GWeatherLocation * gweather_info_get_location     (GWeatherInfo *info);

### gweather_info_get_location_name ()

    gchar *             gweather_info_get_location_name     (GWeatherInfo *info);

### gweather_info_get_update ()

    gchar *             gweather_info_get_update            (GWeatherInfo *info);

### gweather_info_get_sky ()

    gchar *             gweather_info_get_sky               (GWeatherInfo *info);

### gweather_info_get_conditions ()

    gchar *             gweather_info_get_conditions        (GWeatherInfo *info);

### gweather_info_get_temp ()

    gchar *             gweather_info_get_temp              (GWeatherInfo *info);

### gweather_info_get_temp_min ()

    gchar *             gweather_info_get_temp_min          (GWeatherInfo *info);

### gweather_info_get_temp_max ()

    gchar *             gweather_info_get_temp_max          (GWeatherInfo *info);

### gweather_info_get_dew ()

    gchar *             gweather_info_get_dew               (GWeatherInfo *info);

### gweather_info_get_humidity ()

    gchar *             gweather_info_get_humidity          (GWeatherInfo *info);

### gweather_info_get_wind ()

    gchar *             gweather_info_get_wind              (GWeatherInfo *info);

### gweather_info_get_pressure ()

    gchar *             gweather_info_get_pressure          (GWeatherInfo *info);

### gweather_info_get_visibility ()

    gchar *             gweather_info_get_visibility        (GWeatherInfo *info);

### gweather_info_get_apparent ()

    gchar *             gweather_info_get_apparent          (GWeatherInfo *info);

### gweather_info_get_sunrise ()

    gchar *             gweather_info_get_sunrise           (GWeatherInfo *info);

### gweather_info_get_sunset ()

    gchar *             gweather_info_get_sunset            (GWeatherInfo *info);

### gweather_info_get_forecast ()

    gchar *             gweather_info_get_forecast          (GWeatherInfo *info);

### gweather_info_get_forecast_list ()

    GSList *            gweather_info_get_forecast_list     (GWeatherInfo *info);

`info` : | a GWeatherInfo
Returns : | list of GWeatherInfo* objects for the forecast. The list is owned by the 'info' object thus is alive as long as the 'info'. This list is filled only when requested with type FORECAST_LIST and if available for given location. The 'update' property is the date/time when the forecast info is used for. [transfer none][element-type GWeather.Info]

### gweather_info_get_radar ()

    GdkPixbufAnimation * gweather_info_get_radar            (GWeatherInfo *info);

`info` : | a GWeatherInfo
Returns : | what?. [transfer none]

### gweather_info_get_temp_summary ()

    gchar *             gweather_info_get_temp_summary      (GWeatherInfo *info);

### gweather_info_get_weather_summary ()

    gchar *             gweather_info_get_weather_summary   (GWeatherInfo *info);

`info` : | a GWeatherInfo
Returns : | a summary for current weather conditions. [transfer full]

### gweather_info_get_icon_name ()

    const gchar *       gweather_info_get_icon_name         (GWeatherInfo *info);

### gweather_info_next_sun_event ()

    gint                gweather_info_next_sun_event        (GWeatherInfo *info);

### gweather_info_get_value_update ()

    gboolean            gweather_info_get_value_update      (GWeatherInfo *info,
                                                             time_t *value);

`info` : | a GWeatherInfo
`value` : | the time `info` was last updated. [out][type glong]
Returns : | TRUE is `value` is valid, FALSE otherwise.

### gweather_info_get_value_sky ()

    gboolean            gweather_info_get_value_sky         (GWeatherInfo *info,
                                                             GWeatherSky *sky);

Fills out `sky` with current sky conditions.

`info` : | a GWeatherInfo
`sky` : | a location for a GWeatherSky. [out]
Returns : | TRUE is `sky` is valid, FALSE otherwise.

### gweather_info_get_value_conditions ()

    gboolean            gweather_info_get_value_conditions  (GWeatherInfo *info,
                                                             GWeatherConditionPhenomenon *phenomenon,
                                                             GWeatherConditionQualifier *qualifier);

Fills out `phenomenon` and `qualifier` with current weather conditions.

`info` : | a GWeatherInfo
`phenomenon` : | a location for a GWeatherConditionPhenomenon. [out]
`qualifier` : | a location for a GWeatherConditionQualifier. [out]
Returns : | TRUE is out arguments are valid, FALSE otherwise.

### gweather_info_get_value_temp ()

    gboolean            gweather_info_get_value_temp        (GWeatherInfo *info,
                                                             GWeatherTemperatureUnit unit,
                                                             gdouble *value);

`info` : | a GWeatherInfo
`unit` : | the desired unit, as a GWeatherTemperatureUnit
`value` : | the temperature value. [out]
Returns : | TRUE is `value` is valid, FALSE otherwise.

### gweather_info_get_value_temp_min ()

    gboolean            gweather_info_get_value_temp_min    (GWeatherInfo *info,
                                                             GWeatherTemperatureUnit unit,
                                                             gdouble *value);

`info` : | a GWeatherInfo
`unit` : | the desired unit, as a GWeatherTemperatureUnit
`value` : | the minimum temperature value. [out]
Returns : | TRUE is `value` is valid, FALSE otherwise.

### gweather_info_get_value_temp_max ()

    gboolean            gweather_info_get_value_temp_max    (GWeatherInfo *info,
                                                             GWeatherTemperatureUnit unit,
                                                             gdouble *value);

`info` : | a GWeatherInfo
`unit` : | the desired unit, as a GWeatherTemperatureUnit
`value` : | the maximum temperature value. [out]
Returns : | TRUE is `value` is valid, FALSE otherwise.

### gweather_info_get_value_dew ()

    gboolean            gweather_info_get_value_dew         (GWeatherInfo *info,
                                                             GWeatherTemperatureUnit unit,
                                                             gdouble *value);

`info` : | a GWeatherInfo
`unit` : | the desired unit, as a GWeatherTemperatureUnit
`value` : | the dew point. [out]
Returns : | TRUE is `value` is valid, FALSE otherwise.

### gweather_info_get_value_apparent ()

    gboolean            gweather_info_get_value_apparent    (GWeatherInfo *info,
                                                             GWeatherTemperatureUnit unit,
                                                             gdouble *value);

`info` : | a GWeatherInfo
`unit` : | the desired unit, as a GWeatherTemperatureUnit
`value` : | the apparent temperature. [out]
Returns : | TRUE is `value` is valid, FALSE otherwise.

### gweather_info_get_value_wind ()

    gboolean            gweather_info_get_value_wind        (GWeatherInfo *info,
                                                             GWeatherSpeedUnit unit,
                                                             gdouble *speed,
                                                             GWeatherWindDirection *direction);

`info` : | a GWeatherInfo
`unit` : | the desired unit, as a GWeatherSpeedUnit
`speed` : | forecasted wind speed. [out]
`direction` : | forecasted wind direction. [out]
Returns : | TRUE if `speed` and `direction` are valid, FALSE otherwise.

### gweather_info_get_value_pressure ()

    gboolean            gweather_info_get_value_pressure    (GWeatherInfo *info,
                                                             GWeatherPressureUnit unit,
                                                             gdouble *value);

`info` : | a GWeatherInfo
`unit` : | the desired unit, as a GWeatherPressureUnit
`value` : | forecasted pressure, expressed in `unit`. [out]
Returns : | TRUE if `value` is valid, FALSE otherwise.

### gweather_info_get_value_visibility ()

    gboolean            gweather_info_get_value_visibility  (GWeatherInfo *info,
                                                             GWeatherDistanceUnit unit,
                                                             gdouble *value);

`info` : | a GWeatherInfo
`unit` : | the desired unit, as a GWeatherDistanceUnit
`value` : | forecasted visibility, expressed in `unit`. [out]
Returns : | TRUE if `value` is valid, FALSE otherwise.

### gweather_info_get_value_sunrise ()

    gboolean            gweather_info_get_value_sunrise     (GWeatherInfo *info,
                                                             time_t *value);

`info` : | a GWeatherInfo
`value` : | the time of sunrise. [out][type gulong]
Returns : | TRUE is `value` is valid, FALSE otherwise.

### gweather_info_get_value_sunset ()

    gboolean            gweather_info_get_value_sunset      (GWeatherInfo *info,
                                                             time_t *value);

`info` : | a GWeatherInfo
`value` : | the time of sunset. [out][type gulong]
Returns : | TRUE is `value` is valid, FALSE otherwise.

### gweather_info_get_value_moonphase ()

    gboolean            gweather_info_get_value_moonphase   (GWeatherInfo *info,
                                                             GWeatherMoonPhase *value,
                                                             GWeatherMoonLatitude *lat);

`info` : | a GWeatherInfo
`value` : | the current moon phase (represented as the visible percentage). [out]
`lat` : | the latitude the moon is at (???). [out]
Returns : | TRUE is `value` is valid, FALSE otherwise.

### gweather_info_get_upcoming_moonphases ()

    gboolean            gweather_info_get_upcoming_moonphases
                                                            (GWeatherInfo *info,
                                                             time_t *phases);