RTC Toolkit 6.0.0
Loading...
Searching...
No Matches
rtccomponentwidget.RtcComponentWidget Class Reference

Set of widgets for the RtcComponent entry on the TaurusForm widget. More...

Inheritance diagram for rtccomponentwidget.RtcComponentWidget:

Public Member Functions

 __init__ (self, parent=None, designMode=False)
 Initialises the class, which acts as a provider of the widgets for Label, Read, Write, Units and Extra columns of the TaurusForm.
 
 setModel (self, name, **kwargs)
 setModel is the main method to interacts with TaurusWidgets.
 
 setParent (self, parent)
 Sets the parent to the TaurusValue class and inserts itselfs into the layout.
 
 addLabelWidgetToLayout (self)
 Adds Label widget when parent had a QGridLayout.
 
 addReadWidgetToLayout (self)
 Adds Read widget when parent had a QGridLayout or a QStackedWidget.
 
 addWriteWidgetToLayout (self)
 Adds Write widget when parent had a QGridLayout.
 
 addUnitsWidgetToLayout (self)
 Adds Units widget when parent had a QGridLayout.
 
 addExtraWidgetToLayout (self)
 Adds Extra widget when parent had a QGridLayout.
 

Public Attributes

 parent_layout_type = QGridLayout
 

Protected Attributes

# in design mode, no subwidgets are created _designMode
 
 _readWidget
 

Detailed Description

Set of widgets for the RtcComponent entry on the TaurusForm widget.

This class is not a widget by itself. It provides the specific widgets for each column of the grid layout in the TaurusForm:

+-------+------+-------+-------+-------+
| Label | Read | Write | Units | Extra |
+-------+------+-------+-------+-------+

Constructor & Destructor Documentation

◆ __init__()

rtccomponentwidget.RtcComponentWidget.__init__ ( self,
parent = None,
designMode = False )

Initialises the class, which acts as a provider of the widgets for Label, Read, Write, Units and Extra columns of the TaurusForm.

Parameters
[in]parentQWidget that will be the parent of this widget
[in]designModeUsed by the Qt Designer to avoid undesirable interactions.

Member Function Documentation

◆ addExtraWidgetToLayout()

rtccomponentwidget.RtcComponentWidget.addExtraWidgetToLayout ( self)

Adds Extra widget when parent had a QGridLayout.

◆ addLabelWidgetToLayout()

rtccomponentwidget.RtcComponentWidget.addLabelWidgetToLayout ( self)

Adds Label widget when parent had a QGridLayout.

◆ addReadWidgetToLayout()

rtccomponentwidget.RtcComponentWidget.addReadWidgetToLayout ( self)

Adds Read widget when parent had a QGridLayout or a QStackedWidget.

◆ addUnitsWidgetToLayout()

rtccomponentwidget.RtcComponentWidget.addUnitsWidgetToLayout ( self)

Adds Units widget when parent had a QGridLayout.

◆ addWriteWidgetToLayout()

rtccomponentwidget.RtcComponentWidget.addWriteWidgetToLayout ( self)

Adds Write widget when parent had a QGridLayout.

◆ setModel()

rtccomponentwidget.RtcComponentWidget.setModel ( self,
name,
** kwargs )

setModel is the main method to interacts with TaurusWidgets.

It carries the URI of the Component which we want to connect to. We call the default implementation.

Parameters
[in]nameURI of the component.
[in]kwargsextra options for compatibility.

◆ setParent()

rtccomponentwidget.RtcComponentWidget.setParent ( self,
parent )

Sets the parent to the TaurusValue class and inserts itselfs into the layout.

Note
This method has been modified to support other layouts aside from QGridLayout. QGridLayout is used in TaurusForm, while QStackedLayout is used in Rtctk.
Parameters
[in]parentQWidget reference for the parent widget

Member Data Documentation

◆ _designMode

# in design mode, no subwidgets are created rtccomponentwidget.RtcComponentWidget._designMode
protected

◆ _readWidget

rtccomponentwidget.RtcComponentWidget._readWidget
protected

◆ parent_layout_type

rtccomponentwidget.RtcComponentWidget.parent_layout_type = QGridLayout

The documentation for this class was generated from the following file: