src/dbus/qdbuspendingcall.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtDBus module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QDBUSPENDINGCALL_H
  43 #define QDBUSPENDINGCALL_H
  44
  45 #include <QtCore/qglobal.h>
  46 #include <QtCore/qobject.h>
  47 #include <QtCore/qshareddata.h>
  48
  49 #include <QtDBus/qdbusmacros.h>
  50 #include <QtDBus/qdbusmessage.h>
  51
  52 #ifndef QT_NO_DBUS
  53
  54 QT_BEGIN_HEADER
  55
  56 QT_BEGIN_NAMESPACE
  57
  58
  59 class QDBusConnection;
  60 class QDBusError;
  61 class QDBusPendingCallWatcher;
  62
  63 class QDBusPendingCallPrivate;
  64 class Q_DBUS_EXPORT QDBusPendingCall
  65 {
  66 public:
  67     QDBusPendingCall(const QDBusPendingCall &other);
  68     ~QDBusPendingCall();
  69     QDBusPendingCall &operator=(const QDBusPendingCall &other);
  70
  71     void swap(QDBusPendingCall &other) { qSwap(d, other.d); }
  72
  73 #ifndef Q_QDOC
  74     // pretend that they aren't here
  75     bool isFinished() const;
  76     void waitForFinished();
  77
  78     bool isError() const;
  79     bool isValid() const;
  80     QDBusError error() const;
  81     QDBusMessage reply() const;
  82 #endif
  83
  84     static QDBusPendingCall fromError(const QDBusError &error);
  85     static QDBusPendingCall fromCompletedCall(const QDBusMessage &message);
  86
  87 protected:
  88     QExplicitlySharedDataPointer<QDBusPendingCallPrivate> d;
  89     friend class QDBusPendingCallPrivate;
  90     friend class QDBusPendingCallWatcher;
  91     friend class QDBusConnection;
  92
  93     QDBusPendingCall(QDBusPendingCallPrivate *dd);
  94
  95 private:
  96     QDBusPendingCall();         // not defined
  97 };
  98
  99 Q_DECLARE_SHARED(QDBusPendingCall)
 100
 101 class QDBusPendingCallWatcherPrivate;
 102 class Q_DBUS_EXPORT QDBusPendingCallWatcher: public QObject, public QDBusPendingCall
 103 {
 104     Q_OBJECT
 105 public:
 106     explicit QDBusPendingCallWatcher(const QDBusPendingCall &call, QObject *parent = 0);
 107     ~QDBusPendingCallWatcher();
 108
 109 #ifdef Q_QDOC
 110     // trick qdoc into thinking this method is here
 111     bool isFinished() const;
 112 #endif
 113     void waitForFinished();     // non-virtual override
 114
 115 Q_SIGNALS:
 116     void finished(QDBusPendingCallWatcher *self);
 117
 118 private:
 119     Q_DECLARE_PRIVATE(QDBusPendingCallWatcher)
 120     Q_PRIVATE_SLOT(d_func(), void _q_finished())
 121 };
 122
 123 QT_END_NAMESPACE
 124
 125 QT_END_HEADER
 126
 127 #endif // QT_NO_DBUS
 128 #endif