TaurusCommandButton

Inheritance diagram of TaurusCommandButton
class TaurusCommandButton(parent=None, designMode=False, command=None, parameters=None, icon=None, text=None, timeout=None)[source]

Bases: PyQt4.QtGui.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)

Command

returns the command name to be executed when the button is clicked

Return type:str or None
Returns:the command name
CustomText

Returns the custom text of the buttom, or None if no custom text is used

DangerMessage

Returns the current apply danger message or None if the apply operation is safe

Return type:str or None
Returns:the apply danger message
Model

Returns the model name for this component.

Return type:str
Returns:the model name.
Parameters

returns the parameters to be used on command execution

Parameters:parameters (sequence) –
Timeout

Returns the number of seconds to wait for the result of the command (or -1 if timeout is disabled)

UseParentModel

Returns whether this component is using the parent model

Return type:bool
Returns:True if using parent model or False otherwise
commandExecuted
getCommand()[source]

returns the command name to be executed when the button is clicked

Return type:str or None
Returns:the command name
getCustomText()[source]

Returns the custom text of the buttom, or None if no custom text is used

getDisplayValue()[source]

see TaurusBaseComponent.displayValue()

getParameters()[source]

returns the parameters to be used on command execution

Parameters:parameters (sequence) –
classmethod getQtDesignerPluginInfo()[source]
getTimeout()[source]

Returns the number of seconds to wait for the result of the command (or -1 if timeout is disabled)

onClicked(*args, **kwargs)[source]
resetCommand()[source]

equivalent to self.setCommand(None)

resetCustomText()[source]

Equivalent to setCustomText(None)

resetParameters()[source]

Equivalent to setParameters([])

resetTimeout()[source]

Equivalent to setTimeout(None)

setCommand(commandName)[source]

sets the command to be executed when the button is clicked

Parameters:commandName (str or None) – the command name
setCustomText(customText=None)[source]

Sets a custom text for the button (by default it is the command name)

Parameters:customText (str or None) – the custom text. If None passed, it will use the command name
setParameters(parameters)[source]

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.
setTimeout(timeout)[source]

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)