Qt 4.8
qtimer.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtCore module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QTIMER_H
43 #define QTIMER_H
44 
45 #ifndef QT_NO_QOBJECT
46 
47 #include <QtCore/qbasictimer.h> // conceptual inheritance
48 #include <QtCore/qobject.h>
49 
51 
53 
54 QT_MODULE(Core)
55 
57 {
58  Q_OBJECT
59  bool singleShot;
60  int interval;
61  bool active;
62 public:
63  explicit QTimer(QObject *parent = 0);
64 #ifdef QT3_SUPPORT
65  QT3_SUPPORT_CONSTRUCTOR QTimer(QObject *parent, const char *name);
66 #endif
67  ~QTimer();
68 
69  inline bool isActive() const { return id >= 0; }
70  int timerId() const { return id; }
71 
72  void setInterval(int msec);
73  int interval() const { return inter; }
74 
75  inline void setSingleShot(bool singleShot);
76  inline bool isSingleShot() const { return single; }
77 
78  static void singleShot(int msec, QObject *receiver, const char *member);
79 
80 public Q_SLOTS:
81  void start(int msec);
82 
83  void start();
84  void stop();
85 
86 #ifdef QT3_SUPPORT
87  inline QT_MOC_COMPAT void changeInterval(int msec) { start(msec); }
88  QT_MOC_COMPAT int start(int msec, bool sshot);
89 #endif
90 
91 Q_SIGNALS:
92  void timeout();
93 
94 protected:
95  void timerEvent(QTimerEvent *);
96 
97 private:
99 
100  inline int startTimer(int){ return -1;}
101  inline void killTimer(int){}
102 
103  int id, inter, del;
106 };
107 
108 inline void QTimer::setSingleShot(bool asingleShot) { single = asingleShot; }
109 
111 
113 
114 #endif // QT_NO_QOBJECT
115 
116 #endif // QTIMER_H
#define QT_MOC_COMPAT
Definition: qglobal.h:1128
void setSingleShot(bool singleShot)
Definition: qtimer.h:108
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
#define QT_MODULE(x)
Definition: qglobal.h:2783
bool isSingleShot() const
Definition: qtimer.h:76
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
#define Q_SLOTS
Definition: qobjectdefs.h:71
uint nulltimer
Definition: qtimer.h:105
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
#define Q_SIGNALS
Definition: qobjectdefs.h:72
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
int timerId() const
Returns the ID of the timer if the timer is running; otherwise returns -1.
Definition: qtimer.h:70
int interval
the timeout interval in milliseconds
Definition: qtimer.h:60
const char * name
void killTimer(int)
Definition: qtimer.h:101
unsigned int uint
Definition: qglobal.h:996
bool isActive() const
Returns true if the timer is running (pending); otherwise returns false.
Definition: qtimer.h:69
bool active
This boolean property is true if the timer is running; otherwise false.
Definition: qtimer.h:61
#define Q_OBJECT
Definition: qobjectdefs.h:157
int interval() const
Definition: qtimer.h:73
#define Q_CORE_EXPORT
Definition: qglobal.h:1449
The QTimerEvent class contains parameters that describe a timer event.
Definition: qcoreevent.h:341
bool singleShot
This static function calls a slot after a given time interval.
Definition: qtimer.h:59
int inter
Definition: qtimer.h:103
uint single
Definition: qtimer.h:104
The QTimer class provides repetitive and single-shot timers.
Definition: qtimer.h:56
#define class
#define QT_END_HEADER
Definition: qglobal.h:137