TaurusForm

Inheritance diagram of TaurusForm
class TaurusForm(parent=None, formWidget=None, buttons=None, withButtons=True, designMode=False)[source]

Bases: taurus.qt.qtgui.container.tauruswidget.TaurusWidget

A form containing specific widgets for interacting with a given list of taurus attributes and/or devices.

Its model is a list of attribute and/or device names to be shown. Each item is represented in a row consisting of a label, a read widget, a write widget, a units widget and an “extra” widget (some of them may not be shown) which are vertically aligned with their counterparts from other items.

By default a TaurusValue object is used for each item, but this can be changed and customizations can be provided by enabling/disabling item factories with setItemFactories().

Item objects can be accessed by index using a list-like notation:

form = TaurusForm()
form.model = ['sys/tg_test/1'+a for a in ('short_image','/float_scalar','/double_scalar')]
form[0].labelConfig = 'dev_alias'
form[-1].writeWidgetClass = 'TaurusWheelEdit'
print(len(form))  # --> outputs '3' (the length of the form is the number of items)

By default, the form provides global Apply and Cancel buttons.

You can also see some code that exemplifies the use of TaurusForm in Taurus coding examples

addModels(modelNames)[source]

Adds models to the existing ones:

Parameters

modelNames (sequence <str>) – the names of the models to be added

See also

removeModels()

apply()[source]
chooseAttrs()[source]
chooseModels()[source]

launches a model chooser dialog to modify the contents of the form

compact
destroyChildren()[source]
dropEvent(event)[source]

reimplemented to support dropping of modelnames in forms

fillWithChildren()[source]
getCustomWidgetMap(**kwargs)

Returns the map used to create custom widgets.

rtype

dict <str, tuple>

return

a dictionary whose keys are device type strings (i.e. see PyTango.DeviceInfo) and whose values are tuples of classname,args,kwargs

Deprecated since version 4.6.5: Use item factories instead

getFormWidget(**kwargs)

Returns a tuple that can be used for creating a widget for a given model.

type model

str

param model

a taurus model name for which the new item of the form will be created

rtype

tuple <type, list, dict>

return

a tuple containing a class, a list of args and a dict of keyword args. The args and the keyword args can be passed to the class constructor

Deprecated since version 4.6.5: Use item factories instead

getItemByIndex(index)[source]

returns the child item with at the given index position.

getItemByModel(model, index=0)[source]

returns the child item with given model. If there is more than one item with the same model, the index parameter can be used to distinguish among them Please note that his index is only relative to same-model items!

getItemFactories(return_disabled=False)[source]

returns the list of item factories entry points currently in use

Parameters

return_disabled – If False (default), it returns only a list of the enabled factories. If True, it returns a tuple containing two lists: the enabled and the available but disabled factories.

getItems()[source]

returns a list of the objects that have been created as childs of the form

getModel()[source]

Returns the model name for this component.

Return type

str

Returns

the model name.

classmethod getQtDesignerPluginInfo()[source]

Returns pertinent information in order to be able to build a valid QtDesigner widget plugin.

The dictionary returned by this method should contain at least the following keys and values:

  • ‘module’ : a string representing the full python module name (ex.: ‘taurus.qt.qtgui.base’)

  • ‘icon’ : a string representing valid resource icon (ex.: ‘designer:combobox.png’)

  • ‘container’ : a bool telling if this widget is a container widget or not.

This default implementation returns the following dictionary:

{ 'group'     : 'Taurus [Unclassified]',
  'icon'      : 'logos:taurus.png',
  'container' : False }
Return type

dict

Returns

a map with pertinent designer information

getRegExp()[source]
isCompact()[source]
isWithButtons()[source]
model
modifiableByUser

whether the user can change the contents of the widget

Return type

bool

Returns

True if the user is allowed to modify the look&feel

onChangeLabelsAction()[source]

changes the labelConfig of all its items

onSetFormatter()[source]

Reimplemented from TaurusBaseWidget

parentModelChanged(parentmodel_name)[source]

Invoked when the Taurus parent model changes

Parameters

parentmodel_name (str) – the new name of the parent model

removeModels(modelNames)[source]

Removes models from those already in the form.

Parameters

modelNames (sequence <str>) – the names of the models to be removed

See also

addModels()

reset()[source]
resetCompact()[source]
resetFormWidget(**kwargs)

Deprecated since version 4.6.5: Use item factories instead

resetModel()[source]

Sets the model name to the empty string

resetWithButtons()[source]
setCompact(compact)[source]
setCustomWidgetMap(**kwargs)

Sets a map map for custom widgets.

type cwmap

dict <str, tuple>

param cwmap

a dictionary whose keys are device type strings (i.e. see PyTango.DeviceInfo) and whose values are tuples of classname,args,kwargs

Deprecated since version 4.6.5: Use item factories instead

setFormWidget(**kwargs)

Deprecated since version 4.6.5: Use item factories instead

setFormat(format)[source]

Reimplemented to call setFormat on the taurusvalues

setItemFactories(include=None, exclude=None)[source]

Selects and prioritizes the factories to be used to create the form’s items.

TaurusForm item factories are functions that receive a TaurusModel as their only argument and return either a TaurusValue-like instance or None in case the factory does not handle the given model.

The factories are selected using their entry point names as registered in the “taurus.form.item_factories” entry point group.

The factories entry point name is up to the registrar of the entry point (typically a taurus plugin) and should be documented by the registrar to allow for selection and prioritization.

The selection and prioritization is done using taurus.core.util.plugin.selectEntryPoints(). See it for more details.

The selected list is updated in the form, and returned.

The default values for the include and exclude arguments are defined in tauruscustomsettings.T_FORM_ITEM_FACTORIES

Parameters
  • include (tuple) – . The members in the tuple can be: Regexp patterns (in string or compiled form) matching the names to be included in the selection. They can also be item factory functions (which then are wrapped in an EntryPoint-like object and included in the selection).

  • exclude (tuple) – . Regexp patterns ( either str or re.Pattern objects) matching registered names to be excluded.

Return type

list

Returns

selected item factories entry points

setModelCheck(model, check=True)[source]

Sets the component taurus model. Setting the check argument to True (default) will check if the current model is equal to the given argument. If so then nothing is done. This should be the standard way to call this method since it will avoid recursion.

Parameters
  • model (str) – the new model name

  • check (bool) – whether or not to check against the actual model name

setModifiableByUser(modifiable)[source]

sets whether the user can change the contents of the form (e.g., via Modify Contents in the context menu) Reimplemented from TaurusWidget.setModifiableByUser()

Parameters

modifiable (bool) –

See also

TaurusWidget.setModifiableByUser()

setRegExp(regExp)[source]
setWithButtons(trueFalse)[source]
sizeHint(self) → QSize[source]
useParentModel

Returns whether this component is using the parent model

Return type

bool

Returns

True if using parent model or False otherwise

withButtons