1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtGui module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QDBUSMENUTYPES_H
41#define QDBUSMENUTYPES_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of other Qt classes. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QObject>
55#include <QString>
56#include <QDBusArgument>
57#include <QDBusConnection>
58#include <QDBusObjectPath>
59#include <QPixmap>
60
61QT_BEGIN_NAMESPACE
62
63class QDBusPlatformMenu;
64class QDBusPlatformMenuItem;
65class QDBusMenuItem;
66typedef QVector<QDBusMenuItem> QDBusMenuItemList;
67typedef QVector<QStringList> QDBusMenuShortcut;
68
69class QDBusMenuItem
70{
71public:
72 QDBusMenuItem() { }
73 QDBusMenuItem(const QDBusPlatformMenuItem *item);
74
75 static QDBusMenuItemList items(const QList<int> &ids, const QStringList &propertyNames);
76 static QString convertMnemonic(const QString &label);
77#ifndef QT_NO_SHORTCUT
78 static QDBusMenuShortcut convertKeySequence(const QKeySequence &sequence);
79#endif
80 static void registerDBusTypes();
81
82 int m_id;
83 QVariantMap m_properties;
84};
85Q_DECLARE_TYPEINFO(QDBusMenuItem, Q_MOVABLE_TYPE);
86
87const QDBusArgument &operator<<(QDBusArgument &arg, const QDBusMenuItem &item);
88const QDBusArgument &operator>>(const QDBusArgument &arg, QDBusMenuItem &item);
89
90class QDBusMenuItemKeys
91{
92public:
93
94 int id;
95 QStringList properties;
96};
97Q_DECLARE_TYPEINFO(QDBusMenuItemKeys, Q_MOVABLE_TYPE);
98
99const QDBusArgument &operator<<(QDBusArgument &arg, const QDBusMenuItemKeys &keys);
100const QDBusArgument &operator>>(const QDBusArgument &arg, QDBusMenuItemKeys &keys);
101
102typedef QVector<QDBusMenuItemKeys> QDBusMenuItemKeysList;
103
104class QDBusMenuLayoutItem
105{
106public:
107 uint populate(int id, int depth, const QStringList &propertyNames, const QDBusPlatformMenu *topLevelMenu);
108 void populate(const QDBusPlatformMenu *menu, int depth, const QStringList &propertyNames);
109 void populate(const QDBusPlatformMenuItem *item, int depth, const QStringList &propertyNames);
110
111 int m_id;
112 QVariantMap m_properties;
113 QVector<QDBusMenuLayoutItem> m_children;
114};
115Q_DECLARE_TYPEINFO(QDBusMenuLayoutItem, Q_MOVABLE_TYPE);
116
117const QDBusArgument &operator<<(QDBusArgument &arg, const QDBusMenuLayoutItem &);
118const QDBusArgument &operator>>(const QDBusArgument &arg, QDBusMenuLayoutItem &item);
119
120typedef QVector<QDBusMenuLayoutItem> QDBusMenuLayoutItemList;
121
122class QDBusMenuEvent
123{
124public:
125 int m_id;
126 QString m_eventId;
127 QDBusVariant m_data;
128 uint m_timestamp;
129};
130Q_DECLARE_TYPEINFO(QDBusMenuEvent, Q_MOVABLE_TYPE); // QDBusVariant is movable, even though it cannot
131 // be marked as such until Qt 6.
132
133const QDBusArgument &operator<<(QDBusArgument &arg, const QDBusMenuEvent &ev);
134const QDBusArgument &operator>>(const QDBusArgument &arg, QDBusMenuEvent &ev);
135
136typedef QVector<QDBusMenuEvent> QDBusMenuEventList;
137
138#ifndef QT_NO_DEBUG_STREAM
139QDebug operator<<(QDebug d, const QDBusMenuItem &item);
140QDebug operator<<(QDebug d, const QDBusMenuLayoutItem &item);
141#endif
142
143QT_END_NAMESPACE
144
145Q_DECLARE_METATYPE(QDBusMenuItem)
146Q_DECLARE_METATYPE(QDBusMenuItemList)
147Q_DECLARE_METATYPE(QDBusMenuItemKeys)
148Q_DECLARE_METATYPE(QDBusMenuItemKeysList)
149Q_DECLARE_METATYPE(QDBusMenuLayoutItem)
150Q_DECLARE_METATYPE(QDBusMenuLayoutItemList)
151Q_DECLARE_METATYPE(QDBusMenuEvent)
152Q_DECLARE_METATYPE(QDBusMenuEventList)
153Q_DECLARE_METATYPE(QDBusMenuShortcut)
154
155#endif
156

source code of qtbase/src/platformsupport/themes/genericunix/dbusmenu/qdbusmenutypes_p.h