ICalGLib.Recurrence
Description: Reference for ICalGLib.Recurrence

### Class

# ICalGLibRecurrence

#### Description [src]

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

This is the ICalRecurrence instance.

#### Hierarchy

#### Ancestors

- ICalObject
- GObject

#### Constructors

###### i_cal_recurrence_new

Creates a new `ICalRecurrence`.

since: 1.0

###### i_cal_recurrence_new_from_string

Converts a string to a `ICalRecurrence`.

since: 1.0

###### i_cal_recurrence_new_full

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

since: 1.0

#### Functions

###### i_cal_recurrence_day_day_of_week

Decodes a day to a weekday in a week.

since: 1.0

###### i_cal_recurrence_day_position

Decodes a day to a position of the weekday.

since: 1.0

###### i_cal_recurrence_encode_day

Encodes the `weekday` and `position` into a single value, which can by split by `i_cal_recurrence_day_day_of_week()` and i_cal_recurrence_day_position().

since: 3.0.5

###### i_cal_recurrence_encode_month

Encodes the `month` and the `is_leap` flag into a single value, which can be split by `i_cal_recurrence_month_is_leap()` and i_cal_recurrence_month_month().

since: 3.0.5

###### i_cal_recurrence_frequency_from_string

Converts a string representation to an enum representation for the frequency.

since: 2.0

###### i_cal_recurrence_frequency_to_string

Converts an enum representation to a string representation for the frequency.

since: 2.0

###### i_cal_recurrence_month_is_leap

Decodes a month and check whether it is a leap month.

since: 2.0

###### i_cal_recurrence_month_month

Decode a month from an encoded value by i_cal_recurrence_encode_month().

since: 2.0

###### i_cal_recurrence_new_default

No description available.

since: 1.0

###### i_cal_recurrence_rscale_supported_calendars

Gets an array of calendars supporting rscale (currently always return NULL).

since: 2.0

###### i_cal_recurrence_skip_from_string

Converts a string representation to an enum representation for the skip.

since: 2.0

###### i_cal_recurrence_skip_to_string

Converts an enum representation to a string representation for the skip.

since: 2.0

###### i_cal_recurrence_weekday_from_string

Converts a string representation to an enum representation for the weekday.

since: 1.0

###### i_cal_recurrence_weekday_to_string

Converts an enum representation to a string representation for the weekday.

since: 2.0

#### Instance methods

###### i_cal_recurrence_clone

Creates a copy of the `src`.

since: 4.0

###### i_cal_recurrence_get_by

Returns the element at the specified index of the ‘by’ array if it exists, 0 otherwise.

since: 4.0

###### i_cal_recurrence_get_by_array

Gets the by[byrule] array from `ICalRecurrence`.

since: 4.0

###### i_cal_recurrence_get_by_array_size

Returns the size of given ‘by’ array from `ICalRecurrence`.

since: 4.0

###### i_cal_recurrence_get_count

Gets the count from `ICalRecurrence`.

since: 1.0

###### i_cal_recurrence_get_freq

Gets the freq from `ICalRecurrence`.

since: 1.0

###### i_cal_recurrence_get_interval

Gets the interval from `ICalRecurrence`.

since: 1.0

###### i_cal_recurrence_get_until

Gets the until from `ICalRecurrence`.

since: 1.0

###### i_cal_recurrence_get_week_start

Gets the week_start from `ICalRecurrence`.

since: 1.0

###### i_cal_recurrence_ref

Increases the reference counter by 1 for the `self`.

since: 4.0

###### i_cal_recurrence_resize_by_array

Resizes the ‘by’ array to the given size.

since: 4.0

###### i_cal_recurrence_set_by

Sets the by array at the given index. Resizes the array to have a size of at least index+1 elements if necessary.

since: 4.0

###### i_cal_recurrence_set_by_array

Sets the given ‘by’ array.

since: 4.0

###### i_cal_recurrence_set_count

Sets the count from `ICalRecurrence`.

since: 1.0

###### i_cal_recurrence_set_freq

Sets the freq from `ICalRecurrence`.

since: 1.0

###### i_cal_recurrence_set_interval

Sets the interval from `ICalRecurrence`.

since: 1.0

###### i_cal_recurrence_set_until

Sets the until from `ICalRecurrence`.

since: 1.0

###### i_cal_recurrence_set_week_start

Sets the week_start from `ICalRecurrence`.

since: 1.0

###### i_cal_recurrence_to_string

Converts a `ICalRecurrence` to a string.

since: 1.0

###### i_cal_recurrence_unref

Decreases the reference counter by 1 for the `self`.

since: 4.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 ICalGLibRecurrenceClass {
      /* no available fields */
    }

This is the ICalRecurrence class.