Optionalproperties: Partial<Gcr.SystemPrompt.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeConstruct Onlybus_The DBus bus name of the prompter to use for prompting, or null
for the default prompter.
Construct OnlybusThe DBus bus name of the prompter to use for prompting, or null
for the default prompter.
The Gcr.SecretExchange to use when transferring passwords. A default secret exchange will be used if this is not set.
The Gcr.SecretExchange to use when transferring passwords. A default secret exchange will be used if this is not set.
Construct Onlytimeout_The timeout in seconds to wait when opening the prompt.
Construct OnlytimeoutThe timeout in seconds to wait when opening the prompt.
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 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 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 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.
The label for the cancel button in the prompt.
The label for the cancel button in the prompt.
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 Gcr.Prompt.choice_label.
Whether the additional choice is chosen or not.
The additional choice would have been setup using Gcr.Prompt.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 Gcr.Prompt.choice_chosen.
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 Gcr.Prompt.choice_chosen.
Whether the additional choice is chosen or not.
The additional choice would have been setup using Gcr.Prompt.choice_label.
Whether the additional choice is chosen or not.
The additional choice would have been setup using Gcr.Prompt.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 Gcr.Prompt.choice_chosen.
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 Gcr.Prompt.choice_chosen.
The label for the continue button in the prompt.
The label for the continue button in the prompt.
The label for the continue button in the prompt.
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 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.
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.
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.
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 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 Gcr.Prompt.message should contain relevant information.
The title of the prompt.
A prompt implementation may choose not to display the prompt title. The Gcr.Prompt.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.
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.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.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
GObject.Binding 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.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
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.
If flags contains GObject.BindingFlags.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 transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
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 GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Close this prompt. After calling this function, no further prompts will succeed on this object. The prompt object is not unreferenced by this function, and you must unreference it once done.
This call may block, use the gcr_system_prompt_close_async() to perform
this action indefinitely.
Whether or not this function returns true, the system prompt object is
still closed and may not be further used.
Optionalcancellable: Gio.Cancellablean optional cancellation object
whether close was cleanly completed
Close this prompt asynchronously. After calling this function, no further methods may be called on this object. The prompt object is not unreferenced by this function, and you must unreference it once done.
This call returns immediately and completes asynchronously.
Optionalcancellable: Gio.Cancellablean optional cancellation object
Close this prompt asynchronously. After calling this function, no further methods may be called on this object. The prompt object is not unreferenced by this function, and you must unreference it once done.
This call returns immediately and completes asynchronously.
an optional cancellation object
called when the operation completes
Close this prompt asynchronously. After calling this function, no further methods may be called on this object. The prompt object is not unreferenced by this function, and you must unreference it once done.
This call returns immediately and completes asynchronously.
Optionalcancellable: Gio.Cancellablean optional cancellation object
Optionalcallback: AsyncReadyCallback<Gcr.SystemPrompt>called when the operation completes
Complete operation to close this prompt.
Whether or not this function returns true, the system prompt object is
still closed and may not be further used.
asynchronous operation result
whether close was cleanly completed
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.PromptReply.CONTINUE will be returned if the user confirms the prompt. The
return value will also be Gcr.PromptReply.CANCEL if the user cancels or if
an error occurs. Check the error argument to tell the difference.
Optionalcancellable: Gio.Cancellableoptional cancellation object
the reply from the prompt
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.
Optionalcancellable: Gio.Cancellableoptional 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
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.
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Gcr.SystemPrompt>called when the operation completes
Complete an operation to prompt for confirmation.
Gcr.PromptReply.CONTINUE will be returned if the user confirms the prompt. The
return value will also be Gcr.PromptReply.CANCEL if the user cancels or if
an error occurs. Check the error argument to tell the difference.
asynchronous result passed to callback
the reply from the prompt
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.PromptReply.CONTINUE will be returned if the user confirms the prompt. The
return value will also be Gcr.PromptReply.CANCEL if the user cancels or if
an error occurs. Check the error argument to tell the difference.
Optionalcancellable: Gio.Cancellableoptional cancellation object
the reply from the prompt
SignalconnectSignalconnect_Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
SignalemitThis function is intended for GObject.Object 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.Object::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.
a newly allocated string containing the string handle of the window.
Get the label for the cancel button.
This is the button that results in a Gcr.PromptReply.CANCEL reply from the prompt.
a newly allocated string containing the label
Get whether the additional choice was chosen or not.
The additional choice would have been setup using
gcr_prompt_set_choice_label().
whether chosen
Get the label for the additional choice.
This will be null if no additional choice is being displayed.
a newly allocated string containing the additional choice or null
Get the label for the continue button.
This is the button that results in a Gcr.PromptReply.CONTINUE reply from the prompt.
a newly allocated string containing the label
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
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.
a newly allocated string containing the detailed description of the prompt
Gets the prompt message for the user.
A prompt implementation should always display this message.
a newly allocated string containing the detailed description of the prompt
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.
whether in new password mode or not
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.
zero if the password is empty, greater than zero if not
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 GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Get the current SecretExchange used to transfer secrets in this prompt.
the secret exchange
Gets the title of the prompt.
A prompt implementation may choose not to display the prompt title. The prompt message should contain relevant information.
a newly allocated string containing the prompt title.
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.
a newly allocated string containing the prompt warning, or null if no warning
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
Initializes the object implementing the interface.
This method is intended for language bindings. If writing in C,
g_initable_new() should typically be used instead.
The object must be initialized before any real use after initial
construction, either with this function or g_async_initable_init_async().
Implementations may also support cancellation. If cancellable is not null,
then initialization can be cancelled by triggering the cancellable object
from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null and
the object doesn't support cancellable initialization the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
If the object is not initialized, or initialization returns with an
error, then all operations on the object except g_object_ref() and
g_object_unref() are considered to be invalid, and have undefined
behaviour. See the [description][iface@Gio.Initable#description] for more details.
Callers should not assume that a class which implements Gio.Initable can be
initialized multiple times, unless the class explicitly documents itself as
supporting this. Generally, a class’ implementation of init() can assume
(and assert) that it will only be called once. Previously, this documentation
recommended all Gio.Initable implementations should be idempotent; that
recommendation was relaxed in GLib 2.54.
If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.
One reason why a class might need to support idempotent initialization is if
it is designed to be used via the singleton pattern, with a
GObject.ObjectClass.constructor that sometimes returns an existing instance.
In this pattern, a caller would expect to be able to call g_initable_init()
on the result of g_object_new(), regardless of whether it is in fact a new
instance.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
true if successful. If an error has occurred, this function will return false and set error appropriately if present.
Starts asynchronous initialization of the object implementing the
interface. This must be done before any real use of the object after
initial construction. If the object also implements Gio.Initable you can
optionally call g_initable_init() instead.
This method is intended for language bindings. If writing in C,
g_async_initable_new_async() should typically be used instead.
When the initialization is finished, callback will be called. You can
then call g_async_initable_init_finish() to get the result of the
initialization.
Implementations may also support cancellation. If cancellable is not
null, then initialization can be cancelled by triggering the cancellable
object from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null, and
the object doesn't support cancellable initialization, the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
As with Gio.Initable, if the object is not initialized, or initialization
returns with an error, then all operations on the object except
g_object_ref() and g_object_unref() are considered to be invalid, and
have undefined behaviour. They will often fail with g_critical() or
g_warning(), but this must not be relied on.
Callers should not assume that a class which implements Gio.AsyncInitable can
be initialized multiple times; for more information, see g_initable_init().
If a class explicitly supports being initialized multiple times,
implementation requires yielding all subsequent calls to init_async() on the
results of the first call.
For classes that also support the Gio.Initable interface, the default
implementation of this method will run the g_initable_init() function
in a thread, so if you want to support asynchronous initialization via
threads, just implement the Gio.AsyncInitable interface without overriding
any interface methods.
the I/O priority of the operation
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Starts asynchronous initialization of the object implementing the
interface. This must be done before any real use of the object after
initial construction. If the object also implements Gio.Initable you can
optionally call g_initable_init() instead.
This method is intended for language bindings. If writing in C,
g_async_initable_new_async() should typically be used instead.
When the initialization is finished, callback will be called. You can
then call g_async_initable_init_finish() to get the result of the
initialization.
Implementations may also support cancellation. If cancellable is not
null, then initialization can be cancelled by triggering the cancellable
object from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null, and
the object doesn't support cancellable initialization, the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
As with Gio.Initable, if the object is not initialized, or initialization
returns with an error, then all operations on the object except
g_object_ref() and g_object_unref() are considered to be invalid, and
have undefined behaviour. They will often fail with g_critical() or
g_warning(), but this must not be relied on.
Callers should not assume that a class which implements Gio.AsyncInitable can
be initialized multiple times; for more information, see g_initable_init().
If a class explicitly supports being initialized multiple times,
implementation requires yielding all subsequent calls to init_async() on the
results of the first call.
For classes that also support the Gio.Initable interface, the default
implementation of this method will run the g_initable_init() function
in a thread, so if you want to support asynchronous initialization via
threads, just implement the Gio.AsyncInitable interface without overriding
any interface methods.
the I/O priority of the operation
optional Gio.Cancellable object, null to ignore.
a Gio.AsyncReadyCallback to call when the request is satisfied
Starts asynchronous initialization of the object implementing the
interface. This must be done before any real use of the object after
initial construction. If the object also implements Gio.Initable you can
optionally call g_initable_init() instead.
This method is intended for language bindings. If writing in C,
g_async_initable_new_async() should typically be used instead.
When the initialization is finished, callback will be called. You can
then call g_async_initable_init_finish() to get the result of the
initialization.
Implementations may also support cancellation. If cancellable is not
null, then initialization can be cancelled by triggering the cancellable
object from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null, and
the object doesn't support cancellable initialization, the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
As with Gio.Initable, if the object is not initialized, or initialization
returns with an error, then all operations on the object except
g_object_ref() and g_object_unref() are considered to be invalid, and
have undefined behaviour. They will often fail with g_critical() or
g_warning(), but this must not be relied on.
Callers should not assume that a class which implements Gio.AsyncInitable can
be initialized multiple times; for more information, see g_initable_init().
If a class explicitly supports being initialized multiple times,
implementation requires yielding all subsequent calls to init_async() on the
results of the first call.
For classes that also support the Gio.Initable interface, the default
implementation of this method will run the g_initable_init() function
in a thread, so if you want to support asynchronous initialization via
threads, just implement the Gio.AsyncInitable interface without overriding
any interface methods.
the I/O priority of the operation
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gcr.SystemPrompt>a Gio.AsyncReadyCallback to call when the request is satisfied
Finishes asynchronous initialization and returns the result.
See g_async_initable_init_async().
true if successful. If an error has occurred, this function will return false and set error appropriately if present.
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Finishes the async construction for the various g_async_initable_new
calls, returning the created object or null on error.
the Gio.AsyncResult from the callback
a newly created GObject.Object, or null on error. Free with g_object_unref().
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.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
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 GObject.ParamSpec 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.
Optionalcancellable: Gio.Cancellableoptional cancellation object
the password owned by the prompt, or null
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.
Optionalcancellable: Gio.Cancellableoptional 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
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.
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Gcr.SystemPrompt>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
the password owned by the prompt, or null
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.
Optionalcancellable: Gio.Cancellableoptional cancellation object
the password owned by the prompt, or null
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same 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().
object
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.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
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.PromptReply.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.
Optionalchoice_label: stringthe additional choice or null
Set the label for the continue button.
This is the button that results in a Gcr.PromptReply.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 GLib.Quark 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 GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata 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 to set the property to
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.
Optionalwarning: stringthe warning or null
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
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 GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
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.Object::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.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
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.Object 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.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Initializes the object implementing the interface.
This method is intended for language bindings. If writing in C,
g_initable_new() should typically be used instead.
The object must be initialized before any real use after initial
construction, either with this function or g_async_initable_init_async().
Implementations may also support cancellation. If cancellable is not null,
then initialization can be cancelled by triggering the cancellable object
from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null and
the object doesn't support cancellable initialization the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
If the object is not initialized, or initialization returns with an
error, then all operations on the object except g_object_ref() and
g_object_unref() are considered to be invalid, and have undefined
behaviour. See the [description][iface@Gio.Initable#description] for more details.
Callers should not assume that a class which implements Gio.Initable can be
initialized multiple times, unless the class explicitly documents itself as
supporting this. Generally, a class’ implementation of init() can assume
(and assert) that it will only be called once. Previously, this documentation
recommended all Gio.Initable implementations should be idempotent; that
recommendation was relaxed in GLib 2.54.
If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.
One reason why a class might need to support idempotent initialization is if
it is designed to be used via the singleton pattern, with a
GObject.ObjectClass.constructor that sometimes returns an existing instance.
In this pattern, a caller would expect to be able to call g_initable_init()
on the result of g_object_new(), regardless of whether it is in fact a new
instance.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Virtualvfunc_Starts asynchronous initialization of the object implementing the
interface. This must be done before any real use of the object after
initial construction. If the object also implements Gio.Initable you can
optionally call g_initable_init() instead.
This method is intended for language bindings. If writing in C,
g_async_initable_new_async() should typically be used instead.
When the initialization is finished, callback will be called. You can
then call g_async_initable_init_finish() to get the result of the
initialization.
Implementations may also support cancellation. If cancellable is not
null, then initialization can be cancelled by triggering the cancellable
object from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null, and
the object doesn't support cancellable initialization, the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
As with Gio.Initable, if the object is not initialized, or initialization
returns with an error, then all operations on the object except
g_object_ref() and g_object_unref() are considered to be invalid, and
have undefined behaviour. They will often fail with g_critical() or
g_warning(), but this must not be relied on.
Callers should not assume that a class which implements Gio.AsyncInitable can
be initialized multiple times; for more information, see g_initable_init().
If a class explicitly supports being initialized multiple times,
implementation requires yielding all subsequent calls to init_async() on the
results of the first call.
For classes that also support the Gio.Initable interface, the default
implementation of this method will run the g_initable_init() function
in a thread, so if you want to support asynchronous initialization via
threads, just implement the Gio.AsyncInitable interface without overriding
any interface methods.
the I/O priority of the operation
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gcr.SystemPrompt>a Gio.AsyncReadyCallback to call when the request is satisfied
Virtualvfunc_Finishes asynchronous initialization and returns the result.
See g_async_initable_init_async().
Virtualvfunc_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.
Virtualvfunc_close a prompt
Virtualvfunc_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.
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Gcr.SystemPrompt>called when the operation completes
Virtualvfunc_Complete an operation to prompt for confirmation.
Gcr.PromptReply.CONTINUE will be returned if the user confirms the prompt. The
return value will also be Gcr.PromptReply.CANCEL if the user cancels or if
an error occurs. Check the error argument to tell the difference.
asynchronous result passed to callback
Virtualvfunc_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.
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Gcr.SystemPrompt>called when the operation completes
Virtualvfunc_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
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
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.
GObject.Closure to watch
Staticerror_StaticopenOpens a system prompt with the default prompter.
Most system prompters only allow showing one prompt at a time, and if
another prompt is shown then this method will block for up to
timeout_seconds seconds. If timeout_seconds is equal to -1, then this
will block indefinitely until the prompt can be opened. If timeout_seconds
expires, then this function will fail with a Gcr.SystemPromptError.SYSTEM_PROMPT_IN_PROGRESS
error.
the number of seconds to wait to access the prompt, or -1
Optionalcancellable: Gio.Cancellableoptional cancellation object
Staticopen_Asynchronously open a system prompt with the default system prompter.
Most system prompters only allow showing one prompt at a time, and if
another prompt is shown then this method will block for up to
timeout_seconds seconds. If timeout_seconds is equal to -1, then this
will block indefinitely until the prompt can be opened. If timeout_seconds
expires, then this operation will fail with a Gcr.SystemPromptError.SYSTEM_PROMPT_IN_PROGRESS
error.
the number of seconds to wait to access the prompt, or -1
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Gcr.SystemPrompt>called when the operation completes
Staticopen_Complete an operation to asynchronously open a system prompt.
the asynchronous result
Staticopen_Opens a system prompt. If prompter_name is null, then the default
system prompter is used.
Most system prompters only allow showing one prompt at a time, and if
another prompt is shown then this method will block for up to
timeout_seconds seconds. If timeout_seconds is equal to -1, then this
will block indefinitely until the prompt can be opened. If timeout_seconds
expires, then this function will fail with a Gcr.SystemPromptError.SYSTEM_PROMPT_IN_PROGRESS
error.
the prompter dbus name
the number of seconds to wait to access the prompt, or -1
Optionalcancellable: Gio.Cancellableoptional cancellation object
Staticopen_Opens a system prompt asynchronously. If prompter_name is null, then the
default system prompter is used.
Most system prompters only allow showing one prompt at a time, and if
another prompt is shown then this method will block for up to
timeout_seconds seconds. If timeout_seconds is equal to -1, then this
will block indefinitely until the prompt can be opened. If timeout_seconds
expires, then this operation will fail with a Gcr.SystemPromptError.SYSTEM_PROMPT_IN_PROGRESS
error.
the prompter D-Bus name
the number of seconds to wait to access the prompt, or -1
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Gcr.SystemPrompt>called when the operation completes
Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec 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.
Staticinterface_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 GObject.ParamSpec, 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
GObject.TypeInfo.) 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 GObject.ParamSpec for the new property
Staticinterface_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
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
A Prompt implementation which calls to the system prompter to display prompts in a system modal fashion.
Since the system prompter usually only displays one prompt at a time, you may have to wait for the prompt to be displayed. Use SystemPrompt.open or a related function to open a prompt. Since this can take a long time, you should always check that the prompt is still needed after it is opened. A previous prompt may have already provided the information needed and you may no longer need to prompt.
Use SystemPrompt.close to close the prompt when you're done with it.