qplatformwindow_p.h

Go to the documentation of this file.

// Copyright (C) 2016 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 QPLATFORMWINDOW_P_H
#define QPLATFORMWINDOW_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 <QtGui/private/qtguiglobal_p.h>
#include <QtCore/qbasictimer.h>
#include <QtCore/qrect.h>
#include <QtCore/qnativeinterface.h>
#include <QtGui/qwindow.h>
 
#if QT_CONFIG(wayland)
#include <any>
#include <QtCore/qobject.h>
 
struct wl_surface;
#endif
 
#if defined(Q_OS_MACOS)
Q_FORWARD_DECLARE_OBJC_CLASS(NSView);
Q_FORWARD_DECLARE_OBJC_CLASS(CALayer);
typedef long NSInteger;
enum NSVisualEffectMaterial : NSInteger;
enum NSVisualEffectBlendingMode : NSInteger;
enum NSVisualEffectState: NSInteger;
#endif
 
#if defined(Q_OS_WIN)
#include <QtGui/qwindowdefs_win.h>
#endif
 
#if defined(Q_OS_HARMONY)
#include <optional>
 
typedef struct ArkUI_Node *ArkUI_NodeHandle;
#endif
 
QT_BEGIN_NAMESPACE
 
class QMargins;
 
class QPlatformWindowPrivate
{
public:
    QRect rect;
    QBasicTimer updateTimer;
};
 
// ----------------- QNativeInterface -----------------
 
namespace QNativeInterface::Private {
 
#if defined(Q_OS_WASM) || defined(Q_QDOC)
struct Q_GUI_EXPORT QWasmWindow
{
    QT_DECLARE_NATIVE_INTERFACE(QWasmWindow, 1, QWindow)
    virtual emscripten::val document() const = 0;
    virtual emscripten::val clientArea() const = 0;
    virtual emscripten::val canvas() const = 0;
};
#endif
 
#if defined(Q_OS_MACOS) || defined(Q_QDOC)
struct Q_GUI_EXPORT QCocoaWindow
{
    QT_DECLARE_NATIVE_INTERFACE(QCocoaWindow, 5, QWindow)
    virtual NSView *view() const = 0;
    virtual QPoint bottomLeftClippedByNSWindowOffset() const = 0;
    virtual CALayer *contentLayer() const = 0;
    virtual void manageVisualEffectArea(quintptr identifier, const QRect &rect,
        NSVisualEffectMaterial material, NSVisualEffectBlendingMode blendMode,
        NSVisualEffectState activationState) = 0;
    virtual void enableTrackpadTouchDelivery(bool enable) = 0;
};
#endif
 
#if QT_CONFIG(xcb) || defined(Q_QDOC)
struct Q_GUI_EXPORT QXcbWindow
{
    QT_DECLARE_NATIVE_INTERFACE(QXcbWindow, 1, QWindow)
 
    enum WindowType {
        None         = 0x000000,
        Normal       = 0x000001,
        Desktop      = 0x000002,
        Dock         = 0x000004,
        Toolbar      = 0x000008,
        Menu         = 0x000010,
        Utility      = 0x000020,
        Splash       = 0x000040,
        Dialog       = 0x000080,
        DropDownMenu = 0x000100,
        PopupMenu    = 0x000200,
        Tooltip      = 0x000400,
        Notification = 0x000800,
        Combo        = 0x001000,
        Dnd          = 0x002000,
        KdeOverride  = 0x004000
    };
    Q_DECLARE_FLAGS(WindowTypes, WindowType)
 
    virtual void setWindowType(WindowTypes type) = 0;
    virtual void setWindowRole(const QString &role) = 0;
    virtual void setWindowIconText(const QString &text) = 0;
    virtual uint visualId() const = 0;
};
#endif // xcb
 
#if defined(Q_OS_WIN) || defined(Q_QDOC)
struct Q_GUI_EXPORT QWindowsWindow
{
    QT_DECLARE_NATIVE_INTERFACE(QWindowsWindow, 2, QWindow)
 
    virtual HWND handle() const = 0;
 
    virtual void setHasBorderInFullScreen(bool border) = 0;
    virtual bool hasBorderInFullScreen() const = 0;
 
    virtual QMargins customMargins() const = 0;
    virtual void setCustomMargins(const QMargins &margins) = 0;
};
#endif // Q_OS_WIN
 
#if QT_CONFIG(wayland)
struct Q_GUI_EXPORT QWaylandWindow : public QObject
{
    Q_OBJECT
public:
    QT_DECLARE_NATIVE_INTERFACE(QWaylandWindow, 1, QWindow)
 
    enum WindowType {
        Default,
        ToolTip,
        ComboBox,
        Menu,
        SubMenu,
    };
 
    virtual wl_surface *surface() const = 0;
    virtual void setCustomMargins(const QMargins &margins) = 0;
    virtual void requestXdgActivationToken(uint serial) = 0;
    template<typename T>
    T *surfaceRole() const
    {
        std::any anyRole = _surfaceRole();
        auto role = std::any_cast<T *>(&anyRole);
        return role ? *role : nullptr;
    }
    virtual void setSessionRestoreId(const QString &role) = 0;
 
    virtual void setExtendedWindowType(WindowType windowType) = 0;
    virtual void setParentControlGeometry(const QRect &parentAnchor) = 0;
 
Q_SIGNALS:
    void surfaceCreated();
    void surfaceDestroyed();
    void surfaceRoleCreated();
    void surfaceRoleDestroyed();
    void xdgActivationTokenCreated(const QString &token);
 
protected:
    virtual std::any _surfaceRole() const = 0;
};
#endif
 
#if defined(Q_OS_HARMONY)
struct Q_GUI_EXPORT QOhosWindow
{
    QT_DECLARE_NATIVE_INTERFACE(QOhosWindow, 1, QWindow)
    static QWindow *fromNative(ArkUI_NodeHandle content);
    virtual std::optional<double> windowId() const = 0;
};
 
struct Q_GUI_EXPORT QOhosIntegration
{
    QT_DECLARE_NATIVE_INTERFACE(QOhosIntegration)
    virtual WId windowHandle(ArkUI_NodeHandle content) = 0;
    virtual void setMainWindowGeometryPersistenceEnabled(std::optional<bool> enabled) = 0;
};
#endif // defined(Q_OS_HARMONY)
 
} // QNativeInterface::Private
 
QT_END_NAMESPACE
 
#endif // QPLATFORMWINDOW_P_H