Bases: taurus.qt.qtgui.base.taurusbase.TaurusBaseComponent
The base class for all Qt Taurus widgets.
Note
Any class which inherits from TaurusBaseWidget is expected to also inherit from QWidget (or from a QWidget derived class)
overwrites QWidget.changeEvent(self, evt) to handle the ParentChangeEvent in case this widget is using the parent model. Always calls the QWidget.changeEvent in order not to lose events
Override of the QWidget.closeEvent()
reimplemented to support drag&drop of models. See QWidget
reimplemented to support drag&drop of models. See QWidget
Connect the specific XXXXChanged signals from derived classes to this method in order to have a unified signal which can be used by Taurus Widgets
Returns if the widget is automatically generating a tooltip based on the current widget model.
Return type: | :class:~`bool` |
---|---|
Returns: | True if automatically generating tooltip or False otherwise |
returns the method to be called when a dropping event occurs. The default implementation returns self.setModel. Reimplement it subclasses to call different methods.
Return type: | :class:~`callable` |
---|---|
Returns: |
Returns a MimeData object containing the model data. The default implementation fills the TAURUS_MODEL_MIME_TYPE. If the widget’s Model class is Attribute or Device, it also fills TAURUS_ATTR_MIME_TYPE or TAURUS_DEV_MIME_TYPE, respectively
Return type: | :class:~`QMimeData` |
---|---|
Returns: |
Returns the first taurus component in the widget hierarchy or None if no taurus component is found
Return type: | :class:~`TaurusBaseComponent` or :class:~`None` |
---|---|
Returns: | the parent taurus base component |
Returns the parent Qt class for this widget
Parameters: | bases (:class:~`sequence` <:class:~`class`> or :class:~`None`) – the list of class objects. If None is given (default) it uses the object base classes from __bases__ |
---|---|
Return type: | :class:~`QWidget class` |
Returns: | the QWidget class object |
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' : ':/designer/taurus.png',
'container' : False }
Return type: | :class:~`dict` |
---|---|
Returns: | a map with pertinent designer information |
returns a list of supported mimeTypes that this widget support (ordered by priority). If none is set explicitely via setSupportedMimeTypes(), a best effort will be tried based on the model class
..seealso: setSupportedMimeTypes()
This provides only a very basic implementation. Reimplement in derived classes if needed
Return type: | :class:~`list` <:class:~`str`> |
---|---|
Returns: | list of MIME type names |
very basic and generalistic handling of events.
Override when necessary.
Parameters: |
|
---|
Selects the most appropriate data from the given mimeData object (in the order returned by getSupportedMimeTypes()) and passes it to the given method.
Parameters: |
|
---|---|
Return type: | :class:~`str` or :class:~`None` |
Returns: | returns the MimeType used if the model was successfully set, or None if the model could not be set |
Override of the QWidget.hideEvent()
whether the user can drag data from this widget
Return type: | :class:~`bool` |
---|---|
Returns: | True if the user can drag data |
reimplemented to provide drag events. See QWidget
reimplemented to record the start position for drag events. See QWidget
Invoked when the Taurus parent model changes
Parameters: | parentmodel_name (:class:~`str`) – the new name of the parent model |
---|
Forces the widget to recheck its Taurus parent. Taurus Widgets will in most situations keep track of changes in their taurus parenting, but in some special cases (which unfortunately tend to occur when using Qt Designer) they may not update it correctly.
If this happens, you can manually call this method.
For more information, check the issue demo example
Equivalent to setDragEnabled(self.__class__._dragEnabled)
Applies the given operations (or the pending operations if None passed)
Parameters: | ops (:class:~`sequence` <:class:~`taurus.core.taurusoperation.TaurusOperation`> or :class:~`None`) – list of operations to apply. If None is given (default) the component fetches the pending operations |
---|---|
Return type: | :class:~`bool` |
Returns: | False if the apply was aborted by the user. True otherwise. |
Determines if the widget should automatically generate a tooltip based on the current widget model.
Parameters: | yesno (:class:~`bool`) – True to automatically generate tooltip or False otherwise |
---|
Sets/unsets disconnection on hide event
Parameters: | disconnect (:class:~`bool`) – whether or not to disconnect on hide event |
---|
sets whether the user is allowed to drag data from this widget
Parameters: | modifiable (:class:~`bool`) – |
---|
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: |
|
---|
extends TaurusBaseComponent.setModelInConfig() to include also the “useParentModel” property
Reimplemented to acept/reject drops based on whether the widget is modifiable by the user. See TaurusBaseComponent.setModifiableByUser()
sets the mimeTypes that this widget support
Parameters: | mimetypes (:class:~`list` <:class:~`str`>) – list (ordered by priority) of MIME type names |
---|
Sets/unsets using the parent model.
Note
in some cases you may need to call recheckTaurusParent() after reparenting of some of this widget’s ancestors
Parameters: | yesno (:class:~`bool`) – whether or not to use parent model |
---|
See also
Override of the QWidget.showEvent()
This method should be reimplemented by derived classes that want to change their appearance depending whether there are pending operations or not
Updates the widget style. Default implementation just calls QWidget.update()
Override when necessary.