source: trunk/src/testlib/qtestevent.qdoc@ 603

Last change on this file since 603 was 561, checked in by Dmitry A. Kuminov, 15 years ago

trunk: Merged in qt 4.6.1 sources.
  • Property svn:eol-style set to native
File size: 7.4 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the documentation of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and Nokia.
15**
16** GNU Lesser General Public License Usage
17** Alternatively, this file may be used under the terms of the GNU Lesser
18** General Public License version 2.1 as published by the Free Software
19** Foundation and appearing in the file LICENSE.LGPL included in the
20** packaging of this file. Please review the following information to
21** ensure the GNU Lesser General Public License version 2.1 requirements
22** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23**
24** In addition, as a special exception, Nokia gives you certain additional
25** rights. These rights are described in the Nokia Qt LGPL Exception
26** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you have questions regarding the use of this file, please contact
37** Nokia at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42/*!
43 \class QTestEventList
44 \inmodule QtTest
45
46 \brief The QTestEventList class provides a list of GUI events.
47
48 QTestEventList inherits from QList<QTestEvent *>, and provides
49 convenience functions for populating the list.
50
51 A QTestEventList can be populated with GUI events that can be
52 stored as test data for later usage, or be replayed on any
53 QWidget.
54
55 Example:
56 \snippet doc/src/snippets/code/doc_src_qtestevent.qdoc 0
57
58 The example above simulates the user entering the character \c a
59 followed by a backspace, waiting for 200 milliseconds and
60 repeating it.
61*/
62
63/*! \fn QTestEventList::QTestEventList()
64
65 Constructs an empty QTestEventList.
66*/
67
68/*! \fn QTestEventList::QTestEventList(const QTestEventList &other)
69
70 Constructs a new QTestEventList as a copy of \a other.
71*/
72
73/*! \fn QTestEventList::~QTestEventList()
74
75 Empties the list and destroys all stored events.
76*/
77
78/*! \fn void QTestEventList::clear()
79
80 Removes all events from the list.
81*/
82
83/*! \fn void QTestEventList::addKeyClick(Qt::Key qtKey, Qt::KeyboardModifiers modifiers = Qt::NoModifier, int msecs = -1)
84
85 Adds a new key click to the list. The event will simulate the key \a qtKey with the modifier \a modifiers and then wait for \a msecs milliseconds.
86
87 \sa QTest::keyClick()
88*/
89
90/*! \fn void QTestEventList::addKeyPress(Qt::Key qtKey, Qt::KeyboardModifiers modifiers = Qt::NoModifier, int msecs = -1)
91
92 Adds a new key press to the list. The event will press the key \a qtKey with the modifier \a modifiers and then wait for \a msecs milliseconds.
93
94 \sa QTest::keyPress()
95*/
96
97/*! \fn void QTestEventList::addKeyRelease(Qt::Key qtKey, Qt::KeyboardModifiers modifiers = Qt::NoModifier, int msecs = -1)
98
99 Adds a new key release to the list. The event will release the key \a qtKey with the modifier \a modifiers and then wait for \a msecs milliseconds.
100
101 \sa QTest::keyRelease()
102
103*/
104
105/*! \fn void QTestEventList::addKeyEvent(QTest::KeyAction action, Qt::Key qtKey, Qt::KeyboardModifiers modifiers = Qt::NoModifier, int msecs = -1)
106 \internal
107*/
108
109/*! \fn void QTestEventList::addKeyClick(char ascii, Qt::KeyboardModifiers modifiers = Qt::NoModifier, int msecs = -1)
110
111 \overload
112
113 Adds a new key click to the list. The event will simulate the key \a ascii with the modifier \a modifiers and then wait for \a msecs milliseconds.
114
115 \sa QTest::keyClick()
116
117*/
118
119/*! \fn void QTestEventList::addKeyPress(char ascii, Qt::KeyboardModifiers modifiers = Qt::NoModifier, int msecs = -1)
120
121 \overload
122
123 Adds a new key press to the list. The event will press the key \a ascii with the modifier \a modifiers and then wait for \a msecs milliseconds.
124
125 \sa QTest::keyPress()
126*/
127
128/*! \fn void QTestEventList::addKeyRelease(char ascii, Qt::KeyboardModifiers modifiers = Qt::NoModifier, int msecs = -1)
129
130 \overload
131
132 Adds a new key release to the list. The event will release the key \a ascii with the modifier \a modifiers and then wait for \a msecs milliseconds.
133
134 \sa QTest::keyRelease()
135*/
136
137/*! \fn void QTestEventList::addKeyClicks(const QString &keys, Qt::KeyboardModifiers modifiers = Qt::NoModifier, int msecs = -1)
138
139 Adds new keyboard entries to the list. The event will press the \a keys with the \a modifiers and wait \a msecs milliseconds between each key.
140
141 \sa QTest::keyClicks()
142*/
143
144/*! \fn void QTestEventList::addKeyEvent(QTest::KeyAction action, char ascii, Qt::KeyboardModifiers modifiers = Qt::NoModifier, int msecs = -1)
145 \internal
146*/
147
148/*! \fn void QTestEventList::addDelay(int msecs)
149
150 Adds a \a msecs milliseconds delay.
151
152 \sa QTest::qWait()
153*/
154
155/*! \fn void QTestEventList::simulate(QWidget *w)
156
157 Simulates the events from the list one by one on the widget \a w.
158 For an example, please read the \l QTestEventList class documentation.
159*/
160
161/*! \fn void QTestEventList::addMousePress(Qt::MouseButton button, Qt::KeyboardModifiers modifiers = 0, QPoint pos = QPoint(), int delay=-1)
162
163 Add a mouse press to the list. The event will press the \a button with optional \a modifiers at the position \a pos with an optional \a delay. The default position is the center of the widget.
164
165 \sa QTest::mousePress()
166*/
167/*! \fn void QTestEventList::addMouseRelease(Qt::MouseButton button, Qt::KeyboardModifiers modifiers = 0, QPoint pos = QPoint(), int delay=-1)
168
169 Add a mouse release to the list. The event will release the \a button with optional \a modifiers at the position \a pos with an optional \a delay. The default position is the center of the widget.
170
171 \sa QTest::mouseRelease()
172*/
173/*! \fn void QTestEventList::addMouseClick(Qt::MouseButton button, Qt::KeyboardModifiers modifiers = 0, QPoint pos = QPoint(), int delay=-1)
174
175 Add a mouse click to the list. The event will click the \a button with optional \a modifiers at the position \a pos with an optional \a delay. The default position is the center of the widget.
176
177 \sa QTest::mouseClick()
178*/
179/*! \fn void QTestEventList::addMouseDClick(Qt::MouseButton button, Qt::KeyboardModifiers modifiers = 0, QPoint pos = QPoint(), int delay=-1)
180
181 Add a double mouse click to the list. The event will double click the \a button with optional \a modifiers at the position \a pos with an optional \a delay. The default position is the center of the widget.
182
183 \sa QTest::mousePress()
184*/
185/*! \fn void QTestEventList::addMouseMove(QPoint pos = QPoint(), int delay=-1)
186
187 Adds a mouse move to the list. The event will move the mouse to the position \a pos. If a \a delay (in milliseconds) is set, the test will wait after moving the mouse. The default position is the center of the widget.
188
189 \sa QTest::mousePress()
190*/
191
Note: See TracBrowser for help on using the repository browser.