diff options
Diffstat (limited to 'src/widgets/doc/src/qtwidgets-index.qdoc')
-rw-r--r-- | src/widgets/doc/src/qtwidgets-index.qdoc | 98 |
1 files changed, 36 insertions, 62 deletions
diff --git a/src/widgets/doc/src/qtwidgets-index.qdoc b/src/widgets/doc/src/qtwidgets-index.qdoc index 1a23d172dd..3894467ccf 100644 --- a/src/widgets/doc/src/qtwidgets-index.qdoc +++ b/src/widgets/doc/src/qtwidgets-index.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2018 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$ -** -****************************************************************************/ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page qtwidgets-index.html @@ -35,21 +11,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. @@ -61,11 +22,10 @@ interfaces \image parent-child-widgets.png A parent widget containing various child widgets. The QWidget class provides the basic capability to render to the - screen, and to handle user input events. All UI elements that Qt - provides are either subclasses of QWidget, or are used in connection - with a QWidget subclass. Creating custom widgets is done by - subclassing QWidget or a suitable subclass and reimplementing the - virtual event handlers. + screen and to handle user input events. All UI elements that Qt + provides are either subclasses of QWidget or are used in connection + with a QWidget subclass. To create custom widgets, subclass QWidget or a + suitable subclass and reimplement the virtual event handlers. \list \li \l{Window and Dialog Widgets} @@ -88,8 +48,9 @@ interfaces \li \image macos-tabwidget.png \endtable - \l{Qt Style Sheets} are a powerful mechanism that allows you to customize the - appearance of widgets, in addition to what is already possible by subclassing QStyle. + \l{Qt Style Sheets} are a powerful mechanism that lets you customize + the appearance of widgets, in addition to what is already possible by + subclassing QStyle. \section1 Layouts @@ -106,7 +67,7 @@ interfaces \li \image qformlayout-with-6-children.png \endtable - \l {Qt Designer} is a powerful tool for interactively creating and + \l {Qt Widgets Designer} is a powerful tool for interactively creating and arranging widgets in layouts. @@ -128,35 +89,36 @@ interfaces \image graphicsview-items.png - \section1 Licenses + \section1 Using the Module - The Qt Widgets module is available under commercial licenses from \l{The Qt Company}. - In addition, it is available under free software licenses. Since Qt 5.4, - 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. + \include {module-use.qdocinc} {using the c++ api} + + \section2 Building with CMake - \section1 Related Information + \include {module-use.qdocinc} {building with cmake} {Widgets} + + \section2 Building with qmake + + \include {module-use.qdocinc} {building_with_qmake} {widgets} + + \section1 Articles and Guides - \section2 Tutorials \list \li \l{Widgets Tutorial} \li \l{Getting Started Programming with Qt Widgets} \li \l{Creating a Qt Widget Based Application} - - \li \l{Model/View Tutorial} \endlist - \section2 Examples + \section1 Examples + \list \li \l{Qt Widgets Examples} \li \l{Layout Examples} + \li \l{Tools Examples} \endlist \section1 API Reference - These are links to the API reference materials. \list \li \l{Qt Widgets C++ Classes} @@ -174,4 +136,16 @@ interfaces \li \l{Qt Style Sheets Reference} \endlist + \section1 Module Evolution + + \l{Changes to Qt Widgets} lists important changes in the module API + and functionality that were done for the Qt 6 series of Qt. + + \section1 Licenses + + The Qt Widgets module is available under commercial licenses from \l{The Qt Company}. + In addition, it is available under free software licenses: + The \l{GNU Lesser General Public License, version 3}, or + the \l{GNU General Public License, version 2}. + See \l{Qt Licensing} for further details. */ |