diff options
| author | Kai Köhne <kai.koehne@qt.io> | 2023-02-14 14:00:16 +0100 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-03-10 09:21:41 +0000 |
| commit | 2cac1965835588b9090fbef18dab62bc6a15f949 (patch) | |
| tree | 375f25adcad2e33f358f89d9ab4f72dbeae3cc4c | |
| parent | d4ef47ea990697ee74996325673d1fbb9411fac8 (diff) | |
Doc: Improve documentation for Palette / ColorGroup
Clean up mixing of C++ and QML types in QML documentation.
Also properly interlink ColorGroup, Palette documentation.
Fixes: QTBUG-110776
Change-Id: I4f9990923589cfc164cc69fca6f6a733c0139670
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
(cherry picked from commit 7461408a7d9df209ec608a6053fe0da2f513a2cc)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/quick/items/qquickcolorgroup.cpp | 4 | ||||
| -rw-r--r-- | src/quick/items/qquickpalette.cpp | 10 |
2 files changed, 7 insertions, 7 deletions
diff --git a/src/quick/items/qquickcolorgroup.cpp b/src/quick/items/qquickcolorgroup.cpp index fd913aba7a..273ee31fa2 100644 --- a/src/quick/items/qquickcolorgroup.cpp +++ b/src/quick/items/qquickcolorgroup.cpp @@ -45,6 +45,8 @@ QT_BEGIN_NAMESPACE base: "green" } \endcode + + The \l Palette type exposes color groups for each QML item state. */ /*! @@ -180,8 +182,6 @@ QT_BEGIN_NAMESPACE Additional signal indicates that the current state of this color group has been changed. Usually it means that one of the colors is changed. - - \sa Palette */ /*! diff --git a/src/quick/items/qquickpalette.cpp b/src/quick/items/qquickpalette.cpp index 9a72807fe1..d8d01a7588 100644 --- a/src/quick/items/qquickpalette.cpp +++ b/src/quick/items/qquickpalette.cpp @@ -33,7 +33,7 @@ static constexpr bool is_valid(QPalette::ColorGroup cg) noexcept \internal \class QQuickPalette - \brief The QQuickPalette class contains color groups for each QML item state. + \brief Contains color groups for each QML item state. \inmodule QtQuick \since 6.0 @@ -48,7 +48,7 @@ static constexpr bool is_valid(QPalette::ColorGroup cg) noexcept \inherits QQuickColorGroup \inqmlmodule QtQuick \ingroup qtquick-visual - \brief The QQuickPalette class contains color groups for each QML item state. + \brief Contains color groups for each QML item state. A palette consists of three color groups: Active, Disabled, and Inactive. Active color group is the default group, its colors are used for other groups @@ -108,7 +108,7 @@ static constexpr bool is_valid(QPalette::ColorGroup cg) noexcept */ /*! - \qmlproperty QQuickColorGroup QtQuick::Palette::active + \qmlproperty ColorGroup QtQuick::Palette::active The Active group is used for windows that are in focus. @@ -116,7 +116,7 @@ static constexpr bool is_valid(QPalette::ColorGroup cg) noexcept */ /*! - \qmlproperty QQuickColorGroup QtQuick::Palette::inactive + \qmlproperty ColorGroup QtQuick::Palette::inactive The Inactive group is used for windows that have no keyboard focus. @@ -124,7 +124,7 @@ static constexpr bool is_valid(QPalette::ColorGroup cg) noexcept */ /*! - \qmlproperty QQuickColorGroup QtQuick::Palette::disabled + \qmlproperty ColorGroup QtQuick::Palette::disabled The Disabled group is used for elements that are disabled for some reason. |