KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QUrlQuery

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QUrlQuery

Public constructors

new QUrlQuerynewConstructor QUrlQuery::QUrlQuery()
new QUrlQuerynew(const QUrl url)Constructor QUrlQuery::QUrlQuery(const QUrl &url)
new QUrlQuerynew(string queryString)Constructor QUrlQuery::QUrlQuery(const QString &queryString)
new QUrlQuerynew(const QUrlQuery other)Constructor QUrlQuery::QUrlQuery(const QUrlQuery &other)

Public methods

[const]bool!=(const QUrlQuery other)Method bool QUrlQuery::operator!=(const QUrlQuery &other)
[const]bool==(const QUrlQuery other)Method bool QUrlQuery::operator==(const QUrlQuery &other)
void_assign(const QUrlQuery other)Assigns another object to self
[const]QUrlQuery ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidaddQueryItem(string key,
string value)
Method void QUrlQuery::addQueryItem(const QString &key, const QString &value)
[const]string[]allQueryItemValues(string key,
QUrl_QFlags_ComponentFormattingOption encoding = QUrl::PrettyDecoded)
Method QStringList QUrlQuery::allQueryItemValues(const QString &key, QFlags<QUrl::ComponentFormattingOption> encoding)
QUrlQueryassign(const QUrlQuery other)Method QUrlQuery &QUrlQuery::operator=(const QUrlQuery &other)
voidclearMethod void QUrlQuery::clear()
[const]new QUrlQuery ptrdupCreates a copy of self
[const]boolhasQueryItem(string key)Method bool QUrlQuery::hasQueryItem(const QString &key)
[const]boolisDetached?Method bool QUrlQuery::isDetached()
[const]boolisEmpty?Method bool QUrlQuery::isEmpty()
[const]stringquery(QUrl_QFlags_ComponentFormattingOption encoding = QUrl::PrettyDecoded)Method QString QUrlQuery::query(QFlags<QUrl::ComponentFormattingOption> encoding)
voidquery=(string queryString)Method void QUrlQuery::setQuery(const QString &queryString)
[const]stringqueryItemValue(string key,
QUrl_QFlags_ComponentFormattingOption encoding = QUrl::PrettyDecoded)
Method QString QUrlQuery::queryItemValue(const QString &key, QFlags<QUrl::ComponentFormattingOption> encoding)
[const]QPair_QString_QString[]queryItems(QUrl_QFlags_ComponentFormattingOption encoding = QUrl::PrettyDecoded)Method QList<QPair<QString, QString> > QUrlQuery::queryItems(QFlags<QUrl::ComponentFormattingOption> encoding)
voidqueryItems=(QPair_QString_QString[] query)Method void QUrlQuery::setQueryItems(const QList<QPair<QString, QString> > &query)
[const]unsigned intqueryPairDelimiterMethod QChar QUrlQuery::queryPairDelimiter()
[const]unsigned intqueryValueDelimiterMethod QChar QUrlQuery::queryValueDelimiter()
voidremoveAllQueryItems(string key)Method void QUrlQuery::removeAllQueryItems(const QString &key)
voidremoveQueryItem(string key)Method void QUrlQuery::removeQueryItem(const QString &key)
voidsetQuery(string queryString)Method void QUrlQuery::setQuery(const QString &queryString)
voidsetQueryDelimiters(unsigned int valueDelimiter,
unsigned int pairDelimiter)
Method void QUrlQuery::setQueryDelimiters(QChar valueDelimiter, QChar pairDelimiter)
voidsetQueryItems(QPair_QString_QString[] query)Method void QUrlQuery::setQueryItems(const QList<QPair<QString, QString> > &query)
voidswap(QUrlQuery other)Method void QUrlQuery::swap(QUrlQuery &other)
[const]stringtoString(QUrl_QFlags_ComponentFormattingOption encoding = QUrl::PrettyDecoded)Method QString QUrlQuery::toString(QFlags<QUrl::ComponentFormattingOption> encoding)

Public static methods and constants

unsigned intdefaultQueryPairDelimiterStatic method QChar QUrlQuery::defaultQueryPairDelimiter()
unsigned intdefaultQueryValueDelimiterStatic method QChar QUrlQuery::defaultQueryValueDelimiter()

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QUrlQuery other)

Description: Method bool QUrlQuery::operator!=(const QUrlQuery &other)

==

Signature: [const] bool == (const QUrlQuery other)

Description: Method bool QUrlQuery::operator==(const QUrlQuery &other)

_assign

Signature: void _assign (const QUrlQuery other)

Description: Assigns another object to self

_const_cast

Signature: [const] QUrlQuery ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

addQueryItem

Signature: void addQueryItem (string key, string value)

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

allQueryItemValues

Signature: [const] string[] allQueryItemValues (string key, QUrl_QFlags_ComponentFormattingOption encoding = QUrl::PrettyDecoded)

Description: Method QStringList QUrlQuery::allQueryItemValues(const QString &key, QFlags<QUrl::ComponentFormattingOption> encoding)

assign

Signature: QUrlQuery assign (const QUrlQuery other)

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

clear

Signature: void clear

Description: Method void QUrlQuery::clear()

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

defaultQueryPairDelimiter

Signature: [static] unsigned int defaultQueryPairDelimiter

Description: Static method QChar QUrlQuery::defaultQueryPairDelimiter()

This method is static and can be called without an instance.

defaultQueryValueDelimiter

Signature: [static] unsigned int defaultQueryValueDelimiter

Description: Static method QChar QUrlQuery::defaultQueryValueDelimiter()

This method is static and can be called without an instance.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new QUrlQuery ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

hasQueryItem

Signature: [const] bool hasQueryItem (string key)

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

isDetached?

Signature: [const] bool isDetached?

Description: Method bool QUrlQuery::isDetached()

isEmpty?

Signature: [const] bool isEmpty?

Description: Method bool QUrlQuery::isEmpty()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

(1) Signature: [static] new QUrlQuery new

Description: Constructor QUrlQuery::QUrlQuery()

This method creates an object of class QUrlQuery.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QUrlQuery new (const QUrl url)

Description: Constructor QUrlQuery::QUrlQuery(const QUrl &url)

This method creates an object of class QUrlQuery.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QUrlQuery new (string queryString)

Description: Constructor QUrlQuery::QUrlQuery(const QString &queryString)

This method creates an object of class QUrlQuery.

Python specific notes:
This method is the default initializer of the object.

(4) Signature: [static] new QUrlQuery new (const QUrlQuery other)

Description: Constructor QUrlQuery::QUrlQuery(const QUrlQuery &other)

This method creates an object of class QUrlQuery.

Python specific notes:
This method is the default initializer of the object.

query

Signature: [const] string query (QUrl_QFlags_ComponentFormattingOption encoding = QUrl::PrettyDecoded)

Description: Method QString QUrlQuery::query(QFlags<QUrl::ComponentFormattingOption> encoding)

Python specific notes:
This method is available as 'query_' in Python to distiguish it from the property with the same name.

query=

Signature: void query= (string queryString)

Description: Method void QUrlQuery::setQuery(const QString &queryString)

Python specific notes:
The object exposes a writable attribute 'query'. This is the setter.

queryItemValue

Signature: [const] string queryItemValue (string key, QUrl_QFlags_ComponentFormattingOption encoding = QUrl::PrettyDecoded)

Description: Method QString QUrlQuery::queryItemValue(const QString &key, QFlags<QUrl::ComponentFormattingOption> encoding)

queryItems

Signature: [const] QPair_QString_QString[] queryItems (QUrl_QFlags_ComponentFormattingOption encoding = QUrl::PrettyDecoded)

Description: Method QList<QPair<QString, QString> > QUrlQuery::queryItems(QFlags<QUrl::ComponentFormattingOption> encoding)

Python specific notes:
This method is available as 'queryItems_' in Python to distiguish it from the property with the same name.

queryItems=

Signature: void queryItems= (QPair_QString_QString[] query)

Description: Method void QUrlQuery::setQueryItems(const QList<QPair<QString, QString> > &query)

Python specific notes:
The object exposes a writable attribute 'queryItems'. This is the setter.

queryPairDelimiter

Signature: [const] unsigned int queryPairDelimiter

Description: Method QChar QUrlQuery::queryPairDelimiter()

queryValueDelimiter

Signature: [const] unsigned int queryValueDelimiter

Description: Method QChar QUrlQuery::queryValueDelimiter()

removeAllQueryItems

Signature: void removeAllQueryItems (string key)

Description: Method void QUrlQuery::removeAllQueryItems(const QString &key)

removeQueryItem

Signature: void removeQueryItem (string key)

Description: Method void QUrlQuery::removeQueryItem(const QString &key)

setQuery

Signature: void setQuery (string queryString)

Description: Method void QUrlQuery::setQuery(const QString &queryString)

Python specific notes:
The object exposes a writable attribute 'query'. This is the setter.

setQueryDelimiters

Signature: void setQueryDelimiters (unsigned int valueDelimiter, unsigned int pairDelimiter)

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

setQueryItems

Signature: void setQueryItems (QPair_QString_QString[] query)

Description: Method void QUrlQuery::setQueryItems(const QList<QPair<QString, QString> > &query)

Python specific notes:
The object exposes a writable attribute 'queryItems'. This is the setter.

swap

Signature: void swap (QUrlQuery other)

Description: Method void QUrlQuery::swap(QUrlQuery &other)

toString

Signature: [const] string toString (QUrl_QFlags_ComponentFormattingOption encoding = QUrl::PrettyDecoded)

Description: Method QString QUrlQuery::toString(QFlags<QUrl::ComponentFormattingOption> encoding)