Restored compatibility with original Qwt signals (QwtPlot, ...)

Author: PierreRaybaut

qwt/legend.py

@@ -177,10 +177,35 @@ class QwtLegend(QwtAbstractLegend):
         Constructor
         
         :param QWidget parent: Parent widget
+
+    .. py:data:: clicked
+
+        A signal which is emitted when the user has clicked on
+        a legend label, which is in `QwtLegendData.Clickable` mode.
+
+        :param itemInfo: Info for the item item of the selected legend item
+        :param index: Index of the legend label in the list of widgets that are associated with the plot item
+        
+        .. note::
+            
+            Clicks are disabled as default
+
+    .. py:data:: checked
+    
+        A signal which is emitted when the user has clicked on
+        a legend label, which is in `QwtLegendData.Checkable` mode
+
+        :param itemInfo: Info for the item of the selected legend label
+        :param index: Index of the legend label in the list of widgets that are associated with the plot item
+        :param on: True when the legend label is checked
+        
+        .. note::
+            
+            Clicks are disabled as default
     """
 
-    SIG_CLICKED = Signal("PyQt_PyObject", int)
-    SIG_CHECKED = Signal("PyQt_PyObject", bool, int)
+    clicked = Signal("PyQt_PyObject", int)
+    checked = Signal("PyQt_PyObject", bool, int)
 
     def __init__(self, parent=None):
         QwtAbstractLegend.__init__(self, parent)
@@ -338,8 +363,8 @@ def createWidget(self, data):
         """
         label = QwtLegendLabel()
         label.setItemMode(self.defaultItemMode())
-        label.SIG_CLICKED.connect(lambda: self.itemClicked(label))
-        label.SIG_CHECKED.connect(lambda state: self.itemChecked(state, label))
+        label.clicked.connect(lambda: self.itemClicked(label))
+        label.checked.connect(lambda state: self.itemChecked(state, label))
         return label
 
     def updateWidget(self, widget, data):
@@ -421,7 +446,7 @@ def itemClicked(self, widget):
                 widgetList = self.__data.itemMap.legendWidgets(itemInfo)
                 if w in widgetList:
                     index = widgetList.index(w)
-                    self.SIG_CLICKED.emit(itemInfo, index)
+                    self.clicked.emit(itemInfo, index)
 
     def itemChecked(self, on, widget):
 #        w = self.sender()  #TODO: cast to QWidget
@@ -432,7 +457,7 @@ def itemChecked(self, on, widget):
                 widgetList = self.__data.itemMap.legendWidgets(itemInfo)
                 if w in widgetList:
                     index = widgetList.index(w)
-                    self.SIG_CHECKED.emit(itemInfo, on, index)
+                    self.checked.emit(itemInfo, on, index)
 
     def renderLegend(self, painter, rect, fillBackground):
         """

qwt/legend_label.py

@@ -45,10 +45,10 @@ def __init__(self):
 class QwtLegendLabel(QwtTextLabel):
     """A widget representing something on a QwtLegend."""
 
-    SIG_CLICKED = Signal()
-    SIG_PRESSED = Signal()
-    SIG_RELEASED = Signal()
-    SIG_CHECKED = Signal(bool)
+    clicked = Signal()
+    pressed = Signal()
+    released = Signal()
+    checked = Signal(bool)
 
     def __init__(self, parent=None):
         QwtTextLabel.__init__(self, parent)
@@ -229,12 +229,12 @@ def setDown(self, down):
         self.update()
         if self.__data.itemMode == QwtLegendData.Clickable:
             if self.__data.isDown:
-                self.SIG_PRESSED.emit()
+                self.pressed.emit()
             else:
-                self.SIG_RELEASED.emit()
-                self.SIG_CLICKED.emit()
+                self.released.emit()
+                self.clicked.emit()
         if self.__data.itemMode == QwtLegendData.Checkable:
-            self.SIG_CHECKED.emit(self.__data.isDown)
+            self.checked.emit(self.__data.isDown)
 
     def isDown(self):
         """

qwt/plot.py

@@ -39,9 +39,9 @@
 
 def qwtEnableLegendItems(plot, on):
     if on:
-        plot.SIG_LEGEND_DATA_CHANGED.connect(plot.updateLegendItems)
+        plot.legendDataChanged.connect(plot.updateLegendItems)
     else:
-        plot.SIG_LEGEND_DATA_CHANGED.disconnect(plot.updateLegendItems)
+        plot.legendDataChanged.disconnect(plot.updateLegendItems)
 
 def qwtSetTabOrder(first, second, with_children):
     tab_chain = [first, second]
@@ -255,10 +255,26 @@ class QwtPlot(QFrame, QwtPlotDict):
     
         :param str title: Title text
         :param QWidget parent: Parent widget
+        
+    .. py:data:: itemAttached
+    
+        A signal indicating, that an item has been attached/detached
+        
+        :param plotItem: Plot item
+        :param on: Attached/Detached
+
+    .. py:data:: legendDataChanged
+    
+        A signal with the attributes how to update 
+        the legend entries for a plot item.
+
+        :param itemInfo: Info about a plot item, build from itemToInfo()
+        :param data: Attributes of the entries (usually <= 1) for the plot item.
+
     """
 
-    SIG_ITEM_ATTACHED = Signal("PyQt_PyObject", bool)
-    SIG_LEGEND_DATA_CHANGED = Signal("PyQt_PyObject", "PyQt_PyObject")
+    itemAttached = Signal("PyQt_PyObject", bool)
+    legendDataChanged = Signal("PyQt_PyObject", "PyQt_PyObject")
 
     # enum Axis
     yLeft, yRight, xBottom, xTop, axisCnt = list(range(5))
@@ -1432,8 +1448,7 @@ def insertLegend(self, legend, pos=None, ratio=-1):
                 del self.__data.legend
             self.__data.legend = legend
             if self.__data.legend:
-                self.SIG_LEGEND_DATA_CHANGED.connect(
-                                            self.__data.legend.updateLegend)
+                self.legendDataChanged.connect(self.__data.legend.updateLegend)
                 if self.__data.legend.parent() is not self:
                     self.__data.legend.setParent(self)
 
@@ -1467,14 +1482,14 @@ def insertLegend(self, legend, pos=None, ratio=-1):
 
     def updateLegend(self, plotItem=None):
         """
-        If plotItem is None, emit QwtPlot.SIG_LEGEND_DATA_CHANGED for all 
+        If plotItem is None, emit QwtPlot.legendDataChanged for all 
         plot item. Otherwise, emit the signal for passed plot item.
     
         :param qwt.plot.QwtPlotItem plotItem: Plot item
 
         .. seealso::
         
-            :py:meth:`QwtPlotItem.legendData()`, :py:data:`QwtPlot.SIG_LEGEND_DATA_CHANGED`
+            :py:meth:`QwtPlotItem.legendData()`, :py:data:`QwtPlot.legendDataChanged`
         """
         if plotItem is None:
             items = list(self.itemList())
@@ -1486,7 +1501,7 @@ def updateLegend(self, plotItem=None):
             legendData = []
             if plotItem.testItemAttribute(QwtPlotItem.Legend):
                 legendData = plotItem.legendData()
-            self.SIG_LEGEND_DATA_CHANGED.emit(plotItem, legendData)
+            self.legendDataChanged.emit(plotItem, legendData)
 
     def updateLegendItems(self, plotItem, legendData):
         """
@@ -1527,13 +1542,13 @@ def attachItem(self, plotItem, on):
         else:
             self.removeItem(plotItem)
 
-        self.SIG_ITEM_ATTACHED.emit(plotItem, on)
+        self.itemAttached.emit(plotItem, on)
 
         if plotItem.testItemAttribute(QwtPlotItem.Legend):
             if on:
                 self.updateLegend(plotItem)
             else:
-                self.SIG_LEGEND_DATA_CHANGED.emit(plotItem, [])
+                self.legendDataChanged.emit(plotItem, [])
 
         self.autoRefresh()
 

qwt/scale_widget.py

@@ -73,7 +73,7 @@ class QwtScaleWidget(QWidget):
         :param QWidget parent: Parent widget
     """
 
-    SIG_SCALE_DIV_CHANGED = Signal()
+    scaleDivChanged = Signal()
 
     # enum LayoutFlag
     TitleInverted = 1
@@ -694,7 +694,7 @@ def setScaleDiv(self, scaleDiv):
         if sd.scaleDiv() != scaleDiv:
             sd.setScaleDiv(scaleDiv)
             self.layoutScale()
-            self.SIG_SCALE_DIV_CHANGED.emit()
+            self.scaleDivChanged.emit()
 
     def setTransformation(self, transformation):
         """

qwt/tests/CPUplot.py

@@ -347,7 +347,7 @@ def __init__(self, *args):
 
         self.startTimer(1000)
 
-        legend.SIG_CHECKED.connect(self.showCurve)
+        legend.checked.connect(self.showCurve)
         self.replot()
 
     def timerEvent(self, e):

qwt/tests/EventFilterDemo.py

@@ -20,7 +20,7 @@
 
 
 class ColorBar(QWidget):
-    SIG_COLOR_SELECTED = Signal(QColor)
+    colorSelected = Signal(QColor)
 
     def __init__(self, orientation, *args):
         QWidget.__init__(self, *args)
@@ -63,7 +63,7 @@ def mousePressEvent(self, event):
                 pm = QPixmap.grabWidget(self)
             color = QColor()
             color.setRgb(pm.toImage().pixel(event.x(), event.y()))
-            self.SIG_COLOR_SELECTED.emit(color)
+            self.colorSelected.emit(color)
             event.accept()
 
     def paintEvent(self, _):
@@ -136,7 +136,7 @@ def __init__(self, *args):
         self.__colorBar.setRange(
             QColor(Qt.red), QColor(Qt.darkBlue))
         self.__colorBar.setFocusPolicy(Qt.TabFocus)
-        self.__colorBar.SIG_COLOR_SELECTED.connect(self.setCanvasColor)
+        self.__colorBar.colorSelected.connect(self.setCanvasColor)
 
         # we need the resize events, to lay out the color bar
         scaleWidget.installEventFilter(self)
@@ -376,7 +376,7 @@ def __shiftPointCursor(self, up):
 
 
 class ScalePicker(QObject):
-    SIG_CLICKED = Signal(int, float)
+    clicked = Signal(int, float)
 
     def __init__(self, plot):
         QObject.__init__(self, plot)
@@ -412,7 +412,7 @@ def __mouseClicked(self, scale, pos):
         elif scale.alignment() == QwtScaleDraw.TopScale:
             value = sd.scaleMap().invTransform(pos.x())
             axis = QwtPlot.xBottom
-        self.SIG_CLICKED.emit(axis, value)
+        self.clicked.emit(axis, value)
 
     def __scaleRect(self, scale):
         bld = scale.margin()
@@ -447,7 +447,7 @@ def make():
         )
     CanvasPicker(plot)
     scalePicker = ScalePicker(plot)
-    scalePicker.SIG_CLICKED.connect(plot.insertCurve)
+    scalePicker.clicked.connect(plot.insertCurve)
     demo.resize(540, 400)
     demo.show()
     return demo

qwt/tests/ImagePlotDemo.py

@@ -167,7 +167,7 @@ def __init__(self, *args):
         plotImage.setData(square(512, -2*np.pi, 2*np.pi),
                           (-2*np.pi, 2*np.pi), (-2*np.pi, 2*np.pi))
 
-        legend.SIG_CLICKED.connect(self.toggleVisibility)
+        legend.clicked.connect(self.toggleVisibility)
 
         # replot
         self.replot()