Aborts the sequence change needed in the given calendar component, which means it will not require a sequence commit (via e_cal_component_commit_sequence()) even if the changes done require a sequence increment.
Adds an alarm subcomponent to a calendar component. You should have created
the alarm
by using e_cal_component_alarm_new(); it is invalid to use an
#ECalComponentAlarm structure that came from e_cal_component_get_alarm(). After
adding the alarm, the alarm
structure is no longer valid because the
internal structures may change and you should get rid of it by using
e_cal_component_alarm_free().
an alarm, as an #ECalComponentAlarm
Creates a binding between source_property
on source
and target_property
on target
.
Whenever the source_property
is changed the target_property
is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags
contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property
on target
changes then the source_property
on source
will be updated as well.
The binding will automatically be removed when either the source
or the
target
instances are finalized. To remove the binding without affecting the
source
and the target
you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source
and target
are only used from a single thread and it
is clear that both source
and target
outlive the binding. Especially it
is not safe to rely on this if the binding, source
or target
can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
Creates a binding between source_property
on source
and target_property
on target,
allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source
to the target,
or %NULL to use the default
a #GClosure wrapping the transformation function from the target
to the source,
or %NULL to use the default
Increments the sequence number property in a calendar component object if it needs it. This needs to be done when any of a number of properties listed in RFC 2445 change values, such as the start and end dates of a component.
This function must be called before calling e_cal_component_get_as_string() to ensure that the component is fully consistent.
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object
. If the freeze count is
non-zero, the emission of "notify" signals on object
is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Queries a particular alarm subcomponent of a calendar component. Free the returned pointer with e_cal_component_alarm_free(), when no longer needed.
Unique identifier for the sought alarm subcomponent.
Builds a list of the unique identifiers of the alarm subcomponents inside a calendar component. Free the returned #GSList with g_slist_free_full (slist, g_free);, when no longer needed.
Queries all alarm subcomponents of a calendar component. Free the returned #GSList with g_slist_free_full (slist, e_cal_component_alarm_free);, when no longer needed.
Gets the iCalendar string representation of a calendar component. You should call e_cal_component_commit_sequence() before this function to ensure that the component's sequence number is consistent with the state of the object.
Queries the attachment properties as #ICalAttach objects of the calendar component object. Changes on these objects are directly affecting the component. Free the returned #GSList with g_slist_free_full (slist, g_object_unref);, when no longer needed.
Queries the attendee properties of the calendar component object. Free the returned #GSList with g_slist_free_full (slist, e_cal_component_attendee_free);, when no longer needed.
Queries the categories of the given calendar component. The categories
are returned in the categories
argument, which, on success, will contain
a comma-separated list of all categories set in the component.
Free the returned string with g_free(), when no longer needed.
Queries the list of categories of a calendar component object. Each element in the returned categ_list is a string with the corresponding category. Free the returned #GSList with g_slist_free_full (categories, g_free); , when no longer needed.
Queries the classification of a calendar component object. If the classification property is not set on this component, this function returns #E_CAL_COMPONENT_CLASS_NONE.
Retuurns: a classification of the comp,
as an #ECalComponentClassification
Queries the comments of a calendar component object. The comment property can appear several times inside a calendar component, and so a list of #ECalComponentText is returned. Free the returned #GSList with g_slist_free_full (slist, e_cal_component_text_free);, when no longer needed.
Queries the contact of a calendar component object. The contact property can appear several times inside a calendar component, and so a list of #ECalComponentText is returned. Free the returned #GSList with g_slist_free_full (slist, e_cal_component_text_free);, when no longer needed.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Queries the description of a calendar component object. Journal components may have more than one description, and as such this function returns a list of #ECalComponentText structures. All other types of components can have at most one description. Free the returned #GSList with g_slist_free_full (slist, e_cal_component_text_free);, when no longer needed.
Queries the date/time end of a calendar component object. In case there's no DTEND, but only DTSTART and DURATION, then the end is computed from the later two. Free the returned #ECalComponentDateTime with e_cal_component_datetime_free(), when no longer needed.
Queries the date/time start of a calendar component object. Free the returned #ECalComponentDateTime with e_cal_component_datetime_free(), when no longer needed.
Queries the due date/time of a calendar component object. In case there's no DUE, but only DTSTART and DURATION, then the due is computed from the later two. Free the returned #ECalComponentDateTime with e_cal_component_datetime_free(), when no longer needed.
Queries the list of exception date properties in a calendar component object. Free the returned #GSList with g_slist_free_full (exdates, e_cal_component_datetime_free);, when no longer needed.
Queries the list of exception rule properties of a calendar component object. Free the returned list with g_slist_free_full (slist, g_object_unref);, when no longer needed.
Gets the geographic position property of a calendar component object. Free the returned non-NULL object with g_object_unref(), when no longer needed.
Get the ID of the component as an #ECalComponentId. The return value should be freed with e_cal_component_id_free(), when no longer needed.
Queries the location property of a calendar component object.
Queries the organizer property of a calendar component object. Free the returned structure with e_cal_component_organizer_free(), when no longer needed.
Queries the percent-complete property of a calendar component object.
Queries the priority property of a calendar component object.
Gets a property of an object.
The value
can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Queries the list of recurrence date properties in a calendar component object. Free the returned #GSList with g_slist_free_full (slist, e_cal_component_period_free);, when no longer needed.
Queries the recurrence id property of a calendar component object. Free the returned #ECalComponentRange with e_cal_component_range_free(), whe no longer needed.
Gets the recurrence ID property as a string.
Queries the list of recurrence rule properties of a calendar component object. Free the returned list with g_slist_free_full (slist, g_object_unref);, when no longer needed.
Queries the sequence number of a calendar component object.
Queries the status property of a calendar component object.
Queries the summary of a calendar component object. Free the returned pointer withe_cal_component_text_free(), when no longer needed.
Queries the time transparency of a calendar component object.
Queries the unique identifier of a calendar component object.
Queries the uniform resource locator property of a calendar component object. Free the returned URL with g_free(), when no longer needed.
Queries the type of a calendar component object.
Gets n_properties
properties for an object
.
Obtained properties will be set to values
. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether the component has any alarms.
Queries the component to see if it has attachments.
Queries a calendar component object for the existence of attendees.
Queries whether a calendar component object has any exception dates or exception rules.
Queries whether a calendar component object has any exception dates defined for it.
Queries whether a calendar component object has any exception rules defined for it.
Check whether a calendar component object has an organizer or not.
Queries whether a calendar component object has any recurrence dates defined for it.
Queries whether a calendar component object has any recurrence dates or recurrence rules.
Queries whether a calendar component object has any recurrence rules defined for it.
Checks whether the given calendar component object has simple recurrence rules or more complicated ones.
Checks whether object
has a [floating][floating-ref] reference.
Checks whether a calendar component object is an instance of a recurring event.
Emits a "notify" signal for the property property_name
on object
.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object
.
Emits a "notify" signal for the property specified by pspec
on object
.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object
.
Increase the reference count of object,
and possibly remove the
[floating][floating-ref] reference, if object
has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object
will be propagated to the return type
under the same conditions as for g_object_ref().
Removes an alarm subcomponent from a calendar component. If the alarm that
corresponds to the specified auid
had been fetched with
e_cal_component_get_alarm(), then those alarm structures will be invalid; you
should get rid of them with e_cal_component_alarm_free() before using this
function.
UID of the alarm to remove.
Remove all alarms from the calendar component
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets the attachments of the calendar component object.
a #GSList of an #ICalAttach, or %NULL to remove any existing
Sets the attendees of a calendar component object
Values for attendee properties, or %NULL to unset
Sets the list of categories for a calendar component.
Comma-separated list of categories.
Sets the list of categories of a calendar component object.
List of strings, one for each category.
Sets the classification property of a calendar component object. To unset
the property, specify E_CAL_COMPONENT_CLASS_NONE for classif
.
Classification to use.
Sets the comments of a calendar component object. The comment property can appear several times inside a calendar component, and so a list of #ECalComponentText structures is used.
List of #ECalComponentText structures.
Sets the contact of a calendar component object. The contact property can appear several times inside a calendar component, and so a list of #ECalComponentText structures is used.
List of #ECalComponentText structures.
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key
is converted to a #GQuark using g_quark_from_string().
This means a copy of key
is kept permanently (even after object
has been
finalized) — so it is recommended to only use a small, bounded set of values
for key
in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
Sets the description of a calendar component object. Journal components may have more than one description, and as such this function takes in a list of #ECalComponentText structures. All other types of components can have at most one description.
List of #ECalComponentText structures.
Sets the date/time end property of a calendar component object.
End date/time, or %NULL, to remove the property.
Sets the date/time start property of a calendar component object.
Start date/time, or %NULL, to remove the property.
Sets the due date/time property of a calendar component object.
End date/time, or %NULL, to remove the property.
Sets the list of exception dates in a calendar component object.
List of #ECalComponentDateTime structures.
Sets the list of exception rules in a calendar component object.
a #GSList of #ICalRecurrence structures, or %NULL.
Sets the geographic position property on a calendar component object.
Value for the geographic position property, or %NULL to unset.
Sets the contents of a calendar component object from an #ICalComponent.
If the comp
already had an #ICalComponent set into it, it will
be freed automatically.
Supported component types are VEVENT, VTODO, VJOURNAL, VFREEBUSY, and VTIMEZONE.
Sets the location property of a calendar component object.
Location value. Use %NULL or empty string, to unset the property.
Clears any existing component data from a calendar component object and creates a new #ICalComponent of the specified type for it. The only property that will be set in the new component will be its unique identifier.
Type of calendar component to create.
Sets the organizer of a calendar component object
Value for the organizer property, as an #ECalComponentOrganizer
Sets percent complete. The percent
can be between 0 and 100, inclusive.
A special value -1 can be used to remove the percent complete property.
a percent to set, or -1 to remove the property
Sets the priority property of a calendar component object.
The priority
can be between 0 and 9, inclusive.
A special value -1 can be used to remove the priority property.
Value for the priority property.
Sets a property on an object.
the name of the property to set
the value
Sets the list of recurrence dates in a calendar component object.
List of #ECalComponentPeriod structures, or %NULL to set none
Sets the recurrence id property of a calendar component object.
Value for the recurrence id property, or %NULL, to remove the property.
Sets the list of recurrence rules in a calendar component object.
List of #ICalRecurrence structures, or %NULL.
Sets the sequence number of a calendar component object. A special value -1 can be used to remove the sequence number property.
Normally this function should not be called, since the sequence number is incremented automatically at the proper times.
a sequence number to set, or -1 to remove the property
Sets the status property of a calendar component object.
Status value, as an #ICalPropertyStatus. Use %I_CAL_STATUS_NONE, to unset the property
Sets the summary of a calendar component object.
Summary property and its parameters.
Sets the time transparency of a calendar component object. Use %E_CAL_COMPONENT_TRANSP_NONE to unset the property.
Time transparency value.
Sets the unique identifier string of a calendar component object.
Unique identifier.
Sets the uniform resource locator property of a calendar component object. A %NULL or an empty string removes the property.
URL value.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data
from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Strips all error messages from the calendar component. Those error messages are added to the iCalendar string representation whenever an invalid is used for one of its fields.
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Decreases the reference count of object
. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
This function essentially limits the life time of the closure
to
the life time of the object. That is, when the object is finalized,
the closure
is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure,
to ensure that an extra
reference count is held on object
during invocation of the
closure
. Usually, this function will be called on closures that
use this object
as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init
member of
#GTypeInfo.) It must not be called after after class_init
has
been called for any object types implementing this interface.
If pspec
is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface
will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Creates a new #ECalComponent of type vtype
.
an #ECalComponentVType
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
Creates a new empty calendar component object. Once created, you should set it from an existing #icalcomponent structure by using e_cal_component_set_icalcomponent() or with a new empty component type by using e_cal_component_set_new_vtype().