Top | ![]() |
![]() |
![]() |
![]() |
ECalComponentPropertyBag *
e_cal_component_property_bag_new (void
);
Creates a new ECalComponentPropertyBag. Free the structure
with e_cal_component_property_bag_free()
, when no longer needed.
Since: 3.34
ECalComponentPropertyBag * e_cal_component_property_bag_new_from_component (const ICalComponent *component
,ECalComponentPropertyBagFilterFunc func
,gpointer user_data
);
Creates a new ECalComponentPropertyBag, filled with properties
from the component
, for which the func
returned TRUE
. When
the func
is NULL
, all the properties are included.
Free the structure with e_cal_component_property_bag_free()
, when no longer needed.
component |
an ICalComponent containing the properties to fill the bag with |
|
func |
an optional |
[nullable][scope call] |
user_data |
user data for the |
[closure func] |
Since: 3.34
ECalComponentPropertyBag *
e_cal_component_property_bag_copy (const ECalComponentPropertyBag *bag
);
Returns a newly allocated copy of bag
, which should be freed with
e_cal_component_property_bag_free()
, when no longer needed.
Since: 3.34
void
e_cal_component_property_bag_free (gpointer bag
);
Free bag
, previously created by e_cal_component_property_bag_new()
,
e_cal_component_property_bag_new_from_component()
or
e_cal_component_property_bag_copy()
. The function does nothing, if bag
is NULL
.
[skip]
Since: 3.34
void e_cal_component_property_bag_set_from_component (ECalComponentPropertyBag *bag
,const ICalComponent *component
,ECalComponentPropertyBagFilterFunc func
,gpointer user_data
);
Fills the bag
with properties from the component
, for which the func
returned TRUE
. When the func
is NULL
, all the properties are included.
The bag
content is cleared before any property is added.
bag |
||
component |
an ICalComponent containing the properties to fill the |
|
func |
an optional |
[nullable][scope call] |
user_data |
user data for the |
[closure func] |
Since: 3.34
void e_cal_component_property_bag_fill_component (const ECalComponentPropertyBag *bag
,ICalComponent *component
);
Adds all the stored properties in the bag
to the component
.
The function doesn't verify whether the component
contains
the same property already.
Since: 3.34
void e_cal_component_property_bag_assign (ECalComponentPropertyBag *bag
,const ECalComponentPropertyBag *src_bag
);
Assigns content of the src_bag
into the bag
.
Since: 3.34
void e_cal_component_property_bag_add (ECalComponentPropertyBag *bag
,const ICalProperty *prop
);
Adds a copy of the prop
into the bag
.
Since: 3.34
void e_cal_component_property_bag_take (ECalComponentPropertyBag *bag
,ICalProperty *prop
);
Adds the prop
into the bag
and assumes ownership of the prop
.
Since: 3.34
guint
e_cal_component_property_bag_get_count
(const ECalComponentPropertyBag *bag
);
Since: 3.34
ICalProperty * e_cal_component_property_bag_get (const ECalComponentPropertyBag *bag
,guint index
);
Returns the ICalProperty at the given index
. If the index
is
out of bounds (not lower than e_cal_component_property_bag_get_count()
),
then NULL
is returned.
The returned property is owned by the bag
and should not be freed
by the caller.
Since: 3.34
guint e_cal_component_property_bag_get_first_by_kind (const ECalComponentPropertyBag *bag
,ICalPropertyKind kind
);
the index of the first property of the given kind
, or value
out of bounds, if such property cannot be found
Since: 3.34
void e_cal_component_property_bag_remove (ECalComponentPropertyBag *bag
,guint index
);
Removes the ICalProperty at the given index
. If the index
is
out of bounds (not lower than e_cal_component_property_bag_get_count()
),
then the function does nothing.
Since: 3.34
guint e_cal_component_property_bag_remove_by_kind (ECalComponentPropertyBag *bag
,ICalPropertyKind kind
,gboolean all
);
Removes the first or all (depending on the all
) properties of the given kind
.
Since: 3.34
void
e_cal_component_property_bag_clear (ECalComponentPropertyBag *bag
);
Removes all properties from the bag
, thus it doesn't contain any
property after this function returns.
Since: 3.34