traitsui.testing.tester.query module

This module defines interaction objects that can be passed to UIWrapper.inspect where the actions represent ‘queries’.

Implementations for these actions are expected to return value(s), ideally without incurring side-effects.

class traitsui.testing.tester.query.DisplayedText

Bases: object

An object representing an interaction to obtain the displayed (echoed) plain text.

E.g. For a textbox using a password styling, the displayed text should be a string of platform-dependent password mask characters.

Implementations should return a str.

class traitsui.testing.tester.query.IsChecked

Bases: object

An object representing an interaction to obtain whether a checkable widget (e.g. checkbox) is checked or not.

Implementations should return True if checked and False if not.

class traitsui.testing.tester.query.IsEnabled

Bases: object

An object representing an interaction to obtain whether a widget is enabled or not.

Implementations should return True if enabled and False if not.

class traitsui.testing.tester.query.IsVisible

Bases: object

An object representing an interaction to obtain whether a widget is visible or not.

Implementations should return True if visible and False if not.

class traitsui.testing.tester.query.Selected

Bases: object

Represents an interaction to obtain the currently selected object(s).

Implementations should return a list of selected objects, or an empty list if nothing is selected.

class traitsui.testing.tester.query.SelectedIndices

Bases: object

Represents an interaction to obtain the indices of the currently selected objects.

Implementations should return a list of indicies of the selected objects or an empty list if nothing is selected.

Note that an index could be an integer (e.g. when selecting from a list or enumerataion, or selecting entire rows or columns of a table), or it could be a tuple (e.g. corresponding to a specific cell at some (row, column) in a table).

class traitsui.testing.tester.query.SelectedText

Bases: object

An object representing an interaction to obtain the displayed (echoed) plain text which is currently selected.

E.g. For a Enum List, with one entry currently selected, the displayed selected text would be the label of that entry.

Implementations should return a str, or None if nothing is selected.