QUrlQuery Class

メンバ関数の説明

QUrlQuery::QUrlQuery()

空のQUrlQueryオブジェクトを構築します。その後、setQuery() をコールしてクエリを設定したり、addQueryItem() を使用して項目を追加したりすることができます。

setQuery() およびaddQueryItem()も参照してください 。

[explicit] QUrlQuery::QUrlQuery(const QString &queryString)

QUrlQuery オブジェクトを構築し、デフォルトのクエリ区切り文字を使用してqueryString クエリ文字列を解析します。他の区切り文字を使用してクエリ文字列を解析するには、まずsetQueryDelimiters() で区切り文字を設定し、次にsetQuery() でクエリを設定します。

[explicit] QUrlQuery::QUrlQuery(const QUrl &url)

QUrlQueryオブジェクトを構築し、デフォルトのクエリー区切り文字を使用して、url URLで見つかったクエリー文字列を解析します。他の区切り文字を使用してクエリ文字列を解析するには、まずsetQueryDelimiters() で区切り文字を設定し、次にsetQuery() でクエリを設定します。

QUrl::query()も参照してください 。

QUrlQuery::QUrlQuery(std::initializer_list<std::pair<QString, QString>> list)

キー/値ペアのlist から QUrlQuery オブジェクトを構築します。

QUrlQuery::QUrlQuery(const QUrlQuery &other)

クエリの区切り文字を含め、other QUrlQuery オブジェクトの内容をコピーします。

[noexcept, since 6.5] QUrlQuery::QUrlQuery(QUrlQuery &&other)

other QUrlQuery オブジェクトの内容を、クエリの区切り文字を含めて移動します。

この関数は Qt 6.5 で導入されました。

[noexcept] QUrlQuery::~QUrlQuery()

このQUrlQuery オブジェクトを破棄します。

void QUrlQuery::addQueryItem(const QString &key, const QString &value)

URL のクエリー文字列の最後にkey =value のペアを追加します。このメソッドは、同じキーを持つ既存のアイテムを上書きしません。

hasQueryItem() およびqueryItemValue()も参照 。

QStringList QUrlQuery::allQueryItemValues(const QString &key, QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const

URL から、キーがkey に等しいクエリ文字列値のリストを返します。encoding で指定したオプションを使用して、返り値をエンコードします。キーkey が見つからない場合、この関数は空のリストを返します。

queryItemValue() およびaddQueryItem()も参照 。

void QUrlQuery::clear()

現在格納されているすべてのキーと値のペアを削除することにより、このQUrlQuery オブジェクトをクリアします。クエリの区切り文字が変更された場合、この関数は、変更後の値で区切り文字を残します。

isEmpty() およびsetQueryDelimiters()も参照 。

[static constexpr noexcept] char16_t QUrlQuery::defaultQueryPairDelimiter()

キーと値のペアを互いに区切るためのデフォルトの文字、アンパサンド（"&"）を返します。

setQueryDelimiters()、queryPairDelimiter()、defaultQueryValueDelimiter()も参照してください 。

[static constexpr noexcept] char16_t QUrlQuery::defaultQueryValueDelimiter()

query関数は、クエリのキーと値を区切るデフォルトの文字、等号（"="）を返します。

setQueryDelimiters()、queryValueDelimiter()、defaultQueryPairDelimiter()も参照してください 。

bool QUrlQuery::hasQueryItem(const QString &key) const

URL から、キーがkey と等しいクエリ文字列ペアが存在する場合、true を返します。

addQueryItem() およびqueryItemValue()も参照 。

bool QUrlQuery::isEmpty() const

このQUrlQuery オブジェクトにキーと値のペアが含まれていない場合、例えばデフォルトで 構築された後や空のクエリ文字列をパースした後などにはtrue を返します。

setQuery() およびclear()も参照 。

QString QUrlQuery::query(QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const

このQUrlQuery オブジェクトに現在格納されているキーと値のペアを、このオブジェクト用に選択されたクエリ区切り文字で区切って再構成したクエリ文字列を返します。キーと値は、encoding パラメータで与えられたオプションを使用してエンコードされます。

この関数では、唯一のあいまいな区切り文字はハッシュ("#")です。これは、URLにおいて、クエリー文字列とそれに続くフラグメントを区切るために使われるからです。

返される文字列のキーと値のペアの順番は、元のクエリとまったく同じです。

setQuery()、QUrl::setQuery()、QUrl::fragment() およびEncodingも参照 。

QString QUrlQuery::queryItemValue(const QString &key, QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const

encoding で指定したオプションを使用して返り値をエンコードし、 URL からキーkey に関連付けられたクエリ値を返します。キーkey が見つからない場合、この関数は空の文字列を返します。空の値と存在しないキーを区別する必要がある場合は、まずhasQueryItem() を使用してキーの存在を確認する必要があります。

キーkey が複数定義されている場合、この関数は、最初に見つかったものを、クエリ文字列中に存在した順、あるいはaddQueryItem() を使用して追加した順に返します。

addQueryItem()、allQueryItemValues()、Encodingも参照 。

QList<std::pair<QString, QString>> QUrlQuery::queryItems(QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const

URL のクエリ文字列を、encoding で指定したオプションを使用して項目をエンコードしたキーと値のマップとして返します。要素の順番は、クエリ文字列で見つかったもの、あるいはsetQueryItems() で設定されたものと同じです。

setQueryItems() およびEncodingも参照 。

QChar QUrlQuery::queryPairDelimiter() const

query() でクエリ文字列を再構築する際、あるいはsetQuery() でパースする際に、 キーと値のペアの区切りに使用する文字を返します。

setQueryDelimiters() およびqueryValueDelimiter()も参照 。

QChar QUrlQuery::queryValueDelimiter() const

query() でのクエリ文字列の再構築時およびsetQuery() でのパース時に、 キーと値のペアの区切りに使用する文字を返します。

setQueryDelimiters() およびqueryPairDelimiter()も参照のこと 。

void QUrlQuery::removeAllQueryItems(const QString &key)

キーがkey と等しいすべてのクエリー文字列ペアを URL から削除する。

removeQueryItem()も参照 。

void QUrlQuery::removeQueryItem(const QString &key)

キーがkey に等しいクエリ文字列ペアを URL から削除します。キーがkey に等しい項目が複数ある場合、クエリ文字列内に存在する順、あるいはaddQueryItem() で追加された順に、最初の項目を削除する。

removeAllQueryItems()も参照 。

void QUrlQuery::setQuery(const QString &queryString)

queryString のクエリ文字列を解析し、そこで見つかった値を内部項目に設定する。setQueryDelimiters() で区切り文字が指定されている場合は、デフォルトの区切り文字ではなく それを使用して文字列をパースします。

query()も参照 。

void QUrlQuery::setQueryDelimiters(QChar valueDelimiter, QChar pairDelimiter)

URL のクエリ文字列のキーと値、およびキーと値のペアの間の区切りに使用する文字を設定します。デフォルトの値の区切り文字は '=' で、デフォルトのペアの区切り文字は '&' です。

valueDelimiter はキーと値の区切りに使われ、 はキーと値のペアの区切りに使われます。クエリ文字列のキーと値のエンコード表現にこれらの区切り文字があると、 () で返されるときにパーセントエンコードされます。pairDelimiter query

valueDelimiter を ',' に設定し、pairDelimiter を ';' に設定すると、上記のクエリー文字列はこのように表現されます：

http://www.example.com/cgi-bin/drawgraph.cgi?type,pie;color,green

sub-delims    = "!" / "$" / "&" / "'" / "(" / ")"
              / "*" / "+" / "," / ";" / "="

他の文字の使用はサポートされておらず、予期せぬ動作を引き起こす可能性がある。このメソッドは、有効な区切り文字を渡したかどうかを検証しません。

queryValueDelimiter() およびqueryPairDelimiter()も参照 。

void QUrlQuery::setQueryItems(const QList<std::pair<QString, QString>> &query)

このQUrlQuery オブジェクトの項目をquery に設定します。query の要素の順序は保持されます。

queryItems() およびisEmpty()も参照のこと 。

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

このURLクエリーインスタンスをother と交換する。この関数は非常に高速で、失敗することはない。

QString QUrlQuery::toString(QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const

このQUrlQuery をQString として返します。encoding を使用して、返り値の URL 文字列エンコーディングを指定できます。

[noexcept] QUrlQuery &QUrlQuery::operator=(QUrlQuery &&other)

Move-other をこのQUrlQuery インスタンスに代入する。

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

other QUrlQuery オブジェクトの内容を、クエリ区切り文字を含めてコピーします。