1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the tools applications 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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QDBUSMODEL_H
43 #define QDBUSMODEL_H
44 
45 #include <QtCore/qabstractitemmodel.h>
46 #include <QtDBus/QtDBus>
47 
48 struct QDBusItem;
49 
50 QT_FORWARD_DECLARE_CLASS(QDomDocument);
51 QT_FORWARD_DECLARE_CLASS(QDomElement);
52 
53 
54 class QDBusModel: public QAbstractItemModel
55 {
56     Q_OBJECT
57 
58 public:
59     enum Type { InterfaceItem, PathItem, MethodItem, SignalItem, PropertyItem };
60 
61     QDBusModel(const QString &service, const QDBusConnection &connection);
62     ~QDBusModel();
63 
64     QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
65     QModelIndex parent(const QModelIndex &child) const;
66     int rowCount(const QModelIndex &parent = QModelIndex()) const;
67     int columnCount(const QModelIndex &parent = QModelIndex()) const;
68     QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
69     QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const;
70 
71     Type itemType(const QModelIndex &index) const;
72     QString dBusPath(const QModelIndex &index) const;
73     QString dBusInterface(const QModelIndex &index) const;
74     QString dBusMethodName(const QModelIndex &index) const;
75     QString dBusTypeSignature(const QModelIndex &index) const;
76 
77     void refresh(const QModelIndex &index = QModelIndex());
78 
79     QModelIndex findObject(const QDBusObjectPath &objectPath);
80 
81 Q_SIGNALS:
82     void busError(const QString &text);
83 
84 private:
85     QDomDocument introspect(const QString &path);
86     void addMethods(QDBusItem *parent, const QDomElement &iface);
87     void addPath(QDBusItem *parent);
88 
89     QString service;
90     QDBusConnection c;
91     QDBusItem *root;
92 };
93 
94 #endif
95 
96