Add \brief comments to ActiveQt examples.
[qt:qtactiveqt.git] / src / activeqt / doc / src / examples / webbrowser.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     \example activeqt/webbrowser
30     \title Web Browser Example (ActiveQt)
31
32     \brief The Web Browser example uses the Microsoft Web Browser
33     ActiveX control to implement a fully functional Web Browser
34     application. The user interface has been developed using the Qt
35     Designer integration of the QAxWidget class.
36
37     The code demonstrates how the Qt application can communicate 
38     with the embedded ActiveX controls using signals, slots and the 
39     dynamicCall() function.
40
41     \snippet examples/activeqt/webbrowser/main.cpp 0
42
43     The \c MainWindow class declares a \c QMainWindow based user interface,
44     using the \c Ui::MainWindow class generated by Qt Designer. A number
45     of slots are implemented to handle events from the various user 
46     interface elements, including the \c WebBrowser object, which is a
47     QAxWidget hosting the Microsoft Web Browser control.
48
49     \snippet examples/activeqt/webbrowser/main.cpp 1
50
51     The constructor initializes the user interface, installs a
52     progress bar on the status bar, and uses QAxBase::dynamicCall()
53     to invoke the \c GoHome() method of Internet Explorer to
54     navigate  to the user's home page.
55
56     \snippet examples/activeqt/webbrowser/main.cpp 2
57     Different slots handle the signals emitted by the WebBrowser object.
58
59     Connections that don't require any coding, i.e. connecting the \c back 
60     action to the \c GoBack() slot, have already been made in Qt Designer.
61
62     \snippet examples/activeqt/webbrowser/main.cpp 3
63     \snippet examples/activeqt/webbrowser/main.cpp 4
64
65     The rest of the implementation is not related to ActiveQt - the actions
66     are handled by different slots, and the entry point function starts the
67     application using standard Qt APIs.
68
69     To build the example you must first build the QAxContainer
70     library. Then run your make tool in \c
71     examples/activeqt/webbrowser and run the resulting \c
72     webbrowser.exe.
73 */