1// Copyright (C) 2020 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#ifndef QDBUSMENUTYPES_H
5#define QDBUSMENUTYPES_H
6
7//
8// W A R N I N G
9// -------------
10//
11// This file is not part of the Qt API. It exists for the convenience
12// of other Qt classes. This header file may change from version to
13// version without notice, or even be removed.
14//
15// We mean it.
16//
17
18#include <QObject>
19#include <QString>
20#include <QDBusArgument>
21#include <QDBusConnection>
22#include <QDBusObjectPath>
23#include <QPixmap>
24#include <private/qglobal_p.h>
25
26QT_BEGIN_NAMESPACE
27
28class QDBusPlatformMenu;
29class QDBusPlatformMenuItem;
30class QDBusMenuItem;
31typedef QList<QDBusMenuItem> QDBusMenuItemList;
32typedef QList<QStringList> QDBusMenuShortcut;
33
34class QDBusMenuItem
35{
36public:
37 QDBusMenuItem() { }
38 QDBusMenuItem(const QDBusPlatformMenuItem *item);
39
40 static QDBusMenuItemList items(const QList<int> &ids, const QStringList &propertyNames);
41 static QString convertMnemonic(const QString &label);
42#ifndef QT_NO_SHORTCUT
43 static QDBusMenuShortcut convertKeySequence(const QKeySequence &sequence);
44#endif
45 static void registerDBusTypes();
46
47 int m_id;
48 QVariantMap m_properties;
49};
50Q_DECLARE_TYPEINFO(QDBusMenuItem, Q_RELOCATABLE_TYPE);
51
52const QDBusArgument &operator<<(QDBusArgument &arg, const QDBusMenuItem &item);
53const QDBusArgument &operator>>(const QDBusArgument &arg, QDBusMenuItem &item);
54
55class QDBusMenuItemKeys
56{
57public:
58
59 int id;
60 QStringList properties;
61};
62Q_DECLARE_TYPEINFO(QDBusMenuItemKeys, Q_RELOCATABLE_TYPE);
63
64const QDBusArgument &operator<<(QDBusArgument &arg, const QDBusMenuItemKeys &keys);
65const QDBusArgument &operator>>(const QDBusArgument &arg, QDBusMenuItemKeys &keys);
66
67typedef QList<QDBusMenuItemKeys> QDBusMenuItemKeysList;
68
69class QDBusMenuLayoutItem
70{
71public:
72 uint populate(int id, int depth, const QStringList &propertyNames, const QDBusPlatformMenu *topLevelMenu);
73 void populate(const QDBusPlatformMenu *menu, int depth, const QStringList &propertyNames);
74 void populate(const QDBusPlatformMenuItem *item, int depth, const QStringList &propertyNames);
75
76 int m_id;
77 QVariantMap m_properties;
78 QList<QDBusMenuLayoutItem> m_children;
79};
80Q_DECLARE_TYPEINFO(QDBusMenuLayoutItem, Q_RELOCATABLE_TYPE);
81
82const QDBusArgument &operator<<(QDBusArgument &arg, const QDBusMenuLayoutItem &);
83const QDBusArgument &operator>>(const QDBusArgument &arg, QDBusMenuLayoutItem &item);
84
85typedef QList<QDBusMenuLayoutItem> QDBusMenuLayoutItemList;
86
87class QDBusMenuEvent
88{
89public:
90 int m_id;
91 QString m_eventId;
92 QDBusVariant m_data;
93 uint m_timestamp;
94};
95Q_DECLARE_TYPEINFO(QDBusMenuEvent, Q_RELOCATABLE_TYPE); // QDBusVariant is movable, even though it cannot
96 // be marked as such until Qt 6.
97
98const QDBusArgument &operator<<(QDBusArgument &arg, const QDBusMenuEvent &ev);
99const QDBusArgument &operator>>(const QDBusArgument &arg, QDBusMenuEvent &ev);
100
101typedef QList<QDBusMenuEvent> QDBusMenuEventList;
102
103#ifndef QT_NO_DEBUG_STREAM
104QDebug operator<<(QDebug d, const QDBusMenuItem &item);
105QDebug operator<<(QDebug d, const QDBusMenuLayoutItem &item);
106#endif
107
108QT_END_NAMESPACE
109
110QT_DECL_METATYPE_EXTERN(QDBusMenuItem, Q_GUI_EXPORT)
111QT_DECL_METATYPE_EXTERN(QDBusMenuItemList, Q_GUI_EXPORT)
112QT_DECL_METATYPE_EXTERN(QDBusMenuItemKeys, Q_GUI_EXPORT)
113QT_DECL_METATYPE_EXTERN(QDBusMenuItemKeysList, Q_GUI_EXPORT)
114QT_DECL_METATYPE_EXTERN(QDBusMenuLayoutItem, Q_GUI_EXPORT)
115QT_DECL_METATYPE_EXTERN(QDBusMenuLayoutItemList, Q_GUI_EXPORT)
116QT_DECL_METATYPE_EXTERN(QDBusMenuEvent, Q_GUI_EXPORT)
117QT_DECL_METATYPE_EXTERN(QDBusMenuEventList, Q_GUI_EXPORT)
118QT_DECL_METATYPE_EXTERN(QDBusMenuShortcut, Q_GUI_EXPORT)
119
120#endif
121

source code of qtbase/src/gui/platform/unix/dbusmenu/qdbusmenutypes_p.h