Creates a new #ECredentialsPrompter, which listens for credential requests
from registry
.
an #ESourceRegistry to have the prompter listen to
Whether the #ECredentialsPrompter can response to credential requests automatically.
The #ESourceCredentialsProvider object, which the prompter uses.
The #ESourceRegistry object, to whose credential requests the prompter listens.
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
Completes an ongoing credentials prompt on idle, by finishing the async_result
.
This function is meant to be used by an #ECredentialsPrompterImpl implementation.
To actually finish the credentials prompt previously started with
e_credentials_prompter_prompt(), the e_credentials_prompter_prompt_finish() should
be called from the provided callback.
Using %NULL credentials
will result in a G_IO_ERROR_CANCELLED error, if
no other error
is provided.
a #GSimpleAsyncResult
an #ESource, on which the prompt was started
credentials, as provided by a user, on %NULL, when the prompt was cancelled
a resulting #GError, or %NULL
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.
Returns, whether can respond to credential prompts automatically. Default value is %TRUE.
This property does not influence direct calls of e_credentials_prompter_prompt().
Returns whether the auto-prompt is disabled for the given source
.
All sources can be auto-prompted by default. This is a complementary
value for the ECredentialsPrompter::auto-prompt property.
This value does not influence direct calls of e_credentials_prompter_prompt().
an #ESource
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Returns a #GtkWindow, which should be used as a dialog parent. This is determined by an ECredentialsPrompter::get-dialog-parent signal emission. If there is no callback registered or the current callbacks don't have any suitable window, then there's chosen the last active window from the default GApplication, if any available.
Returns a #GtkWindow, which should be used as a dialog parent for the auth_source
.
This is determined by an ECredentialsPrompter::get-dialog-parent-full signal emission and an ECredentialsPrompter::get-dialog-parent when the first doesn't return anything. If there is no callback registered or the current callbacks don't have any suitable window, then there's chosen the last active window from the default GApplication, if any available.
an #ESource
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
Returns an #ESourceCredentialsProvider, which the prompter
uses.
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Returns an #ESourceRegistry, to which the prompter
listens.
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.
Returns a list of #EExtension objects bound to extensible
whose
types are ancestors of extension_type
. For a complete list of
extension objects bound to extensible,
pass %E_TYPE_EXTENSION.
The list itself should be freed with g_list_free(). The extension
objects are owned by extensible
and should not be unreferenced.
the type of extensions to list
Creates an instance of all instantiable subtypes of #EExtension which
target the class of extensible
. The lifetimes of these newly created
#EExtension objects are bound to extensible
such that they are finalized
when extensible
is finalized.
Runs a credentials prompt loop for source,
as long as the func
doesn't
indicate that the provided credentials can be used to successfully
authenticate against source<
!-- -->'s server, or that the func
returns %FALSE. The loop is also teminated when a used cancels
the credentials prompt or the cancellable
is cancelled, though
not sooner than the credentials prompt dialog is closed.
Note: The function doesn't return until the loop is terminated, either successfully or unsuccessfully. The function can be called from any thread, though a dedicated thread is preferred.
an #ESource to be prompted credentials for
a bit-or of #ECredentialsPrompterPromptFlags initial flags
an #ECredentialsPrompterLoopPromptFunc user function to call to check provided credentials
an optional #GCancellable, or %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.
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
.
Process all enabled sources with connection state #E_SOURCE_CONNECTION_STATUS_AWAITING_CREDENTIALS, like if they just asked for its credentials for the first time.
Continues a credential prompt for source
. Returns, whether anything will be done.
The %FALSE either means that the source<
!-- -->'s connection status is not
the %E_SOURCE_CONNECTION_STATUS_AWAITING_CREDENTIALS or it is disabled.
an #ESource
Asks the prompter
to prompt for credentials, which are returned
to the caller through callback,
when available.The flags
are ignored,
when the callback
is %NULL; the credentials are passed to the source
with e_source_invoke_authenticate() directly, in this case.
Call e_credentials_prompter_prompt_finish() in callback
to get to
the provided credentials.
an #ESource, which prompt the credentials for
Additional error text to show to a user, or %NULL
a bit-or of #ECredentialsPrompterPromptFlags
a callback to call when the credentials are ready, or %NULL
Finishes a credentials prompt previously started with e_credentials_prompter_prompt().
The out_source
will have set a referenced #ESource, for which the prompt
was started. Unref it, when no longer needed. Similarly the out_credentials
will have set a newly allocated #ENamedParameters structure with provided credentials,
which should be freed with e_named_credentials_free() when no longer needed.
Both output arguments will be set to %NULL on error and %FALSE will be returned.
a #GAsyncResult
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().
Registers a prompter implementation for a given authentication method. If there is
registered a prompter for the same authentication_method,
then the function does
nothing, otherwise it adds its own reference on the prompter_impl,
and uses it
for that authentication method. One prompter_impl
can be registered for multiple
authentication methods.
A special value %NULL can be used for the authentication_method,
which means
a default credentials prompter, that is to be used when there is no prompter
registered for the exact authentication method.
an authentication method to registr prompter_impl
for; or %NULL
an #ECredentialsPrompterImpl
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 whether can respond to credential prompts automatically. That means that whenever any ESource will ask for credentials, it'll try to provide them.
Use e_credentials_prompter_set_auto_prompt_disabled_for() to influence auto-prompt per an #ESource.
This property does not influence direct calls of e_credentials_prompter_prompt().
new value of the auto-prompt property
Sets whether the auto-prompt should be disabled for the given source
.
All sources can be auto-prompted by default. This is a complementary
value for the ECredentialsPrompter::auto-prompt property.
This value does not influence direct calls of e_credentials_prompter_prompt().
an #ESource
whether the auto-prompt should be disabled for this source
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.
Unregisters previously registered prompter_impl
for the given autnetication_method
with
e_credentials_prompter_register_impl(). Function does nothing, if no such authentication
method is registered or if it has set a different prompter implementation.
an authentication method to registr prompter_impl
for; or %NULL
an #ECredentialsPrompterImpl
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 #ECredentialsPrompter, which listens for credential requests
from registry
.
an #ESourceRegistry to have the prompter listen to
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
Contains only private data that should be read and manipulated using the functions below.