| Evolution-Data-Server Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | ||||
#define E_USER_PROMPTER_SERVER_OBJECT_PATH struct EUserPrompterServer; struct EUserPrompterServerClass; EDBusServer * e_user_prompter_server_new (void); void e_user_prompter_server_response (EUserPrompterServer *server,gint prompt_id,gint response,const ENamedParameters *extension_values); gboolean e_user_prompter_server_register (EUserPrompterServer *server,EExtension *extension,const gchar *dialog_name);
The EUserPrompterServer is the heart of the user prompter D-Bus service. Acting as a global singleton for user prompts from backends.
#define E_USER_PROMPTER_SERVER_OBJECT_PATH
D-Bus object path of the user prompter.
Since 3.8
struct EUserPrompterServer {
EDBusServer parent;
EUserPrompterServerPrivate *priv;
};
Contains only private data that should be read and manipulated using the functions below.
Since 3.8
struct EUserPrompterServerClass {
EDBusServerClass parent_class;
/* signals */
void (*prompt) (EUserPrompterServer *server,
gint id,
const gchar *type,
const gchar *title,
const gchar *primary_text,
const gchar *secondary_text,
gboolean use_markup,
const GSList *button_captions);
};
EDBusServer * e_user_prompter_server_new (void);
Creates a new instance of EUserPrompterServer.
Returns : |
a new instance of EUserPrompterServer |
Since 3.8
void e_user_prompter_server_response (EUserPrompterServer *server,gint prompt_id,gint response,const ENamedParameters *extension_values);
Finishes prompt initiated by a "prompt" signal or an extension prompt.
The response for non-extension prompts is a 0-based index of a button
used to close the prompt.
The extension_values is ignored for non-extension prompts.
|
an EUserPrompterServer |
|
Id of a prompt, which was responded |
|
Response of the prompt |
|
For extension prompts can pass extra return values. [allow-none] |
Since 3.8
gboolean e_user_prompter_server_register (EUserPrompterServer *server,EExtension *extension,const gchar *dialog_name);
Registers extension as a provider of dialog_name dialog. The names
are compared case sensitively and two extensions cannot provide
the same dialog. If the function succeeds, then it adds its own
reference on the extension.
Extensions providing multiple dialogs call this function multiple times, for each dialog name separately.
|
an EUserPrompterServer |
|
an EUserPrompterServerExtension descendant |
|
name of a dialog, which the extensions implement |
Returns : |
Whether properly registered extension
|
Since 3.8