Top | ![]() |
![]() |
![]() |
![]() |
e-cal-component-alarm-triggere-cal-component-alarm-trigger — An ECalComponentAlarmTrigger structure |
ECalComponentAlarmTrigger * e_cal_component_alarm_trigger_new_relative (ECalComponentAlarmTriggerKind kind
,const ICalDuration *duration
);
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.
kind |
an ECalComponentAlarmTriggerKind, any but the |
|
duration |
the duration relative to |
[not nullable] |
Since: 3.34
ECalComponentAlarmTrigger *
e_cal_component_alarm_trigger_new_absolute
(const ICalTime *absolute_time
);
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.
To create a relative trigger use e_cal_component_alarm_trigger_new_relative()
.
Free the trigger with e_cal_component_alarm_trigger_free()
, when no longer needed.
absolute_time |
the absolute time when to trigger the alarm, as an ICalTime. |
[not nullable] |
Since: 3.34
ECalComponentAlarmTrigger *
e_cal_component_alarm_trigger_new_from_property
(const ICalProperty *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
ECalComponentAlarmTrigger *
e_cal_component_alarm_trigger_copy (const ECalComponentAlarmTrigger *trigger
);
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
void
e_cal_component_alarm_trigger_free (gpointer trigger
);
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
.
[skip]
Since: 3.34
void e_cal_component_alarm_trigger_set_from_property (ECalComponentAlarmTrigger *trigger
,const ICalProperty *property
);
Fill the trigger
structure with the information from
the property
, which should be of I_CAL_TRIGGER_PROPERTY
kind.
Since: 3.34
ICalProperty *
e_cal_component_alarm_trigger_get_as_property
(const ECalComponentAlarmTrigger *trigger
);
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
void e_cal_component_alarm_trigger_fill_property (const ECalComponentAlarmTrigger *trigger
,ICalProperty *property
);
Fill property
with information from trigger
. The property
should be of kind I_CAL_TRIGGER_PROPERTY
.
Since: 3.34
void e_cal_component_alarm_trigger_set_relative (ECalComponentAlarmTrigger *trigger
,ECalComponentAlarmTriggerKind kind
,const ICalDuration *duration
);
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()
.
trigger |
||
kind |
an ECalComponentAlarmTriggerKind, any but the |
|
duration |
the duration relative to |
[not nullable] |
Since: 3.34
void e_cal_component_alarm_trigger_set_absolute (ECalComponentAlarmTrigger *trigger
,const ICalTime *absolute_time
);
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.
To set a relative trigger use e_cal_component_alarm_trigger_set_relative()
.
trigger |
||
absolute_time |
the absolute time when to trigger the alarm, as an ICalTime. |
[not nullable] |
Since: 3.34
ECalComponentAlarmTriggerKind
e_cal_component_alarm_trigger_get_kind
(const ECalComponentAlarmTrigger *trigger
);
Since: 3.34
void e_cal_component_alarm_trigger_set_kind (ECalComponentAlarmTrigger *trigger
,ECalComponentAlarmTriggerKind 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
ICalDuration *
e_cal_component_alarm_trigger_get_duration
(const ECalComponentAlarmTrigger *trigger
);
Returns the trigger
duration for a relative trigger
, or NULL
, when
the trigger
is an absolute trigger.
Since: 3.34
void e_cal_component_alarm_trigger_set_duration (ECalComponentAlarmTrigger *trigger
,const ICalDuration *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
ICalTime *
e_cal_component_alarm_trigger_get_absolute_time
(const ECalComponentAlarmTrigger *trigger
);
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
void e_cal_component_alarm_trigger_set_absolute_time (ECalComponentAlarmTrigger *trigger
,const ICalTime *absolute_time
);
Sets the trigger
absolute time for an absolute trigger. The absolute_time
should be date/time (not date) in UTC.
The function does nothing, when the trigger
is a relative trigger.
Since: 3.34
ECalComponentParameterBag *
e_cal_component_alarm_trigger_get_parameter_bag
(const ECalComponentAlarmTrigger *trigger
);
an ECalComponentParameterBag with additional
parameters stored with the trigger property, other than those accessible
with the other functions of the trigger
.
[transfer none]
Since: 3.34