From dcc11ef27784e58efa798a157309d547ad6eba39 Mon Sep 17 00:00:00 2001 From: Alexei Cazacov Date: Fri, 11 Oct 2024 13:52:11 +0300 Subject: [PATCH] Organize the tutorials in Qt Widgets so they are visible and reachable This commit makes visible in the TOC: - both of the tutorials - a set of examples for completer, undo framework, and regex'es Fixes: QTBUG-129818 Change-Id: Id6636782789c4e5b11349af3c4fb33f75035f1a0 Reviewed-by: Paul Wicking --- .../tutorials/notepad/gettingstartedqt.qdoc | 3 ++- src/widgets/doc/src/qtwidgets-examples.qdoc | 13 +++++++++++++ src/widgets/doc/src/qtwidgets-toc.qdoc | 9 ++------- src/widgets/doc/src/qtwidgets-tutorials.qdoc | 15 +++++++++++++++ src/widgets/doc/src/widgets-tutorial.qdoc | 2 +- 5 files changed, 33 insertions(+), 9 deletions(-) create mode 100644 src/widgets/doc/src/qtwidgets-tutorials.qdoc diff --git a/examples/widgets/tutorials/notepad/gettingstartedqt.qdoc b/examples/widgets/tutorials/notepad/gettingstartedqt.qdoc index e9aa8ce7909..1ed862e6205 100644 --- a/examples/widgets/tutorials/notepad/gettingstartedqt.qdoc +++ b/examples/widgets/tutorials/notepad/gettingstartedqt.qdoc @@ -2,8 +2,9 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! - \example tutorials/notepad + \page widgets-getting-started.html \title Getting Started Programming with Qt Widgets + \ingroup widget-tutorials \examplecategory {User Interface Components} \brief A tutorial for Qt Widgets based notepad application. diff --git a/src/widgets/doc/src/qtwidgets-examples.qdoc b/src/widgets/doc/src/qtwidgets-examples.qdoc index d1daa843f80..b864402dd5d 100644 --- a/src/widgets/doc/src/qtwidgets-examples.qdoc +++ b/src/widgets/doc/src/qtwidgets-examples.qdoc @@ -142,3 +142,16 @@ also supports keyboard shortcuts and accelerator keys in menu items. */ + +/*! + \group examples-widgets-tools + \ingroup all-examples + \title Widget Tools Examples + \brief Using autocomplete features, regular expressions, and undo framework. + + \image completer-example.png + + Qt provides the functionality for autocomplete, Undo/Redo actions, and + regular expressions for the Widget-based applications. + +*/ diff --git a/src/widgets/doc/src/qtwidgets-toc.qdoc b/src/widgets/doc/src/qtwidgets-toc.qdoc index 8b31c583288..bc447b8bd58 100644 --- a/src/widgets/doc/src/qtwidgets-toc.qdoc +++ b/src/widgets/doc/src/qtwidgets-toc.qdoc @@ -42,13 +42,7 @@ \li \l {Gestures in Widgets and Graphics View} \li \l {Graphics View Framework} \li \l {Changes to Qt Widgets}{Upgrading form Qt 5} - \li \l {Widgets Tutorial} - \list - \li \l{Widgets Tutorial - Creating a Window}{Creating a Window} - \li \l{Widgets Tutorial - Child Widgets}{Child Widgets} - \li \l{Widgets Tutorial - Using Layouts}{Using Layouts} - \li \l{Widgets Tutorial - Nested Layouts}{Nested Layouts} - \endlist + \li \l {Qt Widgets Tutorials}{Tutorials} \li \l {Qt Widgets Examples}{Examples} \list \li \l{Main Window Examples} @@ -58,6 +52,7 @@ \li \l{Painting Examples} \li \l{Rich Text Examples} \li \l{Graphics View Examples} + \li \l{Widget Tools Examples} \endlist \endlist diff --git a/src/widgets/doc/src/qtwidgets-tutorials.qdoc b/src/widgets/doc/src/qtwidgets-tutorials.qdoc new file mode 100644 index 00000000000..3e09a57f2d6 --- /dev/null +++ b/src/widgets/doc/src/qtwidgets-tutorials.qdoc @@ -0,0 +1,15 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page widget-tutorials.html + \title Qt Widgets Tutorials + \brief Tutorials of how to use different kinds of widgets. + + \image notepad1.png "Notepad application" + + Qt comes with a large range of standard widgets that users of modern + applications have come to expect. + + \annotatedlist widget-tutorials +*/ diff --git a/src/widgets/doc/src/widgets-tutorial.qdoc b/src/widgets/doc/src/widgets-tutorial.qdoc index e0ad4d850c0..f6212da636f 100644 --- a/src/widgets/doc/src/widgets-tutorial.qdoc +++ b/src/widgets/doc/src/widgets-tutorial.qdoc @@ -3,7 +3,7 @@ /*! \page widgets-tutorial.html - \ingroup tutorials + \ingroup widget-tutorials \title Widgets Tutorial \brief This tutorial covers basic usage of widgets and layouts, showing how they are used to build GUI applications.