EBackend.UserPrompterServerExtension¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
|
|
|
Virtual Methods¶
- Inherited:
|
Properties¶
- Inherited:
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
|---|---|---|---|
parent |
r |
Class Details¶
- class EBackend.UserPrompterServerExtension(**kwargs)¶
- Bases:
- Abstract:
Yes
- Structure:
Contains only private data that should be read and manipulated using the functions below.
New in version 3.8.
- prompt(prompt_id, dialog_name, parameters)¶
- Parameters:
prompt_id (
int) – Prompt identificator, which is used in call toEBackend.UserPrompterServerExtension.response()dialog_name (
str) – Name of a dialog to runparameters (
EDataServer.NamedParametersorNone) – Optional extension parameters for the dialog, as passed by a caller
- Returns:
Whether dialog was found and shown.
- Return type:
Instructs extension to show dialog dialog_name. If it cannot be found, or any error, then return
False. The caller can pass optional parameters, if self uses any. Meaning of parameters is known only to the caller and to the dialog implementor, it’s not interpretted nor checked for correctness in any way inEBackend.UserPrompterServer. The only limitation of parameters is that the array elements are strings.The prompt_id is used as an identificator of the prompt itself, and is used in
EBackend.UserPrompterServerExtension.response() call, which finishes the prompt.Note: The function call should not block main loop, it should just show dialog and return.
New in version 3.8.
- response(prompt_id, response, values)¶
- Parameters:
prompt_id (
int) – Prompt identificatorresponse (
int) – Response of the promptvalues (
EDataServer.NamedParametersorNone) – Additional response values, if extension defines any
A conveniente wrapper function around
EBackend.UserPrompterServer.response(), which ends previous call ofEBackend.UserPrompterServerExtension.prompt(). The response and values is known only to the caller and to the dialog implementor, it’s not interpretted nor checked for correctness in any way inEBackend.UserPrompterServer. The only limitation of values is that the array elements are strings.New in version 3.8.
- do_prompt(prompt_id, dialog_name, parameters) virtual¶
- Parameters:
prompt_id (
int) – Prompt identificator, which is used in call toEBackend.UserPrompterServerExtension.response()dialog_name (
str) – Name of a dialog to runparameters (
EDataServer.NamedParametersorNone) – Optional extension parameters for the dialog, as passed by a caller
- Returns:
Whether dialog was found and shown.
- Return type:
Instructs extension to show dialog dialog_name. If it cannot be found, or any error, then return
False. The caller can pass optional parameters, if extension uses any. Meaning of parameters is known only to the caller and to the dialog implementor, it’s not interpretted nor checked for correctness in any way inEBackend.UserPrompterServer. The only limitation of parameters is that the array elements are strings.The prompt_id is used as an identificator of the prompt itself, and is used in
EBackend.UserPrompterServerExtension.response() call, which finishes the prompt.Note: The function call should not block main loop, it should just show dialog and return.
New in version 3.8.