TaurusCommandButton
¶
digraph inheritancee9e172a90d {
bgcolor=transparent;
rankdir=UD;
ratio=compress;
size="8.0, 12.0";
"BaseConfigurableClass" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="A base class defining the API for configurable objects."];
"Logger" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="The taurus logger class. All taurus pertinent classes should inherit"];
"Object" -> "Logger" [arrowsize=0.5,style="setlinewidth(0.5)"];
"Object" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded];
"QAbstractButton" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="QAbstractButton(parent: QWidget = None)"];
"QWidget" -> "QAbstractButton" [arrowsize=0.5,style="setlinewidth(0.5)"];
"QObject" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="QObject(parent: QObject = None)"];
"wrapper" -> "QObject" [arrowsize=0.5,style="setlinewidth(0.5)"];
"QPaintDevice" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="QPaintDevice()"];
"simplewrapper" -> "QPaintDevice" [arrowsize=0.5,style="setlinewidth(0.5)"];
"QPushButton" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="QPushButton(parent: QWidget = None)"];
"QAbstractButton" -> "QPushButton" [arrowsize=0.5,style="setlinewidth(0.5)"];
"QWidget" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="QWidget(parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags())"];
"QObject" -> "QWidget" [arrowsize=0.5,style="setlinewidth(0.5)"];
"QPaintDevice" -> "QWidget" [arrowsize=0.5,style="setlinewidth(0.5)"];
"TaurusBaseComponent" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="A generic Taurus component."];
"TaurusListener" -> "TaurusBaseComponent" [arrowsize=0.5,style="setlinewidth(0.5)"];
"BaseConfigurableClass" -> "TaurusBaseComponent" [arrowsize=0.5,style="setlinewidth(0.5)"];
"TaurusBaseWidget" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="The base class for all Qt Taurus widgets."];
"TaurusBaseComponent" -> "TaurusBaseWidget" [arrowsize=0.5,style="setlinewidth(0.5)"];
"TaurusCommandButton" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="This class provides a button that executes a tango command on its device."];
"QPushButton" -> "TaurusCommandButton" [arrowsize=0.5,style="setlinewidth(0.5)"];
"TaurusBaseWidget" -> "TaurusCommandButton" [arrowsize=0.5,style="setlinewidth(0.5)"];
"TaurusListener" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="TaurusListener Interface"];
"Logger" -> "TaurusListener" [arrowsize=0.5,style="setlinewidth(0.5)"];
"simplewrapper" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded];
"wrapper" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded];
"simplewrapper" -> "wrapper" [arrowsize=0.5,style="setlinewidth(0.5)"];
}
Bases:
PyQt5.QtWidgets.QPushButton
,taurus.qt.qtgui.base.taurusbase.TaurusBaseWidget
This class provides a button that executes a tango command on its device.
Code examples:
# a button that executes the "status" command for the 'a/b/c' device server button = TaurusCommandButton(command = 'Status', icon='logos:taurus.png') button.setModel('a/b/c') # a button that executes the "exec" command for the 'a/b/c' device server with one parameter button = TaurusCommandButton(command = 'Status', parameters=['2+2'],icon='logos:taurus.png') button.setModel('a/b/c')
See also
TaurusCommandsForm
provides a good example of use of TaurusCommandButton (including managing the return value)returns the command name to be executed when the button is clicked
- Return type
str
orNone
- Returns
the command name
Returns the custom text of the buttom, or None if no custom text is used
Returns the current apply danger message or None if the apply operation is safe
- Return type
str
orNone
- Returns
the apply danger message
Returns the model name for this component.
- Return type
str
- Returns
the model name.
returns the parameters to be used on command execution
- Parameters
parameters (
sequence
) –
Returns the number of seconds to wait for the result of the command (or -1 if timeout is disabled)
Returns whether this component is using the parent model
- Return type
bool
- Returns
True if using parent model or False otherwise
returns the command name to be executed when the button is clicked
- Return type
str
orNone
- Returns
the command name
Returns the custom text of the buttom, or None if no custom text is used
see
TaurusBaseComponent.displayValue()
returns the parameters to be used on command execution
- Parameters
parameters (
sequence
) –
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
Returns the number of seconds to wait for the result of the command (or -1 if timeout is disabled)
equivalent to self.setCommand(None)
Equivalent to setCustomText(None)
Equivalent to setParameters([])
Equivalent to setTimeout(None)
sets the command to be executed when the button is clicked
- Parameters
commandName (
str
orNone
) – the command name
Sets a custom text for the button (by default it is the command name)
- Parameters
customText (
str
orNone
) – the custom text. If None passed, it will use the command name
Sets the parameters to be used on command execution.
- Parameters
parameters (
sequence
) – a sequence of parameters. If the elements of the sequence are not of the right type required for the parameter, an automatic conversion will be attempted on execution time. As a special case, if parameters is a string not starting and ending in quote characters, it will be splitted on whitespace to obtain a sequence of parameters. If it is a string starting and ending with quotes, the quotes will be removed and the quoted text will not be splitted.
Sets the number of seconds to wait for the result of the command.
See also
PyTango.DeviceProxy.command_inout()
- Parameters
timeout (
float
) – the command timeout in seconds (timeout <0 or timeout=None disables the timeout)