diff options
Diffstat (limited to 'src/dbus/qdbusextratypes.cpp')
| -rw-r--r-- | src/dbus/qdbusextratypes.cpp | 242 |
1 files changed, 242 insertions, 0 deletions
diff --git a/src/dbus/qdbusextratypes.cpp b/src/dbus/qdbusextratypes.cpp new file mode 100644 index 0000000000..bd7d506d34 --- /dev/null +++ b/src/dbus/qdbusextratypes.cpp @@ -0,0 +1,242 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtDBus module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qdbusextratypes.h" +#include "qdbusutil_p.h" + +#ifndef QT_NO_DBUS + +QT_BEGIN_NAMESPACE + +void QDBusObjectPath::check() +{ + if (!QDBusUtil::isValidObjectPath(*this)) { + qWarning("QDBusObjectPath: invalid path \"%s\"", qPrintable(*this)); + clear(); + } +} + +void QDBusSignature::check() +{ + if (!QDBusUtil::isValidSignature(*this)) { + qWarning("QDBusSignature: invalid signature \"%s\"", qPrintable(*this)); + clear(); + } +} + +/*! + \class QDBusVariant + \inmodule QtDBus + \since 4.2 + + \brief The QDBusVariant class enables the programmer to identify + the variant type provided by the D-Bus typesystem. + + A D-Bus function that takes an integer, a D-Bus variant and a string as parameters + can be called with the following argument list (see QDBusMessage::setArguments()): + + \snippet doc/src/snippets/qdbusextratypes/qdbusextratypes.cpp 0 + + When a D-Bus function returns a D-Bus variant, it can be retrieved as follows: + + \snippet doc/src/snippets/qdbusextratypes/qdbusextratypes.cpp 1 + + The QVariant within a QDBusVariant is required to distinguish between a normal + D-Bus value and a value within a D-Bus variant. + + \sa {The QtDBus type system} +*/ + +/*! + \fn QDBusVariant::QDBusVariant() + + Constructs a new D-Bus variant. +*/ + +/*! + \fn QDBusVariant::QDBusVariant(const QVariant &variant) + + Constructs a new D-Bus variant from the given Qt \a variant. + + \sa setVariant() +*/ + +/*! + \fn QVariant QDBusVariant::variant() const + + Returns this D-Bus variant as a QVariant object. + + \sa setVariant() +*/ + +/*! + \fn void QDBusVariant::setVariant(const QVariant &variant) + + Assigns the value of the given Qt \a variant to this D-Bus variant. + + \sa variant() +*/ + +/*! + \class QDBusObjectPath + \inmodule QtDBus + \since 4.2 + + \brief The QDBusObjectPath class enables the programmer to + identify the OBJECT_PATH type provided by the D-Bus typesystem. + + \sa {The QtDBus type system} +*/ + +/*! + \fn QDBusObjectPath::QDBusObjectPath() + + Constructs a new object path. +*/ + +/*! + \fn QDBusObjectPath::QDBusObjectPath(const char *path) + + Constructs a new object path from the given \a path. + + \sa setPath() +*/ + +/*! + \fn QDBusObjectPath::QDBusObjectPath(const QLatin1String &path) + + Constructs a new object path from the given \a path. +*/ + +/*! + \fn QDBusObjectPath::QDBusObjectPath(const QString &path) + + Constructs a new object path from the given \a path. +*/ + +/*! + \fn QString QDBusObjectPath::path() const + + Returns this object path. + + \sa setPath() +*/ + +/*! + \fn void QDBusObjectPath::setPath(const QString &path) + + Assigns the value of the given \a path to this object path. + + \sa path() +*/ + +/*! + \fn QDBusObjectPath &QDBusObjectPath::operator=(const QDBusObjectPath &path) + + Assigns the value of the given \a path to this object path. + + \sa setPath() +*/ + + +/*! + \class QDBusSignature + \inmodule QtDBus + \since 4.2 + + \brief The QDBusSignature class enables the programmer to + identify the SIGNATURE type provided by the D-Bus typesystem. + + \sa {The QtDBus type system} +*/ + +/*! + \fn QDBusSignature::QDBusSignature() + + Constructs a new signature. + + \sa setSignature() +*/ + +/*! + \fn QDBusSignature::QDBusSignature(const char *signature) + + Constructs a new signature from the given \a signature. +*/ + +/*! + \fn QDBusSignature::QDBusSignature(const QLatin1String &signature) + + Constructs a new signature from the given \a signature. +*/ + +/*! + \fn QDBusSignature::QDBusSignature(const QString &signature) + + Constructs a new signature from the given \a signature. +*/ + +/*! + \fn QString QDBusSignature::signature() const + + Returns this signature. + + \sa setSignature() +*/ + +/*! + \fn void QDBusSignature::setSignature(const QString &signature) + + Assigns the value of the given \a signature to this signature. + \sa signature() +*/ + +/*! + \fn QDBusSignature &QDBusSignature::operator=(const QDBusSignature &signature) + + Assigns the value of the given \a signature to this signature. + + \sa setSignature() +*/ + +QT_END_NAMESPACE + +#endif // QT_NO_DBUS |