Callbacks

	ComponentParameterBagFilterFunc (parameter, *user_data)
	ComponentPropertyBagFilterFunc (property, *user_data)
	RecurFormatDateTimeFunc (itt, buffer, buffer_size)
	RecurInstanceCb (icomp, instance_start, instance_end, user_data, cancellable)
	RecurResolveTimezoneCb (tzid, user_data, cancellable)
	UtilFilterPropertyFunc (prop, *user_data)
	UtilForeachCategoryFunc (comp, inout_category, *user_data)

Details

ECal.ComponentParameterBagFilterFunc(parameter, *user_data)

Parameters:

• parameter (ICalGLib.Parameter) – an ICalGLib.Parameter

• user_data (object or None) – user data for the callback

Returns:

True, to add the parameter to the bag; False, to not add it to the bag

Return type:

bool

A function used to filter which parameters should be added to the bag, when filling it with ECal.ComponentParameterBag.new_from_property() and ECal.ComponentParameterBag.set_from_property().

New in version 3.34.

ECal.ComponentPropertyBagFilterFunc(property, *user_data)

Parameters:

• property (ICalGLib.Property) – an ICalGLib.Property

• user_data (object or None) – user data for the callback

Returns:

True, to add the property to the bag; False, to not add it to the bag

Return type:

bool

A function used to filter which properties should be added to the bag, when filling it with ECal.ComponentPropertyBag.new_from_component() and ECal.ComponentPropertyBag.set_from_component().

New in version 3.34.

ECal.RecurFormatDateTimeFunc(itt, buffer, buffer_size)

Parameters:

• itt (ICalGLib.Time) – an ICalGLib.Time to format to string

• buffer (str) – a buffer to fill with the result

• buffer_size (int) – the buffer size, in bytes, not counting the NUL-terminator character

Format the date/time value from itt into buffer, whose size cannot exceed buffer_size letters.

New in version 3.38.

ECal.RecurInstanceCb(icomp, instance_start, instance_end, user_data, cancellable)

Parameters:

• icomp (ICalGLib.Component) – an ICalGLib.Component

• instance_start (ICalGLib.Time) – start time of an instance

• instance_end (ICalGLib.Time) – end time of an instance

• user_data (object or None) – user data used for this callback in ECal.recur_generate_instances_sync()

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Returns:

True, to continue recurrence generation, False to stop

Return type:

bool

Callback used by ECal.recur_generate_instances_sync(), called for each instance of a (recurring) component within given time range.

New in version 3.34.

ECal.RecurResolveTimezoneCb(tzid, user_data, cancellable)

Parameters:

• tzid (str) – timezone ID to resolve

• user_data (object or None) – user data used for this callback

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Returns:

an ICalGLib.Timezone object for tzid, or None, on error or if not found.

Return type:

ICalGLib.Timezone or None

Resolve timezone by its ID provided as tzid. The returned object, if not None, is owned by the callback implementation and should not be freed.

New in version 3.34.

ECal.UtilFilterPropertyFunc(prop, *user_data)

Parameters:

• prop (ICalGLib.Property) – an ICalGLib.Property

• user_data (object or None) – user data for the function

Returns:

True, when the prop should be considered, False to skip it

Return type:

bool

Function used to determine whether the given property prop should be considered.

New in version 3.52.

ECal.UtilForeachCategoryFunc(comp, inout_category, *user_data)

Parameters:

• comp (ICalGLib.Component) – an ICalGLib.Component

• inout_category (str) – the category name

• user_data (object or None) – user data for the callback

Returns:

True to continue, False to stop

inout_category:

the category name

Return type:

(bool, inout_category: str)

Function called for each non-empty category from ECal.util_foreach_category(). The func can assume owenrship of the inout_category content, in which case it should also set its content to None, to avoid free of it. The string itself, if taken, should be freed with GLib.free(), when no longer needed.

New in version 3.48.