Add \brief comments to ActiveQt examples.
[qt:qtactiveqt.git] / src / activeqt / doc / src / examples / multiple.qdoc
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the documentation of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:FDL$
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 Free Documentation License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Free
19 ** Documentation License version 1.3 as published by the Free Software
20 ** Foundation and appearing in the file included in the packaging of
21 ** this file.  Please review the following information to ensure
22 ** the GNU Free Documentation License version 1.3 requirements
23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
24 ** $QT_END_LICENSE$
25 **
26 ****************************************************************************/
27
28 /*!
29     \page qaxserver-demo-multiple.html
30     \title Two Simple Qt Widgets
31
32     \input examples/multiple-demo.qdocinc
33 */
34
35 /*!
36     \example activeqt/multiple
37     \title Multiple Example (ActiveQt)
38
39     \brief The Multiple example demonstrates the implementation of a
40     QAxFactory to provide multiple ActiveX controls in a single in
41     process ActiveX server using the \c QAXFACTORY_EXPORT() macro.
42     The ActiveX controls in this example are simple QWidget
43     subclasses that reimplement QWidget::paintEvent().
44
45     \snippet examples/activeqt/multiple/ax1.h 0
46
47     The first control draws a filled rectangle. The fill color is exposed
48     as a property. \c Q_CLASSINFO() is used to specify the COM identifiers.
49
50     \snippet examples/activeqt/multiple/ax2.h 0
51
52     The second control draws a circle. The linewith is exposed as a property.
53     \c Q_CLASSINFO() is used to specify the COM identifiers, and to set the
54     attributes \e ToSuperClass and \e StockEvents to expose only the API of
55     the class itself, and to add COM stock events to the ActiveX control.
56
57     \snippet examples/activeqt/multiple/main.cpp 0
58
59     The classes are exported from the server using the QAxFactory macros.
60
61     To build the example you must first build the QAxServer library.
62     Then run \c qmake and your make tool in  \c
63     examples/activeqt/multiple.
64
65     The \l{qaxserver-demo-multiple.html}{demonstration} requires your
66     WebBrowser to support ActiveX controls, and scripting to be
67     enabled.
68
69     \snippet examples/multiple-demo.qdocinc 0
70 */