Struct

ECalComponentAlarmTrigger

Description [src]

struct ECalComponentAlarmTrigger {
  /* No available fields */
}

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

Constructors

e_cal_component_alarm_trigger_new_absolute

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

since: 3.34

e_cal_component_alarm_trigger_new_from_property

Creates a new ECalComponentAlarmTrigger, filled with values from property, which should be of kind I_CAL_TRIGGER_PROPERTY. The function returns NULL when it is not of the expected kind. Free the structure with e_cal_component_alarm_trigger_free(), when no longer needed.

since: 3.34

e_cal_component_alarm_trigger_new_relative

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

since: 3.34

Instance methods

e_cal_component_alarm_trigger_copy

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

since: 3.34

e_cal_component_alarm_trigger_fill_property

Fill property with information from trigger. The property should be of kind I_CAL_TRIGGER_PROPERTY.

since: 3.34

e_cal_component_alarm_trigger_free

Free trigger, previously created by e_cal_component_alarm_trigger_new_relative(), e_cal_component_alarm_trigger_new_absolute(), e_cal_component_alarm_trigger_new_from_property() or e_cal_component_alarm_trigger_copy(). The function does nothing, if trigger is NULL.

since: 3.34

e_cal_component_alarm_trigger_get_absolute_time

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

since: 3.34

e_cal_component_alarm_trigger_get_as_property

Converts information stored in trigger into an ICalProperty of I_CAL_TRIGGER_PROPERTY kind. The caller is responsible to free the returned object with g_object_unref(), when no longer needed.

since: 3.34

e_cal_component_alarm_trigger_get_duration

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

since: 3.34

e_cal_component_alarm_trigger_get_kind
No description available.

since: 3.34

e_cal_component_alarm_trigger_get_parameter_bag
No description available.

since: 3.34

e_cal_component_alarm_trigger_set_absolute

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

since: 3.34

e_cal_component_alarm_trigger_set_absolute_time

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

since: 3.34

e_cal_component_alarm_trigger_set_duration

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

since: 3.34

e_cal_component_alarm_trigger_set_from_property

Fill the trigger structure with the information from the property, which should be of I_CAL_TRIGGER_PROPERTY kind.

since: 3.34

e_cal_component_alarm_trigger_set_kind

Set the trigger kind to kind. This works only for other than the E_CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE. To change the kind from absolute to relative, or vice versa, use either e_cal_component_alarm_trigger_set_relative() or e_cal_component_alarm_trigger_set_absolute().

since: 3.34

e_cal_component_alarm_trigger_set_relative

Set the trigegr with the given kind and duration. The kind can be any but the E_CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE. To set an absolute trigger use e_cal_component_alarm_trigger_set_absolute().

since: 3.34