db/dfb/qdbusmessage_8h_source.html

// Copyright (C) 2016 The Qt Company Ltd.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only


#ifndef QDBUSMESSAGE_H

#define QDBUSMESSAGE_H


#include <QtDBus/qtdbusglobal.h>

#include <QtDBus/qdbuserror.h>

#include <QtCore/qlist.h>

#include <QtCore/qvariant.h>


#if !defined(QT_NO_DBUS) && !defined(QT_BOOTSTRAPPED)


#if defined(Q_OS_WIN) && defined(interface)

#  undef interface

#endif


QT_BEGIN_NAMESPACE


class QDBusMessagePrivate;

class Q_DBUS_EXPORT QDBusMessage

{

public:

    enum MessageType {

        InvalidMessage,

        MethodCallMessage,

        ReplyMessage,

        ErrorMessage,

        SignalMessage

    };


    QDBusMessage();

    QDBusMessage(const QDBusMessage &other);

    QDBusMessage &operator=(QDBusMessage &&other) noexcept { swap(other); return *this; }

    QDBusMessage &operator=(const QDBusMessage &other);

    ~QDBusMessage();


    void swap(QDBusMessage &other) noexcept { qt_ptr_swap(d_ptr, other.d_ptr); }


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

                                     const QString &name);

    static QDBusMessage createTargetedSignal(const QString &service, const QString &path,

                                             const QString &interface, const QString &name);

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

                                         const QString &interface, const QString &method);

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

    static inline QDBusMessage createError(const QDBusError &err)

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

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

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


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

    QDBusMessage createReply(const QVariant &argument) const;


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

    inline QDBusMessage createErrorReply(const QDBusError &err) const

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

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


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

    QString service() const;

    QString path() const;

    QString interface() const;

    QString member() const;

    QString errorName() const;

    QString errorMessage() const;

    MessageType type() const;

    QString signature() const;


    bool isReplyRequired() const;


    void setDelayedReply(bool enable) const;

    bool isDelayedReply() const;


    void setAutoStartService(bool enable);

    bool autoStartService() const;


    void setInteractiveAuthorizationAllowed(bool enable);

    bool isInteractiveAuthorizationAllowed() const;


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

    QList<QVariant> arguments() const;


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


private:

    friend class QDBusMessagePrivate;

    QDBusMessagePrivate *d_ptr;

};

Q_DECLARE_SHARED(QDBusMessage)


#ifndef QT_NO_DEBUG_STREAM

Q_DBUS_EXPORT QDebug operator<<(QDebug, const QDBusMessage &);

#endif


QT_END_NAMESPACE


QT_DECL_METATYPE_EXTERN(QDBusMessage, Q_DBUS_EXPORT)


#else

class Q_DBUS_EXPORT QDBusMessage {}; // dummy class for moc

#endif // QT_NO_DBUS

#endif


QDBusError
\inmodule QtDBus
Definition qdbuserror.h:21

QDBusError::message
QString message() const
Returns the message that the callee associated with this error.
Definition qdbuserror.cpp:282

QDBusError::errorString
static QString errorString(ErrorType error)
Definition qdbuserror.cpp:301

QDBusError::ErrorType
ErrorType
In order to facilitate verification of the most common D-Bus errors generated by the D-Bus implementa...
Definition qdbuserror.h:24

QDBusError::name
QString name() const
Returns this error's name.
Definition qdbuserror.cpp:271

QDBusMessagePrivate
Definition qdbusmessage_p.h:33

QDBusMessage
\inmodule QtDBus
Definition qdbusmessage.h:22

QDBusMessage::createError
static QDBusMessage createError(const QDBusError &err)
Constructs a new DBus message representing the given error.
Definition qdbusmessage.h:47

QDBusMessage::swap
void swap(QDBusMessage &other) noexcept
Swaps this QDBusMessage instance with other.
Definition qdbusmessage.h:38

QDBusMessage::operator=
QDBusMessage & operator=(QDBusMessage &&other) noexcept
Definition qdbusmessage.h:34

QDBusMessage::MessageType
MessageType
The possible message types:
Definition qdbusmessage.h:24

QDBusMessage::MethodCallMessage
@ MethodCallMessage
Definition qdbusmessage.h:26

QDBusMessage::ReplyMessage
@ ReplyMessage
Definition qdbusmessage.h:27

QDBusMessage::InvalidMessage
@ InvalidMessage
Definition qdbusmessage.h:25

QDBusMessage::ErrorMessage
@ ErrorMessage
Definition qdbusmessage.h:28

QDBusMessage::createErrorReply
QDBusMessage createErrorReply(const QDBusError &err) const
Constructs a new DBus message representing an error reply message, from the given error object.
Definition qdbusmessage.h:56

QDBusMessage::createError
static QDBusMessage createError(QDBusError::ErrorType type, const QString &msg)
Constructs a new DBus message for the error type type using the message msg.
Definition qdbusmessage.h:49

QDebug
\inmodule QtCore

QList
Definition qlist.h:74

QString
\macro QT_RESTRICTED_CAST_FROM_ASCII
Definition qstring.h:127

QVariant
\inmodule QtCore
Definition qvariant.h:64

arguments
QList< QVariant > arguments
Definition doc_src_qsignalspy.cpp:12

QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qstandardpaths_haiku.cpp:21

QT_END_NAMESPACE
Definition qsharedpointer.cpp:1545

MessageType
MessageType
Definition qcommandlineparser.cpp:517

destination
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char return DBusMessage return DBusMessage const char * destination
Definition qdbus_symbols_p.h:360

interface
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char * interface
Definition qdbus_symbols_p.h:347

method
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char * method
Definition qdbus_symbols_p.h:348

operator<<
Q_DBUS_EXPORT QDebug operator<<(QDebug, const QDBusMessage &)
Definition qdbusmessage.cpp:811

QT_DECL_METATYPE_EXTERN
#define QT_DECL_METATYPE_EXTERN(TYPE, EXPORT)
Definition qmetatype.h:1367

type
GLenum type
Definition qopengles2ext.h:150

enable
GLboolean enable
Definition qopengles2ext.h:855

name
GLuint name
Definition qopengles2ext.h:156

path
GLsizei const GLchar *const  * path
Definition qopenglext.h:4283

arg
SSL_CTX int(*) void arg)
Definition qsslsocket_openssl_symbols.cpp:404

qt_ptr_swap
constexpr void qt_ptr_swap(T *&lhs, T *&rhs) noexcept
Definition qswap.h:43

errorMessage
static QString errorMessage(QUrlPrivate::ErrorCode errorCode, const QString &errorSource, qsizetype errorPosition)
Definition qurl.cpp:3503

operator<<
QDataStream & operator<<(QDataStream &out, const MyClass &myObj)
[4]

other
QSharedPointer< T > other(t)
[5]

swap
this swap(other)

argument
QDBusArgument argument
Definition src_qdbus_qdbusargument.cpp:16