QDBusArgument Class

メンバ関数のドキュメント

QDBusArgument::QDBusArgument()

空の QDBusArgument 引数を生成します。

空の QDBusArgument オブジェクトでは、読み取りも書き込みも行うことはできません。

QDBusArgument::QDBusArgument(const QDBusArgument &other)

other というQDBusArgumentオブジェクトのコピーを作成します。

したがって、この時点以降、両方のオブジェクトは同じ状態を持つことになります。QDBusArgumentは明示的に共有されるため、いずれかのコピーに変更を加えると、もう一方のコピーにも影響が及びます。

[noexcept] QDBusArgument::~QDBusArgument()

このQDBusArgument オブジェクトに関連付けられているリソースを解放します。

QVariant QDBusArgument::asVariant() const

現在の引数をQVariant の形式で返します。基本型はデコードされ、QVariant で返されますが、複合型の場合、この関数はQVariant 内のQDBusArgument オブジェクトを返します。引数のデコード（例えば、その内部でasVariant()を呼び出すなど）は呼び出し側の責任となります。

たとえば、現在の引数が INT32 の場合、この関数はQMetaType::Int 型の引数を持つQVariant を返します。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 であるか、あるいは1つのテンプレートパラメータを取るQtのコンテナクラスのいずれかである場合、Qt D-Bus がデータのデマーシャル処理を行うための汎用テンプレートを提供しているため、その型に対してoperator>> 関数を宣言する必要はありません。これは、std::list やstd::vector などのSTLのシーケンスコンテナについても同様です。

atEnd()、beginStructure()、およびbeginMap()も参照してください 。

void QDBusArgument::beginArray(QMetaType id)

メタタイプid の要素を追加するのに適した新しいD-Bus配列を開きます。

この関数は通常、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;
}

マーシャリングしたい型がQList 、あるいはテンプレートパラメータを1つ取るQtのコンテナクラスのいずれかである場合、Qt D-Bus がデータのマーシャリングを行うための汎用テンプレートを提供しているため、その型に対してoperator<< 関数を宣言する必要はありません。これは、std::list やstd::vector などのSTLのシーケンスコンテナについても同様です。

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)

要素の追加に適した新しい Qt D-Bus マップを開きます。マップは、1 つのエントリ（キー）を別のエントリ（値）に関連付けるコンテナであり、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 がデータのマーシャリングを行うための汎用テンプレートを提供しているためです。

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` を返します。

この関数は、引数のデマーシャリング時にのみ意味を持ちます。マーシャリング中に使用された場合、常に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 およびQByteArray は、Qt アプリケーションで広く使用されているため、QDBusArgument が直接サポートする唯一の 2 つの非プリミティブ型です。

その他の配列は、Qt D-Bus の複合型を通じてサポートされています。

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

VARIANT 型のプリミティブ値 `arg ` を D-Bus ストリームに追加します。

Qt D-Busのバリアント型は、他のバリアント型を含め、任意の型を格納できます。これはQt XMLのQVariant 型に似ています。

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 およびQByteArray は、Qt アプリケーションで広く使用されているため、QDBusArgument が直接サポートする唯一の 2 つの非プリミティブ型です。

その他の配列は、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プリミティブ引数を1つ抽出し、それをarg に格納します。

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

D-Busストリームからバイト配列を抽出し、QByteArray として返します。

QStringList およびQByteArray は、Qtアプリケーションで広く使用されているため、QDBusArgument によって直接サポートされている2つの非プリミティブ型です。

その他の配列は、Qt D-Bus の複合型を通じてサポートされています。

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

D-Busストリームから、VARIANT 型の D-Bus プリミティブ引数を 1 つ抽出します。

Qt D-Bus バリアント型には、他のバリアント型を含め、あらゆる型を含めることができます。これは Qt XML の `QVariant ` 型に似ています。

バリアントにQDBusArgument が直接サポートしていない型が含まれている場合、返されるQDBusVariant の値には別のQDBusArgument が含まれます。これを別の型にさらにデマーシャルするのは、利用者の責任です。

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

D-Bus ストリームから、STRING （Unicode 文字列）型の D-Bus プリミティブ引数を 1 つ取得します。

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

D-Busストリームから文字列の配列を抽出し、それをQStringList として返します。

QStringList また、QByteArray は、Qt アプリケーションで広く使用されているため、QDBusArgument が直接サポートする唯一の 2 つの非プリミティブ型です。

その他の配列は、Qt D-Bus の複合型を通じてサポートされています。

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

D-Bus ストリームから、BOOLEAN 型の D-Bus プリミティブ引数を 1 つ抽出します。

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

D-Bus ストリームから、DOUBLE （倍精度浮動小数点）型の D-Bus プリミティブ引数を 1 つ抽出します。

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

D-Bus ストリームから、INT32 型の D-Bus プリミティブ引数を 1 つ抽出します。

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

D-Bus ストリームから、INT64 型の D-Bus プリミティブ引数を 1 つ抽出します。

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

D-Bus ストリームから、UINT64 型の D-Bus プリミティブ引数を 1 つ抽出します。

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

D-Bus ストリームから、INT16 型の D-Bus プリミティブ引数を 1 つ抽出します。

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

D-Bus ストリームから、UINT32 型の D-Bus プリミティブ引数を 1 つ抽出します。

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

D-Bus ストリームから、UINT16 型の D-Bus プリミティブ引数を 1 つ抽出します。