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)

AssumeLocalFile

Signature: [static,const] QUrl_UserInputResolutionOption AssumeLocalFile

Description: Enum constant QUrl::AssumeLocalFile

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

DecodeReserved

Signature: [static,const] QUrl_ComponentFormattingOption DecodeReserved

Description: Enum constant QUrl::DecodeReserved

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

DecodedMode

Signature: [static,const] QUrl_ParsingMode DecodedMode

Description: Enum constant QUrl::DecodedMode

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

DefaultResolution

Signature: [static,const] QUrl_UserInputResolutionOption DefaultResolution

Description: Enum constant QUrl::DefaultResolution

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

EncodeDelimiters

Signature: [static,const] QUrl_ComponentFormattingOption EncodeDelimiters

Description: Enum constant QUrl::EncodeDelimiters

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

EncodeReserved

Signature: [static,const] QUrl_ComponentFormattingOption EncodeReserved

Description: Enum constant QUrl::EncodeReserved

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

EncodeSpaces

Signature: [static,const] QUrl_ComponentFormattingOption EncodeSpaces

Description: Enum constant QUrl::EncodeSpaces

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

EncodeUnicode

Signature: [static,const] QUrl_ComponentFormattingOption EncodeUnicode

Description: Enum constant QUrl::EncodeUnicode

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

FullyDecoded

Signature: [static,const] QUrl_ComponentFormattingOption FullyDecoded

Description: Enum constant QUrl::FullyDecoded

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

FullyEncoded

Signature: [static,const] QUrl_ComponentFormattingOption FullyEncoded

Description: Enum constant QUrl::FullyEncoded

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

None

Signature: [static,const] QUrl_UrlFormattingOption 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.

NormalizePathSegments

Signature: [static,const] QUrl_UrlFormattingOption NormalizePathSegments

Description: Enum constant QUrl::NormalizePathSegments

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

PreferLocalFile

Signature: [static,const] QUrl_UrlFormattingOption PreferLocalFile

Description: Enum constant QUrl::PreferLocalFile

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

PrettyDecoded

Signature: [static,const] QUrl_ComponentFormattingOption PrettyDecoded

Description: Enum constant QUrl::PrettyDecoded

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

RemoveAuthority

Signature: [static,const] QUrl_UrlFormattingOption RemoveAuthority

Description: Enum constant QUrl::RemoveAuthority

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

RemoveFilename

Signature: [static,const] QUrl_UrlFormattingOption RemoveFilename

Description: Enum constant QUrl::RemoveFilename

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

RemoveFragment

Signature: [static,const] QUrl_UrlFormattingOption 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_UrlFormattingOption 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_UrlFormattingOption 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_UrlFormattingOption 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_UrlFormattingOption 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_UrlFormattingOption 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_UrlFormattingOption 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_UrlFormattingOption 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

_const_cast

Signature: [const] QUrl 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.

adjusted

Signature: [const] QUrl adjusted (QUrl_FormattingOptions options)

Description: Method QUrl QUrl::adjusted(QUrlTwoFlags<QUrl::UrlFormattingOption, QUrl::ComponentFormattingOption> options)

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 (QUrl_QFlags_ComponentFormattingOption options = QUrl::PrettyDecoded)

Description: Method QString QUrl::authority(QFlags<QUrl::ComponentFormattingOption> options)

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__'.

errorString

Signature: [const] string errorString

Description: Method QString QUrl::errorString()

fileName

Signature: [const] string fileName (QUrl_QFlags_ComponentFormattingOption options = QUrl::FullyDecoded)

Description: Method QString QUrl::fileName(QFlags<QUrl::ComponentFormattingOption> options)

fragment

Signature: [const] string fragment (QUrl_QFlags_ComponentFormattingOption options = QUrl::PrettyDecoded)

Description: Method QString QUrl::fragment(QFlags<QUrl::ComponentFormattingOption> options)

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

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

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.

fromStringList

Signature: [static] QUrl[] fromStringList (string[] uris, const QUrl_ParsingMode mode = QUrl::TolerantMode)

Description: Static method QList<QUrl> QUrl::fromStringList(const QStringList &uris, QUrl::ParsingMode mode)

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

fromUserInput

(1) 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.

(2) Signature: [static] QUrl fromUserInput (string userInput, string workingDirectory, QUrl_QFlags_UserInputResolutionOption options = QUrl::DefaultResolution)

Description: Static method QUrl QUrl::fromUserInput(const QString &userInput, const QString &workingDirectory, QFlags<QUrl::UserInputResolutionOption> options)

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

hasFragment

Signature: [const] bool hasFragment

Description: Method bool QUrl::hasFragment()

hasQuery

Signature: [const] bool hasQuery

Description: Method bool QUrl::hasQuery()

host

Signature: [const] string host (QUrl_QFlags_ComponentFormattingOption arg1 = QUrl::FullyDecoded)

Description: Method QString QUrl::host(QFlags<QUrl::ComponentFormattingOption>)

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()

isLocalFile?

Signature: [const] bool isLocalFile?

Description: Method bool QUrl::isLocalFile()

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.

matches

Signature: [const] bool matches (const QUrl url, QUrl_FormattingOptions options)

Description: Method bool QUrl::matches(const QUrl &url, QUrlTwoFlags<QUrl::UrlFormattingOption, QUrl::ComponentFormattingOption> options)

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

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

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.

password

Signature: [const] string password (QUrl_QFlags_ComponentFormattingOption arg1 = QUrl::FullyDecoded)

Description: Method QString QUrl::password(QFlags<QUrl::ComponentFormattingOption>)

path

Signature: [const] string path (QUrl_QFlags_ComponentFormattingOption options = QUrl::FullyDecoded)

Description: Method QString QUrl::path(QFlags<QUrl::ComponentFormattingOption> options)

port

Signature: [const] int port (int defaultPort = -1)

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.

query

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

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

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, const QUrl_ParsingMode mode = QUrl::TolerantMode)

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

setFragment

Signature: void setFragment (string fragment, const QUrl_ParsingMode mode = QUrl::TolerantMode)

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

setHost

Signature: void setHost (string host, const QUrl_ParsingMode mode = QUrl::DecodedMode)

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

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, const QUrl_ParsingMode mode = QUrl::DecodedMode)

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

setPath

Signature: void setPath (string path, const QUrl_ParsingMode mode = QUrl::DecodedMode)

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

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.

setQuery

(1) Signature: void setQuery (string query, const QUrl_ParsingMode mode = QUrl::TolerantMode)

Description: Method void QUrl::setQuery(const QString &query, QUrl::ParsingMode mode)

(2) Signature: void setQuery (const QUrlQuery query)

Description: Method void QUrl::setQuery(const QUrlQuery &query)

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

Signature: void setUrl (string url, const QUrl_ParsingMode mode = QUrl::TolerantMode)

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

setUserInfo

Signature: void setUserInfo (string userInfo, const QUrl_ParsingMode mode = QUrl::TolerantMode)

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

setUserName

Signature: void setUserName (string userName, const QUrl_ParsingMode mode = QUrl::DecodedMode)

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

swap

Signature: void swap (QUrl other)

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

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.

toDisplayString

Signature: [const] string toDisplayString (QUrl_FormattingOptions options = QUrl::FormattingOptions(QUrl::PrettyDecoded))

Description: Method QString QUrl::toDisplayString(QUrlTwoFlags<QUrl::UrlFormattingOption, QUrl::ComponentFormattingOption> options)

toEncoded

Signature: [const] bytes toEncoded (QUrl_FormattingOptions options = QUrl::FullyEncoded)

Description: Method QByteArray QUrl::toEncoded(QUrlTwoFlags<QUrl::UrlFormattingOption, QUrl::ComponentFormattingOption> 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.

toString

Signature: [const] string toString (QUrl_FormattingOptions options = QUrl::FormattingOptions(QUrl::PrettyDecoded))

Description: Method QString QUrl::toString(QUrlTwoFlags<QUrl::UrlFormattingOption, QUrl::ComponentFormattingOption> options)

toStringList

Signature: [static] string[] toStringList (QUrl[] uris, QUrl_FormattingOptions options = QUrl::FormattingOptions(QUrl::PrettyDecoded))

Description: Static method QStringList QUrl::toStringList(const QList<QUrl> &uris, QUrlTwoFlags<QUrl::UrlFormattingOption, QUrl::ComponentFormattingOption> options)

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

topLevelDomain

Signature: [const] string topLevelDomain (QUrl_QFlags_ComponentFormattingOption options = QUrl::FullyDecoded)

Description: Method QString QUrl::topLevelDomain(QFlags<QUrl::ComponentFormattingOption> options)

url

Signature: [const] string url (QUrl_FormattingOptions options = QUrl::FormattingOptions(QUrl::PrettyDecoded))

Description: Method QString QUrl::url(QUrlTwoFlags<QUrl::UrlFormattingOption, QUrl::ComponentFormattingOption> options)

userInfo

Signature: [const] string userInfo (QUrl_QFlags_ComponentFormattingOption options = QUrl::PrettyDecoded)

Description: Method QString QUrl::userInfo(QFlags<QUrl::ComponentFormattingOption> options)

userName

Signature: [const] string userName (QUrl_QFlags_ComponentFormattingOption options = QUrl::FullyDecoded)

Description: Method QString QUrl::userName(QFlags<QUrl::ComponentFormattingOption> options)