The string handle of the caller's window.
The caller window indicates to the prompt which window is prompting the user. The prompt may choose to ignore this information or use it in whatever way it sees fit.
In X11, this will be a stringified version of the XWindow handle; in Wayland this is the result of an export using the XDG foreign protocol.
The label for the cancel button in the prompt.
Whether the additional choice is chosen or not.
The additional choice would have been setup using #GcrPrompt:choice-label.
The label for the additional choice.
If this is a non-%NULL value then an additional boolean choice will be displayed by the prompt allowing the user to select or deselect it.
If %NULL, then no additional choice is displayed.
The initial value of the choice can be set with #GcrPrompt:choice-chosen.
The label for the continue button in the prompt.
The detailed description of the prompt.
A prompt implementation may choose not to display this detailed description. The prompt message should contain relevant information.
The prompt message for the user.
A prompt implementation should always display this message.
Whether the prompt will prompt for a new password.
This will cause the prompt implementation to ask the user to confirm the password and/or display other relevant user interface for creating a new password.
Indication of the password strength.
Prompts will return a zero value if the password is empty, and a value greater than zero if the password has any characters.
This is only valid after a successful prompt for a password.
The title of the prompt.
A prompt implementation may choose not to display the prompt title. The #GcrPrompt:message should contain relevant information.
A prompt warning displayed on the prompt, or %NULL for no warning.
This is a warning like "The password is incorrect." usually displayed to the user about a previous 'unsuccessful' prompt.
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
Closes the prompt so that in can no longer be used to prompt. The various prompt methods will return results as if the user dismissed the prompt.
The prompt may also be closed by the implementor of the prompt object.
This emits the [signalPrompt::prompt-close] signal on the prompt object.
Prompts for confirmation asking a cancel/continue style question. Set the various properties on the prompt before calling this function to represent the question correctly.
This method will block until the a response is returned from the prompter.
%GCR_PROMPT_REPLY_CONTINUE will be returned if the user confirms the prompt. The
return value will also be %GCR_PROMPT_REPLY_CANCEL if the user cancels or if
an error occurs. Check the error argument to tell the difference.
optional cancellation object
Prompts for confirmation asking a cancel/continue style question. Set the various properties on the prompt before calling this method to represent the question correctly.
This method will return immediately and complete asynchronously.
optional cancellation object
called when the operation completes
Complete an operation to prompt for confirmation.
%GCR_PROMPT_REPLY_CONTINUE will be returned if the user confirms the prompt. The
return value will also be %GCR_PROMPT_REPLY_CANCEL if the user cancels or if
an error occurs. Check the error argument to tell the difference.
asynchronous result passed to callback
Prompts for confirmation asking a cancel/continue style question. Set the various properties on the prompt before calling this function to represent the question correctly.
This method will block until the a response is returned from the prompter
and will run a main loop similar to a gtk_dialog_run(). The application
will remain responsive but care must be taken to handle reentrancy issues.
%GCR_PROMPT_REPLY_CONTINUE will be returned if the user confirms the prompt. The
return value will also be %GCR_PROMPT_REPLY_CANCEL if the user cancels or if
an error occurs. Check the error argument to tell the difference.
optional cancellation object
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.
Get the string handle of the caller's window.
The caller window indicates to the prompt which window is prompting the user. The prompt may choose to ignore this information or use it in whatever way it sees fit.
Get the label for the cancel button.
This is the button that results in a %GCR_PROMPT_REPLY_CANCEL reply from the prompt.
Get whether the additional choice was chosen or not.
The additional choice would have been setup using gcr_prompt_set_choice_label().
Get the label for the additional choice.
This will be %NULL if no additional choice is being displayed.
Get the label for the continue button.
This is the button that results in a %GCR_PROMPT_REPLY_CONTINUE reply from the prompt.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Get the detailed description of the prompt.
A prompt implementation may choose not to display this detailed description. The prompt message should contain relevant information.
Gets the prompt message for the user.
A prompt implementation should always display this message.
Get whether the prompt will prompt for a new password.
This will cause the prompt implementation to ask the user to confirm the password and/or display other relevant user interface for creating a new password.
Get indication of the password strength.
Prompts will return a zero value if the password is empty, and a value greater than zero if the password has any characters.
This is only valid after a successful prompt for a password.
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
Gets the title of the prompt.
A prompt implementation may choose not to display the prompt title. The prompt message should contain relevant information.
Get a prompt warning displayed on the prompt.
This is a warning like "The password is incorrect." usually displayed to the user about a previous 'unsuccessful' prompt.
If this string is %NULL then no warning is displayed.
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.
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.
Prompts for password. Set the various properties on the prompt before calling this method to explain which password should be entered.
This method will block until the a response is returned from the prompter.
A password will be returned if the user enters a password successfully. The returned password is valid until the next time a method is called to display another prompt.
%NULL will be returned if the user cancels or if an error occurs. Check the
error argument to tell the difference.
optional cancellation object
Prompts for password. Set the various properties on the prompt before calling this method to explain which password should be entered.
This method will return immediately and complete asynchronously.
optional cancellation object
called when the operation completes
Complete an operation to prompt for a password.
A password will be returned if the user enters a password successfully. The returned password is valid until the next time a method is called to display another prompt.
%NULL will be returned if the user cancels or if an error occurs. Check the
error argument to tell the difference.
asynchronous result passed to callback
Prompts for password. Set the various properties on the prompt before calling this method to explain which password should be entered.
This method will block until the a response is returned from the prompter and will run a main loop similar to a gtk_dialog_run(). The application will remain responsive but care must be taken to handle reentrancy issues.
A password will be returned if the user enters a password successfully. The returned password is valid until the next time a method is called to display another prompt.
%NULL will be returned if the user cancels or if an error occurs. Check the
error argument to tell the difference.
optional cancellation 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().
Reset the contents and properties of the prompt.
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Set the string handle of the caller's window.
The caller window indicates to the prompt which window is prompting the user. The prompt may choose to ignore this information or use it in whatever way it sees fit.
the window id
Set the label for the continue button.
This is the button that results in a %GCR_PROMPT_REPLY_CANCEL reply from the prompt.
the label
Set whether the additional choice is chosen or not.
The additional choice should be set up using gcr_prompt_set_choice_label().
whether chosen
Set the label for the additional choice.
If this is a non-%NULL value then an additional boolean choice will be displayed by the prompt allowing the user to select or deselect it.
The initial value of the choice can be set with the gcr_prompt_set_choice_label() method.
If this is %NULL, then no additional choice is being displayed.
the additional choice or %NULL
Set the label for the continue button.
This is the button that results in a %GCR_PROMPT_REPLY_CONTINUE reply from the prompt.
the label
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
Set the detailed description of the prompt.
A prompt implementation may choose not to display this detailed description. Use gcr_prompt_set_message() to set a general message containing relevant information.
the detailed description
Sets the prompt message for the user.
A prompt implementation should always display this message.
the prompt message
Set whether the prompt will prompt for a new password.
This will cause the prompt implementation to ask the user to confirm the password and/or display other relevant user interface for creating a new password.
whether in new password mode or not
Sets a property on an object.
the name of the property to set
the value
Sets the title of the prompt.
A prompt implementation may choose not to display the prompt title. The prompt message should contain relevant information.
the prompt title
Set a prompt warning displayed on the prompt.
This is a warning like "The password is incorrect." usually displayed to the user about a previous 'unsuccessful' prompt.
If this string is %NULL then no warning is displayed.
the warning or %NULL
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.
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 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
A prompt displayed to the user. It is an interface with various implementations.
Various properties are set on the prompt, and then the prompt is displayed the various prompt methods like [method
Prompt.password_run].A
GcrPromptmay be used to display multiple related prompts. Most implementions do not hide the window between display of multiple related prompts, and the #GcrPrompt must be closed or destroyed in order to make it go away. This allows the user to see that the prompts are related.Use
GcrPromptDialog(part of gcr-ui) to create an in-process GTK+ dialog prompt. Use [classSystemPrompt]to create a system prompt in a prompter process.The prompt implementation will always display the [property
Prompt:message] property, but may choose not to display the [propertyPrompt:description] or [propertyPrompt:title] properties.