API reference - Class QUrl

!=

Signature: [const] bool != (const QUrl url)

Description: Method bool QUrl::operator !=(const QUrl &url)

<

Signature: [const] bool < (const QUrl url)

Description: Method bool QUrl::operator <(const QUrl &url)

==

Signature: [const] bool == (const QUrl url)

Description: Method bool QUrl::operator ==(const QUrl &url)

None

Signature: [static,const] QUrl_FormattingOption None

Description: Enum constant QUrl::None

Python specific notes:
This member is available as 'None_' in Python.
The object exposes a readable attribute 'None_'. This is the getter.

RemoveAuthority

Signature: [static,const] QUrl_FormattingOption RemoveAuthority

Description: Enum constant QUrl::RemoveAuthority

Python specific notes:
The object exposes a readable attribute 'RemoveAuthority'. This is the getter.

RemoveFragment

Signature: [static,const] QUrl_FormattingOption RemoveFragment

Description: Enum constant QUrl::RemoveFragment

Python specific notes:
The object exposes a readable attribute 'RemoveFragment'. This is the getter.

RemovePassword

Signature: [static,const] QUrl_FormattingOption RemovePassword

Description: Enum constant QUrl::RemovePassword

Python specific notes:
The object exposes a readable attribute 'RemovePassword'. This is the getter.

RemovePath

Signature: [static,const] QUrl_FormattingOption RemovePath

Description: Enum constant QUrl::RemovePath

Python specific notes:
The object exposes a readable attribute 'RemovePath'. This is the getter.

RemovePort

Signature: [static,const] QUrl_FormattingOption RemovePort

Description: Enum constant QUrl::RemovePort

Python specific notes:
The object exposes a readable attribute 'RemovePort'. This is the getter.

RemoveQuery

Signature: [static,const] QUrl_FormattingOption RemoveQuery

Description: Enum constant QUrl::RemoveQuery

Python specific notes:
The object exposes a readable attribute 'RemoveQuery'. This is the getter.

RemoveScheme

Signature: [static,const] QUrl_FormattingOption RemoveScheme

Description: Enum constant QUrl::RemoveScheme

Python specific notes:
The object exposes a readable attribute 'RemoveScheme'. This is the getter.

RemoveUserInfo

Signature: [static,const] QUrl_FormattingOption RemoveUserInfo

Description: Enum constant QUrl::RemoveUserInfo

Python specific notes:
The object exposes a readable attribute 'RemoveUserInfo'. This is the getter.

StrictMode

Signature: [static,const] QUrl_ParsingMode StrictMode

Description: Enum constant QUrl::StrictMode

Python specific notes:
The object exposes a readable attribute 'StrictMode'. This is the getter.

StripTrailingSlash

Signature: [static,const] QUrl_FormattingOption StripTrailingSlash

Description: Enum constant QUrl::StripTrailingSlash

Python specific notes:
The object exposes a readable attribute 'StripTrailingSlash'. This is the getter.

TolerantMode

Signature: [static,const] QUrl_ParsingMode TolerantMode

Description: Enum constant QUrl::TolerantMode

Python specific notes:
The object exposes a readable attribute 'TolerantMode'. This is the getter.

_assign

Signature: void _assign (const QUrl other)

Description: Assigns another object to self

_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.

addEncodedQueryItem

Signature: void addEncodedQueryItem (bytes key, bytes value)

Description: Method void QUrl::addEncodedQueryItem(const QByteArray &key, const QByteArray &value)

addQueryItem

Signature: void addQueryItem (string key, string value)

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

allEncodedQueryItemValues

Signature: [const] bytes[] allEncodedQueryItemValues (bytes key)

Description: Method QList<QByteArray> QUrl::allEncodedQueryItemValues(const QByteArray &key)

allQueryItemValues

Signature: [const] string[] allQueryItemValues (string key)

Description: Method QStringList QUrl::allQueryItemValues(const QString &key)

assign

(1) Signature: QUrl assign (const QUrl copy)

Description: Method QUrl &QUrl::operator =(const QUrl &copy)

(2) Signature: QUrl assign (string url)

Description: Method QUrl &QUrl::operator =(const QString &url)

authority

Signature: [const] string authority

Description: Method QString QUrl::authority()

Python specific notes:
The object exposes a readable attribute 'authority'. This is the getter.

authority=

Signature: void authority= (string authority)

Description: Method void QUrl::setAuthority(const QString &authority)

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

clear

Signature: void clear

Description: Method void QUrl::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.

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.

detach

Signature: void detach

Description: Method void QUrl::detach()

dup

Signature: [const] new QUrl ptr dup

Description: Creates a copy of self

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

encodedFragment

Signature: [const] bytes encodedFragment

Description: Method QByteArray QUrl::encodedFragment()

Python specific notes:
The object exposes a readable attribute 'encodedFragment'. This is the getter.

encodedFragment=

Signature: void encodedFragment= (bytes fragment)

Description: Method void QUrl::setEncodedFragment(const QByteArray &fragment)

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

encodedHost

Signature: [const] bytes encodedHost

Description: Method QByteArray QUrl::encodedHost()

Python specific notes:
The object exposes a readable attribute 'encodedHost'. This is the getter.

encodedHost=

Signature: void encodedHost= (bytes host)

Description: Method void QUrl::setEncodedHost(const QByteArray &host)

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

encodedPassword

Signature: [const] bytes encodedPassword

Description: Method QByteArray QUrl::encodedPassword()

Python specific notes:
The object exposes a readable attribute 'encodedPassword'. This is the getter.

encodedPassword=

Signature: void encodedPassword= (bytes password)

Description: Method void QUrl::setEncodedPassword(const QByteArray &password)

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

encodedPath

Signature: [const] bytes encodedPath

Description: Method QByteArray QUrl::encodedPath()

Python specific notes:
The object exposes a readable attribute 'encodedPath'. This is the getter.

encodedPath=

Signature: void encodedPath= (bytes path)

Description: Method void QUrl::setEncodedPath(const QByteArray &path)

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

encodedQuery

Signature: [const] bytes encodedQuery

Description: Method QByteArray QUrl::encodedQuery()

Python specific notes:
The object exposes a readable attribute 'encodedQuery'. This is the getter.

encodedQuery=

Signature: void encodedQuery= (bytes query)

Description: Method void QUrl::setEncodedQuery(const QByteArray &query)

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

encodedQueryItemValue

Signature: [const] bytes encodedQueryItemValue (bytes key)

Description: Method QByteArray QUrl::encodedQueryItemValue(const QByteArray &key)

encodedQueryItems

Signature: [const] QPair_QByteArray_QByteArray[] encodedQueryItems

Description: Method QList<QPair<QByteArray, QByteArray> > QUrl::encodedQueryItems()

Python specific notes:
The object exposes a readable attribute 'encodedQueryItems'. This is the getter.

encodedQueryItems=

Signature: void encodedQueryItems= (QPair_QByteArray_QByteArray[] query)

Description: Method void QUrl::setEncodedQueryItems(const QList<QPair<QByteArray, QByteArray> > &query)

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

encodedUserName

Signature: [const] bytes encodedUserName

Description: Method QByteArray QUrl::encodedUserName()

Python specific notes:
The object exposes a readable attribute 'encodedUserName'. This is the getter.

encodedUserName=

Signature: void encodedUserName= (bytes userName)

Description: Method void QUrl::setEncodedUserName(const QByteArray &userName)

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

errorString

Signature: [const] string errorString

Description: Method QString QUrl::errorString()

fragment

Signature: [const] string fragment

Description: Method QString QUrl::fragment()

Python specific notes:
The object exposes a readable attribute 'fragment'. This is the getter.

fragment=

Signature: void fragment= (string fragment)

Description: Method void QUrl::setFragment(const QString &fragment)

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

fromAce

Signature: [static] string fromAce (bytes arg1)

Description: Static method QString QUrl::fromAce(const QByteArray &)

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

fromEncoded

(1) Signature: [static] QUrl fromEncoded (bytes url)

Description: Static method QUrl QUrl::fromEncoded(const QByteArray &url)

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

(2) Signature: [static] QUrl fromEncoded (bytes url, const QUrl_ParsingMode mode)

Description: Static method QUrl QUrl::fromEncoded(const QByteArray &url, QUrl::ParsingMode mode)

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

fromLocalFile

Signature: [static] QUrl fromLocalFile (string localfile)

Description: Static method QUrl QUrl::fromLocalFile(const QString &localfile)

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

fromPercentEncoding

Signature: [static] string fromPercentEncoding (bytes arg1)

Description: Static method QString QUrl::fromPercentEncoding(const QByteArray &)

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

fromPunycode

Signature: [static] string fromPunycode (bytes arg1)

Description: Static method QString QUrl::fromPunycode(const QByteArray &)

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

fromUserInput

Signature: [static] QUrl fromUserInput (string userInput)

Description: Static method QUrl QUrl::fromUserInput(const QString &userInput)

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

hasEncodedQueryItem

Signature: [const] bool hasEncodedQueryItem (bytes key)

Description: Method bool QUrl::hasEncodedQueryItem(const QByteArray &key)

hasFragment

Signature: [const] bool hasFragment

Description: Method bool QUrl::hasFragment()

hasQuery

Signature: [const] bool hasQuery

Description: Method bool QUrl::hasQuery()

hasQueryItem

Signature: [const] bool hasQueryItem (string key)

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

host

Signature: [const] string host

Description: Method QString QUrl::host()

Python specific notes:
The object exposes a readable attribute 'host'. This is the getter.

host=

Signature: void host= (string host)

Description: Method void QUrl::setHost(const QString &host)

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

idnWhitelist

Signature: [static] string[] idnWhitelist

Description: Static method QStringList QUrl::idnWhitelist()

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

Python specific notes:
The object exposes a readable attribute 'idnWhitelist'. This is the getter.

idnWhitelist=

Signature: [static] void idnWhitelist= (string[] arg1)

Description: Static method void QUrl::setIdnWhitelist(const QStringList &)

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

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

isDetached?

Signature: [const] bool isDetached?

Description: Method bool QUrl::isDetached()

isEmpty?

Signature: [const] bool isEmpty?

Description: Method bool QUrl::isEmpty()

isParentOf?

Signature: [const] bool isParentOf? (const QUrl url)

Description: Method bool QUrl::isParentOf(const QUrl &url)

isRelative?

Signature: [const] bool isRelative?

Description: Method bool QUrl::isRelative()

isValid?

Signature: [const] bool isValid?

Description: Method bool QUrl::isValid()

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 QUrl new

Description: Constructor QUrl::QUrl()

This method creates an object of class QUrl.

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

(2) Signature: [static] new QUrl new (string url)

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

This method creates an object of class QUrl.

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

(3) Signature: [static] new QUrl new (string url, const QUrl_ParsingMode mode)

Description: Constructor QUrl::QUrl(const QString &url, QUrl::ParsingMode mode)

This method creates an object of class QUrl.

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

(4) Signature: [static] new QUrl new (const QUrl copy)

Description: Constructor QUrl::QUrl(const QUrl &copy)

This method creates an object of class QUrl.

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

password

Signature: [const] string password

Description: Method QString QUrl::password()

Python specific notes:
The object exposes a readable attribute 'password'. This is the getter.

password=

Signature: void password= (string password)

Description: Method void QUrl::setPassword(const QString &password)

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

path

Signature: [const] string path

Description: Method QString QUrl::path()

Python specific notes:
The object exposes a readable attribute 'path'. This is the getter.

path=

Signature: void path= (string path)

Description: Method void QUrl::setPath(const QString &path)

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

port

(1) Signature: [const] int port

Description: Method int QUrl::port()

Python specific notes:
The object exposes a readable attribute 'port'. This is the getter.

(2) Signature: [const] int port (int defaultPort)

Description: Method int QUrl::port(int defaultPort)

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

port=

Signature: void port= (int port)

Description: Method void QUrl::setPort(int port)

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

queryItemValue

Signature: [const] string queryItemValue (string key)

Description: Method QString QUrl::queryItemValue(const QString &key)

queryItems

Signature: [const] QPair_QString_QString[] queryItems

Description: Method QList<QPair<QString, QString> > QUrl::queryItems()

Python specific notes:
The object exposes a readable attribute 'queryItems'. This is the getter.

queryItems=

Signature: void queryItems= (QPair_QString_QString[] query)

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

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

queryPairDelimiter

Signature: [const] char queryPairDelimiter

Description: Method char QUrl::queryPairDelimiter()

queryValueDelimiter

Signature: [const] char queryValueDelimiter

Description: Method char QUrl::queryValueDelimiter()

removeAllEncodedQueryItems

Signature: void removeAllEncodedQueryItems (bytes key)

Description: Method void QUrl::removeAllEncodedQueryItems(const QByteArray &key)

removeAllQueryItems

Signature: void removeAllQueryItems (string key)

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

removeEncodedQueryItem

Signature: void removeEncodedQueryItem (bytes key)

Description: Method void QUrl::removeEncodedQueryItem(const QByteArray &key)

removeQueryItem

Signature: void removeQueryItem (string key)

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

resolved

Signature: [const] QUrl resolved (const QUrl relative)

Description: Method QUrl QUrl::resolved(const QUrl &relative)

scheme

Signature: [const] string scheme

Description: Method QString QUrl::scheme()

Python specific notes:
The object exposes a readable attribute 'scheme'. This is the getter.

scheme=

Signature: void scheme= (string scheme)

Description: Method void QUrl::setScheme(const QString &scheme)

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

setAuthority

Signature: void setAuthority (string authority)

Description: Method void QUrl::setAuthority(const QString &authority)

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

setEncodedFragment

Signature: void setEncodedFragment (bytes fragment)

Description: Method void QUrl::setEncodedFragment(const QByteArray &fragment)

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

setEncodedHost

Signature: void setEncodedHost (bytes host)

Description: Method void QUrl::setEncodedHost(const QByteArray &host)

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

setEncodedPassword

Signature: void setEncodedPassword (bytes password)

Description: Method void QUrl::setEncodedPassword(const QByteArray &password)

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

setEncodedPath

Signature: void setEncodedPath (bytes path)

Description: Method void QUrl::setEncodedPath(const QByteArray &path)

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

setEncodedQuery

Signature: void setEncodedQuery (bytes query)

Description: Method void QUrl::setEncodedQuery(const QByteArray &query)

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

setEncodedQueryItems

Signature: void setEncodedQueryItems (QPair_QByteArray_QByteArray[] query)

Description: Method void QUrl::setEncodedQueryItems(const QList<QPair<QByteArray, QByteArray> > &query)

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

setEncodedUrl

(1) Signature: void setEncodedUrl (bytes url)

Description: Method void QUrl::setEncodedUrl(const QByteArray &url)

(2) Signature: void setEncodedUrl (bytes url, const QUrl_ParsingMode mode)

Description: Method void QUrl::setEncodedUrl(const QByteArray &url, QUrl::ParsingMode mode)

setEncodedUserName

Signature: void setEncodedUserName (bytes userName)

Description: Method void QUrl::setEncodedUserName(const QByteArray &userName)

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

setFragment

Signature: void setFragment (string fragment)

Description: Method void QUrl::setFragment(const QString &fragment)

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

setHost

Signature: void setHost (string host)

Description: Method void QUrl::setHost(const QString &host)

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

setIdnWhitelist

Signature: [static] void setIdnWhitelist (string[] arg1)

Description: Static method void QUrl::setIdnWhitelist(const QStringList &)

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

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

setPassword

Signature: void setPassword (string password)

Description: Method void QUrl::setPassword(const QString &password)

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

setPath

Signature: void setPath (string path)

Description: Method void QUrl::setPath(const QString &path)

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

setPort

Signature: void setPort (int port)

Description: Method void QUrl::setPort(int port)

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

setQueryDelimiters

Signature: void setQueryDelimiters (char valueDelimiter, char pairDelimiter)

Description: Method void QUrl::setQueryDelimiters(char valueDelimiter, char pairDelimiter)

setQueryItems

Signature: void setQueryItems (QPair_QString_QString[] query)

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

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

setScheme

Signature: void setScheme (string scheme)

Description: Method void QUrl::setScheme(const QString &scheme)

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

setUrl

(1) Signature: void setUrl (string url)

Description: Method void QUrl::setUrl(const QString &url)

(2) Signature: void setUrl (string url, const QUrl_ParsingMode mode)

Description: Method void QUrl::setUrl(const QString &url, QUrl::ParsingMode mode)

setUserInfo

Signature: void setUserInfo (string userInfo)

Description: Method void QUrl::setUserInfo(const QString &userInfo)

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

setUserName

Signature: void setUserName (string userName)

Description: Method void QUrl::setUserName(const QString &userName)

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

toAce

Signature: [static] bytes toAce (string arg1)

Description: Static method QByteArray QUrl::toAce(const QString &)

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

toEncoded

Signature: [const] bytes toEncoded (QUrl_QFlags_FormattingOption options = QUrl::None)

Description: Method QByteArray QUrl::toEncoded(QFlags<QUrl::FormattingOption> options)

toLocalFile

Signature: [const] string toLocalFile

Description: Method QString QUrl::toLocalFile()

toPercentEncoding

Signature: [static] bytes toPercentEncoding (string arg1, bytes exclude = QByteArray(), bytes include = QByteArray())

Description: Static method QByteArray QUrl::toPercentEncoding(const QString &, const QByteArray &exclude, const QByteArray &include)

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

toPunycode

Signature: [static] bytes toPunycode (string arg1)

Description: Static method QByteArray QUrl::toPunycode(const QString &)

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

toString

Signature: [const] string toString (QUrl_QFlags_FormattingOption options = QUrl::None)

Description: Method QString QUrl::toString(QFlags<QUrl::FormattingOption> options)

userInfo

Signature: [const] string userInfo

Description: Method QString QUrl::userInfo()

Python specific notes:
The object exposes a readable attribute 'userInfo'. This is the getter.

userInfo=

Signature: void userInfo= (string userInfo)

Description: Method void QUrl::setUserInfo(const QString &userInfo)

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

userName

Signature: [const] string userName

Description: Method QString QUrl::userName()

Python specific notes:
The object exposes a readable attribute 'userName'. This is the getter.

userName=

Signature: void userName= (string userName)

Description: Method void QUrl::setUserName(const QString &userName)

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