\inmodule QtCore More...

#include <qurlquery.h>

Collaboration diagram for QUrlQuery:

Public Types
typedef QSharedDataPointer< QUrlQueryPrivate >	DataPtr

Public Member Functions
	QUrlQuery ()
	Constructs an empty QUrlQuery object.
	QUrlQuery (const QUrl &url)
	Constructs a QUrlQuery object and parses the query string found in the url URL, using the default query delimiters.
	QUrlQuery (const QString &queryString)
	Constructs a QUrlQuery object and parses the queryString query string, using the default query delimiters.
	QUrlQuery (std::initializer_list< std::pair< QString, QString > > list)
	QUrlQuery (const QUrlQuery &other)
	Copies the contents of the other QUrlQuery object, including the query delimiters.
	QUrlQuery (QUrlQuery &&other) noexcept
QUrlQuery &	operator= (const QUrlQuery &other)
	Move-assigns other to this QUrlQuery instance.
	~QUrlQuery ()
	Destroys this QUrlQuery object.
void	swap (QUrlQuery &other) noexcept
	\memberswap{URL query instance}
bool	isEmpty () const
	Returns `true` if this QUrlQuery object contains no key-value pairs, such as after being default-constructed or after parsing an empty query string.
bool	isDetached () const
void	clear ()
	Clears this QUrlQuery object by removing all of the key-value pairs currently stored.
QString	query (QUrl::ComponentFormattingOptions encoding=QUrl::PrettyDecoded) const
	Returns the reconstructed query string, formed from the key-value pairs currently stored in this QUrlQuery object and separated by the query delimiters chosen for this object.
void	setQuery (const QString &queryString)
	Parses the query string in queryString and sets the internal items to the values found there.
QString	toString (QUrl::ComponentFormattingOptions encoding=QUrl::PrettyDecoded) const
	Returns this QUrlQuery as a QString.
void	setQueryDelimiters (QChar valueDelimiter, QChar pairDelimiter)
	Sets the characters used for delimiting between keys and values, and between key-value pairs in the URL's query string.
QChar	queryValueDelimiter () const
	Returns the character used to delimit between keys and values when reconstructing the query string in query() or when parsing in setQuery().
QChar	queryPairDelimiter () const
	Returns the character used to delimit between keys-value pairs when reconstructing the query string in query() or when parsing in setQuery().
void	setQueryItems (const QList< std::pair< QString, QString > > &query)
	Sets the items in this QUrlQuery object to query.
QList< std::pair< QString, QString > >	queryItems (QUrl::ComponentFormattingOptions encoding=QUrl::PrettyDecoded) const
	Returns the query string of the URL, as a map of keys and values, using the options specified in encoding to encode the items.
bool	hasQueryItem (const QString &key) const
	Returns `true` if there is a query string pair whose key is equal to key from the URL.
void	addQueryItem (const QString &key, const QString &value)
	Appends the pair key = value to the end of the query string of the URL.
void	removeQueryItem (const QString &key)
	Removes the query string pair whose key is equal to key from the URL.
QString	queryItemValue (const QString &key, QUrl::ComponentFormattingOptions encoding=QUrl::PrettyDecoded) const
	Returns the query value associated with key key from the URL, using the options specified in encoding to encode the return value.
QStringList	allQueryItemValues (const QString &key, QUrl::ComponentFormattingOptions encoding=QUrl::PrettyDecoded) const
	Returns the a list of query string values whose key is equal to key from the URL, using the options specified in encoding to encode the return value.
void	removeAllQueryItems (const QString &key)
	Removes all the query string pairs whose key is equal to key from the URL.
DataPtr &	data_ptr ()

Static Public Member Functions
static constexpr char16_t	defaultQueryValueDelimiter () noexcept
	Returns the default character for separating keys from values in the query, an equal sign ("=").
static constexpr char16_t	defaultQueryPairDelimiter () noexcept
	Returns the default character for separating keys-value pairs from each other, an ampersand ("&").

Friends
class	QUrl
Q_CORE_EXPORT bool	comparesEqual (const QUrlQuery &lhs, const QUrlQuery &rhs)
Q_CORE_EXPORT size_t	qHash (const QUrlQuery &key, size_t seed=0)

Detailed Description

\inmodule QtCore

Since: 5.0

The QUrlQuery class provides a way to manipulate a key-value pairs in a URL's query.

\reentrant

\compares equality

It is used to parse the query strings found in URLs like the following:

{Illustration of a URL with part after question mark highlighted as query string.}

Query strings like the above are used to transmit options in the URL and are usually decoded into multiple key-value pairs. The one above would contain two entries in its list, with keys "type" and "color". QUrlQuery can also be used to create a query string suitable for use in QUrl::setQuery() from the individual components of the query.

The most common way of parsing a query string is to initialize it in the constructor by passing it the query string. Otherwise, the setQuery() method can be used to set the query to be parsed. That method can also be used to parse a query with non-standard delimiters, after having set them using the setQueryDelimiters() function.

The encoded query string can be obtained again using query(). This will take all the internally-stored items and encode the string using the delimiters.

Definition at line 20 of file qurlquery.h.

Member Typedef Documentation

◆ DataPtr

typedef QSharedDataPointer<QUrlQueryPrivate> QUrlQuery::DataPtr

Definition at line 81 of file qurlquery.h.

Constructor & Destructor Documentation

◆ QUrlQuery() [1/6]

QUrlQuery::QUrlQuery ( )

Constructs an empty QUrlQuery object.

A query can be set afterwards by calling setQuery() or items can be added by using addQueryItem().

See also: setQuery(), addQueryItem()

Definition at line 328 of file qurlquery.cpp.

◆ QUrlQuery() [2/6]

QUrlQuery::QUrlQuery ( const QUrl & url )

explicit

Constructs a QUrlQuery object and parses the query string found in the url URL, using the default query delimiters.

To parse a query string using other delimiters, you should first set them using setQueryDelimiters() and then set the query with setQuery().

See also: QUrl::query()

Definition at line 352 of file qurlquery.cpp.

◆ QUrlQuery() [3/6]

QUrlQuery::QUrlQuery ( const QString & queryString )

explicit

Constructs a QUrlQuery object and parses the queryString query string, using the default query delimiters.

To parse a query string using other delimiters, you should first set them using setQueryDelimiters() and then set the query with setQuery().

Definition at line 339 of file qurlquery.cpp.

◆ QUrlQuery() [4/6]

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

inline

Since: 5.13

Constructs a QUrlQuery object from the list of key/value pair.

Definition at line 26 of file qurlquery.h.

◆ QUrlQuery() [5/6]

QUrlQuery::QUrlQuery ( const QUrlQuery & other )

Copies the contents of the other QUrlQuery object, including the query delimiters.

Definition at line 365 of file qurlquery.cpp.

◆ QUrlQuery() [6/6]

QUrlQuery::QUrlQuery ( QUrlQuery && other )

noexcept

Since: 6.5 Moves the contents of the other QUrlQuery object, including the query delimiters.

Definition at line 375 of file qurlquery.cpp.

◆ ~QUrlQuery()

QUrlQuery::~QUrlQuery ( )

Destroys this QUrlQuery object.

Definition at line 398 of file qurlquery.cpp.

Member Function Documentation

◆ addQueryItem()

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

Appends the pair key = value to the end of the query string of the URL.

This method does not overwrite existing items that might exist with the same key.

Note: This method does not treat spaces (ASCII 0x20) and plus ("+") signs as the same, like HTML forms do. If you need spaces to be represented as plus signs, use actual plus signs.; The key and value strings are expected to be in percent-encoded form.

See also: hasQueryItem(), queryItemValue()

Definition at line 682 of file qurlquery.cpp.

◆ allQueryItemValues()

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

Returns the a list of query string values whose key is equal to key from the URL, using the options specified in encoding to encode the return value.

If the key key is not found, this function returns an empty list.

Note: The key is expected to be in percent-encoded form.

See also: queryItemValue(), addQueryItem()

Definition at line 722 of file qurlquery.cpp.

◆ clear()

void QUrlQuery::clear ( )

Clears this QUrlQuery object by removing all of the key-value pairs currently stored.

If the query delimiters have been changed, this function will leave them with their changed values.

See also: isEmpty(), setQueryDelimiters()

Definition at line 465 of file qurlquery.cpp.

◆ data_ptr()

DataPtr & QUrlQuery::data_ptr ( )

inline

Definition at line 82 of file qurlquery.h.

◆ defaultQueryPairDelimiter()

constexpr char16_t QUrlQuery::defaultQueryPairDelimiter ( )

inlinestaticconstexprnoexcept

Returns the default character for separating keys-value pairs from each other, an ampersand ("&").

Note: Prior to Qt 6, this function returned QChar.

See also: setQueryDelimiters(), queryPairDelimiter(), defaultQueryValueDelimiter()

Definition at line 71 of file qurlquery.h.

◆ defaultQueryValueDelimiter()

constexpr char16_t QUrlQuery::defaultQueryValueDelimiter ( )

inlinestaticconstexprnoexcept

Returns the default character for separating keys from values in the query, an equal sign ("=").

Note: Prior to Qt 6, this function returned QChar.

See also: setQueryDelimiters(), queryValueDelimiter(), defaultQueryPairDelimiter()

Definition at line 70 of file qurlquery.h.

◆ hasQueryItem()

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

Returns true if there is a query string pair whose key is equal to key from the URL.

Note: The key expected to be in percent-encoded form.

See also: addQueryItem(), queryItemValue()

Definition at line 662 of file qurlquery.cpp.

◆ isDetached()

bool QUrlQuery::isDetached ( ) const

Definition at line 453 of file qurlquery.cpp.

◆ isEmpty()

bool QUrlQuery::isEmpty ( ) const

Returns true if this QUrlQuery object contains no key-value pairs, such as after being default-constructed or after parsing an empty query string.

See also: setQuery(), clear()

Definition at line 445 of file qurlquery.cpp.

◆ operator=()

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

Move-assigns other to this QUrlQuery instance.

Copies the contents of the other QUrlQuery object, including the query delimiters.

Since: 5.2

Definition at line 384 of file qurlquery.cpp.

◆ query()

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

Returns the reconstructed query string, formed from the key-value pairs currently stored in this QUrlQuery object and separated by the query delimiters chosen for this object.

The keys and values are encoded using the options given by the encoding parameter.

For this function, the only ambiguous delimiter is the hash ("#"), as in URLs it is used to separate the query string from the fragment that may follow.

The order of the key-value pairs in the returned string is exactly the same as in the original query.

See also: setQuery(), QUrl::setQuery(), QUrl::fragment(), {encoding}{Encoding}

Definition at line 504 of file qurlquery.cpp.

◆ queryItems()

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

Returns the query string of the URL, as a map of keys and values, using the options specified in encoding to encode the items.

The order of the elements is the same as the one found in the query string or set with setQueryItems().

See also: setQueryItems(), {encoding}{Encoding}

Definition at line 637 of file qurlquery.cpp.

◆ queryItemValue()

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

Returns the query value associated with key key from the URL, using the options specified in encoding to encode the return value.

If the key key is not found, this function returns an empty string. If you need to distinguish between an empty value and a non-existent key, you should check for the key's presence first using hasQueryItem().

If the key key is multiply defined, this function will return the first one found, in the order they were present in the query string or added using addQueryItem().

Note: The key is expected to be in percent-encoded form.

See also: addQueryItem(), allQueryItemValues(), {encoding}{Encoding}

Definition at line 702 of file qurlquery.cpp.

◆ queryPairDelimiter()

QChar QUrlQuery::queryPairDelimiter ( ) const

Returns the character used to delimit between keys-value pairs when reconstructing the query string in query() or when parsing in setQuery().

See also: setQueryDelimiters(), queryValueDelimiter()

Definition at line 599 of file qurlquery.cpp.

◆ queryValueDelimiter()

QChar QUrlQuery::queryValueDelimiter ( ) const

Returns the character used to delimit between keys and values when reconstructing the query string in query() or when parsing in setQuery().

See also: setQueryDelimiters(), queryPairDelimiter()

Definition at line 588 of file qurlquery.cpp.

◆ removeAllQueryItems()

void QUrlQuery::removeAllQueryItems ( const QString & key )

Removes all the query string pairs whose key is equal to key from the URL.

Note: The key is expected to be in percent-encoded form.

See also: removeQueryItem()

Definition at line 764 of file qurlquery.cpp.

◆ removeQueryItem()

void QUrlQuery::removeQueryItem ( const QString & key )

Removes the query string pair whose key is equal to key from the URL.

If there are multiple items with a key equal to key, it removes the first item in the order they were present in the query string or added with addQueryItem().

Note: The key is expected to be in percent-encoded form.

See also: removeAllQueryItems()

Definition at line 746 of file qurlquery.cpp.

◆ setQuery()

void QUrlQuery::setQuery ( const QString & queryString )

Parses the query string in queryString and sets the internal items to the values found there.

If any delimiters have been specified with setQueryDelimiters(), this function will use them instead of the default delimiters to parse the string.

Definition at line 477 of file qurlquery.cpp.

◆ setQueryDelimiters()

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

Sets the characters used for delimiting between keys and values, and between key-value pairs in the URL's query string.

The default value delimiter is '=' and the default pair delimiter is '&'.

{Illustration of a URL with part after question mark highlighted as query string.}

valueDelimiter will be used for separating keys from values, and pairDelimiter will be used to separate key-value pairs. Any occurrences of these delimiting characters in the encoded representation of the keys and values of the query string are percent encoded when returned in query().

If valueDelimiter is set to ',' and pairDelimiter is ';', the above query string would instead be represented like this:

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

Note: Non-standard delimiters should be chosen from among what RFC 3986 calls "sub-delimiters". They are:

sub-delims = "!" / "$" / "&" / "'" / "(" / ")"

/ "*" / "+" / "," / ";" / "="

Use of other characters is not supported and may result in unexpected behavior. This method does not verify that you passed a valid delimiter.

See also: queryValueDelimiter(), queryPairDelimiter()

Definition at line 576 of file qurlquery.cpp.

◆ setQueryItems()

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

Sets the items in this QUrlQuery object to query.

The order of the elements in query is preserved.

Note: This method does not treat spaces (ASCII 0x20) and plus ("+") signs as the same, like HTML forms do. If you need spaces to be represented as plus signs, use actual plus signs.; The keys and values are expected to be in percent-encoded form.

See also: queryItems(), isEmpty()

Definition at line 616 of file qurlquery.cpp.

◆ swap()

void QUrlQuery::swap ( QUrlQuery & other )

inlinenoexcept

\memberswap{URL query instance}

Definition at line 45 of file qurlquery.h.

◆ toString()

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

inline

Returns this QUrlQuery as a QString.

encoding can be used to specify the URL string encoding of the return value.

Definition at line 53 of file qurlquery.h.

◆ comparesEqual

Q_CORE_EXPORT bool comparesEqual	(	const QUrlQuery &	lhs,
		const QUrlQuery &	rhs )

friend

Definition at line 410 of file qurlquery.cpp.

◆ qHash

Q_CORE_EXPORT size_t qHash	(	const QUrlQuery &	key,
		size_t	seed = 0 )

friend

Since: 5.6 \qhashold{QUrlQuery}

Definition at line 430 of file qurlquery.cpp.

◆ QUrl

friend class QUrl

friend

Definition at line 76 of file qurlquery.h.

The documentation for this class was generated from the following files:

qtbase/src/corelib/io/qurlquery.h (70edabf98bf56e29296a2921db97a38f60cf896a)
qtbase/src/corelib/io/qurlquery.cpp (0cee9ee3cf8a3310570708b2b421d94083969f72)

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ DataPtr

Constructor & Destructor Documentation

◆ QUrlQuery() [1/6]

◆ QUrlQuery() [2/6]

◆ QUrlQuery() [3/6]

◆ QUrlQuery() [4/6]

◆ QUrlQuery() [5/6]

◆ QUrlQuery() [6/6]

◆ ~QUrlQuery()

Member Function Documentation

◆ addQueryItem()

◆ allQueryItemValues()

◆ clear()

◆ data_ptr()

◆ defaultQueryPairDelimiter()

◆ defaultQueryValueDelimiter()

◆ hasQueryItem()

◆ isDetached()

◆ isEmpty()

◆ operator=()

◆ query()

◆ queryItems()

◆ queryItemValue()

◆ queryPairDelimiter()

◆ queryValueDelimiter()

◆ removeAllQueryItems()

◆ removeQueryItem()

◆ setQuery()

◆ setQueryDelimiters()

◆ setQueryItems()

◆ swap()

◆ toString()

Friends And Related Symbol Documentation

◆ comparesEqual

◆ qHash

◆ QUrl