gcr_prompt_password ()

const gchar *
gcr_prompt_password (GcrPrompt *prompt,
                     GCancellable *cancellable,
                     GError **error);

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.

gcr_prompt_password_async ()

void
gcr_prompt_password_async (GcrPrompt *prompt,
                           GCancellable *cancellable,
                           GAsyncReadyCallback callback,
                           gpointer user_data);

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.

gcr_prompt_password_finish ()

const gchar *
gcr_prompt_password_finish (GcrPrompt *prompt,
                            GAsyncResult *result,
                            GError **error);

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.

gcr_prompt_password_run ()

const gchar *
gcr_prompt_password_run (GcrPrompt *prompt,
                         GCancellable *cancellable,
                         GError **error);

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.

gcr_prompt_confirm ()

GcrPromptReply
gcr_prompt_confirm (GcrPrompt *prompt,
                    GCancellable *cancellable,
                    GError **error);

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.

gcr_prompt_confirm_async ()

void
gcr_prompt_confirm_async (GcrPrompt *prompt,
                          GCancellable *cancellable,
                          GAsyncReadyCallback callback,
                          gpointer user_data);

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.

gcr_prompt_confirm_finish ()

GcrPromptReply
gcr_prompt_confirm_finish (GcrPrompt *prompt,
                           GAsyncResult *result,
                           GError **error);

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.

gcr_prompt_confirm_run ()

GcrPromptReply
gcr_prompt_confirm_run (GcrPrompt *prompt,
                        GCancellable *cancellable,
                        GError **error);

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.

gcr_prompt_reset ()

void
gcr_prompt_reset (GcrPrompt *prompt);

Reset the contents and properties of the prompt.

gcr_prompt_close ()

void
gcr_prompt_close (GcrPrompt *prompt);

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 GcrPrompt object.

This emits the GcrPrompt::prompt-close signal on the prompt object.

gcr_prompt_get_title ()

gchar *
gcr_prompt_get_title (GcrPrompt *prompt);

Gets the title of the prompt.

A prompt implementation may choose not to display the prompt title. The prompt message should contain relevant information.

gcr_prompt_set_title ()

void
gcr_prompt_set_title (GcrPrompt *prompt,
                      const gchar *title);

Sets the title of the prompt.

A prompt implementation may choose not to display the prompt title. The prompt message should contain relevant information.

gcr_prompt_get_message ()

gchar *
gcr_prompt_get_message (GcrPrompt *prompt);

Gets the prompt message for the user.

A prompt implementation should always display this message.

gcr_prompt_set_message ()

void
gcr_prompt_set_message (GcrPrompt *prompt,
                        const gchar *message);

Sets the prompt message for the user.

A prompt implementation should always display this message.

gcr_prompt_get_description ()

gchar *
gcr_prompt_get_description (GcrPrompt *prompt);

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.

gcr_prompt_set_description ()

void
gcr_prompt_set_description (GcrPrompt *prompt,
                            const gchar *description);

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.

gcr_prompt_get_warning ()

gchar *
gcr_prompt_get_warning (GcrPrompt *prompt);

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.

gcr_prompt_set_warning ()

void
gcr_prompt_set_warning (GcrPrompt *prompt,
                        const gchar *warning);

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.

gcr_prompt_get_continue_label ()

gchar *
gcr_prompt_get_continue_label (GcrPrompt *prompt);

Get the label for the continue button.

This is the button that results in a GCR_PROMPT_REPLY_CONTINUE reply from the prompt.

gcr_prompt_set_continue_label ()

void
gcr_prompt_set_continue_label (GcrPrompt *prompt,
                               const gchar *continue_label);

Set the label for the continue button.

This is the button that results in a GCR_PROMPT_REPLY_CONTINUE reply from the prompt.

gcr_prompt_get_cancel_label ()

gchar *
gcr_prompt_get_cancel_label (GcrPrompt *prompt);

Get the label for the cancel button.

This is the button that results in a GCR_PROMPT_REPLY_CANCEL reply from the prompt.

gcr_prompt_set_cancel_label ()

void
gcr_prompt_set_cancel_label (GcrPrompt *prompt,
                             const gchar *cancel_label);

Set the label for the continue button.

This is the button that results in a GCR_PROMPT_REPLY_CANCEL reply from the prompt.

gcr_prompt_get_choice_label ()

gchar *
gcr_prompt_get_choice_label (GcrPrompt *prompt);

Get the label for the additional choice.

This will be NULL if no additional choice is being displayed.

gcr_prompt_set_choice_label ()

void
gcr_prompt_set_choice_label (GcrPrompt *prompt,
                             const gchar *choice_label);

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.

gcr_prompt_get_choice_chosen ()

gboolean
gcr_prompt_get_choice_chosen (GcrPrompt *prompt);

Get whether the additional choice was chosen or not.

The additional choice would have been setup using gcr_prompt_set_choice_label().

gcr_prompt_set_choice_chosen ()

void
gcr_prompt_set_choice_chosen (GcrPrompt *prompt,
                              gboolean chosen);

Set whether the additional choice is chosen or not.

The additional choice should be set up using gcr_prompt_set_choice_label().

gcr_prompt_get_password_new ()

gboolean
gcr_prompt_get_password_new (GcrPrompt *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.

gcr_prompt_set_password_new ()

void
gcr_prompt_set_password_new (GcrPrompt *prompt,
                             gboolean new_password);

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.

gcr_prompt_get_password_strength ()

gint
gcr_prompt_get_password_strength (GcrPrompt *prompt);

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.

gcr_prompt_get_caller_window ()

gchar *
gcr_prompt_get_caller_window (GcrPrompt *prompt);

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.

gcr_prompt_set_caller_window ()

void
gcr_prompt_set_caller_window (GcrPrompt *prompt,
                              const gchar *window_id);

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.

GcrPrompt

typedef struct _GcrPrompt GcrPrompt;

Represents a GcrPrompt displayed to the user.

struct GcrPromptIface

struct GcrPromptIface {
	GTypeInterface parent_iface;

	void               (* prompt_password_async)    (GcrPrompt *prompt,
	                                                 GCancellable *cancellable,
	                                                 GAsyncReadyCallback callback,
	                                                 gpointer user_data);

	const gchar *      (* prompt_password_finish)   (GcrPrompt *prompt,
	                                                 GAsyncResult *result,
	                                                 GError **error);

	void               (* prompt_confirm_async)     (GcrPrompt *prompt,
	                                                 GCancellable *cancellable,
	                                                 GAsyncReadyCallback callback,
	                                                 gpointer user_data);

	GcrPromptReply     (* prompt_confirm_finish)    (GcrPrompt *prompt,
	                                                 GAsyncResult *result,
	                                                 GError **error);

	void               (* prompt_close)             (GcrPrompt *prompt);
};

The interface for implementing GcrPrompt.

enum GcrPromptReply

Various replies returned by gcr_prompt_confirm() and friends.

The “caller-window” property

  “caller-window”            gchar *

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.

Flags: Read / Write / Construct

Default value: NULL

The “cancel-label” property

  “cancel-label”             gchar *

The label for the cancel button in the prompt.

Flags: Read / Write / Construct

Default value: "Cancel"

The “choice-chosen” property

  “choice-chosen”            gboolean

Whether the additional choice is chosen or not.

The additional choice would have been setup using “choice-label”.

Flags: Read / Write

Default value: FALSE

The “choice-label” property

  “choice-label”             gchar *

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 “choice-chosen”.

Flags: Read / Write / Construct

Default value: NULL

The “continue-label” property

  “continue-label”           gchar *

The label for the continue button in the prompt.

Flags: Read / Write / Construct

Default value: "Continue"

The “description” property

  “description”              gchar *

The detailed description of the prompt.

A prompt implementation may choose not to display this detailed description. The prompt message should contain relevant information.

Flags: Read / Write / Construct

Default value: NULL

The “message” property

  “message”                  gchar *

The prompt message for the user.

A prompt implementation should always display this message.

Flags: Read / Write / Construct

Default value: NULL

The “password-new” property

  “password-new”             gboolean

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.

Flags: Read / Write

Default value: FALSE

The “password-strength” property

  “password-strength”        gint

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.

Flags: Read

Allowed values: >= 0

Default value: 0

The “title” property

  “title”                    gchar *

The title of the prompt.

A prompt implementation may choose not to display the prompt title. The “message” should contain relevant information.

Flags: Read / Write / Construct

Default value: NULL

The “warning” property

  “warning”                  gchar *

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.

Flags: Read / Write / Construct

Default value: NULL

The “prompt-close” signal

void
user_function (GcrPrompt *gcrprompt,
               gpointer   user_data)

Action signal fired when the prompt is to be closed. After the default handler has run, the prompt is closed. The various prompting methods will return results as if the user dismissed the prompt.

You can use the gcr_prompt_close() method to emit this signal.

Flags: Run First