robot.libraries.Dialogs Namespace Reference

Functions
def	_validate_user_input (dialog)
def	execute_manual_step (message, default_error='')
	Pauses execution until user sets the keyword status. More...
def	get_selection_from_user (message, *values)
	Pauses execution and asks user to select a value. More...
def	get_selections_from_user (message, *values)
	Pauses execution and asks user to select multiple values. More...
def	get_value_from_user (message, default_value='', hidden=False)
	Pauses execution and asks user to input a value. More...
def	pause_execution (message='Execution paused. Press OK to continue.')
	Pauses execution until user clicks Ok button. More...

Variables
list	__all__
	__version__ = get_version()

Function Documentation

_validate_user_input()

def robot.libraries.Dialogs._validate_user_input (   dialog )

private

Definition at line 116 of file Dialogs.py.

execute_manual_step()

def robot.libraries.Dialogs.execute_manual_step	(		message,
			default_error = ''
	)

Pauses execution until user sets the keyword status.

User can press either ``PASS`` or ``FAIL`` button. In the latter case execution
fails and an additional dialog is opened for defining the error message.

``message`` is the instruction shown in the initial dialog and
``default_error`` is the default value shown in the possible error message
dialog.

Definition at line 57 of file Dialogs.py.

get_selection_from_user()

def robot.libraries.Dialogs.get_selection_from_user	(		message,
		*	values
	)

Pauses execution and asks user to select a value.

The selected value is returned. Pressing ``Cancel`` fails the keyword.

``message`` is the instruction shown in the dialog and ``values`` are
the options given to the user.

Example:
| ${user} = | Get Selection From User | Select user | user1 | user2 | admin |

Definition at line 96 of file Dialogs.py.

get_selections_from_user()

def robot.libraries.Dialogs.get_selections_from_user	(		message,
		*	values
	)

Pauses execution and asks user to select multiple values.

The selected values are returned as a list. Selecting no values is OK
and in that case the returned list is empty. Pressing ``Cancel`` fails
the keyword.

``message`` is the instruction shown in the dialog and ``values`` are
the options given to the user.

Example:
| ${users} = | Get Selections From User | Select users | user1 | user2 | admin |

Definition at line 112 of file Dialogs.py.

get_value_from_user()

def robot.libraries.Dialogs.get_value_from_user	(		message,
			default_value = '',
			hidden = False
	)

Pauses execution and asks user to input a value.

Value typed by the user, or the possible default value, is returned.
Returning an empty value is fine, but pressing ``Cancel`` fails the keyword.

``message`` is the instruction shown in the dialog and ``default_value`` is
the possible default value shown in the input field.

If ``hidden`` is given a true value, the value typed by the user is hidden.
``hidden`` is considered true if it is a non-empty string not equal to
``false``, ``none`` or ``no``, case-insensitively. If it is not a string,
its truth value is got directly using same
[http://docs.python.org/library/stdtypes.html#truth|rules as in Python].

Example:
| ${username} = | Get Value From User | Input user name | default    |
| ${password} = | Get Value From User | Input password  | hidden=yes |

Definition at line 81 of file Dialogs.py.

pause_execution()

def robot.libraries.Dialogs.pause_execution

(

message = 'Execution paused. Press OK to continue.'

)

Pauses execution until user clicks Ok button.

``message`` is the message shown in the dialog.

Definition at line 44 of file Dialogs.py.

Variable Documentation

__all__

list robot.libraries.Dialogs.__all__

private

Initial value:

=  ['execute_manual_step', 'get_value_from_user',
           'get_selection_from_user', 'pause_execution', 'get_selections_from_user']

Definition at line 36 of file Dialogs.py.

__version__

robot.libraries.Dialogs.__version__ = get_version()

private

Definition at line 35 of file Dialogs.py.