EBackend.UserPrompterServer¶

Subclasses:	None

Methods¶

Inherited:	EBackend.DBusServer (5), GObject.Object (37), EDataServer.Extensible (2)
Structs:	GObject.ObjectClass (5)

class	`new` ()
	`register` (extension, dialog_name)
	`response` (prompt_id, response, extension_values)

Virtual Methods¶

Inherited:	EBackend.DBusServer (5), GObject.Object (7)

Properties¶

None

Signals¶

Inherited:	EBackend.DBusServer (5), GObject.Object (1)

Name	Short Description
`prompt`

Fields¶

Inherited:	EBackend.DBusServer (5), GObject.Object (1)

Name	Type	Access	Description
parent	`EBackend.DBusServer`	r

Class Details¶

class EBackend.UserPrompterServer(**kwargs)¶

Bases:	`EBackend.DBusServer`
Abstract:	No
Structure:	`EBackend.UserPrompterServerClass`

Contains only private data that should be read and manipulated using the functions below.

New in version 3.8.

classmethod new()¶

Returns:	a new instance of `EBackend.UserPrompterServer`
Return type:	`EBackend.DBusServer`

Creates a new instance of EBackend.UserPrompterServer.

New in version 3.8.

register(extension, dialog_name)¶

Parameters:	extension (`EDataServer.Extension`) – an `EBackend.UserPrompterServerExtension` descendant dialog_name (`str`) – name of a dialog, which the extensions implement
Returns:	Whether properly registered extension
Return type:	`bool`

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.

New in version 3.8.

response(prompt_id, response, extension_values)¶

Parameters:	prompt_id (`int`) – Id of a prompt, which was responded response (`int`) – Response of the prompt extension_values (`EDataServer.NamedParameters` or `None`) – For extension prompts can pass extra return 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.

New in version 3.8.

Signal Details¶

EBackend.UserPrompterServer.signals.prompt(user_prompter_server, prompt_id, type, title, primary_text, secondary_text, use_markup, button_captions)¶

Signal Name:	`prompt`
Flags:	`RUN_LAST`
Parameters:	user_prompter_server (`EBackend.UserPrompterServer`) – The object which received the signal prompt_id (`int`) – the id of the prompt type (`str` or `None`) – type of the prompt; can be `None` title (`str` or `None`) – window title of the prompt; can be `None` primary_text (`str` or `None`) – primary text of the prompt; can be `None` secondary_text (`str` or `None`) – secondary text of the prompt; can be `None` use_markup (`bool`) – whether both texts are with markup button_captions ([`str`] or `None`) – captions of buttons to use in the message; can be `None`