QScrollEvent Class Reference

The QScrollEvent class is sent when scrolling. More...

#include <qevent.h>

Inheritance diagram for QScrollEvent:

Collaboration diagram for QScrollEvent:

Public Types
enum	ScrollState { ScrollStarted , ScrollUpdated , ScrollFinished }
	This enum describes the states a scroll event can have. More...
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...

Public Member Functions
	QScrollEvent (const QPointF &contentPos, const QPointF &overshoot, ScrollState scrollState)
	Creates a new QScrollEvent contentPos is the new content position, overshootDistance is the new overshoot distance while scrollState indicates if this scroll event is the first one, the last one or some event in between.
QPointF	contentPos () const
	Returns the new scroll position.
QPointF	overshootDistance () const
	Returns the new overshoot distance.
ScrollState	scrollState () const
	Returns the current scroll state as a combination of ScrollStateFlag values.
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
Static Public Member Functions inherited from QEvent
static int	registerEventType (int hint=-1) noexcept
Protected Member Functions inherited from QEvent
	QEvent (Type type, InputEventTag)
	QEvent (Type type, PointerEventTag)
	QEvent (Type type, SinglePointEventTag)
Protected Attributes inherited from QEvent
quint16	t

Detailed Description

The QScrollEvent class is sent when scrolling.

Since

4.8

\inmodule QtGui

The scroll event is sent to indicate that the receiver should be scrolled. Usually the receiver should be something visual like QWidget or QGraphicsObject.

Some care should be taken that no conflicting QScrollEvents are sent from two sources. Using QScroller::scrollTo is save however.

See also

QScrollPrepareEvent, QScroller

Definition at line 975 of file qevent.h.

Member Enumeration Documentation

ScrollState

enum QScrollEvent::ScrollState

This enum describes the states a scroll event can have.

\value ScrollStarted Set for the first scroll event of a scroll activity.

\value ScrollUpdated Set for all but the first and the last scroll event of a scroll activity.

\value ScrollFinished Set for the last scroll event of a scroll activity.

See also

QScrollEvent::scrollState()

Enumerator
ScrollStarted
ScrollUpdated
ScrollFinished

Definition at line 979 of file qevent.h.

Constructor & Destructor Documentation

QScrollEvent()

QScrollEvent::QScrollEvent	(	const QPointF &	contentPos,
		const QPointF &	overshoot,
		ScrollState	scrollState )

Creates a new QScrollEvent contentPos is the new content position, overshootDistance is the new overshoot distance while scrollState indicates if this scroll event is the first one, the last one or some event in between.

Definition at line 4687 of file qevent.cpp.

Member Function Documentation

contentPos()

QPointF QScrollEvent::contentPos ( ) const

inline

Returns the new scroll position.

Definition at line 988 of file qevent.h.

Referenced by operator<<().

Here is the caller graph for this function:

overshootDistance()

QPointF QScrollEvent::overshootDistance ( ) const

inline

Returns the new overshoot distance.

See QScroller for an explanation of the term overshoot.

See also

QScroller

Definition at line 989 of file qevent.h.

scrollState()

QScrollEvent::ScrollState QScrollEvent::scrollState ( ) const

inline

Returns the current scroll state as a combination of ScrollStateFlag values.

ScrollStarted (or ScrollFinished) will be set, if this scroll event is the first (or last) event in a scrolling activity. Please note that both values can be set at the same time, if the activity consists of a single QScrollEvent. All other scroll events in between will have their state set to ScrollUpdated.

A widget could for example revert selections when scrolling is started and stopped.

Definition at line 990 of file qevent.h.

---

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

• qtbase/src/gui/kernel/qevent.h (460b0f98c656643f36729fe3b0abc1ba361481b0)
• qtbase/src/gui/kernel/qevent.cpp (14610fb1749a22abbd203f42e3edb3f4425cb215)