Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QGraphicsSceneEvent Class Reference

The QGraphicsSceneEvent class provides a base class for all graphics view related events. More...

#include <qgraphicssceneevent.h>

+ Inheritance diagram for QGraphicsSceneEvent:
+ Collaboration diagram for QGraphicsSceneEvent:

Public Member Functions

 QGraphicsSceneEvent (Type type)
 
 ~QGraphicsSceneEvent ()
 Destroys the event.
 
QWidgetwidget () const
 Returns the widget where the event originated, or \nullptr if the event originates from another application.
 
void setWidget (QWidget *widget)
 
quint64 timestamp () const
 
void setTimestamp (quint64 ts)
 
- Public Member Functions inherited from QEvent
 QEvent (Type type)
 Constructs an event object of type type.
 
virtual ~QEvent ()
 Destroys the event.
 
Type type () const
 Returns the event type.
 
bool spontaneous () const
 Returns true if the event originated outside the application (a system event); otherwise returns false.
 
virtual void setAccepted (bool accepted)
 
bool isAccepted () const
 
void accept ()
 Sets the accept flag of the event object, the equivalent of calling setAccepted(true).
 
void ignore ()
 Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).
 
bool isInputEvent () const noexcept
 
bool isPointerEvent () const noexcept
 
bool isSinglePointEvent () const noexcept
 
virtual QEventclone () const
 Creates and returns an identical copy of this event.
 

Protected Member Functions

 QGraphicsSceneEvent (QGraphicsSceneEventPrivate &dd, Type type=None)
 
- Protected Member Functions inherited from QEvent
 QEvent (Type type, InputEventTag)
 
 QEvent (Type type, PointerEventTag)
 
 QEvent (Type type, SinglePointEventTag)
 

Protected Attributes

QScopedPointer< QGraphicsSceneEventPrivated_ptr
 
- Protected Attributes inherited from QEvent
quint16 t
 

Additional Inherited Members

- Public Types inherited from QEvent
enum  Type {
  None = 0 , Timer = 1 , MouseButtonPress = 2 , MouseButtonRelease = 3 ,
  MouseButtonDblClick = 4 , MouseMove = 5 , KeyPress = 6 , KeyRelease = 7 ,
  FocusIn = 8 , FocusOut = 9 , FocusAboutToChange = 23 , Enter = 10 ,
  Leave = 11 , Paint = 12 , Move = 13 , Resize = 14 ,
  Create = 15 , Destroy = 16 , Show = 17 , Hide = 18 ,
  Close = 19 , Quit = 20 , ParentChange = 21 , ParentAboutToChange = 131 ,
  ThreadChange = 22 , WindowActivate = 24 , WindowDeactivate = 25 , ShowToParent = 26 ,
  HideToParent = 27 , Wheel = 31 , WindowTitleChange = 33 , WindowIconChange = 34 ,
  ApplicationWindowIconChange = 35 , ApplicationFontChange = 36 , ApplicationLayoutDirectionChange = 37 , ApplicationPaletteChange = 38 ,
  PaletteChange = 39 , Clipboard = 40 , Speech = 42 , MetaCall = 43 ,
  SockAct = 50 , WinEventAct = 132 , DeferredDelete = 52 , DragEnter = 60 ,
  DragMove = 61 , DragLeave = 62 , Drop = 63 , DragResponse = 64 ,
  ChildAdded = 68 , ChildPolished = 69 , ChildRemoved = 71 , ShowWindowRequest = 73 ,
  PolishRequest = 74 , Polish = 75 , LayoutRequest = 76 , UpdateRequest = 77 ,
  UpdateLater = 78 , EmbeddingControl = 79 , ActivateControl = 80 , DeactivateControl = 81 ,
  ContextMenu = 82 , InputMethod = 83 , TabletMove = 87 , LocaleChange = 88 ,
  LanguageChange = 89 , LayoutDirectionChange = 90 , Style = 91 , TabletPress = 92 ,
  TabletRelease = 93 , OkRequest = 94 , HelpRequest = 95 , IconDrag = 96 ,
  FontChange = 97 , EnabledChange = 98 , ActivationChange = 99 , StyleChange = 100 ,
  IconTextChange = 101 , ModifiedChange = 102 , MouseTrackingChange = 109 , WindowBlocked = 103 ,
  WindowUnblocked = 104 , WindowStateChange = 105 , ReadOnlyChange = 106 , ToolTip = 110 ,
  WhatsThis = 111 , StatusTip = 112 , ActionChanged = 113 , ActionAdded = 114 ,
  ActionRemoved = 115 , FileOpen = 116 , Shortcut = 117 , ShortcutOverride = 51 ,
  WhatsThisClicked = 118 , ToolBarChange = 120 , ApplicationActivate = 121 , ApplicationActivated = ApplicationActivate ,
  ApplicationDeactivate = 122 , ApplicationDeactivated = ApplicationDeactivate , QueryWhatsThis = 123 , EnterWhatsThisMode = 124 ,
  LeaveWhatsThisMode = 125 , ZOrderChange = 126 , HoverEnter = 127 , HoverLeave = 128 ,
  HoverMove = 129 , AcceptDropsChange = 152 , ZeroTimerEvent = 154 , GraphicsSceneMouseMove = 155 ,
  GraphicsSceneMousePress = 156 , GraphicsSceneMouseRelease = 157 , GraphicsSceneMouseDoubleClick = 158 , GraphicsSceneContextMenu = 159 ,
  GraphicsSceneHoverEnter = 160 , GraphicsSceneHoverMove = 161 , GraphicsSceneHoverLeave = 162 , GraphicsSceneHelp = 163 ,
  GraphicsSceneDragEnter = 164 , GraphicsSceneDragMove = 165 , GraphicsSceneDragLeave = 166 , GraphicsSceneDrop = 167 ,
  GraphicsSceneWheel = 168 , GraphicsSceneLeave = 220 , KeyboardLayoutChange = 169 , DynamicPropertyChange = 170 ,
  TabletEnterProximity = 171 , TabletLeaveProximity = 172 , NonClientAreaMouseMove = 173 , NonClientAreaMouseButtonPress = 174 ,
  NonClientAreaMouseButtonRelease = 175 , NonClientAreaMouseButtonDblClick = 176 , MacSizeChange = 177 , ContentsRectChange = 178 ,
  MacGLWindowChange = 179 , FutureCallOut = 180 , GraphicsSceneResize = 181 , GraphicsSceneMove = 182 ,
  CursorChange = 183 , ToolTipChange = 184 , NetworkReplyUpdated = 185 , GrabMouse = 186 ,
  UngrabMouse = 187 , GrabKeyboard = 188 , UngrabKeyboard = 189 , StateMachineSignal = 192 ,
  StateMachineWrapped = 193 , TouchBegin = 194 , TouchUpdate = 195 , TouchEnd = 196 ,
  NativeGesture = 197 , RequestSoftwareInputPanel = 199 , CloseSoftwareInputPanel = 200 , WinIdChange = 203 ,
  Gesture = 198 , GestureOverride = 202 , ScrollPrepare = 204 , Scroll = 205 ,
  Expose = 206 , InputMethodQuery = 207 , OrientationChange = 208 , TouchCancel = 209 ,
  ThemeChange = 210 , SockClose = 211 , PlatformPanel = 212 , StyleAnimationUpdate = 213 ,
  ApplicationStateChange = 214 , WindowChangeInternal = 215 , ScreenChangeInternal = 216 , PlatformSurface = 217 ,
  Pointer = 218 , TabletTrackingChange = 219 , WindowAboutToChangeInternal = 221 , DevicePixelRatioChange = 222 ,
  ChildWindowAdded = 223 , ChildWindowRemoved = 224 , ParentWindowAboutToChange = 225 , ParentWindowChange = 226 ,
  User = 1000 , MaxUser = 65535
}
 This enum type defines the valid event types in Qt. More...
 
- Static Public Member Functions inherited from QEvent
static int registerEventType (int hint=-1) noexcept
 

Detailed Description

The QGraphicsSceneEvent class provides a base class for all graphics view related events.

Since
4.2

\inmodule QtWidgets

When a QGraphicsView receives Qt mouse, keyboard, and drag and drop events (QMouseEvent, QKeyEvent, QDragEvent, etc.), it translates them into instances of QGraphicsSceneEvent subclasses and forwards them to the QGraphicsScene it displays. The scene then forwards the events to the relevant items.

For example, when a QGraphicsView receives a QMouseEvent of type MousePress as a response to a user click, the view sends a QGraphicsSceneMouseEvent of type GraphicsSceneMousePress to the underlying QGraphicsScene through its \l{QGraphicsScene::}{mousePressEvent()} function. The default QGraphicsScene::mousePressEvent() implementation determines which item was clicked and forwards the event to QGraphicsItem::mousePressEvent().

\omit ### Beskrive widget() \endomit

Subclasses such as QGraphicsSceneMouseEvent and QGraphicsSceneContextMenuEvent provide the coordinates from the original QEvent in screen, scene, and item coordinates (see \l{QGraphicsSceneMouseEvent::}{screenPos()}, \l{QGraphicsSceneMouseEvent::}{scenePos()}, and \l{QGraphicsSceneMouseEvent::}{pos()}). The item coordinates are set by the QGraphicsScene before it forwards the event to the event to a QGraphicsItem. The mouse events also add the possibility to retrieve the coordinates from the last event received by the view (see \l{QGraphicsSceneMouseEvent::}{lastScreenPos()}, \l{QGraphicsSceneMouseEvent::}{lastScenePos()}, and \l{QGraphicsSceneMouseEvent::}{lastPos()}).

See also
QEvent

Definition at line 25 of file qgraphicssceneevent.h.

Constructor & Destructor Documentation

◆ QGraphicsSceneEvent() [1/2]

QGraphicsSceneEvent::QGraphicsSceneEvent ( Type type)
explicit

Constructs a generic graphics scene event of the specified type.

Definition at line 262 of file qgraphicssceneevent.cpp.

References d_ptr, and QGraphicsSceneEventPrivate::q_ptr.

◆ ~QGraphicsSceneEvent()

QGraphicsSceneEvent::~QGraphicsSceneEvent ( )

Destroys the event.

Definition at line 282 of file qgraphicssceneevent.cpp.

◆ QGraphicsSceneEvent() [2/2]

QGraphicsSceneEvent::QGraphicsSceneEvent ( QGraphicsSceneEventPrivate & dd,
Type type = None )
protected

Constructs a generic graphics scene event.

Definition at line 273 of file qgraphicssceneevent.cpp.

References d_ptr, and QGraphicsSceneEventPrivate::q_ptr.

Member Function Documentation

◆ setTimestamp()

void QGraphicsSceneEvent::setTimestamp ( quint64 ts)

Sets the timestamp for the event to ts.

Definition at line 322 of file qgraphicssceneevent.cpp.

References d_ptr, and QGraphicsSceneEventPrivate::timestamp.

Referenced by QGraphicsView::mouseDoubleClickEvent(), QGraphicsViewPrivate::mouseMoveEventHandler(), QGraphicsView::mousePressEvent(), QGraphicsView::mouseReleaseEvent(), QGraphicsProxyWidgetPrivate::sendWidgetMouseEvent(), and QGraphicsViewPrivate::storeDragDropEvent().

+ Here is the caller graph for this function:

◆ setWidget()

void QGraphicsSceneEvent::setWidget ( QWidget * widget)

Sets the widget related to this event.

See also
widget()

Definition at line 302 of file qgraphicssceneevent.cpp.

References d_ptr, QGraphicsSceneEventPrivate::widget, and widget().

Referenced by _q_hoverFromMouseEvent(), QGraphicsScenePrivate::cloneDragDropEvent(), QGraphicsScenePrivate::leaveScene(), QGraphicsView::mouseDoubleClickEvent(), QGraphicsViewPrivate::mouseMoveEventHandler(), QGraphicsView::mousePressEvent(), QGraphicsView::mouseReleaseEvent(), QGraphicsViewPrivate::populateSceneDragDropEvent(), QGraphicsViewPrivate::storeDragDropEvent(), and QGraphicsView::viewportEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ timestamp()

quint64 QGraphicsSceneEvent::timestamp ( ) const
Since
6.2

Returns the timestamp of the original event, or 0 if the original event does not report a time stamp.

Definition at line 313 of file qgraphicssceneevent.cpp.

References d_ptr, and QGraphicsSceneEventPrivate::timestamp.

Referenced by copyMouseEvent().

+ Here is the caller graph for this function:

◆ widget()

QWidget * QGraphicsSceneEvent::widget ( ) const

Returns the widget where the event originated, or \nullptr if the event originates from another application.

Definition at line 290 of file qgraphicssceneevent.cpp.

References d_ptr, and QGraphicsSceneEventPrivate::widget.

Referenced by _q_hoverFromMouseEvent(), QGraphicsScenePrivate::dispatchHoverEvent(), QGraphicsViewPrivate::mouseMoveEventHandler(), QGraphicsScenePrivate::mousePressEventHandler(), QWidgetTextControl::processEvent(), QGraphicsScenePrivate::sendHoverEvent(), QGraphicsScenePrivate::sendMouseEvent(), and setWidget().

+ Here is the caller graph for this function:

Member Data Documentation

◆ d_ptr

QScopedPointer<QGraphicsSceneEventPrivate> QGraphicsSceneEvent::d_ptr
protected

The documentation for this class was generated from the following files: