From 32a39c4ed1802eab7454d3e6007ff02aa9581b66 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Fri, 22 May 2020 16:12:02 +0200 Subject: Document how to use CMake for Qt Widgets Task-number: QTBUG-73058 Change-Id: Ida459635e159334a4ef67979c0d28b1553317ea9 Reviewed-by: Paul Wicking --- src/widgets/doc/qtwidgets.qdocconf | 3 +- src/widgets/doc/snippets/CMakeLists.txt | 4 ++ .../doc/snippets/code/doc_src_qtwidgets.cpp | 53 ---------------------- .../doc/snippets/code/doc_src_qtwidgets.pro | 3 -- src/widgets/doc/snippets/snippets.pro | 6 ++- src/widgets/doc/src/qtwidgets-index.qdoc | 25 ++++------ src/widgets/doc/src/qtwidgets.qdoc | 14 +----- 7 files changed, 21 insertions(+), 87 deletions(-) create mode 100644 src/widgets/doc/snippets/CMakeLists.txt delete mode 100644 src/widgets/doc/snippets/code/doc_src_qtwidgets.cpp delete mode 100644 src/widgets/doc/snippets/code/doc_src_qtwidgets.pro (limited to 'src/widgets/doc') diff --git a/src/widgets/doc/qtwidgets.qdocconf b/src/widgets/doc/qtwidgets.qdocconf index 548224bf61..e2e96bdf3d 100644 --- a/src/widgets/doc/qtwidgets.qdocconf +++ b/src/widgets/doc/qtwidgets.qdocconf @@ -30,7 +30,7 @@ qhp.QtWidgets.subprojects.classes.sortPages = true tagfile = ../../../doc/qtwidgets/qtwidgets.tags -depends += qtcore qtgui qtdoc qtsql qtdesigner qtquick qmake qtplatformheaders qtsvg qtlinguist +depends += qtcore qtgui qtdoc qtsql qtdesigner qtquick qmake qtcmake qtplatformheaders qtsvg qtlinguist headerdirs += .. @@ -40,6 +40,7 @@ sourcedirs += .. \ exampledirs += ../../../examples/widgets \ ../../../doc/src/snippets \ ../ \ + . / \ snippets excludedirs += snippets diff --git a/src/widgets/doc/snippets/CMakeLists.txt b/src/widgets/doc/snippets/CMakeLists.txt new file mode 100644 index 0000000000..66ce019f33 --- /dev/null +++ b/src/widgets/doc/snippets/CMakeLists.txt @@ -0,0 +1,4 @@ +#! [cmake_use] +find_package(Qt6 COMPONENTS Widgets REQUIRED) +target_link_libraries(mytarget Qt::Widgets) +#! [cmake_use] diff --git a/src/widgets/doc/snippets/code/doc_src_qtwidgets.cpp b/src/widgets/doc/snippets/code/doc_src_qtwidgets.cpp deleted file mode 100644 index c0a57e527c..0000000000 --- a/src/widgets/doc/snippets/code/doc_src_qtwidgets.cpp +++ /dev/null @@ -1,53 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:BSD$ -** 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. -** -** BSD License Usage -** Alternatively, you may use this file under the terms of the BSD license -** as follows: -** -** "Redistribution and use in source and binary forms, with or without -** modification, are permitted provided that the following conditions are -** met: -** * Redistributions of source code must retain the above copyright -** notice, this list of conditions and the following disclaimer. -** * Redistributions in binary form must reproduce the above copyright -** notice, this list of conditions and the following disclaimer in -** the documentation and/or other materials provided with the -** distribution. -** * Neither the name of The Qt Company Ltd nor the names of its -** contributors may be used to endorse or promote products derived -** from this software without specific prior written permission. -** -** -** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -//! [1] -#include -//! [1] diff --git a/src/widgets/doc/snippets/code/doc_src_qtwidgets.pro b/src/widgets/doc/snippets/code/doc_src_qtwidgets.pro deleted file mode 100644 index 2fee715c24..0000000000 --- a/src/widgets/doc/snippets/code/doc_src_qtwidgets.pro +++ /dev/null @@ -1,3 +0,0 @@ -#! [0] -QT += widgets -#! [0] diff --git a/src/widgets/doc/snippets/snippets.pro b/src/widgets/doc/snippets/snippets.pro index 6284e84913..fcfd998373 100644 --- a/src/widgets/doc/snippets/snippets.pro +++ b/src/widgets/doc/snippets/snippets.pro @@ -2,7 +2,11 @@ TEMPLATE = lib TARGET = widgets_snippets -QT += widgets printsupport opengl openglwidgets +#! [qmake_use] +QT += widgets +#! [qmake_use] + +QT += printsupport opengl openglwidgets SOURCES += customviewstyle.cpp \ filedialogurls.cpp \ diff --git a/src/widgets/doc/src/qtwidgets-index.qdoc b/src/widgets/doc/src/qtwidgets-index.qdoc index db09b57863..d41da1673f 100644 --- a/src/widgets/doc/src/qtwidgets-index.qdoc +++ b/src/widgets/doc/src/qtwidgets-index.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -35,21 +35,6 @@ interfaces elements to create classic desktop-style user interfaces. See the \l {User Interfaces} overview for more information on using widgets. -\section1 Getting Started - - To include the definitions of the module's classes, use the - following directive: - - \snippet code/doc_src_qtwidgets.cpp 1 - - To link against the module, add this line to your \l qmake \c - .pro file: - - \snippet code/doc_src_qtwidgets.pro 0 - - - - \section1 Widgets Widgets are the primary elements for creating user interfaces in Qt. @@ -128,6 +113,14 @@ interfaces \image graphicsview-items.png + \include module-use.qdocinc using qt module + \snippet snippets/CMakeLists.txt cmake_use + + See also the \l[QtDoc]{Building with CMake} overview. + + \include module-use.qdocinc building with qmake + \snippet snippets/snippets.pro qmake_use + \section1 Licenses The Qt Widgets module is available under commercial licenses from \l{The Qt Company}. diff --git a/src/widgets/doc/src/qtwidgets.qdoc b/src/widgets/doc/src/qtwidgets.qdoc index 72ba22681c..59ef6288aa 100644 --- a/src/widgets/doc/src/qtwidgets.qdoc +++ b/src/widgets/doc/src/qtwidgets.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -32,17 +32,5 @@ \qtvariable widgets \brief The Qt Widgets module extends Qt GUI with C++ widget functionality. - - To include the definitions of the module's classes, use the - following directive: - - \snippet code/doc_src_qtwidgets.cpp 1 - - \if !defined(qtforpython) - To link against the module, add this line to your \l qmake \c - .pro file: - - \snippet code/doc_src_qtwidgets.pro 0 - \endif */ -- cgit v1.2.3