summaryrefslogtreecommitdiff
path: root/src/designer/src/uitools/doc/src/qtuitools-module.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/designer/src/uitools/doc/src/qtuitools-module.qdoc')
-rw-r--r--src/designer/src/uitools/doc/src/qtuitools-module.qdoc58
1 files changed, 58 insertions, 0 deletions
diff --git a/src/designer/src/uitools/doc/src/qtuitools-module.qdoc b/src/designer/src/uitools/doc/src/qtuitools-module.qdoc
new file mode 100644
index 000000000..99e892058
--- /dev/null
+++ b/src/designer/src/uitools/doc/src/qtuitools-module.qdoc
@@ -0,0 +1,58 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \module QtUiTools
+ \title Qt UI Tools C++ Classes
+ \since 4.1
+ \ingroup modules
+
+ \brief Provides classes to handle forms created with Qt Designer.
+
+ These forms are processed at run-time to produce dynamically-generated
+ user interfaces. In order to generate a form at run-time, a resource
+ file containing a UI file is needed. Applications that use the
+ form handling classes need to be configured to be built against the
+ QtUiTools module. This is done by including the following declaration
+ in a \c qmake project file to ensure that the application is compiled
+ and linked appropriately.
+
+ \snippet quiloader/doc_src_qtuiloader.pro 0
+
+ A form loader object, provided by the QUiLoader class, is used to
+ construct the user interface. This user interface can
+ be retrieved from any QIODevice; for example, a QFile object can be
+ used to obtain a form stored in a project's resources. The
+ QUiLoader::load() function takes the user interface description
+ contained in the file and constructs the form widget.
+
+ To include the definitions of the module's classes, use the following
+ directive:
+
+ \snippet quiloader/doc_src_qtuiloader.cpp 1
+
+*/