mouseEvents.py 13.3 KB
Newer Older
1
2
3
4
5
6
from pyqtgraph.Point import Point
from pyqtgraph.Qt import QtCore, QtGui
import weakref
import pyqtgraph.ptime as ptime

class MouseDragEvent:
Luke Campagnola's avatar
Luke Campagnola committed
7
8
9
10
11
12
13
    """
    Instances of this class are delivered to items in a :class:`GraphicsScene <pyqtgraph.GraphicsScene>` via their mouseDragEvent() method when the item is being mouse-dragged. 
    
    """
    
    
    
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
    def __init__(self, moveEvent, pressEvent, lastEvent, start=False, finish=False):
        self.start = start
        self.finish = finish
        self.accepted = False
        self.currentItem = None
        self._buttonDownScenePos = {}
        self._buttonDownScreenPos = {}
        for btn in [QtCore.Qt.LeftButton, QtCore.Qt.MidButton, QtCore.Qt.RightButton]:
            self._buttonDownScenePos[int(btn)] = moveEvent.buttonDownScenePos(btn)
            self._buttonDownScreenPos[int(btn)] = moveEvent.buttonDownScreenPos(btn)
        self._scenePos = moveEvent.scenePos()
        self._screenPos = moveEvent.screenPos()
        if lastEvent is None:
            self._lastScenePos = pressEvent.scenePos()
            self._lastScreenPos = pressEvent.screenPos()
        else:
            self._lastScenePos = lastEvent.scenePos()
            self._lastScreenPos = lastEvent.screenPos()
        self._buttons = moveEvent.buttons()
        self._button = pressEvent.button()
        self._modifiers = moveEvent.modifiers()
        
    def accept(self):
Luke Campagnola's avatar
Luke Campagnola committed
37
        """An item should call this method if it can handle the event. This will prevent the event being delivered to any other items."""
38
39
40
41
        self.accepted = True
        self.acceptedItem = self.currentItem
        
    def ignore(self):
Luke Campagnola's avatar
Luke Campagnola committed
42
        """An item should call this method if it cannot handle the event. This will allow the event to be delivered to other items."""
43
44
45
46
47
48
        self.accepted = False
    
    def isAccepted(self):
        return self.accepted
    
    def scenePos(self):
Luke Campagnola's avatar
Luke Campagnola committed
49
        """Return the current scene position of the mouse."""
50
51
52
        return Point(self._scenePos)
    
    def screenPos(self):
Luke Campagnola's avatar
Luke Campagnola committed
53
        """Return the current screen position (pixels relative to widget) of the mouse."""
54
55
56
        return Point(self._screenPos)
    
    def buttonDownScenePos(self, btn=None):
Luke Campagnola's avatar
Luke Campagnola committed
57
58
59
60
        """
        Return the scene position of the mouse at the time *btn* was pressed.
        If *btn* is omitted, then the button that initiated the drag is assumed.
        """
61
62
63
64
65
        if btn is None:
            btn = self.button()
        return Point(self._buttonDownScenePos[int(btn)])
    
    def buttonDownScreenPos(self, btn=None):
Luke Campagnola's avatar
Luke Campagnola committed
66
67
68
69
        """
        Return the screen position (pixels relative to widget) of the mouse at the time *btn* was pressed.
        If *btn* is omitted, then the button that initiated the drag is assumed.
        """
70
71
72
73
74
        if btn is None:
            btn = self.button()
        return Point(self._buttonDownScreenPos[int(btn)])
    
    def lastScenePos(self):
Luke Campagnola's avatar
Luke Campagnola committed
75
76
77
        """
        Return the scene position of the mouse immediately prior to this event.
        """
78
79
80
        return Point(self._lastScenePos)
    
    def lastScreenPos(self):
Luke Campagnola's avatar
Luke Campagnola committed
81
82
83
        """
        Return the screen position of the mouse immediately prior to this event.
        """
84
85
86
        return Point(self._lastScreenPos)
    
    def buttons(self):
Luke Campagnola's avatar
Luke Campagnola committed
87
88
89
90
        """
        Return the buttons currently pressed on the mouse.
        (see QGraphicsSceneMouseEvent::buttons in the Qt documentation)
        """
91
92
93
        return self._buttons
        
    def button(self):
Luke Campagnola's avatar
Luke Campagnola committed
94
95
96
97
        """Return the button that initiated the drag (may be different from the buttons currently pressed)
        (see QGraphicsSceneMouseEvent::button in the Qt documentation)
        
        """
98
99
100
        return self._button
        
    def pos(self):
Luke Campagnola's avatar
Luke Campagnola committed
101
102
103
104
        """
        Return the current position of the mouse in the coordinate system of the item
        that the event was delivered to.
        """
105
106
107
        return Point(self.currentItem.mapFromScene(self._scenePos))
    
    def lastPos(self):
Luke Campagnola's avatar
Luke Campagnola committed
108
109
110
111
        """
        Return the previous position of the mouse in the coordinate system of the item
        that the event was delivered to.
        """
112
113
114
        return Point(self.currentItem.mapFromScene(self._lastScenePos))
        
    def buttonDownPos(self, btn=None):
Luke Campagnola's avatar
Luke Campagnola committed
115
116
117
118
        """
        Return the position of the mouse at the time the drag was initiated
        in the coordinate system of the item that the event was delivered to.
        """
119
120
121
122
123
        if btn is None:
            btn = self.button()
        return Point(self.currentItem.mapFromScene(self._buttonDownScenePos[int(btn)]))
    
    def isStart(self):
Luke Campagnola's avatar
Luke Campagnola committed
124
        """Returns True if this event is the first since a drag was initiated."""
125
126
127
        return self.start
        
    def isFinish(self):
Luke Campagnola's avatar
Luke Campagnola committed
128
129
        """Returns False if this is the last event in a drag. Note that this
        event will have the same position as the previous one."""
130
131
132
133
134
135
136
137
        return self.finish

    def __repr__(self):
        lp = self.lastPos()
        p = self.pos()
        return "<MouseDragEvent (%g,%g)->(%g,%g) buttons=%d start=%s finish=%s>" % (lp.x(), lp.y(), p.x(), p.y(), int(self.buttons()), str(self.isStart()), str(self.isFinish()))
        
    def modifiers(self):
Luke Campagnola's avatar
Luke Campagnola committed
138
139
140
141
        """Return any keyboard modifiers currently pressed.
        (see QGraphicsSceneMouseEvent::modifiers in the Qt documentation)
        
        """
142
143
144
145
146
        return self._modifiers



class MouseClickEvent:
Luke Campagnola's avatar
Luke Campagnola committed
147
148
149
150
151
152
    """
    Instances of this class are delivered to items in a :class:`GraphicsScene <pyqtgraph.GraphicsScene>` via their mouseClickEvent() method when the item is clicked. 
    
    
    """
    
153
154
155
156
157
158
159
160
161
162
163
164
165
    def __init__(self, pressEvent, double=False):
        self.accepted = False
        self.currentItem = None
        self._double = double
        self._scenePos = pressEvent.scenePos()
        self._screenPos = pressEvent.screenPos()
        self._button = pressEvent.button()
        self._buttons = pressEvent.buttons()
        self._modifiers = pressEvent.modifiers()
        self._time = ptime.time()
        
        
    def accept(self):
Luke Campagnola's avatar
Luke Campagnola committed
166
        """An item should call this method if it can handle the event. This will prevent the event being delivered to any other items."""
167
168
169
170
        self.accepted = True
        self.acceptedItem = self.currentItem
        
    def ignore(self):
Luke Campagnola's avatar
Luke Campagnola committed
171
        """An item should call this method if it cannot handle the event. This will allow the event to be delivered to other items."""
172
173
174
175
176
177
        self.accepted = False
    
    def isAccepted(self):
        return self.accepted
    
    def scenePos(self):
Luke Campagnola's avatar
Luke Campagnola committed
178
        """Return the current scene position of the mouse."""
179
180
181
        return Point(self._scenePos)
    
    def screenPos(self):
Luke Campagnola's avatar
Luke Campagnola committed
182
        """Return the current screen position (pixels relative to widget) of the mouse."""
183
184
185
        return Point(self._screenPos)
    
    def buttons(self):
Luke Campagnola's avatar
Luke Campagnola committed
186
187
188
189
        """
        Return the buttons currently pressed on the mouse.
        (see QGraphicsSceneMouseEvent::buttons in the Qt documentation)
        """
190
191
192
        return self._buttons
    
    def button(self):
Luke Campagnola's avatar
Luke Campagnola committed
193
194
195
        """Return the mouse button that generated the click event.
        (see QGraphicsSceneMouseEvent::button in the Qt documentation)
        """
196
197
198
        return self._button
    
    def double(self):
Luke Campagnola's avatar
Luke Campagnola committed
199
        """Return True if this is a double-click."""
200
201
202
        return self._double

    def pos(self):
Luke Campagnola's avatar
Luke Campagnola committed
203
204
205
206
        """
        Return the current position of the mouse in the coordinate system of the item
        that the event was delivered to.
        """
207
208
209
        return Point(self.currentItem.mapFromScene(self._scenePos))
    
    def lastPos(self):
Luke Campagnola's avatar
Luke Campagnola committed
210
211
212
213
        """
        Return the previous position of the mouse in the coordinate system of the item
        that the event was delivered to.
        """
214
215
216
        return Point(self.currentItem.mapFromScene(self._lastScenePos))
        
    def modifiers(self):
Luke Campagnola's avatar
Luke Campagnola committed
217
218
219
        """Return any keyboard modifiers currently pressed.
        (see QGraphicsSceneMouseEvent::modifiers in the Qt documentation)        
        """
220
221
222
223
224
225
226
227
228
229
230
231
232
        return self._modifiers

    def __repr__(self):
        p = self.pos()
        return "<MouseClickEvent (%g,%g) button=%d>" % (p.x(), p.y(), int(self.button()))
        
    def time(self):
        return self._time



class HoverEvent:
    """
Luke Campagnola's avatar
Luke Campagnola committed
233
    Instances of this class are delivered to items in a :class:`GraphicsScene <pyqtgraph.GraphicsScene>` via their hoverEvent() method when the mouse is hovering over the item.
234
    This event class both informs items that the mouse cursor is nearby and allows items to 
Luke Campagnola's avatar
Luke Campagnola committed
235
    communicate with one another about whether each item will accept *potential* mouse events. 
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
    
    It is common for multiple overlapping items to receive hover events and respond by changing 
    their appearance. This can be misleading to the user since, in general, only one item will
    respond to mouse events. To avoid this, items make calls to event.acceptClicks(button) 
    and/or acceptDrags(button).
    
    Each item may make multiple calls to acceptClicks/Drags, each time for a different button. 
    If the method returns True, then the item is guaranteed to be
    the recipient of the claimed event IF the user presses the specified mouse button before
    moving. If claimEvent returns False, then this item is guaranteed NOT to get the specified
    event (because another has already claimed it) and the item should change its appearance 
    accordingly.
    
    event.isEnter() returns True if the mouse has just entered the item's shape;
    event.isExit() returns True if the mouse has just left.
    """
    def __init__(self, moveEvent, acceptable):
        self.enter = False
        self.acceptable = acceptable
        self.exit = False
        self.__clickItems = weakref.WeakValueDictionary()
        self.__dragItems = weakref.WeakValueDictionary()
        self.currentItem = None
        if moveEvent is not None:
            self._scenePos = moveEvent.scenePos()
            self._screenPos = moveEvent.screenPos()
            self._lastScenePos = moveEvent.lastScenePos()
            self._lastScreenPos = moveEvent.lastScreenPos()
            self._buttons = moveEvent.buttons()
            self._modifiers = moveEvent.modifiers()
        else:
            self.exit = True
            
        
        
    def isEnter(self):
Luke Campagnola's avatar
Luke Campagnola committed
272
        """Returns True if the mouse has just entered the item's shape"""
273
274
275
        return self.enter
        
    def isExit(self):
Luke Campagnola's avatar
Luke Campagnola committed
276
        """Returns True if the mouse has just exited the item's shape"""
277
278
279
        return self.exit
        
    def acceptClicks(self, button):
Luke Campagnola's avatar
Luke Campagnola committed
280
281
282
283
284
285
286
        """Inform the scene that the item (that the event was delivered to)
        would accept a mouse click event if the user were to click before
        moving the mouse again.
        
        Returns True if the request is successful, otherwise returns False (indicating
        that some other item would receive an incoming click).
        """
287
288
289
290
291
292
293
294
        if not self.acceptable:
            return False
        if button not in self.__clickItems:
            self.__clickItems[button] = self.currentItem
            return True
        return False
        
    def acceptDrags(self, button):
Luke Campagnola's avatar
Luke Campagnola committed
295
296
297
298
299
300
301
        """Inform the scene that the item (that the event was delivered to)
        would accept a mouse drag event if the user were to drag before
        the next hover event.
        
        Returns True if the request is successful, otherwise returns False (indicating
        that some other item would receive an incoming drag event).
        """
302
303
304
305
306
307
308
309
        if not self.acceptable:
            return False
        if button not in self.__dragItems:
            self.__dragItems[button] = self.currentItem
            return True
        return False
        
    def scenePos(self):
Luke Campagnola's avatar
Luke Campagnola committed
310
        """Return the current scene position of the mouse."""
311
312
313
        return Point(self._scenePos)
    
    def screenPos(self):
Luke Campagnola's avatar
Luke Campagnola committed
314
        """Return the current screen position of the mouse."""
315
316
317
        return Point(self._screenPos)
    
    def lastScenePos(self):
Luke Campagnola's avatar
Luke Campagnola committed
318
        """Return the previous scene position of the mouse."""
319
320
321
        return Point(self._lastScenePos)
    
    def lastScreenPos(self):
Luke Campagnola's avatar
Luke Campagnola committed
322
        """Return the previous screen position of the mouse."""
323
324
325
        return Point(self._lastScreenPos)
    
    def buttons(self):
Luke Campagnola's avatar
Luke Campagnola committed
326
327
328
329
        """
        Return the buttons currently pressed on the mouse.
        (see QGraphicsSceneMouseEvent::buttons in the Qt documentation)
        """
330
331
332
        return self._buttons
        
    def pos(self):
Luke Campagnola's avatar
Luke Campagnola committed
333
334
335
336
        """
        Return the current position of the mouse in the coordinate system of the item
        that the event was delivered to.
        """
337
338
339
        return Point(self.currentItem.mapFromScene(self._scenePos))
    
    def lastPos(self):
Luke Campagnola's avatar
Luke Campagnola committed
340
341
342
343
        """
        Return the previous position of the mouse in the coordinate system of the item
        that the event was delivered to.
        """
344
345
346
347
348
349
350
351
        return Point(self.currentItem.mapFromScene(self._lastScenePos))

    def __repr__(self):
        lp = self.lastPos()
        p = self.pos()
        return "<HoverEvent (%g,%g)->(%g,%g) buttons=%d enter=%s exit=%s>" % (lp.x(), lp.y(), p.x(), p.y(), int(self.buttons()), str(self.isEnter()), str(self.isExit()))
        
    def modifiers(self):
Luke Campagnola's avatar
Luke Campagnola committed
352
353
354
        """Return any keyboard modifiers currently pressed.
        (see QGraphicsSceneMouseEvent::modifiers in the Qt documentation)        
        """
355
356
357
358
359
360
361
362
363
364
        return self._modifiers
    
    def clickItems(self):
        return self.__clickItems
        
    def dragItems(self):
        return self.__dragItems