User interface widgets

Taurus provides a collection of Qt widgets for displaying, editing, selecting, and organizing Taurus models. This page is a quick reference to the most common user interface components and where to find their detailed documentation.

For examples and task-oriented instructions, see How-to guides. For the complete Python API, see Python API.

Application and containers

Widget	Purpose	API
`TaurusApplication`	Taurus-aware Qt application class used to initialize GUI applications.	`TaurusApplication`
`TaurusWidget`	General-purpose Taurus-aware widget and base container.	`TaurusWidget`
`TaurusFrame`	Frame container that can be associated with a Taurus model.	`TaurusFrame`
`TaurusGroupBox`	Group-box container with Taurus model support.	`TaurusGroupBox`
`TaurusMainWindow`	Taurus-aware main window with support for persistent configuration.	`TaurusMainWindow`

Display widgets

Widget	Purpose	API
`TaurusLabel`	Displays a model value, label, state, quality, or other model-related text.	`TaurusLabel`
`TaurusLed`	LED-style indicator for boolean or state-like values.	`TaurusLed`
`TaurusLCD`	LCD-style numeric display.	`TaurusLCD`
`QPixmapWidget`	Displays a pixmap while preserving its aspect ratio.	`QPixmapWidget`

Input widgets

Widget	Purpose	API
`TaurusValueLineEdit`	Line editor for writing scalar attribute values.	`TaurusValueLineEdit`
`TaurusValueSpinBox`	Spin box for editing numeric attribute values.	`TaurusValueSpinBox`
`TaurusValueCheckBox`	Check box for boolean attributes.	`TaurusValueCheckBox`
`TaurusValueComboBox`	Combo box for selecting among a predefined set of values.	`TaurusValueComboBox`
`TaurusWheelEdit`	Wheel-style editor for numeric values.	`TaurusWheelEdit`

Forms and model selection

Widget	Purpose	Documentation
`TaurusForm`	Dynamically builds a form for a list of Taurus models.	`API`; how-to
`TaurusValue`	Composite row used by forms to present label, read, write, and units widgets.	`TaurusValue`
`TaurusModelChooser`	Lets users browse and select Taurus models.	`API`; how-to
`TaurusModelList`	Displays and edits a list of Taurus model names.	`TaurusModelList`
`TaurusModelSelectorTree`	Tree-based model selector.	`TaurusModelSelectorTree`

Tables and trees

Widget	Purpose	Documentation
`TaurusGrid`	Organizes Taurus models in a configurable two-dimensional grid.	`API`; how-to
`TaurusValuesTable`	Displays Taurus values in a table-oriented view.	`TaurusValuesTable`
`TaurusDbTableWidget`	Table view for browsing a Taurus database authority.	`TaurusDbTableWidget`
`TaurusDbTreeWidget`	Tree view for browsing a Taurus database authority.	`TaurusDbTreeWidget`

Plotting and images

Plotting widgets are provided through optional Taurus plotting integrations. Their availability depends on the installed plotting plugins.

Widget	Purpose	Documentation
`TaurusPlot`	Displays one-dimensional Taurus data as curves.	How-to; concepts
`TaurusTrend`	Displays the evolution of scalar Taurus values over time.	How-to; concepts
`TaurusImageDialog`	Displays two-dimensional image attributes.	How-to; concepts
`TaurusTrend2DDialog`	Displays the evolution of one-dimensional data as a two-dimensional trend.	How-to; concepts

Synoptics and complete GUIs

Widget	Purpose	Documentation
`TaurusJDrawSynopticsView`	Displays legacy JDraw synoptic files connected to Taurus models.	`TaurusJDrawSynopticsView`
SVG synoptics	Interactive SVG-based synoptics using the external `svgsynoptic` integration.	How-to; concepts
`TaurusGui`	Framework for assembling configurable Taurus applications from panels and tools.	`API`; concepts