1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the QtDBus module of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #ifndef QDBUSMESSAGE_H

    43 #define QDBUSMESSAGE_H

    44 

    45 #include <QtDBus/qdbusmacros.h>

    46 #include <QtDBus/qdbuserror.h>

    47 #include <QtCore/qlist.h>

    48 #include <QtCore/qvariant.h>

    49 

    50 QT_BEGIN_HEADER

    51 

    52 QT_BEGIN_NAMESPACE

    53 

    54 QT_MODULE(DBus)

    55 

    56 class QDBusMessagePrivate;

    57 class QDBUS_EXPORT QDBusMessage

    58 {

    59 public:

    60     enum MessageType {

    61         InvalidMessage,

    62         MethodCallMessage,

    63         ReplyMessage,

    64         ErrorMessage,

    65         SignalMessage

    66     };

    67 

    68     QDBusMessage();

    69     QDBusMessage(const QDBusMessage &other);

    70     QDBusMessage &operator=(const QDBusMessage &other);

    71     ~QDBusMessage();

    72 

    73     static QDBusMessage createSignal(const QString &path, const QString &interface,

    74                                      const QString &name);

    75     static QDBusMessage createMethodCall(const QString &destination, const QString &path,

    76                                          const QString &interface, const QString &method);

    77     static QDBusMessage createError(const QString &name, const QString &msg);

    78     static inline QDBusMessage createError(const QDBusError &err)

    79     { return createError(err.name(), err.message()); }

    80     static inline QDBusMessage createError(QDBusError::ErrorType type, const QString &msg)

    81     { return createError(QDBusError::errorString(type), msg); }

    82 

    83     QDBusMessage createReply(const QList<QVariant> &arguments = QList<QVariant>()) const;

    84     inline QDBusMessage createReply(const QVariant &argument) const

    85     { return createReply(QList<QVariant>() << argument); }

    86 

    87     QDBusMessage createErrorReply(const QString name, const QString &msg) const;

    88     inline QDBusMessage createErrorReply(const QDBusError &err) const

    89     { return createErrorReply(err.name(), err.message()); }

    90     QDBusMessage createErrorReply(QDBusError::ErrorType type, const QString &msg) const;

    91 

    92     // there are no setters; if this changes, see qdbusmessage_p.h

    93     QString service() const;

    94     QString path() const;

    95     QString interface() const;

    96     QString member() const;

    97     QString errorName() const;

    98     QString errorMessage() const;

    99     MessageType type() const;

   100     QString signature() const;

   101 

   102     bool isReplyRequired() const;

   103 

   104     void setDelayedReply(bool enable) const;

   105     bool isDelayedReply() const;

   106 

   107     void setArguments(const QList<QVariant> &arguments);

   108     QList<QVariant> arguments() const;

   109 

   110     QDBusMessage &operator<<(const QVariant &arg);

   111 

   112 private:

   113     friend class QDBusMessagePrivate;

   114     QDBusMessagePrivate *d_ptr;

   115 };

   116 

   117 #ifndef QT_NO_DEBUG_STREAM

   118 QDBUS_EXPORT QDebug operator<<(QDebug, const QDBusMessage &);

   119 #endif

   120 

   121 QT_END_NAMESPACE

   122 

   123 QT_END_HEADER

   124 

   125 #endif

   126