jana-ecal-utils

jana-ecal-utils — A set of utility functions for libjana-ecal

Synopsis

JanaTime *          jana_ecal_utils_time_now            (const gchar *location);
JanaTime *          jana_ecal_utils_time_now_local      ();
JanaTime *          jana_ecal_utils_time_today          (const gchar *location);
gchar *             jana_ecal_utils_guess_location      ();
gchar **            jana_ecal_utils_get_locations       ();
#define             JANA_ECAL_LOCATION_KEY
#define             JANA_ECAL_LOCATION_KEY_DIR

Description

jana-ecal-utils contains a set of libjana-ecal related utility functions.

Details

jana_ecal_utils_time_now ()

JanaTime *          jana_ecal_utils_time_now            (const gchar *location);

Creates a new JanaEcalTime with the current time of the given location.

`location` :	A full timezone name
Returns :	A new JanaEcalTime, cast as a JanaTime.

jana_ecal_utils_time_now_local ()

JanaTime *          jana_ecal_utils_time_now_local      ();

Creates a new JanaEcalTime with the current time of the guessed location. See jana_ecal_utils_guess_location().

Returns :

A new JanaEcalTime, cast as a JanaTime.

jana_ecal_utils_time_today ()

JanaTime *          jana_ecal_utils_time_today          (const gchar *location);

Creates a new JanaEcalTime with the current date of the given location.

`location` :	A full timezone name
Returns :	A new JanaEcalTime, cast as a JanaTime.

jana_ecal_utils_guess_location ()

gchar *             jana_ecal_utils_guess_location      ();

Tries to guess the location by checking for common system settings and files, and finally falling back on the first location that matches the current system timezone. See also JANA_ECAL_LOCATION_KEY.

Returns :

A newly allocated string with the guessed location.

jana_ecal_utils_get_locations ()

gchar **            jana_ecal_utils_get_locations       ();

Retrieves the built-in list of timezone locations from libecal.

Returns :

A newly allocated string array, to be freed with g_strfreev().

JANA_ECAL_LOCATION_KEY

#define JANA_ECAL_LOCATION_KEY "/apps/evolution/calendar/display/timezone"

The GConf key path used to store the ecal timezone location. This will be checked by jana_ecal_utils_guess_location() before any other method. For convenience, this path is the same path Evolution uses to store its ecal timezone location.

JANA_ECAL_LOCATION_KEY_DIR

#define JANA_ECAL_LOCATION_KEY_DIR "/apps/evolution/calendar/display"

The parent directory of the GConf key used to store the ecal timezone location. If JANA_ECAL_LOCATION_KEY exists, this GConf directory can be monitored to detect when it has changed. See also JANA_ECAL_LOCATION_KEY.

see_also :

JANA_ECAL_LOCATION_KEY

			libjana-ecal Reference Manual
Top \| Description