qdbusplatformmenu_p.h

Enable keyboard shortcuts

// 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 QDBUSPLATFORMMENU_H

#define QDBUSPLATFORMMENU_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.

//

//

//  W A R N I N G

//  -------------

//

// This file is part of the DBus menu support and is not meant to be used

// in applications. Usage of this API may make your code

// source and binary incompatible with future versions of Qt.

//

#include <qpa/qplatformmenu.h>

#include <QLoggingCategory>

#include "qdbusmenutypes_p.h"

QT_BEGIN_NAMESPACE

Q_DECLARE_LOGGING_CATEGORY(qLcMenu)

class QDBusPlatformMenu;

class QDBusPlatformMenuItem : public QPlatformMenuItem

    Q_OBJECT

public:

    QDBusPlatformMenuItem();

    ~QDBusPlatformMenuItem();

    const QString text() const { return m_text; }

    void setText(const QString &text) override;

    QIcon icon() const { return m_icon; }

    void setIcon(const QIcon &icon) override;

    const QPlatformMenu *menu() const { return m_subMenu; }

    void setMenu(QPlatformMenu *menu) override;

    bool isEnabled() const { return m_isEnabled; }

    void setEnabled(bool enabled) override;

    bool isVisible() const { return m_isVisible; }

    void setVisible(bool isVisible) override;

    bool isSeparator() const { return m_isSeparator; }

    void setIsSeparator(bool isSeparator) override;

    void setFont(const QFont &font) override { Q_UNUSED(font); }

    void setRole(MenuRole role) override;

    bool isCheckable() const { return m_isCheckable; }

    void setCheckable(bool checkable) override;

    bool isChecked() const { return m_isChecked; }

    void setChecked(bool isChecked) override;

    bool hasExclusiveGroup() const { return m_hasExclusiveGroup; }

    void setHasExclusiveGroup(bool hasExclusiveGroup) override;

#if QT_CONFIG(shortcut)

    QKeySequence shortcut() const { return m_shortcut; }

    void setShortcut(const QKeySequence& shortcut) override;

#endif

    void setIconSize(int size) override { Q_UNUSED(size); }

    void setNativeContents(WId item) override { Q_UNUSED(item); }

    int dbusID() const { return m_dbusID; }

    void trigger();

    static QDBusPlatformMenuItem *byId(int id);

    static QList<const QDBusPlatformMenuItem *> byIds(const QList<int> &ids);

private:

    QString m_text;

    QIcon m_icon;

    QPlatformMenu *m_subMenu;

    MenuRole m_role : 4;

    bool m_isEnabled : 1;

    bool m_isVisible : 1;

    bool m_isSeparator : 1;

    bool m_isCheckable : 1;

    bool m_isChecked : 1;

    bool m_hasExclusiveGroup : 1;

    short /*unused*/ : 6;

    short m_dbusID : 16;

#if QT_CONFIG(shortcut)

    QKeySequence m_shortcut;

#endif

};

class QDBusPlatformMenu : public QPlatformMenu

    Q_OBJECT

public:

    QDBusPlatformMenu();

    ~QDBusPlatformMenu();

    void insertMenuItem(QPlatformMenuItem *menuItem, QPlatformMenuItem *before) override;

    void removeMenuItem(QPlatformMenuItem *menuItem) override;

    void syncSubMenu(const QDBusPlatformMenu *menu);

    void syncMenuItem(QPlatformMenuItem *menuItem) override;

    void syncSeparatorsCollapsible(bool enable) override { Q_UNUSED(enable); }

    const QString text() const { return m_text; }

    void setText(const QString &text) override;

    QIcon icon() const { return m_icon; }

    void setIcon(const QIcon &icon) override;

    bool isEnabled() const override { return m_isEnabled; }

    void setEnabled(bool enabled) override;

    bool isVisible() const { return m_isVisible; }

    void setVisible(bool visible) override;

    void setMinimumWidth(int width) override { Q_UNUSED(width); }

    void setFont(const QFont &font) override { Q_UNUSED(font); }

    void setMenuType(MenuType type) override { Q_UNUSED(type); }

    void setContainingMenuItem(QDBusPlatformMenuItem *item);

    void showPopup(const QWindow *parentWindow, const QRect &targetRect, const QPlatformMenuItem *item) override;

    void dismiss() override { } // Closes this and all its related menu popups

    QPlatformMenuItem *menuItemAt(int position) const override;

    QPlatformMenuItem *menuItemForTag(quintptr tag) const override;

    const QList<QDBusPlatformMenuItem *> items() const;

    QPlatformMenuItem *createMenuItem() const override;

    QPlatformMenu *createSubMenu() const override;

    uint revision() const { return m_revision; }

    void emitUpdated();

signals:

    void updated(uint revision, int dbusId);

    void propertiesUpdated(QDBusMenuItemList updatedProps, QDBusMenuItemKeysList removedProps);

    void popupRequested(int id, uint timestamp);

private:

    QString m_text;

    QIcon m_icon;

    bool m_isEnabled;

    bool m_isVisible;

    uint m_revision;

    QHash<quintptr, QDBusPlatformMenuItem *> m_itemsByTag;

    QList<QDBusPlatformMenuItem *> m_items;

    QDBusPlatformMenuItem *m_containingMenuItem;

};

QT_END_NAMESPACE

#endif