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 QtDBus 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 QDBUSCONTEXT_H 41 #define QDBUSCONTEXT_H 42 43 #include <QtDBus/qtdbusglobal.h> 44 #include <QtCore/qstring.h> 45 #include <QtDBus/qdbuserror.h> 46 47 #ifndef QT_NO_DBUS 48 49 QT_BEGIN_NAMESPACE 50 51 52 class QDBusConnection; 53 class QDBusMessage; 54 55 class QDBusContextPrivate; 56 class Q_DBUS_EXPORT QDBusContext 57 { 58 public: 59 QDBusContext(); 60 ~QDBusContext(); 61 62 bool calledFromDBus() const; 63 QDBusConnection connection() const; 64 const QDBusMessage &message() const; 65 66 // convenience methods 67 bool isDelayedReply() const; 68 // yes, they are const, so that you can use them even from const methods 69 void setDelayedReply(bool enable) const; 70 void sendErrorReply(const QString &name, const QString &msg = QString()) const; 71 void sendErrorReply(QDBusError::ErrorType type, const QString &msg = QString()) const; 72 73 private: 74 QDBusContextPrivate *d_ptr; 75 friend class QDBusContextPrivate; 76 }; 77 78 QT_END_NAMESPACE 79 80 #endif // QT_NO_DBUS 81 #endif 82