Method

EBackendUserPrompterprompt

since: 3.8

Declaration [src]

void
e_user_prompter_prompt (
  EUserPrompter* prompter,
  const gchar* type,
  const gchar* title,
  const gchar* primary_text,
  const gchar* secondary_text,
  gboolean use_markup,
  GList* button_captions,
  GCancellable* cancellable,
  GAsyncReadyCallback callback,
  gpointer user_data
)

Description [src]

Asynchronously prompt a user for a decision.

The type can be one of “info”, “warning”, “question” or “error”, to include an icon in the message prompt; anything else results in no icon in the message.

If button_captions is NULL or empty list, then only one button is shown in the prompt, a “Dismiss” button.

When the operation is finished, callback will be called. You can then call e_user_prompter_prompt_finish() to get the result of the operation.

Available since: 3.8

This method completes asynchronously. Use e_user_prompter_prompt_finish() inside the GAsyncReadyCallback to obtain the result of the operation.

Parameters

type

Type: const gchar*

Type of the prompt; can be NULL.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
title

Type: const gchar*

Window title of the prompt; can be NULL.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
primary_text

Type: const gchar*

Primary text of the prompt; can be NULL.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
secondary_text

Type: const gchar*

Secondary text of the prompt; can be NULL.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
use_markup

Type: gboolean

Whether both texts are with markup.

button_captions

Type: A list of utf8

Captions of buttons to use in the message; can be NULL.

The argument can be NULL.
The data is owned by the caller of the method.
Each element is a NUL terminated UTF-8 string.
cancellable

Type: GCancellable

Optional GCancellable object, or NULL.

The argument can be NULL.
The data is owned by the caller of the method.
callback

Type: GAsyncReadyCallback

A GAsyncReadyCallback to call when the request is satisfied.

The argument can be NULL.
user_data

Type: gpointer

Data to pass to the callback function.

The argument can be NULL.
The data is owned by the caller of the method.