AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: Update CMake functions in Qt Widgets for Qt 6

Browse Source 
Pick-to: 6.0 6.0.0
Change-Id: I4110e8695c75c40cec6f94bb94879b07282b29d3
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
This commit is contained in:
Kai Koehne 2020-11-18 14:26:47 +01:00
parent 9e1aa7fc5f
commit c082213556
3 changed files with 12 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/widgets/doc/snippets/cmake-macros/examples.cmake
View File

@ -1,9 +1,3 @@
#! [qt5_wrap_ui]
set(SOURCES mainwindow.cpp main.cpp)
qt5_wrap_ui(SOURCES mainwindow.ui)
add_executable(myapp ${SOURCES})
#! [qt5_wrap_ui]
#! [qt_wrap_ui]
set(SOURCES mainwindow.cpp main.cpp)
qt_wrap_ui(SOURCES mainwindow.ui)

46
src/widgets/doc/src/cmake-macros.qdoc
View File

@ -26,40 +26,11 @@
****************************************************************************/
/*!
\page qtwidgets-cmake-qt5-wrap-ui.html
\ingroup cmake-macros-qtwidgets
\title qt5_wrap_ui
\brief Creates sources for \c{.ui} files.
\section1 Synopsis
\badcode
qt5_wrap_ui(<VAR> ui_file1 [ui_file2 ...]
[OPTIONS ...])
\endcode
\section1 Description
\include includes/qt_wrap_ui.qdocinc description
\note For compatibility with Qt 6, the command is also available under the name \l qt_wrap_ui.
\section1 Options
\include includes/qt_wrap_ui.qdocinc options
\section1 Examples
\snippet cmake-macros/examples.cmake qt5_wrap_ui
*/
/*!
\page qtwidgets-cmake-qt-wrap-ui.html
\page qt_wrap_ui.html
\ingroup cmake-macros-qtwidgets
\title qt_wrap_ui
\target qt6_wrap_ui
\brief Creates sources for \c{.ui} files.
@ -68,17 +39,24 @@ qt5_wrap_ui(<VAR> ui_file1 [ui_file2 ...]
\badcode
qt_wrap_ui(<VAR> ui_file1 [ui_file2 ...]
[OPTIONS ...])
qt6_wrap_ui(<VAR> ui_file1 [ui_file2 ...]
[OPTIONS ...])
\endcode
\section1 Description
\include includes/qt_wrap_ui.qdocinc description
Creates rules for calling the \l{uic}{User Interface Compiler (uic)} on the given
\c{.ui} files. For each input file, an header file is generated in the build
directory. The paths of the generated header files are added to \c{<VAR>}.
This command was introduced in Qt 5.15. You can use \l qt5_wrap_ui in older versions of Qt.
\note This is a low-level macro. See the \l{CMake AUTOUIC Documentation} for a
more convenient way to process \c{.ui} files with \c{uic}.
\section1 Options
\include includes/qt_wrap_ui.qdocinc options
You can set additional \c{OPTIONS} that should be added to the \c{uic} calls.
You can find possible options in the \l{uic}{uic documentation}.
\section1 Examples

40
src/widgets/doc/src/includes/qt_wrap_ui.qdocinc
View File

@ -1,40 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
//! [description]
Creates rules for calling the \l{uic}{User Interface Compiler (uic)} on the given
\c{.ui} files. For each input file, an header file is generated in the build
directory. The paths of the generated header files are added to \c{<VAR>}.
\note This is a low-level macro. See the \l{CMake AUTOUIC Documentation} for a
more convenient way to process \c{.ui} files with \c{uic}.
//! [description]
//! [options]
You can set additional \c{OPTIONS} that should be added to the \c{uic} calls.
You can find possible options in the \l{uic}{uic documentation}.
//! [options]