Top |
org.gnome.evolution.dataserver.UserPrompterorg.gnome.evolution.dataserver.UserPrompter — UserPrompter interface |
Methods
Prompt (IN s type, IN s title, IN s primary_text, IN s secondary_text, IN b use_markup, IN as button_captions, OUT i id); ExtensionPrompt (IN s dialog_name, IN as parameters, OUT i id);
Method Details
The Prompt() method
Prompt (IN s type, IN s title, IN s primary_text, IN s secondary_text, IN b use_markup, IN as button_captions, OUT i id);
Shows a prompt (#GtkMessageDialog) to a user of given type
with primary_text
and secondary_text
, either as plain text or with markup, according to use_markup
.
The button_captions
can be an empty array, in which case only
one button will be shown, with "Dismiss" caption.
|
Type of the prompt, can be one of GtkMessageType enum values |
|
Window title |
|
The primary text of the prompt |
|
The secondary text of the prompt |
|
whether the text uses markup - this applies to both texts |
|
Array of button captions, choices for a user |
|
Prompt identificator, used in 'Response' signal |
The ExtensionPrompt() method
ExtensionPrompt (IN s dialog_name, IN as parameters, OUT i id);
Shows a dialog provided by an extension to a user. Dialog names are
case sesitive. Extension can define some parameters, which are passed
to it within parameters
. Parameters content is not checked or otherwise
interpretted by the UserPrompter, all this is left to the extension itself.
|
Dialog name, as defined by an extension, to show |
|
|
|
Prompt identificator, used in 'ExtensionResponse' signal |
Signal Details
The "Response" signal
Response (i id, i response_button);
Emitted when user responded to a Prompt.
id
: An identificator of the prompt, as returned by Prompt method
response_button
: Which button index was used to close the prompt
Index in the response_button
corresponds to 'button_captions' index
from the 'Prompt' call. If none button caption was gived, then 0 is returned.
|
|
|
The "ExtensionResponse" signal
ExtensionResponse (i id, i response, as values);
Emitted when user responded to an ExtensionPrompt.
id
: An identificator of the prompt, as returned by ExtensionPrompt method
response
: Generic response, as defined by the extension
values
: Additional values returned by the extension
Extension can return additional values
, which are not interpretted or
otherwise checked by the UserPrompter, all this is left to the extension
and its caller.
|
|
|
|
|