aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2020-11-04 23:38:09 +0100
committerVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2020-11-06 15:06:25 +0100
commite3a31e9d1e9c5d468af9c4e1a342679007e65cc6 (patch)
treeb068521532af36a5f32eeea99c3ea8c894411281 /src
parent749debe64f5da2078039991b9f8522f2af0698b1 (diff)
Doc: Fix qdoc warnings
Mostly broken links to types and properties that are either dropped or renamed. Task-number: QTBUG-88141 Fixes: QTBUG-88141 Change-Id: I44789cdd1b8560a967b0b3868fd637deef488d88 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/imports/controls/doc/src/external-pages.qdoc31
-rw-r--r--src/imports/controls/doc/src/qt6-changes.qdoc8
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-configuration.qdoc7
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-differences.qdoc689
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-fusion.qdoc6
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-imagine.qdoc4
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-index.qdoc5
-rw-r--r--src/imports/platform/qquickplatformmenu.cpp2
-rw-r--r--src/quicktemplates2/qquickcombobox.cpp10
-rw-r--r--src/quicktemplates2/qquickdialog.cpp2
-rw-r--r--src/quicktemplates2/qquickdrawer.cpp7
-rw-r--r--src/quicktemplates2/qquickmenu.cpp2
-rw-r--r--src/quicktemplates2/qquickpane.cpp8
-rw-r--r--src/quicktemplates2/qquickpopup.cpp4
-rw-r--r--src/quicktemplates2/qquickscrollbar.cpp2
-rw-r--r--src/quicktemplates2/qquicksplitview.cpp2
16 files changed, 66 insertions, 723 deletions
diff --git a/src/imports/controls/doc/src/external-pages.qdoc b/src/imports/controls/doc/src/external-pages.qdoc
new file mode 100644
index 00000000..d4a82fb8
--- /dev/null
+++ b/src/imports/controls/doc/src/external-pages.qdoc
@@ -0,0 +1,31 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \externalpage https://doc.qt.io/qt-5/qtquickcontrols2-differences.html
+ \title Qt 5.15: Qt Quick Controls vs Qt Quick Controls 1
+*/
diff --git a/src/imports/controls/doc/src/qt6-changes.qdoc b/src/imports/controls/doc/src/qt6-changes.qdoc
index b29018d6..c1a3d8d3 100644
--- a/src/imports/controls/doc/src/qt6-changes.qdoc
+++ b/src/imports/controls/doc/src/qt6-changes.qdoc
@@ -38,5 +38,11 @@
In this topic we summarize those changes in Qt Quick Controls, and provide
guidance to handle them.
- \section1 ADD STUFF HERE
+ \section1 Migrating from Qt Quick Controls 1
+
+ Qt Quick Controls 1 was deprecated in Qt 5.11 and is removed from
+ Qt 6.0. Use Qt Quick Controls (previously known as Qt Quick Controls 2)
+ instead. For more information, refer to the
+ \l{Qt 5.15: Qt Quick Controls vs Qt Quick Controls 1} topic in the Qt 5
+ documentation.
*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-configuration.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-configuration.qdoc
index e7149852..8ac2b275 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-configuration.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-configuration.qdoc
@@ -151,8 +151,8 @@
\section1 Palette Configuration
- The default \l {Control::palette}{palette} can be specified in a \c Palette sub-group
- in each style's section in the configuration file. The \c Palette sub-group can be
+ The default \c palette can be configured for each style using the
+ \c Palette sub-group in the configuration file. The \c Palette sub-group can be
defined in two alternative ways:
\code
@@ -168,8 +168,7 @@
WindowText=#212121
\endcode
- See \l {qtquickcontrols2-palette}{palette QML Basic Type} for a full list of supported
- attributes.
+ See \l [QtQuick]{Palette} QML type for more information.
\section1 Using the Configuration File in a Project
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-differences.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-differences.qdoc
deleted file mode 100644
index 7f8a066d..00000000
--- a/src/imports/controls/doc/src/qtquickcontrols2-differences.qdoc
+++ /dev/null
@@ -1,689 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2017 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$
-**
-****************************************************************************/
-
-/*!
- \page qtquickcontrols2-differences.html
- \title Differences with Qt Quick Controls 1
-
- Qt Quick Controls 1 was originally developed to support desktop platforms,
- with mobile and embedded support coming shortly afterwards. They have a
- very broad scope, in that they provide a styling system flexible enough to
- allow the development of applications that have either a platform-dependent
- or platform-independent style.
-
- On embedded systems, where the hardware has limited resources, this approach
- can be inefficient. Qt Quick Controls was designed to solve this problem,
- using
- \l {https://blog.qt.io/blog/2015/03/31/qt-quick-controls-for-embedded/}{benchmarks}
- to guide the development.
-
- \section2 C++ and QML
-
- In many cases, the internal state of a control can be more efficiently
- processed in C++. For example, handling input events in C++ makes a
- difference for controls that would otherwise need to create internal
- MouseAreas and attached Keys objects.
-
- \section2 Styles
-
- Not only does handling events and logic in C++ increase performance, but it
- allows the visual QML layer to be a simple, declarative layer on top. This
- is reflected in the structure of the controls project: all visual
- implementations sit in the \e imports folder, so that users who want to
- create their own complete style can copy the folder and start tweaking.
- Read more about implementing a style plugin
- \l {Creating a Custom Style}{here}.
-
- In Qt Quick Controls, styles no longer provide components that are
- dynamically instantiated by controls, but controls themselves consist of
- item delegates that can be replaced. In effect, this means that delegates
- are Qt Quick items that are instantiated on the spot, as properties of the
- control, and are simply parented to the control.
-
- \section2 Modularity and Simplicity
-
- When it comes to more complex controls, it is sometimes better to split
- them up into separate building blocks. As an example, the complex
- ScrollView control:
-
- \qml
- ScrollView {
- horizontalScrollBarPolicy: Qt.ScrollBarAlwaysOff
- Flickable {
- // ...
- }
- }
- \endqml
-
- Is replaced with simple ScrollBar/ScrollIndicator controls that can be
- attached to any Flickable:
-
- \qml
- Flickable {
- // ...
- ScrollBar.vertical: ScrollBar { }
- }
- \endqml
-
- The API of Qt Quick Controls aims to be clean and simple. Common
- operations are easy, and more advanced ones are liberally documented with
- snippets that can be copied into your code.
-
- \section2 Feature Comparison Table
-
- \table
- \header
- \li
- \li Qt Quick Controls 1
- \li Qt Quick Controls
- \row
- \li Stylable delegates
- \li Yes
- \li Yes
- \row
- \li Pre-built native styles
- \li Yes
- \li No
- \row
- \li Runtime style/theme changes
- \li Yes \sup 1
- \li Yes \sup 2
- \row
- \li Can be used on Desktop
- \li Yes
- \li Yes
- \row
- \li Can be used on Mobile
- \li Yes \sup 3
- \li Yes
- \row
- \li Can be used on Embedded
- \li Yes \sup 3
- \li Yes
- \row
- \li Internal event handling
- \li QML
- \li C++
- \endtable
-
- \list 1
- \li Not officially supported, but technically possible via private APIs
- \li Only themes for specific styles can be changed at runtime, styles are fixed
- \li Performance may not be optimal
- \endlist
-
- \section2 Porting Qt Quick Controls 1 Code
-
- The API of Qt Quick Controls is very similar to Qt Quick Controls 1, but it
- does come with some changes necessary to facilitate the improvements. The
- majority of changes are to do with styling; all of a control's delegates
- are now accessible in the control itself, instead of in a separate style
- object.
-
- For example, to style a button in Qt Quick Controls 1:
-
- \qml
- Button {
- style: ButtonStyle {
- label: Label {
- // ...
- }
- }
- }
- \endqml
-
- To style a button in Qt Quick Controls:
-
- \qml
- Button {
- contentItem: Label {
- // ...
- }
- }
- \endqml
-
- \section3 Preparing for Migration
-
- With this in mind, a good way to prepare for a migration to Qt Quick
- Controls 2 is to place each control that you have a custom style for in its
- own QML file. For example, the Qt Quick Controls 1 button above could be
- moved to a file named \c Button.qml in a directory named \c controls, and
- used in the following manner:
-
- \qml
- import "controls" as Controls
-
- Controls.Button {
- // ...
- }
- \endqml
-
- This works with both modules, and will reduce the amount of work needed
- when the migration begins.
-
- \section2 Type Comparison Table
-
- The first column lists all types available in \l {Qt Quick Controls 1},
- \l {Qt Quick Dialogs}, and \l {Qt Quick Extras}.
- The second column documents the respective type in Qt Quick Controls.
- When a direct alternative is not available, the third column contains
- an alternative that provides related functionality. The last column
- contains some remarks about the differences between the types in the
- different modules.
-
- \table
- \header
- \li Qt Quick Controls 1
- \li Qt Quick Controls
- \li Alternatives
- \li Remarks
- \row
- \li \l [QML QtQuickControls1] {Action}
- \li \l [QML QtQuickControls2] {Action}
- \li \l [QML QtQuick] {Shortcut} \br\sup {(Qt Quick)}
- \li
- \row
- \li \l [QML QtQuickControls1] {ApplicationWindow}
- \li \l [QML QtQuickControls2] {ApplicationWindow}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {BusyIndicator}
- \li \l [QML QtQuickControls2] {BusyIndicator}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {Button}
- \li \l [QML QtQuickControls2] {Button}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {Calendar}
- \li \mdash
- \li \l [QML QtQuickCalendar] {MonthGrid},\br
- \l [QML QtQuickCalendar] {DayOfWeekRow},\br
- \l [QML QtQuickCalendar] {WeekNumberColumn} \br\sup {(Qt Quick Calendar)}
- \li \list
- \li \b {Qt Quick Calendar}: \c MonthGrid, \c DayOfWeek, and \c WeekNumberColumn
- are \e unstyled building blocks for calendar views.
- \endlist
- \row
- \li \l [QML QtQuickControls1] {CheckBox}
- \li \l [QML QtQuickControls2] {CheckBox}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {ComboBox}
- \li \l [QML QtQuickControls2] {ComboBox}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {ExclusiveGroup}
- \li \mdash
- \li \l [QML QtQuickControls2] {ActionGroup},\br
- \l [QML QtQuickControls2] {ButtonGroup} \br\sup {(Qt Quick Controls)}
- \li \list
- \li \b {Qt Quick Controls}: \c ActionGroup and \c ButtonGroup offer similar functionality.
- \endlist
- \row
- \li \l [QML QtQuickControls1] {GroupBox}
- \li \l [QML QtQuickControls2] {GroupBox}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {Label}
- \li \l [QML QtQuickControls2] {Label}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {Menu}
- \li \l [QML QtQuickControls2] {Menu}
- \li \l [QML QtLabsPlatform] {Menu} \br\sup {(Qt Labs Platform)}
- \li \list
- \li \b {Qt Quick Controls 1}: \c Menu is native on platforms where an
- implementation is available in the Qt Platform Abstraction Layer.
- Other platforms use a QML-based top-level menu popup window. \c Menu
- supports traditional desktop style cascading submenus, but does not
- work on Embedded Linux because \l EGLFS does not support multiple
- top-level windows.
- \li \b {Qt Quick Controls}: \c Menu is a non-native \c Item-based popup
- that is stacked above the application content. Due to this, menu popups
- are restricted within window boundaries. \c Menu is fully customizable
- using QML and Qt Quick, and allows adding any \c Items. Traditional
- desktop oriented features, such as cascading submenus and visualizing
- keyboard shortcuts are missing.
- \li \b {Qt Labs Platform}: \c Menu is an \e experimental native menu that
- uses Qt Widgets as a fallback on platforms where a native implementation
- is not available in the Qt Platform Abstraction Layer.
- \endlist
- \row
- \li \l [QML QtQuickControls1] {MenuBar}
- \li \l [QML QtQuickControls2] {MenuBar}
- \li \l [QML QtLabsPlatform] {MenuBar} \br\sup {(Qt Labs Platform)}
- \li \list
- \li \b {Qt Quick Controls 1}: \c MenuBar is native on platforms where an
- implementation is available in the Qt Platform Abstraction Layer. Other
- platforms use a QML-based menubar item stacked at the top of the window.
- \li \b {Qt Quick Controls}: \c MenuBar is a non-native QML-based menubar
- that can be fully customized using QML and Qt Quick.
- \li \b {Qt Labs Platform}: \c MenuBar is an \e experimental native menubar.
- It is only available on platforms where a native implementation is available
- in the Qt Platform Abstraction Layer.
- \endlist
- \row
- \li \l [QML QtQuickControls1] {MenuItem},\br
- \l [QML QtQuickControls1] {MenuSeparator}
- \li \l [QML QtQuickControls2] {MenuItem},\br
- \l [QML QtQuickControls2] {MenuSeparator}
- \li \l [QML QtLabsPlatform] {MenuItem},\br
- \l [QML QtLabsPlatform] {MenuSeparator} \br\sup {(Qt Labs Platform)}
- \li \list
- \li \b {Qt Quick Controls 1}: \c MenuItem and \c MenuSeparator are native
- on platforms where an implementation is available in the Qt Platform
- Abstraction Layer. Other platforms use QML-based menu items and separators.
- \li \b {Qt Quick Controls}: \c MenuItem and \c MenuSeparator are a non-native
- QML-based menu items and separators that can be fully customized using QML
- and Qt Quick.
- \li \b {Qt Labs Platform}: \c MenuItem and \c MenuSeparator are \e experimental
- native menu items and separators.
- \endlist
- \row
- \li \l [QML QtQuickControls1] {ProgressBar}
- \li \l [QML QtQuickControls2] {ProgressBar}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {RadioButton}
- \li \l [QML QtQuickControls2] {RadioButton}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {ScrollView}
- \li \l [QML QtQuickControls2] {ScrollView}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {Slider}
- \li \l [QML QtQuickControls2] {Slider}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {SpinBox}
- \li \l [QML QtQuickControls2] {SpinBox}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {SplitView}
- \li \l [QML QtQuickControls2] {SplitView}
- \li
- \li \list
- \li \b {Qt Quick Controls 1}: Uses \l Layout attached properties
- to specify size hints.
- \li \b {Qt Quick Controls}: Uses dedicated
- \l [QML QtQuickControls2] {SplitView} attached properties
- to specify size hints.
- Allows \l {SplitView::saveState()}{saving} and
- \l {SplitView::restoreState()}{restoring} state.
- Separate attached \l SplitHandle API for managing split
- handles.
- \endlist
- \row
- \li \l [QML QtQuickControls1] {StackView},\br
- \l [QML QtQuickControls1] {StackViewDelegate},\br
- \l [QML QtQuickControls1] {Stack}
- \li \l [QML QtQuickControls2] {StackView}
- \li
- \li \list
- \li \b {Qt Quick Controls}: \c StackView provides customizable transitions
- and attached properties via a single \c StackView type.
- \endlist
- \row
- \li \l [QML QtQuickControls1] {StatusBar}
- \li \mdash
- \li \l [QML QtQuickControls2] {ToolBar} \br\sup {(Qt Quick Controls)}
- \li \list
- \li \b {Qt Quick Controls}: \c ApplicationWindow allows assigning any
- item or control, such as \c ToolBar, as a header or footer.
- \endlist
- \row
- \li \l [QML QtQuickControls1] {Switch}
- \li \l [QML QtQuickControls2] {Switch}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {TabView},\br
- \l [QML QtQuickControls1] {Tab}
- \li \mdash
- \li \l [QML QtQuickControls2] {TabBar},\br
- \l [QML QtQuickControls2] {TabButton} \br\sup {(Qt Quick Controls)}
- \li \list
- \li \b {Qt Quick Controls}: \c TabBar and \c TabButton offer similar
- functionality, and can be used to build tabbed views.
- \endlist
- \row
- \li \l [QML QtQuickControls1] {TableView}
- \li \mdash
- \li The new \l [QML QtQuick] {TableView} can be found in the Qt Quick
- module.
- \li
- \row
- \li \l [QML QtQuickControls1] {TextArea}
- \li \l [QML QtQuickControls2] {TextArea}
- \li
- \li \list
- \li \b {Qt Quick Controls 1}: \c TextArea inherits \c ScrollView and is therefore
- always a scrollable editor.
- \li \b {Qt Quick Controls}: \c TextArea is a simpler multi-line editor that can
- be optionally attached to a \c Flickable to provide scrolling functionality.
- This allows using \c TextArea in a scrollable page without having two nested
- scrollable areas, which can be problematic and cause usability issues.
- \endlist
- \row
- \li \l [QML QtQuickControls1] {TextField}
- \li \l [QML QtQuickControls2] {TextField}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {ToolBar}
- \li \l [QML QtQuickControls2] {ToolBar}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {ToolButton}
- \li \l [QML QtQuickControls2] {ToolButton}
- \li
- \li
- \row
- \li \l [QML QtQuickControls1] {TreeView}
- \li \mdash
- \li
- \li
-
- \header
- \li Qt Quick Dialogs
- \li Qt Quick Controls
- \li Alternatives
- \li Remarks
- \row
- \li \l [QML QtQuickDialogs] {Dialog}
- \li \mdash
- \li \l [QML QtQuickControls2] {Dialog}
- \li \list
- \li \b {Qt Quick Dialogs}: \c Dialog is either a top-level window or an \c Item-based popup
- depending on whether the underlying platform supports multiple top-level windows.
- \li \b {Qt Quick Controls}: \c Dialog is not a top-level window, but an \c Item-based
- popup that is stacked above the application content. Due to this, dialogs are restricted
- within window boundaries.
- \endlist
- \row
- \li \l [QML QtQuickDialogs] {ColorDialog},\br
- \l [QML QtQuickDialogs] {FileDialog},\br
- \l [QML QtQuickDialogs] {FontDialog},\br
- \l [QML QtQuickDialogs] {MessageDialog}
- \li \mdash
- \li \l [QML QtLabsPlatform] {ColorDialog},\br
- \l [QML QtLabsPlatform] {FileDialog},\br
- \l [QML QtLabsPlatform] {FolderDialog},\br
- \l [QML QtLabsPlatform] {FontDialog},\br
- \l [QML QtLabsPlatform] {MessageDialog} \br\sup {(Qt Labs Platform)}
- \li \list
- \li \b {Qt Quick Dialogs}: Dialogs are native on platforms where an implementation
- is available in the Qt Platform Abstraction Layer. Other platforms use either
- Qt Widgets or QML-based dialogs depending on whether the underlying platform
- supports multiple top-level windows.
- \li \b {Qt Labs Platform}: \e Experimental native dialogs that use Qt Widgets as
- a fallback on platforms where a native implementation is not available in the
- Qt Platform Abstraction Layer.
- \endlist
-
- \header
- \li Qt Quick Extras
- \li Qt Quick Controls
- \li Alternatives
- \li Remarks
- \row
- \li \l [QML QtQuickExtras] {CircularGauge}
- \li \mdash
- \li
- \li
- \row
- \li \l [QML QtQuickExtras] {DelayButton}
- \li \l [QML QtQuickControls2] {DelayButton}
- \li
- \li
- \row
- \li \l [QML QtQuickExtras] {Dial}
- \li \l [QML QtQuickControls2] {Dial}
- \li
- \li
- \row
- \li \l [QML QtQuickExtras] {Gauge}
- \li \mdash
- \li
- \li
- \row
- \li \l [QML QtQuickExtras] {Picture}
- \li \mdash
- \li
- \li
- \row
- \li \l [QML QtQuickExtras] {PieMenu}
- \li \mdash
- \li
- \li
- \row
- \li \l [QML QtQuickExtras] {StatusIndicator}
- \li \mdash
- \li
- \li
- \row
- \li \l [QML QtQuickExtras] {ToggleButton}
- \li \mdash
- \li
- \li
- \row
- \li \l [QML QtQuickExtras] {Tumbler},\br
- \l [QML QtQuickExtras] {TumblerColumn}
- \li \l [QML QtQuickControls2] {Tumbler}
- \li
- \li \list
- \li \b {Qt Quick Extras}: \c Tumbler can consist of multiple columns.
- \li \b {Qt Quick Controls}: \c Tumbler presents a single spinnable wheel.
- Multiple columns can be created by placing multiple \c Tumblers next
- to each other.
- \endlist
-
- \header
- \li No Predecessor
- \li Qt Quick Controls
- \li Alternatives
- \li Remarks
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {AbstractButton}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {ActionGroup}
- \li \l [QML QtQuickControls1] {ExclusiveGroup} \br\sup {(Qt Quick Controls 1)}
- \li \list
- \li \b {Qt Quick Controls 1}: \c ExclusiveGroup offers similar functionality.
- \endlist
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {ButtonGroup}
- \li \l [QML QtQuickControls1] {ExclusiveGroup} \br\sup {(Qt Quick Controls 1)}
- \li \list
- \li \b {Qt Quick Controls 1}: \c ExclusiveGroup offers similar functionality.
- \endlist
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {CheckDelegate}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {Container}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {Control}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {Drawer}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {Frame}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {ItemDelegate}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {Page}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {PageIndicator}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {Pane}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {Popup}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {RadioDelegate}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {RangeSlider}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {RoundButton}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {ScrollBar},\br
- \l [QML QtQuickControls2] {ScrollIndicator}
- \li \l [QML QtQuickControls1] {ScrollView} \br\sup {(Qt Quick Controls 1)}
- \li \list
- \li \b {Qt Quick Controls 1}: \c ScrollView offers similar functionality.
- It combines horizontal and vertical scrollbars, and the background and
- frame around the scrollable view.
- \endlist
- \row
- \li \mdash
- \li \mdash
- \li \l [QML QtLabsPlatform] {StandardPaths} \br\sup {(Qt Labs Platform)}
- \li \list
- \li \b {Qt Quick Dialogs}: \c FileDialog offers a shortcut property that can be used
- to access the most common standard paths.
- \li \b {Qt Labs Platform}: \c StandardPaths offers a separate type to give full access
- to the standard paths.
- \endlist
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {SwipeDelegate}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {SwipeView}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {SwitchDelegate}
- \li
- \li
- \row
- \li \mdash
- \li \mdash
- \li \l [QML QtLabsPlatform] {SystemTrayIcon} \br\sup {(Qt Labs Platform)}
- \li \list
- \li \b {Qt Labs Platform}: \c SystemTrayIcon is an \e experimental native
- system tray icon that uses Qt Widgets as a fallback on platforms where
- a native implementation is not available in the Qt Platform Abstraction
- Layer.
- \endlist
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {TabBar},\br
- \l [QML QtQuickControls2] {TabButton}
- \li \l [QML QtQuickControls1] {TabView} \br\sup {(Qt Quick Controls 1)}
- \li \list
- \li \b {Qt Quick Controls 1}: \c TabView offers similar functionality.
- It combines the tab bar, background and frame around the tabs.
- \endlist
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {ToolSeparator}
- \li
- \li
- \row
- \li \mdash
- \li \l [QML QtQuickControls2] {ToolTip}
- \li
- \li \list
- \li \b {Qt Quick Controls 1}: \c Button and \c Action have built-in
- Qt Widgets-based tooltips.
- \li \b {Qt Quick Controls}: \c ToolTip can be attached to any \c Item.
- \endlist
- \endtable
-
- \section1 Related Information
-
- \list
- \li \l{Qt Quick}
- \li \l{Qt Quick Controls QML Types}
- \li \l{Qt Quick Controls 1 QML Types}
- \li \l{Qt Quick Extras QML Types}
- \li \l{Qt Labs Calendar QML Types}
- \li \l{Qt Labs Platform QML Types}
- \endlist
-*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-fusion.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-fusion.qdoc
index b7929061..ca67985f 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-fusion.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-fusion.qdoc
@@ -47,13 +47,13 @@
\section2 Customization
- The Fusion style uses the standard system \l {Control::palette}{palettes}
+ The Fusion style uses the standard system \l[QtQuick]{Palette}
to provide colors that match the desktop environment.
\image qtquickcontrols2-fusion-palettes.png
- Custom palettes can be specified for any \l {Control::palette}{control},
- \l {Popup::palette}{popup}, or \l {ApplicationWindow::palette}{application window}.
+ Custom palettes can be specified for any control,
+ \l{Popup::palette}{popup}, or \l{Window::palette}{application window}.
Explicit palette attributes are automatically propagated from parent to children,
overriding any system defaults for that attribute. In the following example,
the window and all three switches appear with a violet highlight color:
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-imagine.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-imagine.qdoc
index bca826fd..15730ba3 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-imagine.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-imagine.qdoc
@@ -2471,9 +2471,9 @@
\section3 Palette
- The Imagine style supports palette customization via the \l {Control::}{palette}
+ The Imagine style supports palette customization via the \l {Item::}{palette}
property and the \l {Palette Configuration}{qtquickcontrols2.conf} file.
- As with other styles, the exact \l[QML]{palette}{palette roles}
+ As with other styles, the exact \l[QML]{Palette}{palette roles}
that the Imagine style uses are style-dependent. However, as most of the visual
appearance of controls (for example: backgrounds) are managed through image assets,
only the roles that are typically used for text will have an effect.
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc
index 32ce14df..6133f330 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc
@@ -76,10 +76,7 @@
\section2 Building From Source
- When building from source, ensure that the \l {Qt Graphical Effects} module
- is also built, as Qt Quick Controls requires it.
-
- The \l {Qt Image Formats} module is recommended, but not
+ The \b{Qt Image Formats} module is recommended, but not
required. It provides support for the \c {.webp} format used by the
\l {Animated Images}{Imagine style}.
diff --git a/src/imports/platform/qquickplatformmenu.cpp b/src/imports/platform/qquickplatformmenu.cpp
index 7219ef54..f174b0bf 100644
--- a/src/imports/platform/qquickplatformmenu.cpp
+++ b/src/imports/platform/qquickplatformmenu.cpp
@@ -127,7 +127,7 @@ QT_BEGIN_NAMESPACE
\section2 Dynamically Generating Menu Items
It is possible to dynamically generate menu items. One of the easiest ways
- to do so is with \l[QtQml]{Instantiator}. For example, to implement a
+ to do so is with \l Instantiator. For example, to implement a
"Recent Files" submenu, where the items are based on a list of files stored
in settings, the following code could be used:
diff --git a/src/quicktemplates2/qquickcombobox.cpp b/src/quicktemplates2/qquickcombobox.cpp
index 4a7492ba..0f537ede 100644
--- a/src/quicktemplates2/qquickcombobox.cpp
+++ b/src/quicktemplates2/qquickcombobox.cpp
@@ -1691,7 +1691,7 @@ void QQuickComboBox::setSelectTextByMouse(bool canSelect)
\since QtQuick.Controls 6.0 (Qt 6.0)
\qmlproperty enumeration QtQuick.Controls::ComboBox::implicitContentWidthPolicy
- This property controls how the \l implicitContentWidth of the ComboBox is
+ This property controls how the \l{Control::}{implicitContentWidth} of the ComboBox is
calculated.
When the width of a ComboBox is not large enough to display text, that text
@@ -1711,12 +1711,12 @@ void QQuickComboBox::setSelectTextByMouse(bool canSelect)
implicitContentWidthPolicy provides an easy way to control how the
implicitContentWidth is calculated, which in turn affects the
- \l implicitWidth of the ComboBox and ensures that text will not be elided.
+ \l{Item::}{implicitWidth} of the ComboBox and ensures that text will not be elided.
The available values are:
\value ContentItemImplicitWidth
- The implicitContentWidth will default to that of the \l contentItem.
+ The implicitContentWidth will default to that of the \l{Control::}{contentItem}.
This is the most efficient option, as no extra text layout is done.
\value WidestText
@@ -1734,8 +1734,8 @@ void QQuickComboBox::setSelectTextByMouse(bool canSelect)
The default value is \c ContentItemImplicitWidth.
- As this property only affects the \l implicitWidth of the ComboBox, setting
- an explicit \l width can still result in eliding.
+ As this property only affects the \c implicitWidth of the ComboBox, setting
+ an explicit \l{Item::}{width} can still result in eliding.
\note This feature requires the contentItem to be a type derived from
\l TextInput.
diff --git a/src/quicktemplates2/qquickdialog.cpp b/src/quicktemplates2/qquickdialog.cpp
index 1fe3545d..d32f6272 100644
--- a/src/quicktemplates2/qquickdialog.cpp
+++ b/src/quicktemplates2/qquickdialog.cpp
@@ -511,7 +511,7 @@ void QQuickDialog::reject()
\li Emits \l accepted() or \l rejected() depending on
whether the result is \c Dialog.Accepted or \c Dialog.Rejected,
respectively.
- \li Emits \l closed().
+ \li Emits \l{Popup::}{closed()).
\endlist
\sa accept(), reject(), result
diff --git a/src/quicktemplates2/qquickdrawer.cpp b/src/quicktemplates2/qquickdrawer.cpp
index a5b84873..e5839906 100644
--- a/src/quicktemplates2/qquickdrawer.cpp
+++ b/src/quicktemplates2/qquickdrawer.cpp
@@ -90,10 +90,9 @@ QT_BEGIN_NAMESPACE
\endcode
Drawer is a special type of popup that resides at one of the window \l {edge}{edges}.
- By default, Drawer re-parents itself to the window \l {ApplicationWindow::}{overlay},
- and therefore operates on window coordinates. It is also possible to manually set the
- \l {Popup::}{parent} to something else to make the drawer operate in a specific
- coordinate space.
+ By default, Drawer re-parents itself to the window \c overlay, and therefore operates
+ on window coordinates. It is also possible to manually set the \l{Popup::}{parent} to
+ something else to make the drawer operate in a specific coordinate space.
Drawer can be configured to cover only part of its window edge. The following example
illustrates how Drawer can be positioned to appear below a window header:
diff --git a/src/quicktemplates2/qquickmenu.cpp b/src/quicktemplates2/qquickmenu.cpp
index 5bc44f0d..b471a3fc 100644
--- a/src/quicktemplates2/qquickmenu.cpp
+++ b/src/quicktemplates2/qquickmenu.cpp
@@ -193,7 +193,7 @@ static const int SUBMENU_DELAY = 225;
The default value is \c false.
- \sa activeFocus
+ \sa {Popup::}{activeFocus}
*/
static const QQuickPopup::ClosePolicy cascadingSubMenuClosePolicy = QQuickPopup::CloseOnEscape | QQuickPopup::CloseOnPressOutsideParent;
diff --git a/src/quicktemplates2/qquickpane.cpp b/src/quicktemplates2/qquickpane.cpp
index ecdc27db..29ef2b84 100644
--- a/src/quicktemplates2/qquickpane.cpp
+++ b/src/quicktemplates2/qquickpane.cpp
@@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE
Items declared as children of a Pane are automatically parented to the
Pane's \l[QtQuickControls2]{Control::}{contentItem}. Items created
- dynamically need to be explicitly parented to the contentItem.
+ dynamically need to be explicitly parented to the \c contentItem.
\section1 Content Sizing
@@ -103,9 +103,9 @@ QT_BEGIN_NAMESPACE
}
\endcode
- If the \l contentItem has no implicit size and only one child, Pane will
- use the implicit size of that child. For example, in the following code,
- the Pane will assume the size of the Rectangle:
+ If the \l[QtQuickControls2]{Control::}{contentItem} has no implicit size
+ and only one child, Pane will use the implicit size of that child. For
+ example, in the following code, the Pane assumes the size of the Rectangle:
\code
Pane {
diff --git a/src/quicktemplates2/qquickpopup.cpp b/src/quicktemplates2/qquickpopup.cpp
index fee4fcba..040a928c 100644
--- a/src/quicktemplates2/qquickpopup.cpp
+++ b/src/quicktemplates2/qquickpopup.cpp
@@ -610,7 +610,7 @@ void QQuickPopupPrivate::setBottomMargin(qreal value, bool reset)
\note Popups can only be centered within their immediate parent or
the window overlay; trying to center in other items will produce a warning.
- \sa {Popup Positioning}, {QtQuick::Item::anchors}{anchors}
+ \sa {Popup Positioning}, {Item::}{anchors}
*/
QQuickPopupAnchors *QQuickPopupPrivate::getAnchors()
{
@@ -2360,7 +2360,7 @@ void QQuickPopup::resetBottomInset()
}
\endcode
- \sa Item::palette, Window::palette, QQuickAbstractPaletteProvider, ColorGroup, Palette
+ \sa Item::palette, Window::palette, ColorGroup, Palette
*/
bool QQuickPopup::filtersChildMouseEvents() const
diff --git a/src/quicktemplates2/qquickscrollbar.cpp b/src/quicktemplates2/qquickscrollbar.cpp
index b88f396c..f7b403d7 100644
--- a/src/quicktemplates2/qquickscrollbar.cpp
+++ b/src/quicktemplates2/qquickscrollbar.cpp
@@ -144,7 +144,7 @@ QT_BEGIN_NAMESPACE
\list
\li Layout the scroll bar (with the \l {Item::}{x} and \l {Item::}{y} or
- \l [QtQuick]{Item::}{anchors} property, for example).
+ \l {Item::}{anchors} property, for example).
\li Set the \l size and \l position properties to determine the size and position
of the scroll bar in relation to the scrolled item.
\li Set the \l active property to determine when the scroll bar will be
diff --git a/src/quicktemplates2/qquicksplitview.cpp b/src/quicktemplates2/qquicksplitview.cpp
index f5232a47..9c3da3f0 100644
--- a/src/quicktemplates2/qquicksplitview.cpp
+++ b/src/quicktemplates2/qquicksplitview.cpp
@@ -1727,7 +1727,7 @@ void QQuickSplitViewAttached::resetPreferredWidth()
\l{Item::}{implicitHeight} will be used instead. To reset this property to
its default value, set it to \c undefined.
- \note Do not set the \l{Item:}{height} property of a split item, as it will be
+ \note Do not set the \l{Item::}{height} property of a split item, as it will be
overwritten upon each layout of the SplitView.
\sa minimumHeight, maximumHeight, fillHeight, preferredWidth