#!/usr/bin/env python
# ###########################################################################
#
# This file is part of Taurus
#
# http://taurus-scada.org
#
# Copyright 2011 CELLS / ALBA Synchrotron, Bellaterra, Spain
#
# Taurus is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Taurus is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Taurus. If not, see <http://www.gnu.org/licenses/>.
#
# ###########################################################################
"""This module contains the graphics view widget for jdraw files
"""
import os
import traceback
import taurus
from taurus.external.qt import Qt, compat
from taurus.core.taurusbasetypes import TaurusElementType
from taurus.qt.qtgui.graphic.taurusgraphic import (
parseTangoUri,
TaurusGraphicsItem,
SynopticSelectionStyle,
)
from taurus.qt.qtcore.mimetypes import (
TAURUS_ATTR_MIME_TYPE,
TAURUS_DEV_MIME_TYPE,
TAURUS_MODEL_MIME_TYPE,
)
from taurus.qt.qtgui.base import TaurusBaseWidget
from .jdraw_parser import parse
__docformat__ = "restructuredtext"
[docs]
class TaurusJDrawSynopticsView(Qt.QGraphicsView, TaurusBaseWidget):
"""Taurus Class that visualizes Synoptics drawn with the JDraw tool (by
ESRF). It is equivalent to ATK Synoptic Player (Java).
After initialization call setModel('/your/file.jdw') to parse the synoptic
file and connect to controlled objects.
Arguments to TaurusJDrawSynopticsView() creator are:
- designMode; used by Qt Designer
- updateMode; controls Qt Viewport refresh (disabled by default)
- alias; a dictionary of name replacements to be applied on graphical
objects
- resizable: whether to allow resizing or not
- panelClass: class object, class name or shell command to be shown
when an object is clicked (None will show default panel, '' or
'noPanel' will disable it)
TaurusJDrawSynopticsView and TaurusGraphicsScene signals/slots
External events::
Slot selectGraphicItem(const QString &) displays a selection
mark around the TaurusGraphicsItem that matches the argument passed.
Mouse Left-button events::
Signal graphicItemSelected(QString) is triggered, passing the
selected TaurusGraphicsItem.name() as argument.
Mouse Right-button events::
TaurusGraphicsItem.setContextMenu([(ActionName,ActionMethod(device_name))]
allows to configure custom context menus for graphic items using a list
of tuples. Empty tuples will insert separators in the menu.
"""
itemsChanged = Qt.pyqtSignal("QString", dict)
modelsChanged = Qt.pyqtSignal(list)
graphicItemSelected = Qt.pyqtSignal("QString")
graphicSceneClicked = Qt.pyqtSignal("QPoint")
def __init__(
self,
parent=None,
designMode=False,
updateMode=None,
alias=None,
resizable=True,
panelClass=None,
):
name = self.__class__.__name__
self.call__init__wo_kw(Qt.QGraphicsView, parent)
self.call__init__(TaurusBaseWidget, name, designMode=designMode)
self._currF = self.modelName
self.path = ""
self.w_scene = None
self.h_scene = None
self._fileName = "Root"
self._mousePos = (0, 0)
self._selectionStyle = SynopticSelectionStyle.OUTLINE
self.setResizable(resizable)
self.setInteractive(True)
self.setAlias(alias)
self.setDragEnabled(True)
self.setPanelClass(panelClass)
self.setRenderHints(Qt.QPainter.Antialiasing)
# By default the items will update the view when necessary.
# This default value is much more efficient then the QQraphicsView
# default value, so if you decide to change then expect a lot
# of processor to be used by your application.
if updateMode is None:
self.setViewportUpdateMode(Qt.QGraphicsView.NoViewportUpdate)
else:
self.setViewportUpdateMode(updateMode)
[docs]
def defineStyle(self):
self.updateStyle()
# -~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~
# TaurusBaseWidget over writing
# -~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~
[docs]
def isReadOnly(self):
return True
[docs]
def update(self):
# self.emit_signal()
self.emitColors()
[docs]
def openJDraw(self):
ifile, _ = compat.getOpenFileName(
self, "Load JDraw File", "", "JDraw File (*.jdw)"
)
if not ifile:
return
fileName = ifile.split("/")
self._fileName = fileName[-1]
self.setModel(ifile)
return fileName[-1]
[docs]
def setAlias(self, alias):
"""Assigning a dictionary like {'Tag':'Value'} with tags to be replaced
in object names while parsing.
"""
if (isinstance(alias, dict) or hasattr(alias, "items")) and alias:
self.alias = alias
else:
self.alias = None
return
[docs]
def get_item_list(self):
return [
item._name
for item in self.scene().items()
if hasattr(item, "_name") and item._name
]
[docs]
def get_device_list(self):
items = [(item, parseTangoUri(item)) for item in self.get_item_list()]
return list(set(v["_devslashname"] for k, v in items if v))
[docs]
def get_item_colors(self, emit=False):
item_colors = {}
try:
for item in self.scene().items():
if not getattr(item, "_name", "") or not getattr(
item, "_currBgBrush", None
):
continue
item_colors[item._name] = item._currBgBrush.color().name()
if emit:
self.itemsChanged.emit(
self.modelName.split("/")[-1].split(".")[0], item_colors
)
except Exception:
self.warning("Unable to emitColors: %s" % traceback.format_exc())
return item_colors
[docs]
@Qt.pyqtSlot(object)
@Qt.pyqtSlot("QString")
def selectGraphicItem(self, item_name):
if self.scene() is not None:
self.scene().selectGraphicItem(item_name)
return False
def _graphicItemSelected(self, item_name):
self.debug(" => graphicItemSelected(QString)(%s)" % item_name)
self.graphicItemSelected.emit(item_name)
def _graphicSceneClicked(self, point):
self.debug(
"In TaurusJDrawSynopticsView.graphicSceneClicked(%s,%s)"
% (point.x(), point.y())
)
self.graphicSceneClicked.emit(point)
def __modelsChanged(self):
items = self.get_item_list()
self.debug("modelsChanged(%s)" % len(items))
self.modelsChanged.emit(items)
[docs]
def emitColors(self):
"""emit signal which is used to refresh the tree and colors of icons
depend of the current status in jdrawSynoptic
"""
self.get_item_colors(True)
[docs]
def get_sizes(self):
srect = self.scene().sceneRect()
sizes = [
x
for s in (self.size(), self.sizeHint(), srect.size())
for x in (s.width(), s.height())
]
try:
s = self.parent().size()
sizes.extend([s.width(), s.height()])
except Exception:
sizes.extend([0, 0])
return tuple(sizes)
[docs]
def fitting(self, ADJUST_FRAME=False):
"""
Parent size is the size of the bigger panel (desn't keep ratio)
Rect size never changes (fixed by the graphics objects)
Size and SizeHint move one around the other
the method works well until an object is clicked,
then the whole reference changes and doesn't work again.
"""
srect = self.scene().sceneRect()
w, h = (srect.width(), srect.height())
offset = self.mapToGlobal(Qt.QPoint(int(srect.x()), int(srect.y())))
x0, y0 = (offset.x(), offset.y())
self.debug("\n\nIn TauJDrawSynopticsView.fitting()")
self.debug(self.get_sizes())
self.debug(
"\tAdjusting SizeHint: "
+ "size(%s,%s),hint(%s,%s),srect(%s,%s),parent(%s,%s)",
*self.get_sizes(),
)
self.debug("\toffset = %s,%s ; size = %s,%s" % (x0, y0, w, h))
self.fitInView(x0, y0, w, h, Qt.Qt.KeepAspectRatio)
# -------------------------------------------------------------------
# This block seems to be a poorly executed workaround to some
# issue, but it is itself causing bugs (see
# https://gitlab.com/taurus-org/taurus/-/issues/484 ).
# We are not removing it yet to preserve bck-compat
# TODO: Deprecate the ADJUST_FRAME kwarg?
if ADJUST_FRAME: # adjust the "white" frame around the synoptic
self.debug(
"\tResizing: "
+ "size(%s,%s),hint(%s,%s),srect(%s,%s),parent(%s,%s)",
*self.get_sizes(),
)
self.resize(self.sizeHint() + Qt.QSize(5, 5))
# -------------------------------------------------------------------
# THIS LINE MUST BE ALWAYS EXECUTED, It prevents the UP/DOWN resize bug
# apparently Qt needs this 2 fitInView calls to be aware of it, maybe
# first offset was not good
self.debug(
"\tFitting:: size(%s,%s),hint(%s,%s),srect(%s,%s),parent(%s,%s)"
% self.get_sizes()
)
self.fitInView(x0, y0, w, h, Qt.Qt.KeepAspectRatio)
self.debug(
"Done: size(%s,%s),hint(%s,%s),srect(%s,%s),parent(%s,%s)\n\n"
% self.get_sizes()
)
[docs]
def resizeEvent(self, event):
"""It has been needed to reimplent size policies"""
if (
not self.resizable()
or not self.scene()
or isinstance(self.parent(), Qt.QScrollArea)
or not self.isVisible()
):
self.debug(
"In TaurusJDrawSynopticsView("
+ self._fileName
+ ").resizeEvent(): Disabled"
)
return
try:
self.debug(
"In TaurusJDrawSynopticsView("
+ self._fileName
+ ").resizeEvent()"
)
if self.size() == self.sizeHint():
self.debug("\tSize already fits: %s" % self.size())
return
self.setVerticalScrollBarPolicy(Qt.Qt.ScrollBarAlwaysOff)
self.setHorizontalScrollBarPolicy(Qt.Qt.ScrollBarAlwaysOff)
self.fitting()
self.emitColors()
except Exception:
self.warning(
"Exception in JDrawView("
+ self._fileName
+ ").resizeEvent: %s" % traceback.format_exc()
)
pass
[docs]
def refreshModel(self):
self.setModel(self.getModelName())
[docs]
def updateStyle(self):
self.repaint()
[docs]
def repaint(self):
Qt.QGraphicsView.repaint(self)
# self.fitting()
[docs]
def getGraphicsFactory(self, delayed=False):
from . import jdraw
# self.parent())
return jdraw.TaurusJDrawGraphicsFactory(
self, alias=(self.alias or None), delayed=delayed
)
###########################################################################
[docs]
def getFramed(self):
try:
parent = self.parent()
except Exception:
parent = None
frame = Qt.QFrame(parent)
self.setFrameStyle(self.StyledPanel | self.Raised)
self.setLineWidth(2)
self.setParent(frame)
return frame
[docs]
def setResizable(self, resizable):
self._resizable = resizable
[docs]
def resizable(self):
return self._resizable
[docs]
def mousePressEvent(self, event):
"""Records last event position to use it for DragEvents"""
try:
self.mousePos = event.scenePos().x(), event.scenePos().y()
except Exception:
self.mousePos = event.x(), event.y()
self.debug(
"MouseEvent received is not a GraphicsScene event, "
+ "using raw position %s",
str(self.mousePos),
)
TaurusBaseWidget.mousePressEvent(self, event)
[docs]
def getModelMimeData(self):
"""Used for drag events"""
model, mimeData = "", None
try:
# model = getattr(self.scene().itemAt(*self.mousePos),'_name','')
selected = self.scene()._selectedItems
if not selected:
self.debug(
"jdrawView.getModelMimeData(%s): nothing to drag" % model
)
return
model = getattr(
(
[
s
for s in selected
if s.isUnderMouse() and getattr(s, "_name", "")
]
or [selected]
)[0],
"_name",
"",
)
self.debug("getModelMimeData(%s)" % model)
mimeData = Qt.QMimeData()
if model:
taurusType = taurus.getValidTypesForName(model, False)
model = str(model).encode("utf8")
if TaurusElementType.Device in taurusType:
mimeData.setData(TAURUS_DEV_MIME_TYPE, model)
if TaurusElementType.Attribute in taurusType:
mimeData.setData(TAURUS_ATTR_MIME_TYPE, model)
else:
mimeData.setData(TAURUS_MODEL_MIME_TYPE, model)
except Exception:
self.debug(
"jdrawView.getModelMimeData(%s): unable to get MimeData"
% model
)
self.debug(traceback.format_exc())
return mimeData
# -~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~
# QT properties
# -~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~
[docs]
@classmethod
def setDefaultPanelClass(klass, other):
"""
This method returns the Class used to open new object panels on
double-click (TaurusDevicePanel by default)
"""
klass._defaultClass = other
[docs]
@classmethod
def defaultPanelClass(klass):
"""
This method assigns the Class used to open new object panels on
double-click (TaurusDevicePanel by default) If an string is used it can
be either a Taurus class or an OS launcher
"""
if not hasattr(klass, "_defaultClass"):
from taurus.qt.qtgui.panel import TaurusDevicePanel
# 'taurusdevicepanel' # You can use an executable or a class
klass._defaultClass = TaurusDevicePanel
obj = klass._defaultClass
return obj
[docs]
def setPanelClass(self, widget):
self._panelClass = widget
[docs]
def panelClass(self):
if self._panelClass is None:
return self.defaultPanelClass()
else:
return self._panelClass
[docs]
@Qt.pyqtSlot("QString")
def setModel(
self, model, alias=None, delayed=False, trace=False, **kwargs
):
self.modelName = str(model)
self._currF = str(model)
if alias is not None:
self.setAlias(alias)
ll = taurus.getLogLevel()
if trace:
taurus.setLogLevel(taurus.Debug)
# self.debug('setModel("%s")'%model)
if self._currF:
# filename = str(self._currFile.absoluteFilePath())
filename = self._currF
filename = os.path.realpath(filename)
if os.path.isfile(filename):
self.debug("Starting to parse %s" % filename)
self.path = os.path.dirname(filename)
factory = self.getGraphicsFactory(delayed=delayed)
scene = parse(filename, factory)
self.setSelectionStyle(self._selectionStyle)
self.debug("Obtained %s(%s)", type(scene).__name__, filename)
if not scene:
self.warning(
"TaurusJDrawSynopticsView.setModel(%s): "
+ "Unable to parse %s!!!",
model,
filename,
)
elif self.w_scene is None and scene.sceneRect():
self.w_scene = scene.sceneRect().width()
self.h_scene = scene.sceneRect().height()
else:
self.debug("JDrawView.sceneRect() is NONE!!!")
self.setScene(scene)
self.scene().graphicItemSelected.connect(
self._graphicItemSelected
)
self.scene().graphicSceneClicked.connect(
self._graphicSceneClicked
)
self.__modelsChanged()
self.setWindowTitle(self.modelName)
# The emitted signal contains the filename and a dictionary
# with the name of items and its color
self.emitColors() # get_item_colors(emit=True)
self.fitting()
else:
self.setScene(None)
# self.debug('out of setModel()')
taurus.setLogLevel(ll)
[docs]
def closeEvent(self, event=None):
if self.scene():
self.scene().closeAllPanels()
Qt.QGraphicsView.closeEvent(self, event)
[docs]
def setModels(self):
"""This method triggers item.setModel(item._name) in all internal
items.
"""
for item in self.scene().items():
if item._name and isinstance(item, TaurusGraphicsItem):
self.debug(
"TaurusJDrawGraphicsFactory.setModels(): "
+ "calling item.setModel(%s)",
item._name,
)
item.setModel(item._name)
[docs]
def getModel(self, **kwargs):
return self._currF
[docs]
@classmethod
def getQtDesignerPluginInfo(cls):
ret = TaurusBaseWidget.getQtDesignerPluginInfo()
ret["group"] = "Taurus Display"
ret["module"] = "taurus.qt.qtgui.graphic"
ret["icon"] = "designer:graphicsview.png"
return ret
model = Qt.pyqtProperty("QString", getModel, setModel)
[docs]
def setSelectionStyle(self, selectionStyle):
if isinstance(selectionStyle, str):
selectionStyle = str(selectionStyle).upper()
try:
selectionStyle = SynopticSelectionStyle[selectionStyle]
except Exception:
self.debug('invalid selectionStyle "%s"', selectionStyle)
return
if self.scene() is not None:
self.setSelectionStyle(selectionStyle)
self._selectionStyle = selectionStyle
[docs]
def getSelectionStyle(self):
return self._selectionStyle
[docs]
def getSelectionStyleName(self):
return SynopticSelectionStyle.whatis(self.getSelectionStyle())
[docs]
def resetSelectionStyle(self):
self.setSelectionStyle(SynopticSelectionStyle.OUTLINE)
selectionStyle = Qt.pyqtProperty(
"QString",
getSelectionStyleName,
setSelectionStyle,
resetSelectionStyle,
)
def jdraw_view_main():
import sys
import taurus.qt.qtgui.graphic
taurus.setLogLevel(taurus.Info)
from taurus.qt.qtgui.application import TaurusApplication
app = TaurusApplication(sys.argv, cmd_line_parser=None)
# form = Qt.QDialog()
# ly=Qt.QVBoxLayout(form)
# container=Qt.QWidget()
# ly.addWidget(container)
# for m in sys.argv[1:]:
# tv=TaurusJDrawSynopticsView(container, designMode=False)
# tv.setModel(m)
form = taurus.qt.qtgui.graphic.TaurusJDrawSynopticsView(designMode=False)
form.show()
form.setModel(sys.argv[1])
form.setWindowTitle(sys.argv[1].rsplit(".", 1)[0])
sys.exit(app.exec_())
if __name__ == "__main__":
jdraw_view_main()