`TaurusGui`

class TaurusGui(parent=None, confname=None, configRecursionDepth=None, settingsname=None)[source]

This is main class for constructing the dynamic GUIs. TaurusGui is a specialised TaurusMainWindow which is able to handle “panels” and load configuration files. There are several ways of using TaurusGui. In the following we will give 3 examples on how to create a simple GUI called “MyGui” which contains one panel called “Foo” and consisting of a QWidget:

Example 1: use declarative configuration files.

You can create a purely declarative configuration file to be interpreted by the standard taurusgui script:

from taurus.qt.qtgui.taurusgui.utils import PanelDescription

GUI_NAME = 'MyGui'
panel = PanelDescription('Foo',
                         classname='taurus.external.qt.Qt.QWidget')

Note that this just a very simple example. For a much richer one, see the taurus.qt.qtgui.taurusgui.conf.tgconf_example01

Example 2: do everything programmatically.

A stand-alone python script that launches the gui when executed. No configuration file is used here. Panels and other components are added programatically:

if __name__ == '__main__':
    from taurus.qt.qtgui.application import TaurusApplication
    from taurus.qt.qtgui.taurusgui import TaurusGui
    from taurus.external.qt import Qt
    app = TaurusApplication(cmd_line_parser=None, app_name='MyGui')
    gui = TaurusGui()
    panel = Qt.QWidget()
    gui.createPanel(panel, 'Foo')
    gui.show()
    app.exec_()

Example 3: mixing declarative and programmatic ways

It is also possible to create a stand-alone python script which loads itself as a configuration file. In this way you can add things programmatically and at the same time use the declarative way:

GUI_NAME = 'MyGui' # <-- declarative!
if __name__ == '__main__':
    from taurus.qt.qtgui.application import TaurusApplication
    from taurus.qt.qtgui.taurusgui import TaurusGui
    from taurus.external.qt import Qt
    app = TaurusApplication(cmd_line_parser=None)
    gui = TaurusGui(confname=__file__)
    panel = Qt.QWidget()
    gui.createPanel(panel, 'Foo')  # <-- programmatic!
    gui.show()
    app.exec_()

Import from taurus.qt.qtgui.taurusgui as:

from taurus.qt.qtgui.taurusgui import TaurusGui

APPLETS_TOOLBAR_ENABLED = True: Whether to show the applets toolbar

IMPLICIT_ASSOCIATION = '__[IMPLICIT]__'

PANELS_MENU_ENABLED = True: Whether to show user actions related to shared data connections

QUICK_ACCESS_TOOLBAR_ENABLED = True: Whether to add the Quick access Toolbar (empty by default)

SelectedInstrument

closeEvent(event)[source]: This event handler receives widget close events

createConfig(*args, **kwargs)[source]: reimplemented from TaurusMainWindow.createConfig

createConsole(kernels)[source]

createCustomPanel(paneldesc=None)[source]

Creates a panel from a Panel Description and sets it as “custom panel”.

Parameters:: paneldesc (PanelDescription) – description of the panel to be created

TaurusGui

`TaurusGui`