The QUrl class provides a convenient interface for working with URLs. More...
#include <qurl.h>
Static Public Member Functions | |
| static QUrl | fromEncoded (const QByteArray &url, ParsingMode mode=TolerantMode) |
| static QUrl | fromUserInput (const QString &userInput, const QString &workingDirectory=QString(), UserInputResolutionOptions options=DefaultResolution) |
| static QUrl | fromLocalFile (const QString &localfile) |
| static QString | fromPercentEncoding (const QByteArray &) |
| static QByteArray | toPercentEncoding (const QString &, const QByteArray &exclude=QByteArray(), const QByteArray &include=QByteArray()) |
| static QString | fromAce (const QByteArray &domain, AceProcessingOptions options={}) |
| static QByteArray | toAce (const QString &domain, AceProcessingOptions options={}) |
| static QStringList | idnWhitelist () |
| static QStringList | toStringList (const QList< QUrl > &uris, FormattingOptions options=FormattingOptions(PrettyDecoded)) |
| static QList< QUrl > | fromStringList (const QStringList &uris, ParsingMode mode=TolerantMode) |
| static void | setIdnWhitelist (const QStringList &) |
Friends | |
| class | QUrlQuery |
| Q_CORE_EXPORT size_t | qHash (const QUrl &url, size_t seed) noexcept |
Related Functions | |
(Note that these are not member functions.) | |
| QUrl (const QString &url, ParsingMode parsingMode) | |
| QDataStream & | operator<< (QDataStream &out, const QUrl &url) |
| QDataStream & | operator>> (QDataStream &in, QUrl &url) |
Detailed Description
The QUrl class provides a convenient interface for working with URLs.
\inmodule QtCore
\reentrant
It can parse and construct URLs in both encoded and unencoded form. QUrl also has support for internationalized domain names (IDNs).
The most common way to use QUrl is to initialize it via the constructor by passing a QString. Otherwise, setUrl() can also be used.
URLs can be represented in two forms: encoded or unencoded. The unencoded representation is suitable for showing to users, but the encoded representation is typically what you would send to a web server. For example, the unencoded URL "http://bühler.example.com/List of applicants.xml" would be sent to the server as "http://xn--bhler-kva.example.com/List%20of%20applicants.xml".
A URL can also be constructed piece by piece by calling setScheme(), setUserName(), setPassword(), setHost(), setPort(), setPath(), setQuery() and setFragment(). Some convenience functions are also available: setAuthority() sets the user name, password, host and port. setUserInfo() sets the user name and password at once.
Call isValid() to check if the URL is valid. This can be done at any point during the constructing of a URL. If isValid() returns false, you should clear() the URL before proceeding, or start over by parsing a new URL with setUrl().
Constructing a query is particularly convenient through the use of the \l QUrlQuery class and its methods QUrlQuery::setQueryItems(), QUrlQuery::addQueryItem() and QUrlQuery::removeQueryItem(). Use QUrlQuery::setQueryDelimiters() to customize the delimiters used for generating the query string.
For the convenience of generating encoded URL strings or query strings, there are two static functions called fromPercentEncoding() and toPercentEncoding() which deal with percent encoding and decoding of QString objects.
fromLocalFile() constructs a QUrl by parsing a local file path. toLocalFile() converts a URL to a local file path.
The human readable representation of the URL is fetched with toString(). This representation is appropriate for displaying a URL to a user in unencoded form. The encoded form however, as returned by toEncoded(), is for internal use, passing to web servers, mail clients and so on. Both forms are technically correct and represent the same URL unambiguously – in fact, passing either form to QUrl's constructor or to setUrl() will yield the same QUrl object.
QUrl conforms to the URI specification from \l{RFC 3986} (Uniform Resource Identifier: Generic Syntax), and includes scheme extensions from \l{RFC 1738} (Uniform Resource Locators). Case folding rules in QUrl conform to \l{RFC 3491} (Nameprep: A Stringprep Profile for Internationalized Domain Names (IDN)). It is also compatible with the \l{http://freedesktop.org/wiki/Specifications/file-uri-spec/}{file URI specification} from freedesktop.org, provided that the locale encodes file names using UTF-8 (required by IDN).
Member Typedef Documentation
◆ DataPtr
◆ FormattingOptions
Member Enumeration Documentation
◆ AceProcessingOption
| enum QUrl::AceProcessingOption : unsigned int |
- Since
- 6.3
The ACE processing options control the way URLs are transformed to and from ASCII-Compatible Encoding.
\value IgnoreIDNWhitelist Ignore the IDN whitelist when converting URLs to Unicode. \value AceTransitionalProcessing Use transitional processing described in UTS #46. This allows better compatibility with IDNA 2003 specification.
The default is to use nontransitional processing and to allow non-ASCII characters only inside URLs whose top-level domains are listed in the IDN whitelist.
- See also
- toAce(), fromAce(), idnWhitelist()
| Enumerator | |
|---|---|
| IgnoreIDNWhitelist | |
| AceTransitionalProcessing | |
◆ ComponentFormattingOption
| enum QUrl::ComponentFormattingOption : unsigned int |
- Since
- 5.0
The component formatting options define how the components of an URL will be formatted when written out as text. They can be combined with the options from QUrl::FormattingOptions when used in toString() and toEncoded().
\value PrettyDecoded The component is returned in a "pretty form", with most percent-encoded characters decoded. The exact behavior of PrettyDecoded varies from component to component and may also change from Qt release to Qt release. This is the default.
\value EncodeSpaces Leave space characters in their encoded form ("%20").
\value EncodeUnicode Leave non-US-ASCII characters encoded in their UTF-8 percent-encoded form (e.g., "%C3%A9" for the U+00E9 codepoint, LATIN SMALL LETTER E WITH ACUTE).
\value EncodeDelimiters Leave certain delimiters in their encoded form, as would appear in the URL when the full URL is represented as text. The delimiters are affected by this option change from component to component. This flag has no effect in toString() or toEncoded().
\value EncodeReserved Leave US-ASCII characters not permitted in the URL by the specification in their encoded form. This is the default on toString() and toEncoded().
\value DecodeReserved Decode the US-ASCII characters that the URL specification does not allow to appear in the URL. This is the default on the getters of individual components.
\value FullyEncoded Leave all characters in their properly-encoded form, as this component would appear as part of a URL. When used with toString(), this produces a fully-compliant URL in QString form, exactly equal to the result of toEncoded()
\value FullyDecoded Attempt to decode as much as possible. For individual components of the URL, this decodes every percent encoding sequence, including control characters (U+0000 to U+001F) and UTF-8 sequences found in percent-encoded form. Use of this mode may cause data loss, see below for more information.
The values of EncodeReserved and DecodeReserved should not be used together in one call. The behavior is undefined if that happens. They are provided as separate values because the behavior of the "pretty mode" with regards to reserved characters is different on certain components and specially on the full URL.
| Enumerator | |
|---|---|
| PrettyDecoded | |
| EncodeSpaces | |
| EncodeUnicode | |
| EncodeDelimiters | |
| EncodeReserved | |
| DecodeReserved | |
| FullyEncoded | |
| FullyDecoded | |
◆ ParsingMode
| enum QUrl::ParsingMode |
The parsing mode controls the way QUrl parses strings.
\value TolerantMode QUrl will try to correct some common errors in URLs. This mode is useful for parsing URLs coming from sources not known to be strictly standards-conforming.
\value StrictMode Only valid URLs are accepted. This mode is useful for general URL validation.
\value DecodedMode QUrl will interpret the URL component in the fully-decoded form, where percent characters stand for themselves, not as the beginning of a percent-encoded sequence. This mode is only valid for the setters setting components of a URL; it is not permitted in the QUrl constructor, in fromEncoded() or in setUrl(). For more information on this mode, see the documentation for \l {QUrl::ComponentFormattingOption}{QUrl::FullyDecoded}.
In TolerantMode, the parser has the following behaviour:
\list
- Spaces and "%20": unencoded space characters will be accepted and will be treated as equivalent to "%20".
- Single "%" characters: Any occurrences of a percent character "%" not followed by exactly two hexadecimal characters (e.g., "13% coverage.html") will be replaced by "%25". Note that one lone "%" character will trigger the correction mode for all percent characters.
- Reserved and unreserved characters: An encoded URL should only contain a few characters as literals; all other characters should be percent-encoded. In TolerantMode, these characters will be accepted if they are found in the URL: space / double-quote / "<" / ">" / "\" / "^" / "`" / "{" / "|" / "}" Those same characters can be decoded again by passing QUrl::DecodeReserved to toString() or toEncoded(). In the getters of individual components, those characters are often returned in decoded form.
\endlist
When in StrictMode, if a parsing error is found, isValid() will return false and errorString() will return a message describing the error. If more than one error is detected, it is undefined which error gets reported.
Note that TolerantMode is not usually enough for parsing user input, which often contains more errors and expectations than the parser can deal with. When dealing with data coming directly from the user – as opposed to data coming from data-transfer sources, such as other programs – it is recommended to use fromUserInput().
| Enumerator | |
|---|---|
| TolerantMode | |
| StrictMode | |
| DecodedMode | |
◆ UrlFormattingOption
| enum QUrl::UrlFormattingOption : unsigned int |
The formatting options define how the URL is formatted when written out as text.
\value None The format of the URL is unchanged. \value RemoveScheme The scheme is removed from the URL. \value RemovePassword Any password in the URL is removed. \value RemoveUserInfo Any user information in the URL is removed. \value RemovePort Any specified port is removed from the URL. \value RemoveAuthority \value RemovePath The URL's path is removed, leaving only the scheme, host address, and port (if present). \value RemoveQuery The query part of the URL (following a '?' character) is removed. \value RemoveFragment \value RemoveFilename The filename (i.e. everything after the last '/' in the path) is removed. The trailing '/' is kept, unless StripTrailingSlash is set. Only valid if RemovePath is not set. \value PreferLocalFile If the URL is a local file according to isLocalFile() and contains no query or fragment, a local file path is returned. \value StripTrailingSlash The trailing slash is removed from the path, if one is present. \value NormalizePathSegments Modifies the path to remove redundant directory separators, and to resolve "."s and ".."s (as far as possible). For non-local paths, adjacent slashes are preserved.
Note that the case folding rules in \l{RFC 3491}{Nameprep}, which QUrl conforms to, require host names to always be converted to lower case, regardless of the Qt::FormattingOptions used.
The options from QUrl::ComponentFormattingOptions are also possible.
- See also
- QUrl::ComponentFormattingOptions
| Enumerator | |
|---|---|
| None | |
| RemoveScheme | |
| RemovePassword | |
| RemoveUserInfo | |
| RemovePort | |
| RemoveAuthority | |
| RemovePath | |
| RemoveQuery | |
| RemoveFragment | |
| PreferLocalFile | |
| StripTrailingSlash | |
| RemoveFilename | |
| NormalizePathSegments | |
◆ UserInputResolutionOption
- Since
- 5.4
The user input resolution options define how fromUserInput() should interpret strings that could either be a relative path or the short form of a HTTP URL. For instance {file.pl} can be either a local file or the URL {http://file.pl}.
\value DefaultResolution The default resolution mechanism is to check whether a local file exists, in the working directory given to fromUserInput, and only return a local path in that case. Otherwise a URL is assumed. \value AssumeLocalFile This option makes fromUserInput() always return a local path unless the input contains a scheme, such as {http://file.pl}. This is useful for applications such as text editors, which are able to create the file if it doesn't exist.
- See also
- fromUserInput()
| Enumerator | |
|---|---|
| DefaultResolution | |
| AssumeLocalFile | |
Constructor & Destructor Documentation
◆ QUrl() [1/4]
| QUrl::QUrl | ( | ) |
◆ QUrl() [2/4]
◆ QUrl() [3/4]
| QUrl | ( | const QString & | url, |
| ParsingMode | parsingMode = TolerantMode |
||
| ) |
\macro QT_NO_URL_CAST_FROM_STRING
Disables automatic conversions from QString (or char *) to QUrl.
Compiling your code with this define is useful when you have a lot of code that uses QString for file names and you wish to convert it to use QUrl for network transparency. In any code that uses QUrl, it can help avoid missing QUrl::resolved() calls, and other misuses of QString to QUrl conversions.
For example, if you have code like
you can rewrite it as
- See also
- QT_NO_CAST_FROM_ASCII
Constructs a URL by parsing url. QUrl will automatically percent encode all characters that are not allowed in a URL and decode the percent-encoded sequences that represent an unreserved character (letters, digits, hyphens, underscores, dots and tildes). All other characters are left in their original forms.
Parses the url using the parser mode parsingMode. In TolerantMode (the default), QUrl will correct certain mistakes, notably the presence of a percent character ('') not followed by two hexadecimal digits, and it will accept any character in any position. In StrictMode, encoding mistakes will not be tolerated and QUrl will also check that certain forbidden characters are not present in unencoded form. If an error is detected in StrictMode, isValid() will return false. The parsing mode DecodedMode is not permitted in this context.
Example:
To construct a URL from an encoded string, you can also use fromEncoded():
Both functions are equivalent and, in Qt 5, both functions accept encoded data. Usually, the choice of the QUrl constructor or setUrl() versus fromEncoded() will depend on the source data: the constructor and setUrl() take a QString, whereas fromEncoded takes a QByteArray.
- See also
- setUrl(), fromEncoded(), TolerantMode
Definition at line 1858 of file qurl.cpp.
◆ QUrl() [4/4]
|
inlinenoexcept |
◆ ~QUrl()
| QUrl::~QUrl | ( | ) |
Member Function Documentation
◆ adjusted()
| QUrl QUrl::adjusted | ( | QUrl::FormattingOptions | options | ) | const |
- Since
- 5.2
Returns an adjusted version of the URL. The output can be customized by passing flags with options.
The encoding options from QUrl::ComponentFormattingOption don't make much sense for this method, nor does QUrl::PreferLocalFile.
This is always equivalent to QUrl(url.toString(options)).
- See also
- FormattingOptions, toEncoded(), toString()
Definition at line 2944 of file qurl.cpp.
◆ authority()
| QString QUrl::authority | ( | ComponentFormattingOptions | options = PrettyDecoded | ) | const |
Returns the authority of the URL if it is defined; otherwise an empty string is returned.
This function returns an unambiguous value, which may contain that characters still percent-encoded, plus some control sequences not representable in decoded form in QString.
The options argument controls how to format the user info component. The value of QUrl::FullyDecoded is not permitted in this function. If you need to obtain fully decoded data, call userName(), password(), host() and port() individually.
- See also
- setAuthority(), userInfo(), userName(), password(), host(), port()
Definition at line 2075 of file qurl.cpp.
◆ clear()
| void QUrl::clear | ( | ) |
◆ data_ptr()
◆ detach()
| void QUrl::detach | ( | ) |
◆ errorString()
| QString QUrl::errorString | ( | ) | const |
- Since
- 4.2
Returns an error message if the last operation that modified this QUrl object ran into a parsing error. If no error was detected, this function returns an empty string and isValid() returns true.
The error message returned by this function is technical in nature and may not be understood by end users. It is mostly useful to developers trying to understand why QUrl will not accept some input.
- See also
- QUrl::ParsingMode
Definition at line 3618 of file qurl.cpp.
◆ fileName()
| QString QUrl::fileName | ( | ComponentFormattingOptions | options = FullyDecoded | ) | const |
- Since
- 5.2
Returns the name of the file, excluding the directory path.
Note that, if this QUrl object is given a path ending in a slash, the name of the file is considered empty.
If the path doesn't contain any slash, it is fully returned as the fileName.
Example:
The options argument controls how to format the file name component. All values produce an unambiguous result. With QUrl::FullyDecoded, all percent-encoded sequences are decoded; otherwise, the returned value may contain some percent-encoded sequences for some control sequences not representable in decoded form in QString.
- See also
- path()
Definition at line 2517 of file qurl.cpp.
◆ fragment()
| QString QUrl::fragment | ( | ComponentFormattingOptions | options = PrettyDecoded | ) | const |
Returns the fragment of the URL. To determine if the parsed URL contained a fragment, use hasFragment().
The options argument controls how to format the fragment component. All values produce an unambiguous result. With QUrl::FullyDecoded, all percent-encoded sequences are decoded; otherwise, the returned value may contain some percent-encoded sequences for some control sequences not representable in decoded form in QString.
Note that QUrl::FullyDecoded may cause data loss if those non-representable sequences are present. It is recommended to use that value when the result will be used in a non-URL context.
- See also
- setFragment(), hasFragment()
Definition at line 2702 of file qurl.cpp.
◆ fromAce()
|
static |
- Since
- 6.3
Returns the Unicode form of the given domain name domain, which is encoded in the ASCII Compatible Encoding (ACE). The output can be customized by passing flags with options. The result of this function is considered equivalent to domain.
If the value in domain cannot be encoded, it will be converted to QString and returned.
The ASCII-Compatible Encoding (ACE) is defined by RFC 3490, RFC 3491 and RFC 3492 and updated by the Unicode Technical Standard #46. It is part of the Internationalizing Domain Names in Applications (IDNA) specification, which allows for domain names (like "example.com") to be written using non-US-ASCII characters.
◆ fromEncoded()
|
static |
Parses input and returns the corresponding QUrl. input is assumed to be in encoded form, containing only ASCII characters.
Parses the URL using parsingMode. See setUrl() for more information on this parameter. QUrl::DecodedMode is not permitted in this context.
- See also
- toEncoded(), setUrl()
Definition at line 3004 of file qurl.cpp.
◆ fromLocalFile()
Returns a QUrl representation of localFile, interpreted as a local file. This function accepts paths separated by slashes as well as the native separator for this platform.
This function also accepts paths with a doubled leading slash (or backslash) to indicate a remote file, as in "//servername/path/to/file.txt". Note that only certain platforms can actually open this file using QFile::open().
An empty localFile leads to an empty URL (since Qt 5.4).
In the first line in snippet above, a file URL is constructed from a local, relative path. A file URL with a relative path only makes sense if there is a base URL to resolve it against. For example:
To resolve such a URL, it's necessary to remove the scheme beforehand:
For this reason, it is better to use a relative URL (that is, no scheme) for relative file paths:
Definition at line 3373 of file qurl.cpp.
◆ fromPercentEncoding()
|
static |
Returns a decoded copy of input. input is first decoded from percent encoding, then converted from UTF-8 to unicode.
- Note
- Given invalid input (such as a string containing the sequence "%G5", which is not a valid hexadecimal number) the output will be invalid as well. As an example: the sequence "%G5" could be decoded to 'W'.
Definition at line 3017 of file qurl.cpp.
◆ fromStringList()
|
static |
◆ fromUserInput()
|
static |
Returns a valid URL from a user supplied userInput string if one can be deduced. In the case that is not possible, an invalid QUrl() is returned.
This allows the user to input a URL or a local file path in the form of a plain string. This string can be manually typed into a location bar, obtained from the clipboard, or passed in via command line arguments.
When the string is not already a valid URL, a best guess is performed, making various assumptions.
In the case the string corresponds to a valid file path on the system, a file:// URL is constructed, using QUrl::fromLocalFile().
If that is not the case, an attempt is made to turn the string into a http:// or ftp:// URL. The latter in the case the string starts with 'ftp'. The result is then passed through QUrl's tolerant parser, and in the case or success, a valid QUrl is returned, or else a QUrl().
Definition at line 3771 of file qurl.cpp.
◆ hasFragment()
| bool QUrl::hasFragment | ( | ) | const |
- Since
- 4.2
Returns true if this URL contains a fragment (i.e., if # was seen on it).
- See also
- fragment(), setFragment()
Definition at line 2720 of file qurl.cpp.
◆ hasQuery()
| bool QUrl::hasQuery | ( | ) | const |
- Since
- 4.2
Returns true if this URL contains a Query (i.e., if ? was seen on it).
- See also
- setQuery(), query(), hasFragment()
Definition at line 2533 of file qurl.cpp.
◆ host()
| QString QUrl::host | ( | ComponentFormattingOptions | options = FullyDecoded | ) | const |
Returns the host of the URL if it is defined; otherwise an empty string is returned.
The options argument controls how the hostname will be formatted. The QUrl::EncodeUnicode option will cause this function to return the hostname in the ASCII-Compatible Encoding (ACE) form, which is suitable for use in channels that are not 8-bit clean or that require the legacy hostname (such as DNS requests or in HTTP request headers). If that flag is not present, this function returns the International Domain Name (IDN) in Unicode form, according to the list of permissible top-level domains (see idnWhitelist()).
All other flags are ignored. Host names cannot contain control or percent characters, so the returned value can be considered fully decoded.
- See also
- setHost(), idnWhitelist(), setIdnWhitelist(), authority()
Definition at line 2360 of file qurl.cpp.
◆ idnWhitelist()
|
static |
- Since
- 4.2
Returns the current whitelist of top-level domains that are allowed to have non-ASCII characters in their compositions.
See setIdnWhitelist() for the rationale of this list.
- See also
- AceProcessingOption
Definition at line 960 of file qurlidna.cpp.
◆ isDetached()
| bool QUrl::isDetached | ( | ) | const |
◆ isEmpty()
| bool QUrl::isEmpty | ( | ) | const |
◆ isLocalFile()
| bool QUrl::isLocalFile | ( | ) | const |
- Since
- 4.8 Returns
trueif this URL is pointing to a local file path. A URL is a local file path if the scheme is "file".
Note that this function considers URLs with hostnames to be local file paths, even if the eventual file path cannot be opened with QFile::open().
- See also
- fromLocalFile(), toLocalFile()
Definition at line 3450 of file qurl.cpp.
◆ isParentOf()
◆ isRelative()
| bool QUrl::isRelative | ( | ) | const |
Returns true if the URL is relative; otherwise returns false. A URL is relative reference if its scheme is undefined; this function is therefore equivalent to calling scheme().isEmpty().
Relative references are defined in RFC 3986 section 4.2.
- See also
- {Relative URLs vs Relative Paths}
Definition at line 2820 of file qurl.cpp.
◆ isValid()
| bool QUrl::isValid | ( | ) | const |
Returns true if the URL is non-empty and valid; otherwise returns false.
The URL is run through a conformance test. Every part of the URL must conform to the standard encoding rules of the URI standard for the URL to be reported as valid.
Definition at line 1897 of file qurl.cpp.
◆ matches()
| bool QUrl::matches | ( | const QUrl & | url, |
| FormattingOptions | options | ||
| ) | const |
◆ operator!=()
| bool QUrl::operator!= | ( | const QUrl & | url | ) | const |
◆ operator<()
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ operator==()
◆ password()
| QString QUrl::password | ( | ComponentFormattingOptions | options = FullyDecoded | ) | const |
Returns the password of the URL if it is defined; otherwise an empty string is returned.
The options argument controls how to format the user name component. All values produce an unambiguous result. With QUrl::FullyDecoded, all percent-encoded sequences are decoded; otherwise, the returned value may contain some percent-encoded sequences for some control sequences not representable in decoded form in QString.
Note that QUrl::FullyDecoded may cause data loss if those non-representable sequences are present. It is recommended to use that value when the result will be used in a non-URL context, such as setting in QAuthenticator or negotiating a login.
- See also
- setPassword()
Definition at line 2282 of file qurl.cpp.
◆ path()
| QString QUrl::path | ( | ComponentFormattingOptions | options = FullyDecoded | ) | const |
Returns the path of the URL.
The options argument controls how to format the path component. All values produce an unambiguous result. With QUrl::FullyDecoded, all percent-encoded sequences are decoded; otherwise, the returned value may contain some percent-encoded sequences for some control sequences not representable in decoded form in QString.
Note that QUrl::FullyDecoded may cause data loss if those non-representable sequences are present. It is recommended to use that value when the result will be used in a non-URL context, such as sending to an FTP server.
An example of data loss is when you have non-Unicode percent-encoded sequences and use FullyDecoded (the default):
In this example, there will be some level of data loss because the FF cannot be converted.
Data loss can also occur when the path contains sub-delimiters (such as +):
Other decoding examples:
- See also
- setPath()
Definition at line 2488 of file qurl.cpp.
◆ port()
| int QUrl::port | ( | int | defaultPort = -1 | ) | const |
◆ query()
| QString QUrl::query | ( | ComponentFormattingOptions | options = PrettyDecoded | ) | const |
Returns the query string of the URL if there's a query string, or an empty result if not. To determine if the parsed URL contained a query string, use hasQuery().
The options argument controls how to format the query component. All values produce an unambiguous result. With QUrl::FullyDecoded, all percent-encoded sequences are decoded; otherwise, the returned value may contain some percent-encoded sequences for some control sequences not representable in decoded form in QString.
Note that use of QUrl::FullyDecoded in queries is discouraged, as queries often contain data that is supposed to remain percent-encoded, including the use of the "%2B" sequence to represent a plus character ('+').
- See also
- setQuery(), hasQuery()
Definition at line 2629 of file qurl.cpp.
◆ resolved()
Returns the result of the merge of this URL with relative. This URL is used as a base to convert relative to an absolute URL.
If relative is not a relative URL, this function will return relative directly. Otherwise, the paths of the two URLs are merged, and the new URL returned has the scheme and authority of the base URL, but with the merged path, as in the following example:
Calling resolved() with ".." returns a QUrl whose directory is one level higher than the original. Similarly, calling resolved() with "../.." removes two levels from the path. If relative is "/", the path becomes "/".
- See also
- isRelative()
Definition at line 2745 of file qurl.cpp.
◆ scheme()
| QString QUrl::scheme | ( | ) | const |
Returns the scheme of the URL. If an empty string is returned, this means the scheme is undefined and the URL is then relative.
The scheme can only contain US-ASCII letters or digits, which means it cannot contain any character that would otherwise require encoding. Additionally, schemes are always returned in lowercase form.
- See also
- setScheme(), isRelative()
Definition at line 2006 of file qurl.cpp.
◆ setAuthority()
| void QUrl::setAuthority | ( | const QString & | authority, |
| ParsingMode | mode = TolerantMode |
||
| ) |
Sets the authority of the URL to authority.
The authority of a URL is the combination of user info, a host name and a port. All of these elements are optional; an empty authority is therefore valid.
The user info and host are separated by a '@', and the host and port are separated by a ':'. If the user info is empty, the '@' must be omitted; although a stray ':' is permitted if the port is empty.
The following example shows a valid authority string:
The authority data is interpreted according to mode: in StrictMode, any '' characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. In TolerantMode (the default), all characters are accepted in undecoded form and the tolerant parser will correct stray '' not followed by two hex characters.
This function does not allow mode to be QUrl::DecodedMode. To set fully decoded data, call setUserName(), setPassword(), setHost() and setPort() individually.
- See also
- setUserInfo(), setHost(), setPort()
Definition at line 2042 of file qurl.cpp.
◆ setFragment()
| void QUrl::setFragment | ( | const QString & | fragment, |
| ParsingMode | mode = TolerantMode |
||
| ) |
Sets the fragment of the URL to fragment. The fragment is the last part of the URL, represented by a '#' followed by a string of characters. It is typically used in HTTP for referring to a certain link or point on a page:
The fragment is sometimes also referred to as the URL "reference".
Passing an argument of QString() (a null QString) will unset the fragment. Passing an argument of QString("") (an empty but not null QString) will set the fragment to an empty string (as if the original URL had a lone "#").
The fragment data is interpreted according to mode: in StrictMode, any '' characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. In TolerantMode, all characters are accepted in undecoded form and the tolerant parser will correct stray '' not followed by two hex characters. In DecodedMode, '' stand for themselves and encoded characters are not possible.
QUrl::DecodedMode should be used when setting the fragment from a data source which is not a URL or with a fragment obtained by calling fragment() with the QUrl::FullyDecoded formatting option.
- See also
- fragment(), hasFragment()
Definition at line 2668 of file qurl.cpp.
◆ setHost()
| void QUrl::setHost | ( | const QString & | host, |
| ParsingMode | mode = DecodedMode |
||
| ) |
Sets the host of the URL to host. The host is part of the authority.
The host data is interpreted according to mode: in StrictMode, any '' characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. In TolerantMode, all characters are accepted in undecoded form and the tolerant parser will correct stray '' not followed by two hex characters. In DecodedMode, '' stand for themselves and encoded characters are not possible.
Note that, in all cases, the result of the parsing must be a valid hostname according to STD 3 rules, as modified by the Internationalized Resource Identifiers specification (RFC 3987). Invalid hostnames are not permitted and will cause isValid() to become false.
- See also
- host(), setAuthority()
Definition at line 2309 of file qurl.cpp.
◆ setIdnWhitelist()
|
static |
- Since
- 4.2
Sets the whitelist of Top-Level Domains (TLDs) that are allowed to have non-ASCII characters in domains to the value of list.
Note that if you call this function, you need to do so before you start any threads that might access idnWhitelist().
Qt comes with a default list that contains the Internet top-level domains that have published support for Internationalized Domain Names (IDNs) and rules to guarantee that no deception can happen between similarly-looking characters (such as the Latin lowercase letter 'a' and the Cyrillic equivalent, which in most fonts are visually identical).
This list is periodically maintained, as registrars publish new rules.
This function is provided for those who need to manipulate the list, in order to add or remove a TLD. It is not recommended to change its value for purposes other than testing, as it may expose users to security risks.
Definition at line 998 of file qurlidna.cpp.
◆ setPassword()
| void QUrl::setPassword | ( | const QString & | password, |
| ParsingMode | mode = DecodedMode |
||
| ) |
Sets the URL's password to password. The password is part of the user info element in the authority of the URL, as described in setUserInfo().
The password data is interpreted according to mode: in StrictMode, any '' characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. In TolerantMode, all characters are accepted in undecoded form and the tolerant parser will correct stray '' not followed by two hex characters. In DecodedMode, '' stand for themselves and encoded characters are not possible.
QUrl::DecodedMode should be used when setting the password from a data source which is not a URL, such as a password dialog shown to the user or with a password obtained by calling password() with the QUrl::FullyDecoded formatting option.
- See also
- password(), setUserInfo()
Definition at line 2247 of file qurl.cpp.
◆ setPath()
| void QUrl::setPath | ( | const QString & | path, |
| ParsingMode | mode = DecodedMode |
||
| ) |
Sets the path of the URL to path. The path is the part of the URL that comes after the authority but before the query string.
For non-hierarchical schemes, the path will be everything following the scheme declaration, as in the following example:
The path data is interpreted according to mode: in StrictMode, any '' characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. In TolerantMode, all characters are accepted in undecoded form and the tolerant parser will correct stray '' not followed by two hex characters. In DecodedMode, '' stand for themselves and encoded characters are not possible.
QUrl::DecodedMode should be used when setting the path from a data source which is not a URL, such as a dialog shown to the user or with a path obtained by calling path() with the QUrl::FullyDecoded formatting option.
- See also
- path()
Definition at line 2434 of file qurl.cpp.
◆ setPort()
| void QUrl::setPort | ( | int | port | ) |
Sets the port of the URL to port. The port is part of the authority of the URL, as described in setAuthority().
port must be between 0 and 65535 inclusive. Setting the port to -1 indicates that the port is unspecified.
Definition at line 2378 of file qurl.cpp.
◆ setQuery() [1/2]
| void QUrl::setQuery | ( | const QString & | query, |
| ParsingMode | mode = TolerantMode |
||
| ) |
Sets the query string of the URL to query.
This function is useful if you need to pass a query string that does not fit into the key-value pattern, or that uses a different scheme for encoding special characters than what is suggested by QUrl.
Passing a value of QString() to query (a null QString) unsets the query completely. However, passing a value of QString("") will set the query to an empty value, as if the original URL had a lone "?".
The query data is interpreted according to mode: in StrictMode, any '' characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. In TolerantMode, all characters are accepted in undecoded form and the tolerant parser will correct stray '' not followed by two hex characters. In DecodedMode, '' stand for themselves and encoded characters are not possible.
Query strings often contain percent-encoded sequences, so use of DecodedMode is discouraged. One special sequence to be aware of is that of the plus character ('+'). QUrl does not convert spaces to plus characters, even though HTML forms posted by web browsers do. In order to represent an actual plus character in a query, the sequence "%2B" is usually used. This function will leave "%2B" sequences untouched in TolerantMode or StrictMode.
- See also
- query(), hasQuery()
Definition at line 2570 of file qurl.cpp.
◆ setQuery() [2/2]
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
- Since
- 5.0 Sets the query string of the URL to query.
This function reconstructs the query string from the QUrlQuery object and sets on this QUrl object. This function does not have parsing parameters because the QUrlQuery contains data that is already parsed.
- See also
- query(), hasQuery()
Definition at line 2599 of file qurl.cpp.
◆ setScheme()
Sets the scheme of the URL to scheme. As a scheme can only contain ASCII characters, no conversion or decoding is done on the input. It must also start with an ASCII letter.
The scheme describes the type (or protocol) of the URL. It's represented by one or more ASCII characters at the start the URL.
A scheme is strictly \l {RFC 3986}-compliant: \tt {scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )}
The following example shows a URL where the scheme is "ftp":
To set the scheme, the following call is used:
The scheme can also be empty, in which case the URL is interpreted as relative.
- See also
- scheme(), isRelative()
Definition at line 1982 of file qurl.cpp.
◆ setUrl()
| void QUrl::setUrl | ( | const QString & | url, |
| ParsingMode | parsingMode = TolerantMode |
||
| ) |
Parses url and sets this object to that value. QUrl will automatically percent encode all characters that are not allowed in a URL and decode the percent-encoded sequences that represent an unreserved character (letters, digits, hyphens, underscores, dots and tildes). All other characters are left in their original forms.
Parses the url using the parser mode parsingMode. In TolerantMode (the default), QUrl will correct certain mistakes, notably the presence of a percent character ('') not followed by two hexadecimal digits, and it will accept any character in any position. In StrictMode, encoding mistakes will not be tolerated and QUrl will also check that certain forbidden characters are not present in unencoded form. If an error is detected in StrictMode, isValid() will return false. The parsing mode DecodedMode is not permitted in this context and will produce a run-time warning.
- See also
- url(), toString()
Definition at line 1949 of file qurl.cpp.
◆ setUserInfo()
| void QUrl::setUserInfo | ( | const QString & | userInfo, |
| ParsingMode | mode = TolerantMode |
||
| ) |
Sets the user info of the URL to userInfo. The user info is an optional part of the authority of the URL, as described in setAuthority().
The user info consists of a user name and optionally a password, separated by a ':'. If the password is empty, the colon must be omitted. The following example shows a valid user info string:
The userInfo data is interpreted according to mode: in StrictMode, any '' characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. In TolerantMode (the default), all characters are accepted in undecoded form and the tolerant parser will correct stray '' not followed by two hex characters.
This function does not allow mode to be QUrl::DecodedMode. To set fully decoded data, call setUserName() and setPassword() individually.
- See also
- userInfo(), setUserName(), setPassword(), setAuthority()
Definition at line 2113 of file qurl.cpp.
◆ setUserName()
| void QUrl::setUserName | ( | const QString & | userName, |
| ParsingMode | mode = DecodedMode |
||
| ) |
Sets the URL's user name to userName. The userName is part of the user info element in the authority of the URL, as described in setUserInfo().
The userName data is interpreted according to mode: in StrictMode, any '' characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. In TolerantMode (the default), all characters are accepted in undecoded form and the tolerant parser will correct stray '' not followed by two hex characters. In DecodedMode, '' stand for themselves and encoded characters are not possible.
QUrl::DecodedMode should be used when setting the user name from a data source which is not a URL, such as a password dialog shown to the user or with a user name obtained by calling userName() with the QUrl::FullyDecoded formatting option.
- See also
- userName(), setUserInfo()
Definition at line 2184 of file qurl.cpp.
◆ swap()
◆ toAce()
|
static |
- Since
- 6.3
Returns the ASCII Compatible Encoding of the given domain name domain. The output can be customized by passing flags with options. The result of this function is considered equivalent to domain.
The ASCII-Compatible Encoding (ACE) is defined by RFC 3490, RFC 3491 and RFC 3492 and updated by the Unicode Technical Standard #46. It is part of the Internationalizing Domain Names in Applications (IDNA) specification, which allows for domain names (like "example.com") to be written using non-US-ASCII characters.
This function returns an empty QByteArray if domain is not a valid hostname. Note, in particular, that IPv6 literals are not valid domain names.
Definition at line 3080 of file qurl.cpp.
◆ toDisplayString()
| QString QUrl::toDisplayString | ( | FormattingOptions | options = FormattingOptions(PrettyDecoded) | ) | const |
- Since
- 5.0
Returns a human-displayable string representation of the URL. The output can be customized by passing flags with options. The option RemovePassword is always enabled, since passwords should never be shown back to users.
With the default options, the resulting QString can be passed back to a QUrl later on, but any password that was present initially will be lost.
- See also
- FormattingOptions, toEncoded(), toString()
Definition at line 2926 of file qurl.cpp.
◆ toEncoded()
| QByteArray QUrl::toEncoded | ( | FormattingOptions | options = FullyEncoded | ) | const |
Returns the encoded representation of the URL if it's valid; otherwise an empty QByteArray is returned. The output can be customized by passing flags with options.
The user info, path and fragment are all converted to UTF-8, and all non-ASCII characters are then percent encoded. The host name is encoded using Punycode.
Definition at line 2987 of file qurl.cpp.
◆ toLocalFile()
| QString QUrl::toLocalFile | ( | ) | const |
Returns the path of this URL formatted as a local file path. The path returned will use forward slashes, even if it was originally created from one with backslashes.
If this URL contains a non-empty hostname, it will be encoded in the returned value in the form found on SMB networks (for example, "//servername/path/to/file.txt").
Note: if the path component of this URL contains a non-UTF-8 binary sequence (such as %80), the behaviour of this function is undefined.
- See also
- fromLocalFile(), isLocalFile()
Definition at line 3430 of file qurl.cpp.
◆ toPercentEncoding()
|
static |
Returns an encoded copy of input. input is first converted to UTF-8, and all ASCII-characters that are not in the unreserved group are percent encoded. To prevent characters from being percent encoded pass them to exclude. To force characters to be percent encoded pass them to include.
Unreserved is defined as: \tt {ALPHA / DIGIT / "-" / "." / "_" / "~"}
Definition at line 3035 of file qurl.cpp.
◆ toString()
| QString QUrl::toString | ( | FormattingOptions | options = FormattingOptions(PrettyDecoded) | ) | const |
Returns a string representation of the URL. The output can be customized by passing flags with options. The option QUrl::FullyDecoded is not permitted in this function since it would generate ambiguous data.
The default formatting option is \l{QUrl::FormattingOptions}{PrettyDecoded}.
- See also
- FormattingOptions, url(), setUrl()
Definition at line 2851 of file qurl.cpp.
◆ toStringList()
|
static |
◆ url()
| QString QUrl::url | ( | FormattingOptions | options = FormattingOptions(PrettyDecoded) | ) | const |
Returns a string representation of the URL. The output can be customized by passing flags with options. The option QUrl::FullyDecoded is not permitted in this function since it would generate ambiguous data.
The resulting QString can be passed back to a QUrl later on.
Synonym for toString(options).
- See also
- FormattingOptions, toEncoded(), toString()
Definition at line 2837 of file qurl.cpp.
◆ userInfo()
| QString QUrl::userInfo | ( | ComponentFormattingOptions | options = PrettyDecoded | ) | const |
Returns the user info of the URL, or an empty string if the user info is undefined.
This function returns an unambiguous value, which may contain that characters still percent-encoded, plus some control sequences not representable in decoded form in QString.
The options argument controls how to format the user info component. The value of QUrl::FullyDecoded is not permitted in this function. If you need to obtain fully decoded data, call userName() and password() individually.
- See also
- setUserInfo(), userName(), password(), authority()
Definition at line 2149 of file qurl.cpp.
◆ userName()
| QString QUrl::userName | ( | ComponentFormattingOptions | options = FullyDecoded | ) | const |
Returns the user name of the URL if it is defined; otherwise an empty string is returned.
The options argument controls how to format the user name component. All values produce an unambiguous result. With QUrl::FullyDecoded, all percent-encoded sequences are decoded; otherwise, the returned value may contain some percent-encoded sequences for some control sequences not representable in decoded form in QString.
Note that QUrl::FullyDecoded may cause data loss if those non-representable sequences are present. It is recommended to use that value when the result will be used in a non-URL context, such as setting in QAuthenticator or negotiating a login.
- See also
- setUserName(), userInfo()
Definition at line 2219 of file qurl.cpp.
Friends And Related Function Documentation
◆ operator<<()
|
related |
Writes url url to the stream out and returns a reference to the stream.
- See also
- {Serializing Qt Data Types}{Format of the QDataStream operators}
Definition at line 3488 of file qurl.cpp.
◆ operator>>()
|
related |
Reads a url into url from the stream in and returns a reference to the stream.
- See also
- {Serializing Qt Data Types}{Format of the QDataStream operators}
Definition at line 3504 of file qurl.cpp.
◆ qHash
◆ QUrl()
|
related |
\macro QT_NO_URL_CAST_FROM_STRING
Disables automatic conversions from QString (or char *) to QUrl.
Compiling your code with this define is useful when you have a lot of code that uses QString for file names and you wish to convert it to use QUrl for network transparency. In any code that uses QUrl, it can help avoid missing QUrl::resolved() calls, and other misuses of QString to QUrl conversions.
For example, if you have code like
you can rewrite it as
- See also
- QT_NO_CAST_FROM_ASCII
Constructs a URL by parsing url. QUrl will automatically percent encode all characters that are not allowed in a URL and decode the percent-encoded sequences that represent an unreserved character (letters, digits, hyphens, underscores, dots and tildes). All other characters are left in their original forms.
Parses the url using the parser mode parsingMode. In TolerantMode (the default), QUrl will correct certain mistakes, notably the presence of a percent character ('') not followed by two hexadecimal digits, and it will accept any character in any position. In StrictMode, encoding mistakes will not be tolerated and QUrl will also check that certain forbidden characters are not present in unencoded form. If an error is detected in StrictMode, isValid() will return false. The parsing mode DecodedMode is not permitted in this context.
Example:
To construct a URL from an encoded string, you can also use fromEncoded():
Both functions are equivalent and, in Qt 5, both functions accept encoded data. Usually, the choice of the QUrl constructor or setUrl() versus fromEncoded() will depend on the source data: the constructor and setUrl() take a QString, whereas fromEncoded takes a QByteArray.
- See also
- setUrl(), fromEncoded(), TolerantMode
Definition at line 1858 of file qurl.cpp.
◆ QUrlQuery
The documentation for this class was generated from the following files:
- src/corelib/io/qurl.h
- src/corelib/io/qurl.cpp
- src/corelib/io/qurlidna.cpp
