qtuitools-index.qdoc

Go to the documentation of this file.

// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
 
/*!
    \page qtuitools-index.html
    \title Qt UI Tools
 
    \brief Provides classes to dynamically instantiate UI files created with \QD.
 
    The Qt UI Tools module allows you to instantiate \QD forms (UI files)
    at run-time. This is an alternative to compiling the form into code using the
    \l{User Interface Compiler (uic)}. It enables you to adapt the user interface
    without the need to recompile or restart the application.
 
    UI files can be loaded from various places, such as the application's resources,
    the local file system, or a trusted network source. Once located,
    use the \l QUiLoader class and its \l QUiLoader::load() function to
    instantiate the file.
 
    \section1 Using the Module
 
    \include {module-use.qdocinc} {using the c++ api}
 
    \section2 Building with CMake
 
    \include {module-use.qdocinc} {building with cmake} {UiTools}
 
    \section2 Building with qmake
 
    \include {module-use.qdocinc} {building_with_qmake} {uitools}
 
    \section1 Security Considerations
 
    \include security_considerations.qdocinc
 
    \section1 Examples
 
    \list
        \li \l {Qt UI Tools Examples}
    \endlist
 
    \section1 Reference
 
    \list
        \li \l {Qt UI Tools C++ Classes} {C++ Classes}
    \endlist
 
    \section1 Licenses
 
    Qt UI Tools is available under commercial licenses from \l{The Qt Company}.
    In addition, it is available under free software licenses. Since Qt 6.0,
    these free software licenses are
    \l{GNU Lesser General Public License, version 3}, or
    the \l{GNU General Public License, version 2}.
    See \l{Qt Licensing} for further details.
*/