1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\example tools/customtypesending
\title Custom Type Sending Example
The Custom Type Sending example shows how to use a custom type with signals
and slots.
\image customtypesending-example.png
Contents:
\tableofcontents
\section1 Overview
In the \l{Custom Type Example}, we showed how to integrate custom types
with the meta-object system, enabling them to be stored in QVariant
objects, written out in debugging information and used in signal-slot
communication.
In this example, we demonstrate that the preparations made to the
\c Message class and its declaration with Q_DECLARE_METATYPE() enable it
to be used with direct signal-slot connections. We do this by creating
a \c Window class containing signals and slots whose signatures include
\c Message arguments.
\section1 The Window Class Definition
We define a simple \c Window class with a signal and public slot that
allow a \c Message object to be sent via a signal-slot connection:
\snippet examples/tools/customtypesending/window.h Window class definition
The window will contain a text editor to show the contents of a message
and a push button that the user can click to send a message. To facilitate
this, we also define the \c sendMessage() slot. We also keep a \c Message
instance in the \c thisMessage private variable which holds the actual
message to be sent.
\section1 The Window Class Implementation
The \c Window constructor sets up a user interface containing a text
editor and a push button.
\snippet examples/tools/customtypesending/window.cpp Window constructor
The button's \l{QPushButton::}{clicked()} signal is connected to the
window's \c{sendMessage()} slot, which emits the \c{messageSent(Message)}
signal with the \c Message held by the \c thisMessage variable:
\snippet examples/tools/customtypesending/window.cpp sending a message
We implement a slot to allow the message to be received, and this also
lets us set the message in the window programatically:
\snippet examples/tools/customtypesending/window.cpp receiving a message
In this function, we simply assign the new message to \c thisMessage
and update the text in the editor.
\section1 Making the Connection
In the example's \c{main()} function, we perform the connection between
two instances of the \c Window class:
\snippet examples/tools/customtypesending/main.cpp main function
We set the message for the first window and connect the
\c{messageSent(Message)} signal from each window to the other's
\c{setMessage(Message)} slot. Since the signals and slots mechanism is only
concerned with the type, we can simplify the signatures of both the
signal and slot when we make the connection.
When the user clicks on the \gui{Send message} button in either window,
the message shown will be emitted in a signal that the other window will
receive and display.
\section1 Further Reading
Although the custom \c Message type can be used with direct signals and
slots, an additional registration step needs to be performed if you want
to use it with queued signal-slot connections. See the
\l{Queued Custom Type Example} for details.
More information on using custom types with Qt can be found in the
\l{Creating Custom Qt Types} document.
*/
|