Add new method to get the main Android activity.
[qt:qtandroidextras.git] / src / androidextras / doc / src / qtandroidextras-index.qdoc
1 /****************************************************************************
2 **
3 ** Copyright (C) 2013 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 qtandroidextras-index.html
30     \title Qt Android Extras
31
32     \brief The Qt Android Extras module contains adittional functionality to aid development on Android.
33
34     \section1 Getting Started
35
36     To include the definitions of the module's classes, use the
37     following directive:
38
39     \code
40     #include <QtAndroidExtras>
41     \endcode
42
43     To link against the Qt Android Extras module, add this line to your project file:
44
45     \code
46     QT += androidextras
47     \endcode
48
49     \section1 API Reference
50
51     Links to the API reference materials:
52     \list
53     \li \l{Qt Android Extras C++ Classes}{C++ Classes and Namespaces}
54     \endlist
55
56     \section1 Examples
57
58     \list
59     \li \l{Qt Android Extras Examples}
60     \endlist
61 */