Top | ![]() |
![]() |
![]() |
![]() |
ECalComponentAlarm *
e_cal_component_alarm_new (void
);
Creates a new empty ECalComponentAlarm structure. Free it
with e_cal_component_alarm_free()
, when no longer needed.
Since: 3.34
ECalComponentAlarm *
e_cal_component_alarm_new_from_component
(const ICalComponent *component
);
Creates a new ECalComponentAlarm, filled with values from component
,
which should be of kind I_CAL_VALARM_COMPONENT
. The function returns
NULL
when it is not of the expected kind. Free the structure
with e_cal_component_alarm_free()
, when no longer needed.
Since: 3.34
ECalComponentAlarm *
e_cal_component_alarm_copy (const ECalComponentAlarm *alarm
);
Returns a newly allocated copy of alarm
, which should be freed with
e_cal_component_alarm_free()
, when no longer needed.
Since: 3.34
void
e_cal_component_alarm_free (gpointer alarm
);
Free alarm
, previously created by e_cal_component_alarm_new()
,
e_cal_component_alarm_new_from_component()
or e_cal_component_alarm_copy()
. The function does nothing, if alarm
is NULL
.
[skip]
Since: 3.34
void e_cal_component_alarm_set_from_component (ECalComponentAlarm *alarm
,const ICalComponent *component
);
Fill the alarm
structure with the information from
the component
, which should be of I_CAL_VALARM_COMPONENT
kind.
Since: 3.34
ICalComponent *
e_cal_component_alarm_get_as_component
(ECalComponentAlarm *alarm
);
Creates a VALARM ICalComponent filled with data from the alarm
.
In case the alarm
doesn't have set 'uid', a new is assigned.
Free the returned component with g_object_unref()
, when no longer
needed.
Since: 3.34
void e_cal_component_alarm_fill_component (ECalComponentAlarm *alarm
,ICalComponent *component
);
Fills component
with data from alarm
. The component
should
be of I_CAL_VALARM_COMPONENT
kind - the function does nothing,
if it's not. In case the alarm
doesn't have set 'uid', a new
is assigned.
Since: 3.34
const gchar *
e_cal_component_alarm_get_uid (const ECalComponentAlarm *alarm
);
Get the alarm
UID.
Since: 3.34
void e_cal_component_alarm_set_uid (ECalComponentAlarm *alarm
,const gchar *uid
);
Set the alarm
UID, or generates a new UID, if uid
is NULL
or an empty string.
Since: 3.34
ECalComponentAlarmAction
e_cal_component_alarm_get_action (const ECalComponentAlarm *alarm
);
Get the alarm
action, as an ECalComponentAlarmAction.
Since: 3.34
void e_cal_component_alarm_set_action (ECalComponentAlarm *alarm
,ECalComponentAlarmAction action
);
Set the alarm
action, as an ECalComponentAlarmAction.
Since: 3.34
ECalComponentText *
e_cal_component_alarm_get_summary (const ECalComponentAlarm *alarm
);
Get the alarm
summary, as an ECalComponentText.
Since: 3.34
void e_cal_component_alarm_set_summary (ECalComponentAlarm *alarm
,const ECalComponentText *summary
);
Set the alarm
summary, as an ECalComponentText.
Since: 3.34
void e_cal_component_alarm_take_summary (ECalComponentAlarm *alarm
,ECalComponentText *summary
);
Set the alarm
summary, as an ECalComponentText, and assumes
ownership of the summary
.
[skip]
Since: 3.34
ECalComponentText *
e_cal_component_alarm_get_description (const ECalComponentAlarm *alarm
);
Get the alarm
description, as an ECalComponentText.
Since: 3.34
void e_cal_component_alarm_set_description (ECalComponentAlarm *alarm
,const ECalComponentText *description
);
Set the alarm
description, as an ECalComponentText.
Since: 3.34
void e_cal_component_alarm_take_description (ECalComponentAlarm *alarm
,ECalComponentText *description
);
Set the alarm
description, as an ECalComponentText, and assumes
ownership of the description
.
[skip]
Since: 3.34
ECalComponentAlarmRepeat *
e_cal_component_alarm_get_repeat (const ECalComponentAlarm *alarm
);
Get the alarm
repeat information, as an ECalComponentAlarmRepeat.
Since: 3.34
void e_cal_component_alarm_set_repeat (ECalComponentAlarm *alarm
,const ECalComponentAlarmRepeat *repeat
);
Set the alarm
repeat information, as an ECalComponentAlarmRepeat.
Since: 3.34
void e_cal_component_alarm_take_repeat (ECalComponentAlarm *alarm
,ECalComponentAlarmRepeat *repeat
);
Set the alarm
repeat information, as an ECalComponentAlarmRepeat and assumes
ownership of the trigger
.
[skip]
Since: 3.34
ECalComponentAlarmTrigger *
e_cal_component_alarm_get_trigger (const ECalComponentAlarm *alarm
);
Get the alarm
trigger, as an ECalComponentAlarmTrigger.
Since: 3.34
void e_cal_component_alarm_set_trigger (ECalComponentAlarm *alarm
,const ECalComponentAlarmTrigger *trigger
);
Set the alarm
trigger, as an ECalComponentAlarmTrigger.
Since: 3.34
void e_cal_component_alarm_take_trigger (ECalComponentAlarm *alarm
,ECalComponentAlarmTrigger *trigger
);
Set the alarm
trigger, as an ECalComponentAlarmTrigger and assumes
ownership of the trigger
.
[skip]
Since: 3.34
gboolean
e_cal_component_alarm_has_attendees (const ECalComponentAlarm *alarm
);
Since: 3.34
void e_cal_component_alarm_set_attendees (ECalComponentAlarm *alarm
,const GSList *attendees
);
Set the list of attendees, as a GSList of an ECalComponentAttendee.
alarm |
||
attendees |
a GSList
of an ECalComponentAttendee objects to set as attendees, or |
[transfer none][nullable][element-type ECalComponentAttendee] |
Since: 3.34
void e_cal_component_alarm_take_attendees (ECalComponentAlarm *alarm
,GSList *attendees
);
Sets the list of attendees, as a GSList of an ECalComponentAttendee and assumes
ownership of the attendees
and its content.
[skip]
alarm |
||
attendees |
a GSList
of an ECalComponentAttendee objects to set as attendees, or |
[transfer full][nullable][element-type ECalComponentAttendee] |
Since: 3.34
gboolean
e_cal_component_alarm_has_attachments (const ECalComponentAlarm *alarm
);
Since: 3.34
void e_cal_component_alarm_set_attachments (ECalComponentAlarm *alarm
,const GSList *attachments
);
Set the list of attachments, as a GSList of an ICalAttach.
alarm |
||
attachments |
a GSList
of an ICalAttach objects to set as attachments, or |
[transfer none][nullable][element-type ICalAttach] |
Since: 3.34
void e_cal_component_alarm_take_attachments (ECalComponentAlarm *alarm
,GSList *attachments
);
Sets the list of attachments, as a GSList of an ICalAttach and assumes
ownership of the attachments
and its content.
[skip]
alarm |
||
attachments |
a GSList
of an ICalAttach objects to set as attachments, or |
[transfer full][nullable][element-type ICalAttach] |
Since: 3.34
ECalComponentPropertyBag *
e_cal_component_alarm_get_property_bag
(const ECalComponentAlarm *alarm
);
an ECalComponentPropertyBag with additional
properties stored with an alarm component, other than those accessible
with the other functions of the alarm
.
[transfer none]
Since: 3.34
ICalTime *
e_cal_component_alarm_get_acknowledged
(const ECalComponentAlarm *alarm
);
Get the last time the alarm had been acknowledged, that is, when its
reminder had been triggered.
The returned ICalTime is owned by alarm
and should not be modified,
neither its content.
Since: 3.40
void e_cal_component_alarm_set_acknowledged (ECalComponentAlarm *alarm
,const ICalTime *when
);
Set the acknowledged time of the alarm
. Use NULL
to unset it.
Since: 3.40
void e_cal_component_alarm_take_acknowledged (ECalComponentAlarm *alarm
,ICalTime *when
);
Set the acknowledged time of the alarm
. Use NULL
to unset it.
The function assumes ownership of the when
.
Since: 3.40
#define E_CAL_EVOLUTION_ALARM_UID_PROPERTY "X-EVOLUTION-ALARM-UID"
Extension property for alarm components so that we can reference them by UID.
Since: 3.34