ECal.ComponentAlarmTrigger¶

Fields¶

None

Methods¶

class	`new_absolute` (absolute_time)
class	`new_from_property` (property)
class	`new_relative` (kind, duration)
	`copy` ()
	`fill_property` (property)
	`get_absolute_time` ()
	`get_as_property` ()
	`get_duration` ()
	`get_kind` ()
	`get_parameter_bag` ()
	`set_absolute` (absolute_time)
	`set_absolute_time` (absolute_time)
	`set_duration` (duration)
	`set_from_property` (property)
	`set_kind` (kind)
	`set_relative` (kind, duration)

Details¶

class ECal.ComponentAlarmTrigger¶

Opaque structure, which represents when an alarm is supposed to be triggered. Use the functions below to work with it.

classmethod new_absolute(absolute_time)¶

Parameters:: absolute_time (ICalGLib.Time) – the absolute time when to trigger the alarm, as an ICalGLib.Time
Returns:: a newly allocated ECal.ComponentAlarmTrigger
Return type:: ECal.ComponentAlarmTrigger

Creates a new ECal.ComponentAlarmTrigger structure, set with the ECal.ComponentAlarmTriggerKind.ABSOLUTE kind and the absolute_time as the time of the trigger. The absolute_time should be date/time (not date) in UTC.

To create a relative trigger use ECal.ComponentAlarmTrigger.new_relative(). Free the trigger with e_cal_component_alarm_trigger_free(), when no longer needed.

New in version 3.34.

classmethod new_from_property(property)¶

Parameters:: property (ICalGLib.Property) – an ICalGLib.Property of kind ICalGLib.PropertyKind.TRIGGER_PROPERTY
Returns:: a newly allocated ECal.ComponentAlarmTrigger
Return type:: ECal.ComponentAlarmTrigger or None

Creates a new ECal.ComponentAlarmTrigger, filled with values from property, which should be of kind ICalGLib.PropertyKind.TRIGGER_PROPERTY. The function returns None when it is not of the expected kind. Free the structure with e_cal_component_alarm_trigger_free(), when no longer needed.

New in version 3.34.

classmethod new_relative(kind, duration)¶

Parameters:

kind (ECal.ComponentAlarmTriggerKind) – an ECal.ComponentAlarmTriggerKind, any but the ECal.ComponentAlarmTriggerKind.ABSOLUTE
duration (ICalGLib.Duration) – the duration relative to kind, as an ICalGLib.Duration

Returns:

a newly allocated ECal.ComponentAlarmTrigger

Return type:

ECal.ComponentAlarmTrigger

Creates a new ECal.ComponentAlarmTrigger structure, set with the given kind and duration. The kind can be any but the ECal.ComponentAlarmTriggerKind.ABSOLUTE. To create an absolute trigger use ECal.ComponentAlarmTrigger.new_absolute(). Free the trigger with e_cal_component_alarm_trigger_free(), when no longer needed.

New in version 3.34.

copy()¶

Returns:: a newly allocated copy of self
Return type:: ECal.ComponentAlarmTrigger

Returns a newly allocated copy of self, which should be freed with e_cal_component_alarm_trigger_free(), when no longer needed.

New in version 3.34.

fill_property(property)¶

Parameters:: property (ICalGLib.Property) – an ICalGLib.Property
Returns:: an ICalGLib.Property
Return type:: property: ICalGLib.Property

Fill property with information from self. The property should be of kind ICalGLib.PropertyKind.TRIGGER_PROPERTY.

New in version 3.34.

get_absolute_time()¶

Returns:: the self absolute time, as an ICalGLib.Time, or None
Return type:: ICalGLib.Time or None

Returns the self absolute time for an absolute trigger, or None, when the self is a relative trigger. The object is owned by self and it’s valid until the self is freed or its absolute time changed.

New in version 3.34.

get_as_property()¶

Returns:: a newly created ICalGLib.Property, containing information from the self.
Return type:: ICalGLib.Property

Converts information stored in self into an ICalGLib.Property of ICalGLib.PropertyKind.TRIGGER_PROPERTY kind. The caller is responsible to free the returned object with GObject.Object.unref(), when no longer needed.

New in version 3.34.

get_duration()¶

Returns:: the self duration, as an ICalGLib.Duration, or None
Return type:: ICalGLib.Duration or None

Returns the self duration for a relative self, or None, when the self is an absolute trigger.

New in version 3.34.

get_kind()¶

Returns:: the self kind, one of ECal.ComponentAlarmTriggerKind
Return type:: ECal.ComponentAlarmTriggerKind

New in version 3.34.

get_parameter_bag()¶

Returns:: an ECal.ComponentParameterBag with additional parameters stored with the trigger property, other than those accessible with the other functions of the self.
Return type:: ECal.ComponentParameterBag

New in version 3.34.

set_absolute(absolute_time)¶

Parameters:: absolute_time (ICalGLib.Time) – the absolute time when to trigger the alarm, as an ICalGLib.Time

Set the trigegr with the ECal.ComponentAlarmTriggerKind.ABSOLUTE kind and the absolute_time as the time of the trigger. The absolute_time should be date/time (not date) in UTC.

To set a relative trigger use ECal.ComponentAlarmTrigger.set_relative().

New in version 3.34.

set_absolute_time(absolute_time)¶

Parameters:: absolute_time (ICalGLib.Time) – absolute time for an absolute trigger, as an ICalGLib.Time

Sets the self absolute time for an absolute trigger. The absolute_time should be date/time (not date) in UTC.

The function does nothing, when the self is a relative trigger.

New in version 3.34.

set_duration(duration)¶

Parameters:: duration (ICalGLib.Duration) – duration for a relative trigger, as an ICalGLib.Duration

Sets the self duration for a relative trigger. The function does nothing, when the self is an absolute trigger. The object is owned by self and it’s valid until the self is freed or its relative duration changed.

New in version 3.34.

set_from_property(property)¶

Parameters:: property (ICalGLib.Property) – an ICalGLib.Property

Fill the self structure with the information from the property, which should be of ICalGLib.PropertyKind.TRIGGER_PROPERTY kind.

New in version 3.34.

set_kind(kind)¶

Parameters:: kind (ECal.ComponentAlarmTriggerKind) – the kind to set, one of ECal.ComponentAlarmTriggerKind

Set the self kind to kind. This works only for other than the ECal.ComponentAlarmTriggerKind.ABSOLUTE. To change the kind from absolute to relative, or vice versa, use either ECal.ComponentAlarmTrigger.set_relative() or ECal.ComponentAlarmTrigger.set_absolute().

New in version 3.34.

set_relative(kind, duration)¶

Parameters:

kind (ECal.ComponentAlarmTriggerKind) – an ECal.ComponentAlarmTriggerKind, any but the ECal.ComponentAlarmTriggerKind.ABSOLUTE
duration (ICalGLib.Duration) – the duration relative to kind, as an ICalGLib.Duration

Set the trigegr with the given kind and duration. The kind can be any but the ECal.ComponentAlarmTriggerKind.ABSOLUTE. To set an absolute trigger use ECal.ComponentAlarmTrigger.set_absolute().

New in version 3.34.