ICalGLib.Timezone
Description: Reference for ICalGLib.Timezone

### Class

# ICalGLibTimezone

#### Description [src]

    final class ICalGLib.Timezone : ICalGLib.Object
    {
      /* No available fields */
    }

This is the ICalTimezone instance.

#### Hierarchy

#### Ancestors

- ICalObject
- GObject

#### Constructors

###### i_cal_timezone_new

The constructor of the type `ICalTimezone`.

since: 1.0

###### i_cal_timezone_new_full

Create a new libical-glib object from the native libical object and the owner.

since: 1.0

#### Functions

###### i_cal_timezone_array_element_at

Gets the `ICalTimezone` at specified position in array.

since: 1.0

###### i_cal_timezone_destroy

The destructor of the type `ICalTimezone` to fully destroy the object by providing 1 as the second argument of i_cal_time_zone_free. The method is used as a default destructor for introspection.

since: 1.0

###### i_cal_timezone_free_builtin_timezones

Frees any builtin timezone information.

since: 1.0

###### i_cal_timezone_free_zone_directory

Frees memory dedicated to the zonefile directory.

since: 1.0

###### i_cal_timezone_get_builtin_timezone

Returns a single builtin timezone, given its Olson city name.

since: 1.0

###### i_cal_timezone_get_builtin_timezone_from_offset

Returns a single builtin timezone, given its offset.

since: 1.0

###### i_cal_timezone_get_builtin_timezone_from_tzid

Returns a single builtin timezone, given its TZID.

since: 1.0

###### i_cal_timezone_get_builtin_timezones

Returns a list of builtin timezones.

since: 1.0

###### i_cal_timezone_get_builtin_tzdata

Gets whether to use builtin timezones files.

since: 2.0

###### i_cal_timezone_get_location_from_vtimezone

Gets the location of the vtimezone in component.

since: 2.0

###### i_cal_timezone_get_system_zone_directory

Returns the full path to the system zoneinfo directory (where zone.tab lives).

since: 4.0

###### i_cal_timezone_get_tzid_prefix

Returns the current timezone ID prefix used by the libical. See i_cal_timezone_set_tzid_prefix().

since: 4.0

###### i_cal_timezone_get_tznames_from_vtimezone

Gets the name of the vtimezone in component.

since: 2.0

###### i_cal_timezone_get_utc_timezone

Returns the UTC timezone.

since: 1.0

###### i_cal_timezone_get_zone_directory

Gets the directory to look for the zonefiles.

since: 3.0.17

###### i_cal_timezone_set_builtin_tzdata

Sets whether to use builtin timezones files.

since: 2.0

###### i_cal_timezone_set_system_zone_directory

Sets the full path to the system zoneinfo directory (where zone.tab lives).

since: 4.0

###### i_cal_timezone_set_tzid_prefix

Sets the prefix to be used for tzid’s generated from system tzdata. Must be globally unique (such as a domain name owned by the developer of the calling application), and begin and end with forward slashes. Do not change or de-allocate the string buffer after calling this.

since: 1.0

###### i_cal_timezone_set_zone_directory

Sets the directory to look for the zonefiles.

since: 1.0

###### i_cal_timezone_truncate_vtimezone

Truncate a VTIMEZONE component to the given start and end times. If either time is null, then no truncation will occur at that point. If either time is non-null, then it MUST be specified as UTC. If the start time is non-null and ms_compatible is zero, then the DTSTART of RRULEs will be adjusted to occur after the start time.

since: 4.0

#### Instance methods

###### i_cal_timezone_copy

The clone method for `ICalTimezone`.

since: 1.0

###### i_cal_timezone_dump_changes

Outputs a list of timezone changes for the given timezone to the given file, up to the maximum year given.

since: 1.0

###### i_cal_timezone_free

The destructor of `ICalTimezone`.

since: 1.0

###### i_cal_timezone_get_component

Returns the VTIMEZONE component of a timezone.

since: 1.0

###### i_cal_timezone_get_display_name

Gets the display name of the `zone`.

since: 1.0

###### i_cal_timezone_get_latitude

Returns the latitude of a builtin timezone.

since: 1.0

###### i_cal_timezone_get_location

Returns the city name of a timezone, or `NULL`, when none is set or when `zone` is also `NULL`.

since: 1.0

###### i_cal_timezone_get_longitude

Returns the longitude of a builtin timezone.

since: 1.0

###### i_cal_timezone_get_tzid

Returns the TZID of a timezone, or `NULL`, when none is set or when `zone` is also `NULL`.

since: 1.0

###### i_cal_timezone_get_tznames

Returns the TZNAME properties used in the latest STANDARD and DAYLIGHT components. If they are the same it will return just one, e.g. “LMT”. If they are different it will format them like “EST/EDT”. Note that this may also return NULL.

since: 1.0

###### i_cal_timezone_get_utc_offset

Calculates the UTC offset of a given local time in the given timezone. It is the number of seconds to add to UTC to get local time. The is_daylight flag is set to 1 if the time is in daylight-savings time.

since: 1.0

###### i_cal_timezone_get_utc_offset_of_utc_time

Calculates the UTC offset of a given UTC time in the given timezone. It is the number of seconds to add to UTC to get local time. The is_daylight flag is set to 1 if the time is in daylight-savings time.

since: 1.0

###### i_cal_timezone_set_component

Sets the VTIMEZONE component of `ICalTimezone`, initializing the tzid, location and tzname fields. It returns 1 on success or 0 on failure, i.e. no TZID was found.

since: 1.0

##### Methods inherited from ICalObject (12)

###### i_cal_object_add_depender

Adds a `depender` into the list of objects which should not be destroyed before this `iobject`. It’s usually used for cases where the `iobject` uses native libical structure from the `depender`. The `depender` is referenced. It’s illegal to try to add one `depender` multiple times.

since: 1.0

###### i_cal_object_get_always_destroy

Obtain the `ICalObject`::always-destroy property value.

since: 3.0.11

###### i_cal_object_get_is_global_memory

Obtains whether the native libical structure is a global shared memory, thus should not be destroyed. This can be set only during construction time.

since: 1.0

###### i_cal_object_get_native

Obtain native libical structure pointer associated with this `iobject`.

since: 1.0

###### i_cal_object_get_native_destroy_func

Obtain a pointer to a function responsible to free the libical native structure.

since: 1.0

###### i_cal_object_ref_owner

Obtain current owner of the native libical structure. The returned pointer, if not NULL, is referenced for thread safety. Unref it with g_object_unref when done with it.

since: 1.0

###### i_cal_object_remove_depender

Removes a `depender` from the list of objects which should not be destroyed before this `iobject`, previously added with i_cal_object_add_depender(). It’s illegal to try to remove the `depender` which is not in the internal list.

since: 1.0

###### i_cal_object_remove_owner

Unref and remove the owner.

since: 1.0

###### i_cal_object_set_always_destroy

Sets the `ICalObject`::always-destroy property value. When `TRUE`, the native libical structure is always freed, even when an owner of the `iobject` is set.

since: 3.0.11

###### i_cal_object_set_native_destroy_func

Sets a function to be used to destroy the native libical structure.

since: 1.0

###### i_cal_object_set_owner

Sets an owner of the native libical structure, that is an object responsible for a destroy of the native libical structure.

since: 1.0

###### i_cal_object_steal_native

Obtain native libical structure pointer associated with this `iobject` and sets the one at `iobject` to NULL, thus it’s invalid since now on.

since: 1.0

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

#### Properties

##### Properties inherited from ICalObject (5)

###### ICalGLib.Object:always-destroy

Whether free the native libical structure on `ICalObject`‘s finalize even if the object has set an owner.

since: 3.0.11

###### ICalGLib.Object:is-global-memory

Whether the native libical structure is from a global shared memory. If TRUE, then it is not freed on `ICalObject`‘s finalize.

###### ICalGLib.Object:native

The native libical structure for this ICalObject.

###### ICalGLib.Object:native-destroy-func

GDestroyNotify function to use to destroy the native libical pointer.

###### ICalGLib.Object:owner

Owner of the native libical structure. If set, then it is responsible for a free of the native libical structure.

#### Signals

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct ICalGLibTimezoneClass {
      /* no available fields */
    }

This is the ICalTimezone class.