ICalGLib.Recurrence¶

Subclasses:: None

Methods¶

Inherited:: ICalGLib.Object (11), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`day_day_of_week` (day)
class	`day_position` (day)
class	`frequency_from_string` (str)
class	`frequency_to_string` (kind)
class	`month_is_leap` (month)
class	`month_month` (month)
class	`new` ()
class	`new_from_string` (str)
class	`rscale_is_supported` ()
class	`rscale_supported_calendars` ()
class	`skip_from_string` (str)
class	`skip_to_string` (kind)
class	`weekday_from_string` (str)
class	`weekday_to_string` (kind)
	`clear` ()
	`get_by_day` (index)
	`get_by_day_array` ()
	`get_by_hour` (index)
	`get_by_hour_array` ()
	`get_by_minute` (index)
	`get_by_minute_array` ()
	`get_by_month` (index)
	`get_by_month_array` ()
	`get_by_month_day` (index)
	`get_by_month_day_array` ()
	`get_by_second` (index)
	`get_by_second_array` ()
	`get_by_set_pos` (index)
	`get_by_set_pos_array` ()
	`get_by_week_no` (index)
	`get_by_week_no_array` ()
	`get_by_year_day` (index)
	`get_by_year_day_array` ()
	`get_count` ()
	`get_freq` ()
	`get_interval` ()
	`get_until` ()
	`get_week_start` ()
	`set_by_day` (index, value)
	`set_by_day_array` (values)
	`set_by_hour` (index, value)
	`set_by_hour_array` (values)
	`set_by_minute` (index, value)
	`set_by_minute_array` (values)
	`set_by_month` (index, value)
	`set_by_month_array` (values)
	`set_by_month_day` (index, value)
	`set_by_month_day_array` (values)
	`set_by_second` (index, value)
	`set_by_second_array` (values)
	`set_by_set_pos` (index, value)
	`set_by_set_pos_array` (values)
	`set_by_week_no` (index, value)
	`set_by_week_no_array` (values)
	`set_by_year_day` (index, value)
	`set_by_year_day_array` (values)
	`set_count` (count)
	`set_freq` (freq)
	`set_interval` (interval)
	`set_until` (until)
	`set_week_start` (week_start)
	`to_string` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: ICalGLib.Object (5)

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class ICalGLib.Recurrence(**kwargs)¶

Bases:: ICalGLib.Object
Abstract:: No
Structure:: ICalGLib.RecurrenceClass

This is the ICalGLib.Recurrence instance.

classmethod day_day_of_week(day)¶

Parameters:: day (int) – The encoded day which represents the day of the week and Nth day of the week
Returns:: The decoded weekday with Monday to be 1.
Return type:: ICalGLib.RecurrenceWeekday

Decodes a day to a weekday in a week.

New in version 1.0.

classmethod day_position(day)¶

Parameters:: day (int) – The encoded day which represents the day of the week and Nth day of the week
Returns:: The decoded day of the week. 0 == any of day of week. 1 == first, 2 = second, -2 == second to last, etc
Return type:: int

Decodes a day to a position of the weekday.

New in version 1.0.

classmethod frequency_from_string(str)¶

Parameters:: str (str) – The string representation of the frequency
Returns:: The enum representation of the frequency.
Return type:: ICalGLib.RecurrenceFrequency

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

New in version 2.0.

classmethod frequency_to_string(kind)¶

Parameters:: kind (ICalGLib.RecurrenceFrequency) – The frequency enum
Returns:: The string representation of frequency
Return type:: str

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

New in version 2.0.

classmethod month_is_leap(month)¶

Parameters:: month (int) – The month to be decoded
Returns:: Whether this month is a leap month.
Return type:: bool

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

New in version 2.0.

classmethod month_month(month)¶

Parameters:: month (int) – The month to be decoded
Returns:: The actual month number regardless of the leap flag.
Return type:: int

New in version 2.0.

classmethod new()¶

Returns:: The newly created ICalGLib.Recurrence.
Return type:: ICalGLib.Recurrence

Creates a new ICalGLib.Recurrence.

New in version 1.0.

classmethod new_from_string(str)¶

Parameters:: str (str) – The string representation of the ICalGLib.Recurrence
Returns:: The ICalGLib.Recurrence converted from str.
Return type:: ICalGLib.Recurrence

Converts a string to a ICalGLib.Recurrence.

New in version 1.0.

classmethod rscale_is_supported()¶

Returns:: Whether rscale is supported
Return type:: bool

Checks whether rscale is supported.

New in version 2.0.

classmethod rscale_supported_calendars()¶

Returns:: Array of calendars. Currently always None.
Return type:: ICalGLib.Array

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

New in version 2.0.

classmethod skip_from_string(str)¶

Parameters:: str (str) – The string representation of the skip
Returns:: The enum representation of the skip.
Return type:: ICalGLib.RecurrenceSkip

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

New in version 2.0.

classmethod skip_to_string(kind)¶

Parameters:: kind (ICalGLib.RecurrenceSkip) – The frequency enum
Returns:: The string representation of skip
Return type:: str

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

New in version 2.0.

classmethod weekday_from_string(str)¶

Parameters:: str (str) – The string representation of the weekday
Returns:: The enum representation of the weekday.
Return type:: ICalGLib.RecurrenceWeekday

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

New in version 1.0.

classmethod weekday_to_string(kind)¶

Parameters:: kind (ICalGLib.RecurrenceWeekday) – The frequency enum
Returns:: The string representation of weekday
Return type:: str

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

New in version 2.0.

clear()¶: Resets an ICalGLib.Recurrence.

New in version 1.0.

get_by_day(index)¶

Parameters:: index (int) – The index in by_day of ICalGLib.Recurrence, less than ICalGLib.RecurrenceArraySizes.DAY_SIZE
Returns:: The by_day of ICalGLib.Recurrence at index index.
Return type:: int

Gets the by_day value at index index. The index should be less than ICalGLib.RecurrenceArraySizes.DAY_SIZE.

New in version 1.0.

get_by_day_array()¶

Returns:: The by_day of ICalGLib.Recurrence.
Return type:: [int]

Gets the by_day array from ICalGLib.Recurrence. The array size is ICalGLib.RecurrenceArraySizes.DAY_SIZE.

New in version 1.0.

get_by_hour(index)¶

Parameters:: index (int) – The index in by_hour of ICalGLib.Recurrence, less than ICalGLib.RecurrenceArraySizes.HOUR_SIZE
Returns:: The by_hour of ICalGLib.Recurrence at index index.
Return type:: int

Gets the by_hour value at index index. The index should be less than ICalGLib.RecurrenceArraySizes.HOUR_SIZE.

New in version 1.0.

get_by_hour_array()¶

Returns:: The by_hour of ICalGLib.Recurrence.
Return type:: [int]

Gets the by_hour array from ICalGLib.Recurrence. The array size is ICalGLib.RecurrenceArraySizes.HOUR_SIZE.

New in version 1.0.

get_by_minute(index)¶

Parameters:: index (int) – The index in by_minute of ICalGLib.Recurrence, less than ICalGLib.RecurrenceArraySizes.MINUTE_SIZE
Returns:: The by_minute of ICalGLib.Recurrence at index index.
Return type:: int

Gets the by_minute value at index index. The index should be less than ICalGLib.RecurrenceArraySizes.MINUTE_SIZE.

New in version 1.0.

get_by_minute_array()¶

Returns:: The by_minute of ICalGLib.Recurrence.
Return type:: [int]

Gets the by_minute array from ICalGLib.Recurrence. The array size is ICalGLib.RecurrenceArraySizes.MINUTE_SIZE.

New in version 1.0.

get_by_month(index)¶

Parameters:: index (int) – The index in by_month of ICalGLib.Recurrence, less than ICalGLib.RecurrenceArraySizes.MONTH_SIZE
Returns:: The by_month of ICalGLib.Recurrence at index index.
Return type:: int

Gets the by_month value at index index. The index should be less than ICalGLib.RecurrenceArraySizes.MONTH_SIZE.

New in version 1.0.

get_by_month_array()¶

Returns:: The by_month of ICalGLib.Recurrence.
Return type:: [int]

Gets the by_month array from ICalGLib.Recurrence. The array size is ICalGLib.RecurrenceArraySizes.MONTH_SIZE.

New in version 1.0.

get_by_month_day(index)¶

Parameters:: index (int) – The index in by_month_day of ICalGLib.Recurrence, less than ICalGLib.RecurrenceArraySizes.MONTHDAY_SIZE
Returns:: The by_month_day of ICalGLib.Recurrence at index index.
Return type:: int

Gets the by_month_day value at index index. The index should be less than ICalGLib.RecurrenceArraySizes.MONTHDAY_SIZE.

New in version 1.0.

get_by_month_day_array()¶

Returns:: The by_month_day of ICalGLib.Recurrence.
Return type:: [int]

Gets the by_month_day array from ICalGLib.Recurrence. The array size is ICalGLib.RecurrenceArraySizes.MONTHDAY_SIZE.

New in version 1.0.

get_by_second(index)¶

Parameters:: index (int) – The index in by_second of ICalGLib.Recurrence, less than ICalGLib.RecurrenceArraySizes.SECOND_SIZE
Returns:: The by_second of ICalGLib.Recurrence at index index.
Return type:: int

Gets the by_second value at index index. The index should be less than ICalGLib.RecurrenceArraySizes.SECOND_SIZE.

New in version 1.0.

get_by_second_array()¶

Returns:: The by_second of ICalGLib.Recurrence.
Return type:: [int]

Gets the by_second array from ICalGLib.Recurrence. The array size if ICalGLib.RecurrenceArraySizes.SECOND_SIZE.

New in version 1.0.

get_by_set_pos(index)¶

Parameters:: index (int) – The index in by_set_pos of ICalGLib.Recurrence, less than ICalGLib.RecurrenceArraySizes.SETPOS_SIZE
Returns:: The by_week_no of ICalGLib.Recurrence at index index.
Return type:: int

Gets the by_set_pos value at index index. The index should be less than ICalGLib.RecurrenceArraySizes.SETPOS_SIZE.

New in version 1.0.

get_by_set_pos_array()¶

Returns:: The by_set_pos of ICalGLib.Recurrence.
Return type:: [int]

Gets the by_set_pos array from ICalGLib.Recurrence. The array size is ICalGLib.RecurrenceArraySizes.SETPOS_SIZE.

New in version 1.0.

get_by_week_no(index)¶

Parameters:: index (int) – The index in by_week_no of ICalGLib.Recurrence, less than ICalGLib.RecurrenceArraySizes.WEEKNO_SIZE
Returns:: The by_week_no of ICalGLib.Recurrence at index index.
Return type:: int

Gets the by_week_no value at index index. The index should be less than ICalGLib.RecurrenceArraySizes.WEEKNO_SIZE.

New in version 1.0.

get_by_week_no_array()¶

Returns:: The by_week_no of ICalGLib.Recurrence.
Return type:: [int]

Gets the by_week_no array from ICalGLib.Recurrence. The array size is ICalGLib.RecurrenceArraySizes.WEEKNO_SIZE.

New in version 1.0.

get_by_year_day(index)¶

Parameters:: index (int) – The index in by_year_day of ICalGLib.Recurrence, less than ICalGLib.RecurrenceArraySizes.YEARDAY_SIZE
Returns:: The by_year_day of ICalGLib.Recurrence at index index.
Return type:: int

Gets the by_year_day value at index index. The index should be less than ICalGLib.RecurrenceArraySizes.YEARDAY_SIZE.

New in version 1.0.

get_by_year_day_array()¶

Returns:: The by_year_day of ICalGLib.Recurrence.
Return type:: [int]

Gets the by_year_day array from ICalGLib.Recurrence. The array size is ICalGLib.RecurrenceArraySizes.YEARDAY_SIZE.

New in version 1.0.

get_count()¶

Returns:: The count of ICalGLib.Recurrence.
Return type:: int

Gets the count from ICalGLib.Recurrence.

New in version 1.0.

get_freq()¶

Returns:: The freq of ICalGLib.Recurrence.
Return type:: ICalGLib.RecurrenceFrequency

Gets the freq from ICalGLib.Recurrence.

New in version 1.0.

get_interval()¶

Returns:: The interval of ICalGLib.Recurrence.
Return type:: int

Gets the interval from ICalGLib.Recurrence.

New in version 1.0.

get_until()¶

Returns:: The until of ICalGLib.Recurrence.
Return type:: ICalGLib.Time

Gets the until from ICalGLib.Recurrence.

New in version 1.0.

get_week_start()¶

Returns:: The week_start of ICalGLib.Recurrence.
Return type:: ICalGLib.RecurrenceWeekday

Gets the week_start from ICalGLib.Recurrence.

New in version 1.0.

set_by_day(index, value)¶

Parameters:

index (int) – The index in by_day of ICalGLib.Recurrence
value (int) – The value to be set into by_day of ICalGLib.Recurrence

Sets the by_day array from ICalGLib.Recurrence at the given index. The array size if ICalGLib.RecurrenceArraySizes.DAY_SIZE.

New in version 1.0.

set_by_day_array(values)¶

Parameters:: values ([int]) – The array of values

Sets the by_day array in self at once. The array size can be less than ICalGLib.RecurrenceArraySizes.DAY_SIZE. Shorter arrays are terminated with ICalGLib.RecurrenceArrayMaxValues.RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

New in version 1.0.

set_by_hour(index, value)¶

Parameters:

index (int) – The index in by_hour of ICalGLib.Recurrence
value (int) – The value to be set into by_hour of ICalGLib.Recurrence

Sets the by_hour array from ICalGLib.Recurrence at the given index. The array size is ICalGLib.RecurrenceArraySizes.HOUR_SIZE.

New in version 1.0.

set_by_hour_array(values)¶

Parameters:: values ([int]) – The array of values

Sets the by_hour array in self at once. The array size can be less than ICalGLib.RecurrenceArraySizes.HOUR_SIZE. Shorter arrays are terminated with ICalGLib.RecurrenceArrayMaxValues.RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

New in version 1.0.

set_by_minute(index, value)¶

Parameters:

index (int) – The index in by_minute of ICalGLib.Recurrence
value (int) – The value to be set into by_minute of ICalGLib.Recurrence

Sets the by_minute array from ICalGLib.Recurrence at the given index. The array size is ICalGLib.RecurrenceArraySizes.MINUTE_SIZE.

New in version 1.0.

set_by_minute_array(values)¶

Parameters:: values ([int]) – The array of values

Sets the by_minute array in self at once. The array size can be less than ICalGLib.RecurrenceArraySizes.MINUTE_SIZE. Shorter arrays are terminated with ICalGLib.RecurrenceArrayMaxValues.RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

New in version 1.0.

set_by_month(index, value)¶

Parameters:

index (int) – The index in by_month of ICalGLib.Recurrence
value (int) – The value to be set into by_month of ICalGLib.Recurrence

Sets the by_month array from ICalGLib.Recurrence at the given index. The array size is ICalGLib.RecurrenceArraySizes.MONTH_SIZE.

New in version 1.0.

set_by_month_array(values)¶

Parameters:: values ([int]) – The array of values

Sets the by_month array in self at once. The array size can be less than ICalGLib.RecurrenceArraySizes.MONTH_SIZE. Shorter arrays are terminated with ICalGLib.RecurrenceArrayMaxValues.RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

New in version 1.0.

set_by_month_day(index, value)¶

Parameters:

index (int) – The index in by_month_day of ICalGLib.Recurrence
value (int) – The value to be set into by_month_day of ICalGLib.Recurrence

Sets the by_month_day array from ICalGLib.Recurrence at the given index. The array size if ICalGLib.RecurrenceArraySizes.MONTHDAY_SIZE.

New in version 1.0.

set_by_month_day_array(values)¶

Parameters:: values ([int]) – The array of values

Sets the by_month_day array in self at once. The array size can be less than ICalGLib.RecurrenceArraySizes.MONTHDAY_SIZE. Shorter arrays are terminated with ICalGLib.RecurrenceArrayMaxValues.RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

New in version 1.0.

set_by_second(index, value)¶

Parameters:

index (int) – The index in by_second of ICalGLib.Recurrence, less than ICalGLib.RecurrenceArraySizes.SECOND_SIZE
value (int) – The value to be set into by_second of ICalGLib.Recurrence

Sets the by_second array from ICalGLib.Recurrence at the given index. The array size is ICalGLib.RecurrenceArraySizes.SECOND_SIZE.

New in version 1.0.

set_by_second_array(values)¶

Parameters:: values ([int]) – The array of values

Sets the by_second array in self at once. The array size can be less than ICalGLib.RecurrenceArraySizes.SECOND_SIZE. Shorter arrays are terminated with ICalGLib.RecurrenceArrayMaxValues.RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

New in version 1.0.

set_by_set_pos(index, value)¶

Parameters:

index (int) – The index in by_set_pos of ICalGLib.Recurrence
value (int) – The value to be set into by_set_pos of ICalGLib.Recurrence

Sets the by_set_pos array from ICalGLib.Recurrence at the given index. The array size is ICalGLib.RecurrenceArraySizes.SETPOS_SIZE.

New in version 1.0.

set_by_set_pos_array(values)¶

Parameters:: values ([int]) – The array of values

Sets the by_set_pos array in self at once. The array size can be less than ICalGLib.RecurrenceArraySizes.SETPOS_SIZE. Shorter arrays are terminated with ICalGLib.RecurrenceArrayMaxValues.RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

New in version 1.0.

set_by_week_no(index, value)¶

Parameters:

index (int) – The index in by_week_no of ICalGLib.Recurrence
value (int) – The value to be set into by_week_no of ICalGLib.Recurrence

Sets the by_week_no array from ICalGLib.Recurrence at the given index. The array size is ICalGLib.RecurrenceArraySizes.WEEKNO_SIZE.

New in version 1.0.

set_by_week_no_array(values)¶

Parameters:: values ([int]) – The array of values

Sets the by_week_no array in self at once. The array size can be less than ICalGLib.RecurrenceArraySizes.WEEKNO_SIZE. Shorter arrays are terminated with ICalGLib.RecurrenceArrayMaxValues.RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

New in version 1.0.

set_by_year_day(index, value)¶

Parameters:

index (int) – The index in by_year_day of ICalGLib.Recurrence
value (int) – The value to be set into by_year_day of ICalGLib.Recurrence

Sets the by_year_day array from ICalGLib.Recurrence at the given index. The array size if ICalGLib.RecurrenceArraySizes.YEARDAY_SIZE.

New in version 1.0.

set_by_year_day_array(values)¶

Parameters:: values ([int]) – The array of values

Sets the by_year_day array in self at once. The array size can be less than ICalGLib.RecurrenceArraySizes.YEARDAY_SIZE. Shorter arrays are terminated with ICalGLib.RecurrenceArrayMaxValues.RECURRENCE_ARRAY_MAX value, longer arrays are truncated.

New in version 1.0.

set_count(count)¶

Parameters:: count (int) – The count of ICalGLib.Recurrence

Sets the count from ICalGLib.Recurrence.

New in version 1.0.

set_freq(freq)¶

Parameters:: freq (ICalGLib.RecurrenceFrequency) – The freq of ICalGLib.Recurrence

Sets the freq from ICalGLib.Recurrence.

New in version 1.0.

set_interval(interval)¶

Parameters:: interval (int) – The interval of ICalGLib.Recurrence

Sets the interval from ICalGLib.Recurrence.

New in version 1.0.

set_until(until)¶

Parameters:: until (ICalGLib.Time) – The until of ICalGLib.Recurrence

Sets the until from ICalGLib.Recurrence.

New in version 1.0.

set_week_start(week_start)¶

Parameters:: week_start (ICalGLib.RecurrenceWeekday) – The week_start of ICalGLib.Recurrence

Sets the week_start from ICalGLib.Recurrence.

New in version 1.0.

to_string()¶

Returns:: The string representation of self.
Return type:: str

Converts a ICalGLib.Recurrence to a string.

New in version 1.0.