tqdbusdata.h

Go to the documentation of this file.

/* qdbusdata.h DBUS data transport type
 *
 * Copyright (C) 2007 Kevin Krammer <kevin.krammer@gmx.at>
 *
 * Licensed under the Academic Free License version 2.1
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
 * USA.
 *
 */

#ifndef TQDBUSDATA_H
#define TQDBUSDATA_H

#include "tqdbusmacros.h"
#include <tqglobal.h>

class TQCString;
class TQT_DBusDataList;
class TQT_DBusVariant;
class TQT_DBusObjectPath;
class TQT_DBusUnixFd;
class TQString;

template<typename T> class TQValueList;
template<typename T> class TQT_DBusDataMap;

class TQDBUS_EXPORT TQT_DBusData
{
public:
    enum Type
    {
        Invalid = 0,

        Bool,

        Byte,

        Int16,

        UInt16,

        Int32,

        UInt32,

        Int64,

        UInt64,

        Double,

        String,

        ObjectPath,

        UnixFd,

        List,

        Struct,

        Variant,

        Map
    };

    TQT_DBusData();

    TQT_DBusData(const TQT_DBusData& other);

    ~TQT_DBusData();

    TQT_DBusData& operator=(const TQT_DBusData& other);

    bool operator==(const TQT_DBusData& other) const;

    bool operator!=(const TQT_DBusData& other) const;

    inline bool isValid() const { return type() != TQT_DBusData::Invalid; }

    Type type() const;

    Type keyType() const;

    inline const char* typeName() const { return typeName(type()); }

    static const char* typeName(Type type);

    static TQT_DBusData fromBool(bool value);

    bool toBool(bool* ok = 0) const;

    static TQT_DBusData fromByte(TQ_UINT8 value);

    TQ_UINT8 toByte(bool* ok = 0) const;

    static TQT_DBusData fromInt16(TQ_INT16 value);

    TQ_INT16 toInt16(bool* ok = 0) const;

    static TQT_DBusData fromUInt16(TQ_UINT16 value);

    TQ_UINT16 toUInt16(bool* ok = 0) const;

    static TQT_DBusData fromInt32(TQ_INT32 value);

    TQ_INT32 toInt32(bool* ok = 0) const;

    static TQT_DBusData fromUInt32(TQ_UINT32 value);

    TQ_UINT32 toUInt32(bool* ok = 0) const;

    static TQT_DBusData fromInt64(TQ_INT64 value);

    TQ_INT64 toInt64(bool* ok = 0) const;

    static TQT_DBusData fromUInt64(TQ_UINT64 value);

    TQ_UINT64 toUInt64(bool* ok = 0) const;

    static TQT_DBusData fromDouble(double value);

    double toDouble(bool* ok = 0) const;

    static TQT_DBusData fromString(const TQString& value);

    TQString toString(bool* ok = 0) const;

    static TQT_DBusData fromObjectPath(const TQT_DBusObjectPath& value);

    TQT_DBusObjectPath toObjectPath(bool* ok = 0) const;

    static TQT_DBusData fromUnixFd(const TQT_DBusUnixFd& value);

    TQT_DBusUnixFd toUnixFd(bool* ok = 0) const;

    static TQT_DBusData fromList(const TQT_DBusDataList& list);

    TQT_DBusDataList toList(bool* ok = 0) const;

    static TQT_DBusData fromTQValueList(const TQValueList<TQT_DBusData>& list);

    TQValueList<TQT_DBusData> toTQValueList(bool* ok = 0) const;

    static TQT_DBusData fromStruct(const TQValueList<TQT_DBusData>& memberList);

    TQValueList<TQT_DBusData> toStruct(bool* ok = 0) const;

    static TQT_DBusData fromVariant(const TQT_DBusVariant& value);

    TQT_DBusVariant toVariant(bool* ok = 0) const;

    TQT_DBusData getAsVariantData();

    static TQT_DBusData fromByteKeyMap(const TQT_DBusDataMap<TQ_UINT8>& map);

    TQT_DBusDataMap<TQ_UINT8> toByteKeyMap(bool* ok = 0) const;

    static TQT_DBusData fromInt16KeyMap(const TQT_DBusDataMap<TQ_INT16>& map);

    TQT_DBusDataMap<TQ_INT16> toInt16KeyMap(bool* ok = 0) const;

    static TQT_DBusData fromUInt16KeyMap(const TQT_DBusDataMap<TQ_UINT16>& map);

    TQT_DBusDataMap<TQ_UINT16> toUInt16KeyMap(bool* ok = 0) const;

    static TQT_DBusData fromInt32KeyMap(const TQT_DBusDataMap<TQ_INT32>& map);

    TQT_DBusDataMap<TQ_INT32> toInt32KeyMap(bool* ok = 0) const;

    static TQT_DBusData fromUInt32KeyMap(const TQT_DBusDataMap<TQ_UINT32>& map);

    TQT_DBusDataMap<TQ_UINT32> toUInt32KeyMap(bool* ok = 0) const;

    static TQT_DBusData fromInt64KeyMap(const TQT_DBusDataMap<TQ_INT64>& map);

    TQT_DBusDataMap<TQ_INT64> toInt64KeyMap(bool* ok = 0) const;

    static TQT_DBusData fromUInt64KeyMap(const TQT_DBusDataMap<TQ_UINT64>& map);

    TQT_DBusDataMap<TQ_UINT64> toUInt64KeyMap(bool* ok = 0) const;

    static TQT_DBusData fromStringKeyMap(const TQT_DBusDataMap<TQString>& map);

    TQT_DBusDataMap<TQString> toStringKeyMap(bool* ok = 0) const;

    static TQT_DBusData fromObjectPathKeyMap(const TQT_DBusDataMap<TQT_DBusObjectPath>& map);

    TQT_DBusDataMap<TQT_DBusObjectPath> toObjectPathKeyMap(bool* ok = 0) const;

    static TQT_DBusData fromUnixFdKeyMap(const TQT_DBusDataMap<TQT_DBusUnixFd>& map);

    TQT_DBusDataMap<TQT_DBusUnixFd> toUnixFdKeyMap(bool* ok = 0) const;

    TQCString buildDBusSignature() const;

private:
    class Private;
    Private* d;
};

#endif