Class

GcrSystemPrompt

Description [src]

class Gcr.SystemPrompt : GObject.Object {
  parent: GObject
}

A GcrPrompt 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 gcr_system_prompt_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 gcr_system_prompt_close() to close the prompt when you’re done with it.

Ancestors

  • GObject

Implements

Instance methods

gcr_system_prompt_close

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.

gcr_system_prompt_close_async

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.

gcr_system_prompt_close_finish

Complete operation to close this prompt.

gcr_system_prompt_get_secret_exchange

Get the current GcrSecretExchange used to transfer secrets in this prompt.

Methods inherited from GcrPrompt (31)
gcr_prompt_close

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.

gcr_prompt_confirm

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.

gcr_prompt_confirm_async

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.

gcr_prompt_confirm_finish

Complete an operation to prompt for confirmation.

gcr_prompt_confirm_run

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.

gcr_prompt_get_caller_window

Get the string handle of the caller’s window.

gcr_prompt_get_cancel_label

Get the label for the cancel button.

gcr_prompt_get_choice_chosen

Get whether the additional choice was chosen or not.

gcr_prompt_get_choice_label

Get the label for the additional choice.

gcr_prompt_get_continue_label

Get the label for the continue button.

gcr_prompt_get_description

Get the detailed description of the prompt.

gcr_prompt_get_message

Gets the prompt message for the user.

gcr_prompt_get_password_new

Get whether the prompt will prompt for a new password.

gcr_prompt_get_password_strength

Get indication of the password strength.

gcr_prompt_get_title

Gets the title of the prompt.

gcr_prompt_get_warning

Get a prompt warning displayed on the prompt.

gcr_prompt_password

Prompts for password. Set the various properties on the prompt before calling this method to explain which password should be entered.

gcr_prompt_password_async

Prompts for password. Set the various properties on the prompt before calling this method to explain which password should be entered.

gcr_prompt_password_finish

Complete an operation to prompt for a password.

gcr_prompt_password_run

Prompts for password. Set the various properties on the prompt before calling this method to explain which password should be entered.

gcr_prompt_reset

Reset the contents and properties of the prompt.

gcr_prompt_set_caller_window

Set the string handle of the caller’s window.

gcr_prompt_set_cancel_label

Set the label for the continue button.

Properties

Gcr.SystemPrompt:bus-name

The DBus bus name of the prompter to use for prompting, or NULL for the default prompter.

Gcr.SystemPrompt:secret-exchange

The GcrSecretExchange to use when transferring passwords. A default secret exchange will be used if this is not set.

Gcr.SystemPrompt:timeout-seconds

The timeout in seconds to wait when opening the prompt.

Properties inherited from GcrPrompt (11)
Gcr.Prompt:caller-window

The string handle of the caller’s window.

Gcr.Prompt:cancel-label

The label for the cancel button in the prompt.

Gcr.Prompt:choice-chosen

Whether the additional choice is chosen or not.

Gcr.Prompt:choice-label

The label for the additional choice.

Gcr.Prompt:continue-label

The label for the continue button in the prompt.

Gcr.Prompt:description

The detailed description of the prompt.

Gcr.Prompt:message

The prompt message for the user.

Gcr.Prompt:password-new

Whether the prompt will prompt for a new password.

Gcr.Prompt:password-strength

Indication of the password strength.

Gcr.Prompt:title

The title of the prompt.

Gcr.Prompt:warning

A prompt warning displayed on the prompt, or NULL for no warning.

Class structure

struct GcrSystemPromptClass {
  GObjectClass parent_class;
  
}
Class members
parent_class
GObjectClass
  No description available.

Functions

gcr_system_prompt_error_get_domain
No description available.
gcr_system_prompt_open

Opens a system prompt with the default prompter.

gcr_system_prompt_open_async

Asynchronously open a system prompt with the default system prompter.

gcr_system_prompt_open_finish

Complete an operation to asynchronously open a system prompt.

gcr_system_prompt_open_for_prompter

Opens a system prompt. If prompter_name is NULL, then the default system prompter is used.

gcr_system_prompt_open_for_prompter_async

Opens a system prompt asynchronously. If prompter_name is NULL, then the default system prompter is used.