Allows users to implement their own basic Screens, consisting of ConfirmDialog, InputDialog, ChoiceDialog and ShowDocumentDialog.
More...
#include <IBasicScreenImplementation.h>
|
| virtual int | ChoiceDialog (const std::string &title, const std::string &message, const std::list< std::string > &options, const int &_default)=0 |
| | Invoked when a ChoiceDialog occurs in OTX-Runtime. More...
|
| |
| virtual ConfirmationTypes | ConfirmDialog (const std::string &title, const std::string &message, const MessageTypes &messageType)=0 |
| | Invoked when a ConfirmDialog occurs in OTX-Runtime. More...
|
| |
| virtual std::string | InputDialog (const std::string &title, const std::string &message, const std::string &initValue, const std::string &instruction, const std::string &restriction)=0 |
| | Invoked when an InputDialog occurs in OTX-Runtime. More...
|
| |
| virtual void | ShowDocumentDialog (const std::string &title, const std::string &message, const std::string &document)=0 |
| | Invoked when a ShowDocumentDialog occurs in OTX-Runtime. More...
|
| |
Allows users to implement their own basic Screens, consisting of ConfirmDialog, InputDialog, ChoiceDialog and ShowDocumentDialog.
◆ ChoiceDialog()
| virtual int OpenTestSystem::Otx::Runtime::Api::Custom::IBasicScreenImplementation::ChoiceDialog |
( |
const std::string & |
title, |
|
|
const std::string & |
message, |
|
|
const std::list< std::string > & |
options, |
|
|
const int & |
_default |
|
) |
| |
|
pure virtual |
Invoked when a ChoiceDialog occurs in OTX-Runtime.
- Parameters
-
| title | Title of the dialog. |
| message | Message of the dialog. |
| options | Options specifies a list of strings which contains the possible options that shall be displayed. |
| _default | Default represents the index of the option which shall be preselected in the dialog. |
- Returns
- Selection from the user will be sent to OTX-Runtime.
◆ ConfirmDialog()
| virtual ConfirmationTypes OpenTestSystem::Otx::Runtime::Api::Custom::IBasicScreenImplementation::ConfirmDialog |
( |
const std::string & |
title, |
|
|
const std::string & |
message, |
|
|
const MessageTypes & |
messageType |
|
) |
| |
|
pure virtual |
Invoked when a ConfirmDialog occurs in OTX-Runtime.
- Parameters
-
| title | Title of the dialog. |
| message | Message of the dialog. |
| messageType | Type of message and the buttons that shall be shown to the user to confirm the action. |
- Returns
- Selection from the user will be sent to OTX-Runtime.
◆ InputDialog()
| virtual std::string OpenTestSystem::Otx::Runtime::Api::Custom::IBasicScreenImplementation::InputDialog |
( |
const std::string & |
title, |
|
|
const std::string & |
message, |
|
|
const std::string & |
initValue, |
|
|
const std::string & |
instruction, |
|
|
const std::string & |
restriction |
|
) |
| |
|
pure virtual |
Invoked when an InputDialog occurs in OTX-Runtime.
- Parameters
-
| title | Title of the dialog. |
| message | Message of the dialog. |
| initialValue | Initial value represents the string value that shall be used to initialize the dialog's input field. |
| instruction | Instruction is an additional message to provide information regarding the expected value that should be introduced. |
| restriction | Restriction shall be formulated by a regular expression which validates the input data. |
- Returns
- Returned value will be sent to OTX-Runtime.
◆ ShowDocumentDialog()
| virtual void OpenTestSystem::Otx::Runtime::Api::Custom::IBasicScreenImplementation::ShowDocumentDialog |
( |
const std::string & |
title, |
|
|
const std::string & |
message, |
|
|
const std::string & |
document |
|
) |
| |
|
pure virtual |
Invoked when a ShowDocumentDialog occurs in OTX-Runtime.
- Parameters
-
| title | Title of the dialog. |
| message | Message of the dialog. |
| document | This identifies the external document that should be shown. |
The documentation for this class was generated from the following file:
