QDBusArgument Class

成员函数文档

QDBusArgument::QDBusArgument()

构造一个空的 QDBusArgument 参数。

空的 QDBusArgument 对象不允许执行读或写操作。

QDBusArgument::QDBusArgument(const QDBusArgument &other)

构造other QDBusArgument 对象的副本。

因此，从这一点出发，两个对象将包含相同的状态。QDBusArguments 是明确共享的，因此对其中一个副本的任何修改都会影响另一个副本。

[noexcept] QDBusArgument::~QDBusArgument()

处理与QDBusArgument 对象相关的资源。

QVariant QDBusArgument::asVariant() const

以QVariant 的形式返回当前参数。基本类型将在QVariant 中解码并返回，但对于复杂类型，该函数将在QVariant 中返回一个QDBusArgument 对象。调用者有责任对参数进行解码（例如，在其中调用 asVariant()）。

例如，如果当前参数是 INT32，该函数将返回一个QVariant ，其参数类型为QMetaType::Int 。对于 INT32 数组，它将返回一个包含QDBusArgument 的QVariant 。

如果出现错误或没有更多参数可供解码（即参数列表已结束），该函数将返回一个无效的QVariant 。

另请参见 atEnd()。

bool QDBusArgument::atEnd() const

如果从QDBusArgument 中不再提取元素，则返回true 。该函数通常用于beginMap() 和beginArray() 返回的QDBusArgument 对象。

void QDBusArgument::beginArray() const

递归到 D-Bus 数组，以便提取数组元素。

该函数通常用于operator>> 流运算符，如下面的示例：

// Extract a MyArray array of MyElement elements
const QDBusArgument &operator>>(const QDBusArgument &argument, MyArray &myArray)
{
    argument.beginArray();
    myArray.clear();

    while (!argument.atEnd()) {
        MyElement element;
        argument >> element;
        myArray.append(element);
    }

    argument.endArray();
    return argument;
}

如果您要解散的类型是QList 或 Qt XML 的任何一个只接受一个模板参数的容器类，则无需为其声明operator>> 函数，因为Qt D-Bus 提供了通用模板来完成解散数据的工作。这同样适用于 STL 的序列容器，如std::list,std::vector 等。

另请参见 atEnd()、beginStructure() 和beginMap()。

void QDBusArgument::beginArray(QMetaType id)

打开一个新的 D-Bus 数组，用于追加元类型为id 的元素。

该函数通常用于operator<< 流操作符，如下面的示例：

// Append an array of MyElement types
QDBusArgument &operator<<(QDBusArgument &argument, const MyArray &myArray)
{
    argument.beginArray(qMetaTypeId<MyElement>());
    for (const auto &element : myArray)
        argument << element;
    argument.endArray();
    return argument;
}

如果您要 marshall 的类型是QList 或任何 Qt XML 的容器类（只需一个模板参数），则无需为其声明operator<< 函数，因为Qt D-Bus 提供了通用模板来完成数据 marshall 的工作。这同样适用于 STL 的序列容器，如std::list,std::vector 等。

另请参见 endArray()、beginStructure() 和beginMap()。

void QDBusArgument::beginMap() const

递归到 D-Bus 映射中，以便提取映射中的元素。

该函数通常用于operator>> 流操作符，如下面的示例：

// Extract a MyDictionary map that associates integers to MyElement items
const QDBusArgument &operator>>(const QDBusArgument &argument, MyDictionary &myDict)
{
    argument.beginMap();
    myDict.clear();

    while (!argument.atEnd()) {
        int key;
        MyElement value;
        argument.beginMapEntry();
        argument >> key >> value;
        argument.endMapEntry();
        myDict.insert(key, value);
    }

    argument.endMap();
    return argument;
}

如果要拆分的类型是QMap 或QHash ，则无需为其声明operator>> 函数，因为Qt D-Bus 提供了通用模板来完成拆分数据的工作。

另请参阅 endMap()、beginStructure()、beginArray() 和beginMapEntry()。

void QDBusArgument::beginMap(QMetaType keyMetaType, QMetaType valueMetaType)

打开一个适合添加元素的新 D-Bus 映射。映射是将一个条目（键）与另一个条目（值）关联起来的容器，如 Qt 的QMap 或QHash 。映射的键和值元类型的 id 必须分别在keyMetaType 和valueMetaType 中传递。

该函数通常用于operator<< 流操作符，如下面的示例：

// Append a dictionary that associates ints to MyValue types
QDBusArgument &operator<<(QDBusArgument &argument, const MyDictionary &myDict)
{
    argument.beginMap(QMetaType::fromType<int>(), QMetaType::fromType<MyValue>());
    MyDictionary::const_iterator i;
    for (i = myDict.cbegin(); i != myDict.cend(); ++i) {
        argument.beginMapEntry();
        argument << i.key() << i.value();
        argument.endMapEntry();
    }
    argument.endMap();
    return argument;
}

您通常不需要为关联容器（如QHash 或 std::map）提供operator<< 或operator>> 函数，因为Qt D-Bus 提供了通用模板来完成数据的 marshalling 工作。

另请参见 endMap()、beginStructure()、beginArray() 和beginMapEntry()。

void QDBusArgument::beginMapEntry()

打开一个适合附加键和值条目的 D-Bus 地图条目。该函数仅在使用beginMap() 打开映射时有效。

有关该函数的使用示例，请参见beginMap() 。

另请参阅 endMapEntry() 和beginMap()。

void QDBusArgument::beginMapEntry() const

递归到 D-Bus 映射条目，以便提取键和值对。

请参见beginMap() 以了解该函数的使用示例。

另请参阅 endMapEntry() 和beginMap()。

void QDBusArgument::beginStructure()

打开一个适合添加新参数的新 D-Bus 结构。

该函数通常用于operator<< 流运算符，如下例所示：

QDBusArgument &operator<<(QDBusArgument &argument, const MyStructure &myStruct)
{
    argument.beginStructure();
    argument << myStruct.member1 << myStruct.member2;
    argument.endStructure();
    return argument;
}

结构体可以包含其他结构体，因此下面的代码也是有效的：

QDBusArgument &operator<<(QDBusArgument &argument, const MyStructure &myStruct)
{
    argument.beginStructure();
    argument << myStruct.member1 << myStruct.member2;

    argument.beginStructure();
    argument << myStruct.member3.subMember1 << myStruct.member3.subMember2;
    argument.endStructure();

    argument << myStruct.member4;
    argument.endStructure();
    return argument;
}

另请参见 endStructure(),beginArray() 和beginMap()。

void QDBusArgument::beginStructure() const

打开一个适合提取元素的 D-Bus 结构。

该函数通常用于operator>> 流操作符，如下面的示例：

const QDBusArgument &operator>>(const QDBusArgument &argument, MyStructure &myStruct)
{
    argument.beginStructure();
    argument >> myStruct.member1 >> myStruct.member2 >> myStruct.member3;
    argument.endStructure();
    return argument;
}

另请参阅 endStructure(),beginArray() 和beginMap()。

QDBusArgument::ElementType QDBusArgument::currentType() const

返回当前元素类型的分类。如果出现类型解码错误或参数已结束，该函数将返回QDBusArgument::UnknownType 。

该函数只有在对参数进行解码时才有意义。如果在 marshalling 时使用该函数，它将始终返回UnknownType 。

void QDBusArgument::endArray()

关闭用beginArray() 打开的 D-Bus 数组。该函数的调用次数必须与beginArray() 的调用次数相同。

另请参阅 beginArray()、endStructure() 和endMap()。

void QDBusArgument::endArray() const

关闭 D-Bus 数组并允许提取数组后的下一个元素。

另请参见 beginArray().

void QDBusArgument::endMap()

关闭用beginMap() 打开的 D-Bus 映射。该函数的调用次数必须与beginMap() 的调用次数相同。

另请参见 beginMap()、endStructure() 和endArray()。

void QDBusArgument::endMap() const

关闭 D-Bus 映射，允许提取映射后的下一个元素。

另请参见 beginMap().

void QDBusArgument::endMapEntry()

关闭用beginMapEntry() 打开的 D-Bus 地图条目。该函数的调用次数必须与beginMapEntry() 的调用次数相同。

另请参见 beginMapEntry()。

void QDBusArgument::endMapEntry() const

关闭 D-Bus 地图条目并允许提取地图上的下一个元素。

另请参见 beginMapEntry().

void QDBusArgument::endStructure()

关闭用beginStructure() 打开的 D-Bus 结构。该函数的调用次数必须与beginStructure() 的调用次数相同。

另请参见 beginStructure()、endArray() 和endMap()。

void QDBusArgument::endStructure() const

关闭 D-Bus 结构，允许提取结构后的下一个元素。

另请参见 beginStructure().

[noexcept] void QDBusArgument::swap(QDBusArgument &other)

将该参数与other 互换。这一操作速度非常快，而且从未出现过故障。

QDBusArgument &QDBusArgument::operator<<(uchar arg)

将BYTE 类型的基元值arg 添加到 D-Bus 数据流中。

QDBusArgument &QDBusArgument::operator<<(bool arg)

这是一个重载函数。

将BOOLEAN 类型的基元值arg 附加到 D-Bus 数据流中。

QDBusArgument &QDBusArgument::operator<<(const QByteArray &arg)

这是一个重载函数。

将arg 给出的QByteArray 作为ARRAY of BYTE 附加到 D-Bus 数据流中。

QStringList 和 是 直接支持的仅有的两种非原始类型，因为它们在 Qt XML 应用程序中广泛使用。QByteArray QDBusArgument

其他数组通过Qt D-Bus 中的复合类型支持。

QDBusArgument &QDBusArgument::operator<<(const QDBusVariant &arg)

这是一个重载函数。

将VARIANT 类型的基元值arg 附加到 D-Bus 数据流中。

D-Bus 变体类型可包含任何类型，包括其他变体。它类似于 Qt XMLQVariant 类型。

QDBusArgument &QDBusArgument::operator<<(const QString &arg)

这是一个重载函数。

将STRING （Unicode 字符串）类型的基元值arg 附加到 D-Bus 数据流中。

QDBusArgument &QDBusArgument::operator<<(const QStringList &arg)

这是一个重载函数。

将arg 给出的QStringList 作为ARRAY of STRING 附加到 D-Bus 数据流中。

QStringList 和 是 直接支持的仅有的两种非原始类型，因为它们在 Qt XML 应用程序中广泛使用。QByteArray QDBusArgument

其他数组通过Qt D-Bus 中的复合类型支持。

QDBusArgument &QDBusArgument::operator<<(double arg)

这是一个重载函数。

将DOUBLE （双精度浮点型）类型的基元值arg 附加到 D-Bus 数据流中。

QDBusArgument &QDBusArgument::operator<<(int arg)

这是一个重载函数。

将INT32 类型的基元值arg 附加到 D-Bus 数据流中。

QDBusArgument &QDBusArgument::operator<<(qlonglong arg)

这是一个重载函数。

将INT64 类型的基元值arg 附加到 D-Bus 数据流中。

QDBusArgument &QDBusArgument::operator<<(qulonglong arg)

这是一个重载函数。

将UINT64 类型的基元值arg 附加到 D-Bus 数据流中。

QDBusArgument &QDBusArgument::operator<<(short arg)

这是一个重载函数。

将INT16 类型的基元值arg 附加到 D-Bus 数据流中。

QDBusArgument &QDBusArgument::operator<<(uint arg)

这是一个重载函数。

将UINT32 类型的基元值arg 附加到 D-Bus 数据流中。

QDBusArgument &QDBusArgument::operator<<(ushort arg)

这是一个重载函数。

将UINT16 类型的基元值arg 附加到 D-Bus 数据流中。

QDBusArgument &QDBusArgument::operator=(const QDBusArgument &other)

将other QDBusArgument 对象复制到此对象中。

因此，从现在起，两个对象将包含相同的状态。QDBusArguments 是明确共享的，因此对其中一个副本的任何修改都会影响另一个副本。

const QDBusArgument &QDBusArgument::operator>>(uchar &arg) const

从 D-Bus 数据流中提取一个BYTE 类型的 D-Bus 原始参数，并将其放入arg 。

const QDBusArgument &QDBusArgument::operator>>(QByteArray &arg) const

这是一个重载函数。

从 D-Bus 数据流中提取字节数组，并以QByteArray 的形式返回。

QStringList 和 是 直接支持的仅有的两种非原始类型，因为它们在 Qt XML 应用程序中广泛使用。QByteArray QDBusArgument

其他数组通过Qt D-Bus 中的复合类型支持。

const QDBusArgument &QDBusArgument::operator>>(QDBusVariant &arg) const

这是一个重载函数。

从 D-Bus 数据流中提取一个VARIANT 类型的 D-Bus 原始参数。

D-Bus 变体类型可包含任何类型，包括其他变体。它类似于 Qt XMLQVariant 类型。

如果变体包含QDBusArgument 不直接支持的类型，则返回的QDBusVariant 的值将包含另一个QDBusArgument 。您有责任进一步将其转换为另一种类型。

const QDBusArgument &QDBusArgument::operator>>(QString &arg) const

这是一个重载函数。

从 D-Bus 数据流中提取一个STRING （Unicode 字符串）类型的 D-Bus 原始参数。

const QDBusArgument &QDBusArgument::operator>>(QStringList &arg) const

这是一个重载函数。

从 D-Bus 数据流中提取字符串数组，并以QStringList 的形式返回。

QStringList 和 是 直接支持的唯一两种非原始类型，因为它们在 Qt 应用程序中广泛使用。QByteArray QDBusArgument

其他数组通过Qt D-Bus 中的复合类型支持。

const QDBusArgument &QDBusArgument::operator>>(bool &arg) const

这是一个重载函数。

从 D-Bus 数据流中提取一个BOOLEAN 类型的 D-Bus 原始参数。

const QDBusArgument &QDBusArgument::operator>>(double &arg) const

这是一个重载函数。

从 D-Bus 数据流中提取一个DOUBLE （双精度浮点）类型的 D-Bus 原始参数。

const QDBusArgument &QDBusArgument::operator>>(int &arg) const

这是一个重载函数。

从 D-Bus 数据流中提取一个INT32 类型的 D-Bus 原始参数。

const QDBusArgument &QDBusArgument::operator>>(qlonglong &arg) const

这是一个重载函数。

从 D-Bus 数据流中提取一个INT64 类型的 D-Bus 原始参数。

const QDBusArgument &QDBusArgument::operator>>(qulonglong &arg) const

这是一个重载函数。

从 D-Bus 数据流中提取一个UINT64 类型的 D-Bus 原始参数。

const QDBusArgument &QDBusArgument::operator>>(short &arg) const

这是一个重载函数。

从 D-Bus 数据流中提取一个INT16 类型的 D-Bus 原始参数。

const QDBusArgument &QDBusArgument::operator>>(uint &arg) const

这是一个重载函数。

从 D-Bus 数据流中提取一个UINT32 类型的 D-Bus 原始参数。

const QDBusArgument &QDBusArgument::operator>>(ushort &arg) const

这是一个重载函数。

从 D-Bus 数据流中提取一个UINT16 类型的 D-Bus 原始参数。