The capabilities of this client
The main loop context in which notifications for this client will be delivered.
Whether this client's backing data is online.
Whether this client is open and ready to use.
Whether this client's backing data is readonly.
The #ESource for which this client was created.
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
Cancels all pending operations started on client.
Check if backend supports particular capability. To get all capabilities use e_client_get_capabilities().
a capability
Checks whether a client supports explicit refreshing (see e_client_refresh()).
Returns a D-Bus bus name that will be used to connect the client to the backend subprocess.
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 client's backend for a property of name prop_name.
The call is finished by e_client_get_backend_property_finish()
from the callback.
property name, whose value to retrieve; cannot be %NULL
a #GCancellable; can be %NULL
callback to call when a result is ready
Finishes previous call of e_client_get_backend_property().
a #GAsyncResult
Queries client's backend for a property of name prop_name.
property name, whose value to retrieve; cannot be %NULL
a #GCancellable; can be %NULL
Get list of strings with capabilities advertised by a backend.
This list, together with inner strings, is owned by the client.
To check for individual capabilities use e_client_check_capability().
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
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
Get the #ESource that this client has assigned.
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 object has a [floating][floating-ref] reference.
Check if this client is connected.
Check if this client is fully opened. This includes
everything from e_client_open() call up to the authentication,
if required by a backend. Client cannot do any other operation
during the opening phase except of authenticate or cancel it.
Every other operation results in an %E_CLIENT_ERROR_BUSY error.
Check if this client is read-only.
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.
Opens the client, making it ready for queries and other operations.
The call is finished by e_client_open_finish() from the callback.
this parameter is not used anymore
a #GCancellable; can be %NULL
callback to call when a result is ready
Finishes previous call of e_client_open().
a #GAsyncResult
Opens the client, making it ready for queries and other operations.
this parameter is not used anymore
a #GCancellable; can be %NULL
Returns the #GMainContext on which event sources for client are to
be attached.
The returned #GMainContext is referenced for thread-safety and must be unreferenced with g_main_context_unref() when finished with it.
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().
Initiates refresh on the client. Finishing the method doesn't mean
that the refresh is done, backend only notifies whether it started
refreshing or not. Use e_client_check_refresh_supported() to check
whether the backend supports this method.
The call is finished by e_client_refresh_finish() from the callback.
a #GCancellable; can be %NULL
callback to call when a result is ready
Finishes previous call of e_client_refresh().
a #GAsyncResult
Initiates refresh on the client. Finishing the method doesn't mean
that the refresh is done, backend only notifies whether it started
refreshing or not. Use e_client_check_refresh_supported() to check
whether the backend supports this method.
a #GCancellable; can be %NULL
Removes the backing data for this #EClient. For example, with the file
backend this deletes the database file. You cannot get it back!
The call is finished by e_client_remove_finish() from the callback.
a #GCancellable; can be %NULL
callback to call when a result is ready
Finishes previous call of e_client_remove().
a #GAsyncResult
Removes the backing data for this #EClient. For example, with the file backend this deletes the database file. You cannot get it back!
a #GCancellable; can be %NULL
Initiates retrieval of capabilities on the client. This is usually
required only once, after the client is opened. The returned value
is cached and any subsequent call of e_client_get_capabilities() and
e_client_check_capability() is using the cached value.
The call is finished by e_client_retrieve_capabilities_finish()
from the callback.
a #GCancellable; can be %NULL
callback to call when a result is ready
Finishes previous call of e_client_retrieve_capabilities().
Returned value of capabilities should be freed with g_free(),
when no longer needed.
a #GAsyncResult
Initiates retrieval of capabilities on the client. This is usually
required only once, after the client is opened. The returned value
is cached and any subsequent call of e_client_get_capabilities() and
e_client_check_capability() is using the cached value. Returned value
of capabilities should be freed with g_free(), when no longer needed.
a #GCancellable; can be %NULL
Asynchronously retrieves client properties to match server-side values,
without waiting for the D-Bus property change notifications delivery.
When the operation is finished, callback will be called. You can then
call e_client_retrieve_properties_finish() to get the result of the operation.
optional #GCancellable object, or %NULL
a #GAsyncReadyCallback to call when the request is satisfied
Finishes the operation started with e_client_retrieve_properties().
If an error occurs, the function sets error and returns %FALSE.
a #GAsyncResult
Retrieves client properties to match server-side values, without waiting
for the D-Bus property change notifications delivery.
If an error occurs, the function sets error and returns %FALSE.
optional #GCancellable object, or %NULL
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 client's backend property of name prop_name
to value prop_value. The call is finished
by e_client_set_backend_property_finish() from the callback.
property name, whose value to change; cannot be %NULL
property value, to set; cannot be %NULL
a #GCancellable; can be %NULL
callback to call when a result is ready
Finishes previous call of e_client_set_backend_property().
a #GAsyncResult
Sets client's backend property of name prop_name
to value prop_value.
property name, whose value to change; cannot be %NULL
property value, to set; cannot be %NULL
a #GCancellable; can be %NULL
Sets a D-Bus bus name that will be used to connect the client to the backend subprocess.
a string representing a D-Bus bus name
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 a property on an object.
the name of the property to set
the 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
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.
Queries client's backend for a property of name prop_name.
The call is finished by e_client_get_backend_property_finish()
from the callback.
property name, whose value to retrieve; cannot be %NULL
a #GCancellable; can be %NULL
callback to call when a result is ready
Finishes previous call of e_client_get_backend_property().
a #GAsyncResult
Queries client's backend for a property of name prop_name.
property name, whose value to retrieve; cannot be %NULL
a #GCancellable; can be %NULL
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.
Opens the client, making it ready for queries and other operations.
The call is finished by e_client_open_finish() from the callback.
this parameter is not used anymore
a #GCancellable; can be %NULL
callback to call when a result is ready
Finishes previous call of e_client_open().
a #GAsyncResult
Opens the client, making it ready for queries and other operations.
this parameter is not used anymore
a #GCancellable; can be %NULL
Initiates refresh on the client. Finishing the method doesn't mean
that the refresh is done, backend only notifies whether it started
refreshing or not. Use e_client_check_refresh_supported() to check
whether the backend supports this method.
The call is finished by e_client_refresh_finish() from the callback.
a #GCancellable; can be %NULL
callback to call when a result is ready
Finishes previous call of e_client_refresh().
a #GAsyncResult
Initiates refresh on the client. Finishing the method doesn't mean
that the refresh is done, backend only notifies whether it started
refreshing or not. Use e_client_check_refresh_supported() to check
whether the backend supports this method.
a #GCancellable; can be %NULL
Removes the backing data for this #EClient. For example, with the file
backend this deletes the database file. You cannot get it back!
The call is finished by e_client_remove_finish() from the callback.
a #GCancellable; can be %NULL
callback to call when a result is ready
Finishes previous call of e_client_remove().
a #GAsyncResult
Removes the backing data for this #EClient. For example, with the file backend this deletes the database file. You cannot get it back!
a #GCancellable; can be %NULL
Initiates retrieval of capabilities on the client. This is usually
required only once, after the client is opened. The returned value
is cached and any subsequent call of e_client_get_capabilities() and
e_client_check_capability() is using the cached value.
The call is finished by e_client_retrieve_capabilities_finish()
from the callback.
a #GCancellable; can be %NULL
callback to call when a result is ready
Finishes previous call of e_client_retrieve_capabilities().
Returned value of capabilities should be freed with g_free(),
when no longer needed.
a #GAsyncResult
Initiates retrieval of capabilities on the client. This is usually
required only once, after the client is opened. The returned value
is cached and any subsequent call of e_client_get_capabilities() and
e_client_check_capability() is using the cached value. Returned value
of capabilities should be freed with g_free(), when no longer needed.
a #GCancellable; can be %NULL
Retrieves client properties to match server-side values, without waiting
for the D-Bus property change notifications delivery.
If an error occurs, the function sets error and returns %FALSE.
optional #GCancellable object, or %NULL
Sets client's backend property of name prop_name
to value prop_value. The call is finished
by e_client_set_backend_property_finish() from the callback.
property name, whose value to change; cannot be %NULL
property value, to set; cannot be %NULL
a #GCancellable; can be %NULL
callback to call when a result is ready
Finishes previous call of e_client_set_backend_property().
a #GAsyncResult
Sets client's backend property of name prop_name
to value prop_value.
property name, whose value to change; cannot be %NULL
property value, to set; cannot be %NULL
a #GCancellable; can be %NULL
Asynchronously waits until the client is connected (according
to ESource::connection-status property), but not longer than timeout_seconds.
The call is finished by e_client_wait_for_connected_finish() from
the callback.
a timeout for the wait, in seconds
a #GCancellable; or %NULL
callback to call when a result is ready
Finishes previous call of e_client_wait_for_connected().
a #GAsyncResult
Synchronously waits until the client is connected (according
to ESource::connection-status property), but not longer than timeout_seconds.
Note: This also calls e_client_retrieve_properties_sync() on success, to have up-to-date property values on the client side, without a delay due to property change notifcations delivery through D-Bus.
a timeout for the wait, in seconds
a #GCancellable; or %NULL
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
Get localized human readable description of the given error code.
an #EClientError error code
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 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
Copies the #GSList of strings to the end of copy_to.
Where to copy; may be %NULL
#GSList of strings to be copied
Frees memory previously allocated by e_client_util_strv_to_slist().
a #GSList of strings (gchar *)
Parses comma-separated list of values into #GSList.
string of comma-separated values
Convert a list of strings into a %NULL-terminated array of strings.
a #GSList of strings (const gchar *)
Convert a %NULL-terminated array of strings to a list of strings.
a %NULL-terminated array of strings (const gchar *)
The function takes a dbus_error and tries to find a match in known_errors
for it, if it is a G_IO_ERROR, G_IO_ERROR_DBUS_ERROR. If it is anything else
then the dbus_error is moved to client_error.
The fail_when_none_matched influences behaviour. If it's %TRUE, and none of
known_errors matches, or this is not a G_IO_ERROR_DBUS_ERROR, then %FALSE
is returned and the client_error is left without change. Otherwise, the
fail_when_none_matched is %FALSE, the error is always processed and will
result in E_CLIENT_ERROR, E_CLIENT_ERROR_OTHER_ERROR if none of known_error
matches.
DBus #GError to unwrap
List of known errors against which try to match
How many items are stored in known_errors
Error domain for known_errors
Whether to fail when none of known_errors matches
Contains only private data that should be read and manipulated using the functions below.