Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QGraphicsSceneWheelEvent Class Reference

The QGraphicsSceneWheelEvent class provides wheel events in the graphics view framework. More...

#include <qgraphicssceneevent.h>

+ Inheritance diagram for QGraphicsSceneWheelEvent:
+ Collaboration diagram for QGraphicsSceneWheelEvent:

Public Member Functions

 QGraphicsSceneWheelEvent (Type type=None)
 
 ~QGraphicsSceneWheelEvent ()
 Destroys the QGraphicsSceneWheelEvent.
 
QPointF pos () const
 Returns the position of the cursor in item coordinates when the wheel event occurred.
 
void setPos (const QPointF &pos)
 
QPointF scenePos () const
 Returns the position of the cursor in scene coordinates when the wheel event occurred.
 
void setScenePos (const QPointF &pos)
 
QPoint screenPos () const
 Returns the position of the cursor in screen coordinates when the wheel event occurred.
 
void setScreenPos (const QPoint &pos)
 
Qt::MouseButtons buttons () const
 Returns the mouse buttons that were pressed when the wheel event occurred.
 
void setButtons (Qt::MouseButtons buttons)
 
Qt::KeyboardModifiers modifiers () const
 Returns the keyboard modifiers that were active when the wheel event occurred.
 
void setModifiers (Qt::KeyboardModifiers modifiers)
 
int delta () const
 Returns the distance that the wheel is rotated, in eighths (1/8s) of a degree.
 
void setDelta (int delta)
 
Qt::Orientation orientation () const
 Returns the wheel orientation.
 
void setOrientation (Qt::Orientation orientation)
 
Qt::ScrollPhase phase () const
 
void setPhase (Qt::ScrollPhase scrollPhase)
 
QPoint pixelDelta () const
 
void setPixelDelta (QPoint delta)
 
bool isInverted () const
 Returns whether the delta values delivered with the event are inverted.
 
void setInverted (bool inverted)
 
- Public Member Functions inherited from QGraphicsSceneEvent
 QGraphicsSceneEvent (Type type)
 
 ~QGraphicsSceneEvent ()
 Destroys the event.
 
QWidget * widget () 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 QEvent * clone () const
 Creates and returns an identical copy of this event.
 

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 ,
  SafeAreaMarginsChange = 227 , 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
 
- Protected Member Functions inherited from QGraphicsSceneEvent
 QGraphicsSceneEvent (QGraphicsSceneEventPrivate &dd, Type type=None)
 
- Protected Member Functions inherited from QEvent
 QT_DEFINE_TAG_STRUCT (InputEventTag)
 
 QEvent (Type type, InputEventTag)
 
 QT_DEFINE_TAG_STRUCT (PointerEventTag)
 
 QEvent (Type type, PointerEventTag)
 
 QT_DEFINE_TAG_STRUCT (SinglePointEventTag)
 
 QEvent (Type type, SinglePointEventTag)
 
- Protected Attributes inherited from QGraphicsSceneEvent
QScopedPointer< QGraphicsSceneEventPrivate > d_ptr
 
- Protected Attributes inherited from QEvent
quint16 t
 

Detailed Description

The QGraphicsSceneWheelEvent class provides wheel events in the graphics view framework.

The QGraphicsSceneWheelEvent class provides wheel events in the graphics view framework.

Since
4.2

\inmodule QtWidgets

\l{QWheelEvent}{QWheelEvent}s received by a QGraphicsView are translated into QGraphicsSceneWheelEvents; it translates the QWheelEvent::globalPos() into item, scene, and screen coordinates (pos(), scenePos(), and screenPos()).

See also
QGraphicsSceneMouseEvent, QGraphicsSceneContextMenuEvent, QGraphicsSceneHoverEvent, QWheelEvent

Definition at line 100 of file qgraphicssceneevent.h.

Constructor & Destructor Documentation

◆ QGraphicsSceneWheelEvent()

QGraphicsSceneWheelEvent::QGraphicsSceneWheelEvent ( Type type = None)
explicit

Constructs a QGraphicsSceneWheelEvent of type type, which is always QEvent::GraphicsSceneWheel.

Definition at line 698 of file qgraphicssceneevent.cpp.

◆ ~QGraphicsSceneWheelEvent()

QGraphicsSceneWheelEvent::~QGraphicsSceneWheelEvent ( )

Destroys the QGraphicsSceneWheelEvent.

Definition at line 706 of file qgraphicssceneevent.cpp.

Member Function Documentation

◆ buttons()

Qt::MouseButtons QGraphicsSceneWheelEvent::buttons ( ) const

Returns the mouse buttons that were pressed when the wheel event occurred.

See also
modifiers()

Definition at line 778 of file qgraphicssceneevent.cpp.

◆ delta()

int QGraphicsSceneWheelEvent::delta ( ) const

Returns the distance that the wheel is rotated, in eighths (1/8s) of a degree.

A positive value indicates that the wheel was rotated forwards away from the user; a negative value indicates that the wheel was rotated backwards toward the user.

Most mouse types work in steps of 15 degrees, in which case the delta value is a multiple of 120 (== 15 * 8).

Definition at line 823 of file qgraphicssceneevent.cpp.

◆ isInverted()

bool QGraphicsSceneWheelEvent::isInverted ( ) const

Returns whether the delta values delivered with the event are inverted.

Since
6.2

Definition at line 908 of file qgraphicssceneevent.cpp.

◆ modifiers()

Qt::KeyboardModifiers QGraphicsSceneWheelEvent::modifiers ( ) const

Returns the keyboard modifiers that were active when the wheel event occurred.

See also
buttons()

Definition at line 799 of file qgraphicssceneevent.cpp.

◆ orientation()

Qt::Orientation QGraphicsSceneWheelEvent::orientation ( ) const

Returns the wheel orientation.

Definition at line 841 of file qgraphicssceneevent.cpp.

◆ phase()

Qt::ScrollPhase QGraphicsSceneWheelEvent::phase ( ) const
Since
6.2

Returns the scrolling phase of this wheel event.

See also
QWheelEvent::phase

Definition at line 863 of file qgraphicssceneevent.cpp.

◆ pixelDelta()

QPoint QGraphicsSceneWheelEvent::pixelDelta ( ) const
Since
6.2

Returns the scrolling distance in pixels on screen. This value is provided on platforms that support high-resolution pixel-based delta values, such as \macos. The value should be used directly to scroll content on screen.

See also
QWheelEvent::pixelDelta

Definition at line 888 of file qgraphicssceneevent.cpp.

◆ pos()

QPointF QGraphicsSceneWheelEvent::pos ( ) const

Returns the position of the cursor in item coordinates when the wheel event occurred.

See also
scenePos(), screenPos()

Definition at line 716 of file qgraphicssceneevent.cpp.

◆ scenePos()

QPointF QGraphicsSceneWheelEvent::scenePos ( ) const

Returns the position of the cursor in scene coordinates when the wheel event occurred.

See also
pos(), screenPos()

Definition at line 737 of file qgraphicssceneevent.cpp.

◆ screenPos()

QPoint QGraphicsSceneWheelEvent::screenPos ( ) const

Returns the position of the cursor in screen coordinates when the wheel event occurred.

See also
pos(), scenePos()

Definition at line 758 of file qgraphicssceneevent.cpp.

◆ setButtons()

void QGraphicsSceneWheelEvent::setButtons ( Qt::MouseButtons buttons)

Definition at line 787 of file qgraphicssceneevent.cpp.

◆ setDelta()

void QGraphicsSceneWheelEvent::setDelta ( int delta)

Definition at line 832 of file qgraphicssceneevent.cpp.

◆ setInverted()

void QGraphicsSceneWheelEvent::setInverted ( bool inverted)

Definition at line 917 of file qgraphicssceneevent.cpp.

◆ setModifiers()

void QGraphicsSceneWheelEvent::setModifiers ( Qt::KeyboardModifiers modifiers)

Definition at line 808 of file qgraphicssceneevent.cpp.

◆ setOrientation()

void QGraphicsSceneWheelEvent::setOrientation ( Qt::Orientation orientation)

Definition at line 850 of file qgraphicssceneevent.cpp.

◆ setPhase()

void QGraphicsSceneWheelEvent::setPhase ( Qt::ScrollPhase scrollPhase)

Definition at line 872 of file qgraphicssceneevent.cpp.

◆ setPixelDelta()

void QGraphicsSceneWheelEvent::setPixelDelta ( QPoint pixelDelta)

Definition at line 897 of file qgraphicssceneevent.cpp.

◆ setPos()

void QGraphicsSceneWheelEvent::setPos ( const QPointF & pos)

Definition at line 725 of file qgraphicssceneevent.cpp.

◆ setScenePos()

void QGraphicsSceneWheelEvent::setScenePos ( const QPointF & pos)

Definition at line 746 of file qgraphicssceneevent.cpp.

◆ setScreenPos()

void QGraphicsSceneWheelEvent::setScreenPos ( const QPoint & pos)

Definition at line 767 of file qgraphicssceneevent.cpp.

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