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
QTimerEvent Class Reference

\inmodule QtCore More...

#include <qcoreevent.h>

Inheritance diagram for QTimerEvent:
Collaboration diagram for QTimerEvent:

Public Member Functions

 QTimerEvent (int timerId)
 Constructs a timer event object with the timer identifier set to timerId.
 QTimerEvent (Qt::TimerId timerId)
int timerId () const
 Returns the unique timer identifier, which is the same identifier as returned from QObject::startTimer().
Qt::TimerId id () const
bool matches (const QBasicTimer &timer) const noexcept
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.

Protected Attributes

Qt::TimerId m_id
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 ,
  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 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)

Detailed Description

\inmodule QtCore

The QTimerEvent class contains parameters that describe a timer event.

Timer events are sent at regular intervals to objects that have started one or more timers. Each timer has a unique identifier. A timer is started with QObject::startTimer().

The QChronoTimer class provides a high-level programming interface that uses signals instead of events.

The event handler QObject::timerEvent() receives timer events.

See also
QChronoTimer, QObject::timerEvent(), QObject::startTimer(), QObject::killTimer()

Definition at line 371 of file qcoreevent.h.

Constructor & Destructor Documentation

◆ QTimerEvent() [1/2]

QTimerEvent::QTimerEvent ( int timerId)
explicit

Constructs a timer event object with the timer identifier set to timerId.

Definition at line 537 of file qcoreevent.cpp.

◆ QTimerEvent() [2/2]

QTimerEvent::QTimerEvent ( Qt::TimerId timerId)
explicit
Since
6.8

Constructs a timer event object with the timer identifier set to timerId.

Definition at line 547 of file qcoreevent.cpp.

Member Function Documentation

◆ id()

Qt::TimerId QTimerEvent::id ( ) const
inline
Since
6.8

Returns the Qt::TimerId of the timer associated with this event, which is the same identifier returned by QObject::startTimer() cast to Qt::TimerId.

Definition at line 379 of file qcoreevent.h.

◆ matches()

bool QTimerEvent::matches ( const QBasicTimer & timer) const
inlinenoexcept
Since
6.9

Returns true if this timer event and timer have the same ID, otherwise returns false.

Definition at line 380 of file qcoreevent.h.

◆ timerId()

int QTimerEvent::timerId ( ) const
inline

Returns the unique timer identifier, which is the same identifier as returned from QObject::startTimer().

Definition at line 378 of file qcoreevent.h.

Member Data Documentation

◆ m_id

Qt::TimerId QTimerEvent::m_id
protected

Definition at line 384 of file qcoreevent.h.

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