Add doxygen documentations

Sine Striker

2023-12-27 1571d7b43228a0ed4347f681a16b2b23defccda9

 src/quick/quickwindowagent_win.cpp

@@ -4,18 +4,24 @@
#include <QtQuick/private/qquickitem_p.h>

#include <QWKCore/qwindowkit_windows.h>
#include <QWKCore/qwkconfig.h>
#include <QWKCore/private/nativeeventfilter_p.h>

namespace QWK {

#if QWINDOWKIT_CONFIG(ENABLE_WINDOWS_SYSTEM_BORDER)
    class BorderItem : public QQuickPaintedItem, public NativeEventFilter {
#if QWINDOWKIT_CONFIG(ENABLE_WINDOWS_SYSTEM_BORDERS)
    // TODO: Find a way to draw native border
    // We haven't found a way to place hooks in the Quick program and call the GDI API to draw
    // the native border area so that we'll use the emulated drawn border for now.

    class BorderItem : public QQuickPaintedItem,
                       public NativeEventFilter,
                       public SharedEventFilter {
    public:
        explicit BorderItem(QQuickItem *parent, AbstractWindowContext *context);
        ~BorderItem() override;

        void updateGeometry();
        inline bool isNormalWindow() const;

        inline void updateGeometry();

    public:
        void paint(QPainter *painter) override;
@@ -24,6 +30,8 @@
    protected:
        bool nativeEventFilter(const QByteArray &eventType, void *message,
                               QT_NATIVE_EVENT_RESULT_TYPE *result) override;

        bool sharedEventFilter(QObject *obj, QEvent *event) override;

        AbstractWindowContext *context;

@@ -47,6 +55,8 @@
        setZ(9999); // Make sure our fake border always above everything in the window.

        context->installNativeEventFilter(this);
        context->installSharedEventFilter(this);

        connect(window(), &QQuickWindow::activeChanged, this,
                &BorderItem::_q_windowActivityChanged);
        updateGeometry();
@@ -54,8 +64,14 @@

    BorderItem::~BorderItem() = default;

    bool BorderItem::isNormalWindow() const {
        return !(context->window()->windowState() &
                 (Qt::WindowMinimized | Qt::WindowMaximized | Qt::WindowFullScreen));
    }

    void BorderItem::updateGeometry() {
        setHeight(context->property("borderThickness").toInt());
        setHeight(context->windowAttribute(QStringLiteral("border-thickness")).toInt());
        setVisible(isNormalWindow());
    }

    void BorderItem::paint(QPainter *painter) {
@@ -95,9 +111,7 @@
            }

            case WM_SETTINGCHANGE: {
                if (!msg->wParam && msg->lParam &&
                    std::wcscmp(reinterpret_cast<LPCWSTR>(msg->lParam), L"ImmersiveColorSet") ==
                        0) {
                if (isImmersiveColorSetChange(msg->wParam, msg->lParam)) {
                    update();
                }
                break;
@@ -109,19 +123,30 @@
        return false;
    }

    bool BorderItem::sharedEventFilter(QObject *obj, QEvent *event) {
        Q_UNUSED(obj)
        switch (event->type()) {
            case QEvent::WindowStateChange: {
                updateGeometry();
                break;
            }
            default:
                break;
        }
        return false;
    }

    void BorderItem::_q_windowActivityChanged() {
        update();
    }
#endif

    void QuickWindowAgentPrivate::setupWindows10BorderWorkaround() {
#if QWINDOWKIT_CONFIG(ENABLE_WINDOWS_SYSTEM_BORDER)
        // Install painting hook
        auto ctx = context.get();
        if (ctx->property("needBorderPainter").toBool()) {
        if (ctx->windowAttribute(QStringLiteral("win10-border-needed")).toBool()) {
            std::ignore = new BorderItem(hostWindow->contentItem(), ctx);
        }
#endif
    }
#endif

}