qqstylekitreader_p.h

Go to the documentation of this file.

// Copyright (C) 2025 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
#ifndef QQSTYLEKITREADER_P_H
#define QQSTYLEKITREADER_P_H
 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
 
#include <QtQml/QtQml>
#include <QtQuick/private/qquickpalette_p.h>
 
#include "qqstylekitpropertypath_p.h"
#include "qqstylekitcontrolproperties_p.h"
#include "qqstylekitfont_p.h"
 
#include <QtCore/qcompare.h>
 
QT_BEGIN_NAMESPACE
 
class QQuickPalette;
class QQStyleKitVariation;
class QQStyleKitPropertyResolver;
 
class Q_LABSSTYLEKIT_EXPORT QQStyleKitReader : public QQStyleKitControlProperties, public QQmlParserStatus
{
    Q_OBJECT
    Q_INTERFACES(QQmlParserStatus)
    Q_PROPERTY(QQStyleKitExtendableControlType controlType READ controlType WRITE setControlType NOTIFY controlTypeChanged FINAL)
    Q_PROPERTY(bool enabled READ enabled WRITE setEnabled NOTIFY enabledChanged FINAL)
    Q_PROPERTY(bool focused READ focused WRITE setFocused NOTIFY focusedChanged FINAL)
    Q_PROPERTY(bool checked READ checked WRITE setChecked NOTIFY checkedChanged FINAL)
    Q_PROPERTY(bool hovered READ hovered WRITE setHovered NOTIFY hoveredChanged FINAL)
    Q_PROPERTY(bool pressed READ pressed WRITE setPressed NOTIFY pressedChanged FINAL)
    Q_PROPERTY(bool vertical READ vertical WRITE setVertical NOTIFY verticalChanged FINAL)
    Q_PROPERTY(bool highlighted READ highlighted WRITE setHighlighted NOTIFY highlightedChanged FINAL)
    Q_PROPERTY(QFont font READ font NOTIFY fontChanged FINAL)
    Q_PROPERTY(QQuickPalette *palette READ palette WRITE setPalette NOTIFY paletteChanged FINAL)
    Q_PROPERTY(QQStyleKitControlProperties *global READ global CONSTANT FINAL)
 
    QML_NAMED_ELEMENT(StyleReader)
 
public:
    enum ControlType {
        Unspecified = 100000,
        Control,
        AbstractButton,
        ApplicationWindow,
        BusyIndicator,
        Button,
        CheckBox,
        CheckDelegate,
        ComboBox,
        DelayButton,
        Dial,
        Dialog,
        DialogButtonBox,
        Drawer,
        FlatButton,
        HeaderViewDelegate,
        ProgressBar,
        ScrollBar,
        ScrollIndicator,
        ScrollView,
        Slider,
        SpinBox,
        SwipeDelegate,
        SwitchControl,
        SwitchDelegate,
        SearchField,
        TabBar,
        TabButton,
        TableViewDelegate,
        TextArea,
        TextField,
        TextInput,
        ToolBar,
        ToolButton,
        ToolSeparator,
        ToolTip,
        TreeViewDelegate,
        Tumbler,
        RadioButton,
        RadioDelegate,
        RoundButton,
        ItemDelegate,
        Popup,
        Menu,
        MenuBar,
        MenuBarItem,
        MenuItem,
        MenuSeparator,
        Pane,
        Page,
        PageIndicator,
        Frame,
        Label,
        GroupBox
    };
    Q_ENUM(ControlType)
 
    enum class AlternateState {
        Alternate1,
        Alternate2
    };
    Q_ENUM(AlternateState)
 
    QQStyleKitReader(QObject *parent = nullptr);
    ~QQStyleKitReader();
 
    QQStyleKitExtendableControlType controlType() const;
    void setControlType(QQStyleKitExtendableControlType type);
#ifdef QT_DEBUG
    ControlType typeAsControlType() const;
#endif
 
    bool hovered() const;
    void setHovered(bool hovered);
 
    bool enabled() const;
    void setEnabled(bool enabled);
 
    bool focused() const;
    void setFocused(bool focused);
 
    bool checked() const;
    void setChecked(bool checked);
 
    bool pressed() const;
    void setPressed(bool pressed);
 
    QQuickPalette *palette() const;
    void setPalette(QQuickPalette *palette);
    QPalette effectivePalette() const;
 
    bool vertical() const;
    void setVertical(bool vertical);
 
    bool highlighted() const;
    void setHighlighted(bool highlighted);
 
    QQStyleKitStyle *explicitStyle() const;
    void setExplicitStyle(QQStyleKitStyle *style);
 
    QFont font() const;
 
    QQStyleKitControlProperties *global() const;
 
    QVariant readStyleProperty(PropertyStorageId key) const;
    void writeStyleProperty(PropertyStorageId key, const QVariant &value);
    void clearLocalStorage();
 
    QQSK::State controlState() const;
 
    void setControlTypeAndState(QQStyleKitExtendableControlType controlType, QQSK::State flags,
                                bool applyStateChange = true);
 
    QObject *target() const;
    void setTarget(QObject *target);
 
    // Called by componentComplete()
    // Factored out so the widget style can call it
    void setCompleted(bool completed);
 
    bool transitionsEnabled() const;
    void setTransitionsEnabled(bool enabled);
 
    static void resetReadersForStyle(const QQStyleKitStyle *style);
 
    static QList<QQStyleKitReader *> s_allReaders;
 
signals:
    void controlTypeChanged();
    void customTypeChanged();
    void propertiesChanged();
    void enabledChanged();
    void focusedChanged();
    void checkedChanged();
    void hoveredChanged();
    void pressedChanged();
    void paletteChanged();
    void verticalChanged();
    void highlightedChanged();
    void fontChanged();
 
private slots:
    void onPaletteChanged();
 
protected:
    void classBegin() override {}
    void componentComplete() override;
 
private:
    void updateControl(bool applyStateChange = true);
    void populateLocalStorage();
    bool dontEmitChangedSignals() const;
 
    QQuickStateGroup *stateGroup();
    QQmlComponent *createControlChangesComponent() const;
    QQmlComponent *createDelegateChangesComponent(const QString &delegateName) const;
    void instantiatePropertyChanges(QQmlComponent *comp);
    void maybeTrackDelegates();
 
    bool rebuildEffectivePalette();
    bool rebuildEffectiveFont();
 
private:
    Q_DISABLE_COPY(QQStyleKitReader)
 
    /* The reason we have a QQStyleKitExtendableControlType in addition to
     * QQStyleKitReader::ControlType, is that we allow the style to define controls types
     * in the style beyond the types we offer in Qt Quick Controls. The predefined controls
     * (QQStyleKitReader::ControlType) have types that starts at 100000 (ControlType::Unspecified),
     * and any number before that is available for use for defining custom controls. */
    QQStyleKitExtendableControlType m_type = ControlType::Unspecified;
 
    bool m_dontEmitChangedSignals: 1;
    bool m_effectiveVariationsDirty: 1;
    bool m_transitionsEnabled: 1;
    bool m_completed: 1;
 
    QPointer<QQuickPalette> m_palette;
    QPalette m_effectivePalette;
    QFont m_font;
    bool m_fontDirty = true;
    quint64 m_lastTextFontOverridesSignature = 0;
    mutable QQStyleKitPropertyStorage m_storage;
    AlternateState m_alternateState = AlternateState::Alternate1;
    QQSK::State m_state = QQSK::StateFlag::Unspecified;
    QQuickStateGroup *m_stateGroup = nullptr;
    QQSK::Delegates m_trackedDelegates = QQSK::Delegate::NoDelegate;
 
    QPointer<QObject> m_target;
    QPointer<QQStyleKitStyle> m_explicitStyle;
    QPointer<QQStyleKitReader> m_parentReader;
    QList<QPointer<QQStyleKitVariation>> m_effectiveVariations;
 
    QQStyleKitControlProperties m_global;
 
    using PropertyChangesComponents = QMap<std::pair<Qt::totally_ordered_wrapper<QQmlEngine*>, QString>, QPointer<QQmlComponent>>;
    static PropertyChangesComponents s_propertyChangesComponents;
 
    friend class QQStyleKitControlProperties;
    friend class QQStyleKitPropertyResolver;
    friend class QQStyleKitPropertyGroup;
};
 
QT_END_NAMESPACE
 
#endif // QQSTYLEKITREADER_P_H