QUrl Class Reference

The QUrl class provides a convenient interface for working with URLs.

  1. #include <QUrl>

Note: All functions in this class are reentrant.

Detailed Description

The QUrl class provides a convenient interface for working with URLs.

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() and setEncodedUrl() 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&uuml;hler.example.com" 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(), setEncodedQuery() 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.

Constructing a query is particularly convenient through the use of setQueryItems(), addQueryItem() and removeQueryItem(). Use 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 QStrings.

Calling isRelative() will tell whether or not the URL is relative. A relative URL can be resolved by passing it as argument to resolved(), which returns an absolute URL. isParentOf() is used for determining whether one URL is a parent of another.

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.

QUrl conforms to the URI specification from RFC 3986 (Uniform Resource Identifier: Generic Syntax), and includes scheme extensions from RFC 1738 (Uniform Resource Locators). Case folding rules in QUrl conform to RFC 3491 (Nameprep: A Stringprep Profile for Internationalized Domain Names (IDN)).

See also QUrlInfo.

Public Types

Toggle detailsenum QUrl::

FormattingOptionFormattingOption { None , RemoveScheme , RemovePassword , RemoveUserInfo RemovePassword | , RemovePort , RemoveAuthority RemoveUserInfo | RemovePort | , RemovePath , RemoveQuery , RemoveFragment , StripTrailingSlash 0x10000 ...} { None , RemoveScheme , RemovePassword , RemoveUserInfo RemovePassword | , RemovePort , RemoveAuthority RemoveUserInfo | RemovePort | , RemovePath , RemoveQuery , RemoveFragment , StripTrailingSlash 0x10000 }

The formatting options define how the URL is formatted when written out as text.

ConstantValueDescription
QUrl::None 0x0 The format of the URL is unchanged.
QUrl::RemoveScheme 0x1 The scheme is removed from the URL.
QUrl::RemovePassword 0x2 Any password in the URL is removed.
QUrl::RemoveUserInfo RemovePassword | 0x4 Any user information in the URL is removed.
QUrl::RemovePort 0x8 Any specified port is removed from the URL.
QUrl::RemoveAuthority RemoveUserInfo | RemovePort | 0x10
QUrl::RemovePath 0x20 The URL's path is removed, leaving only the scheme, host address, and port (if present).
QUrl::RemoveQuery 0x40 The query part of the URL (following a '?' character) is removed.
QUrl::RemoveFragment 0x80
QUrl::StripTrailingSlash 0x10000 The trailing slash is removed if one is present.

Note that the case folding rules in Nameprep, which QUrl conforms to, require host names to always be converted to lower case, regardless of the Qt::FormattingOptions used.

Look up this member in the source code.

Toggle detailsenum QUrl::

ParsingModeParsingMode { TolerantMode , StrictMode 1 ...} { TolerantMode , StrictMode 1 }

The parsing mode controls the way QUrl parses strings.

ConstantValueDescription
QUrl::TolerantMode 0 QUrl will try to correct some common errors in URLs. This mode is useful when processing URLs entered by users.
QUrl::StrictMode 1 Only valid URLs are accepted. This mode is useful for general URL validation.

In TolerantMode, the parser corrects the following invalid input:

  • Spaces and "%20": If an encoded URL contains a space, this will be replaced with "%20". If a decoded URL contains "%20", this will be replaced with a single space before the URL is parsed.
  • 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".
  • 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 automatically percent-encoded where they are not allowed: space / double-quote / "<" / ">" / "[" / "" / "]" / "^" / "`" / "{" / "|" / "}"

Look up this member in the source code.

    Public Functions

    Toggle details QUrl

    QUrlQUrl () ()

    Constructs an empty QUrl object.

    Look up this member in the source code.

    Toggle details QUrl

    QUrlQUrl ( const QString &url ) ( const QString &url )

    Constructs a URL by parsing url. url is assumed to be in human readable representation, with no percent encoding. QUrl will automatically percent encode all characters that are not allowed in a URL.

    Example:

    1.                     QUrl url("http://www.example.com/List of holidays.xml");
    2. // url.toEncoded() == "http://www.example.com/List%20of%20holidays.xml"

    To construct a URL from an encoded string, call fromEncoded():

    1.                     QUrl url = QUrl::fromEncoded("http://qt.nokia.com/List%20of%20holidays.xml");

    See also setUrl(), setEncodedUrl(), fromEncoded(), and TolerantMode.

    Look up this member in the source code.

    Toggle details QUrl

    QUrlQUrl ( const QUrl &other ) ( const QUrl &other )

    Constructs a copy of other.

    Look up this member in the source code.

    Toggle details QUrl

    QUrlQUrl ( const QString &url , ParsingMode parsingMode ) ( const QString &url , ParsingMode parsingMode )

    This is an overloaded function.

    Parses the url using the parser mode parsingMode.

    See also setUrl().

    Look up this member in the source code.

    Toggle details QUrl

    ~QUrl~QUrl () ()

    Destructor; called immediately before the object is deleted.

    Look up this member in the source code.

    Toggle details void QUrl

    addEncodedQueryItemaddEncodedQueryItem ( const QByteArray &key , const QByteArray &value ...) ( const QByteArray &key , const QByteArray &value )

    Inserts the pair key = value into the query string of the URL.

    Note: this function does not verify that either key or value are properly encoded. It is the caller's responsibility to ensure that the query delimiters are properly encoded, if any.

    See also addQueryItem() and setQueryDelimiters().

    Look up this member in the source code.

    Toggle details void QUrl

    addQueryItemaddQueryItem ( const QString &key , const QString &value ...) ( const QString &key , const QString &value )

    Inserts the pair key = value into the query string of the URL.

    The key/value pair is encoded before it is added to the query. The pair is converted into separate strings internally. The key and value is first encoded into UTF-8 and then delimited by the character returned by valueDelimiter(). Each key/value pair is delimited by the character returned by pairDelimiter().

    Note: This method does not encode spaces (ASCII 0x20) as plus (+) signs, like HTML forms do. If you need that kind of encoding, you must encode the value yourself and use QUrl::addEncodedQueryItem.

    See also addEncodedQueryItem().

    Look up this member in the source code.

    Toggle details QList <QByteArray > QUrl

    allEncodedQueryItemValuesallEncodedQueryItemValues ( const QByteArray &key ...) ( const QByteArray &key )const

    Returns the a list of query string values whose key is equal to key from the URL.

    Note: if the encoded key does not match the encoded version of the query, this function will not work. That is, if the encoded query of this URL is "search=Qt%20Rules", calling this function with key = "%73earch" will return an empty list.

    See also allQueryItemValues(), queryItemValue(), and encodedQueryItemValue().

    Look up this member in the source code.

    Toggle details QStringList QUrl

    allQueryItemValuesallQueryItemValues ( const QString &key ( const QString &key )const

    Returns the a list of query string values whose key is equal to key from the URL.

    Note: This method does not decode spaces plus (+) signs as spaces (ASCII 0x20), like HTML forms do. If you need that kind of decoding, you must use QUrl::allEncodedQueryItemValues and decode the data yourself.

    See also queryItemValue().

    Look up this member in the source code.

    Toggle details QString QUrl

    authorityauthority () ()const

    Returns the authority of the URL if it is defined; otherwise an empty string is returned.

    See also setAuthority().

    Look up this member in the source code.

    Toggle details void QUrl

    clearclear () ()

    Resets the content of the QUrl. After calling this function, the QUrl is equal to one that has been constructed with the default empty constructor.

    Look up this member in the source code.

    Toggle details QByteArray QUrl

    encodedFragmentencodedFragment () ()const

    Returns the fragment of the URL if it is defined; otherwise an empty string is returned. The returned value will have its non-ASCII and other control characters percent-encoded, as in toEncoded().

    See also setEncodedFragment() and toEncoded().

    Look up this member in the source code.

    Toggle details QByteArray QUrl

    encodedHostencodedHost () ()const

    Returns the host part of the URL if it is defined; otherwise an empty string is returned.

    Note: encodedHost() does not return percent-encoded hostnames. Instead, the ACE-encoded (bare ASCII in Punycode encoding) form will be returned for any non-ASCII hostname.

    This function is equivalent to calling QUrl::toAce() on the return value of host().

    See also setEncodedHost().

    Look up this member in the source code.

    Toggle details QByteArray QUrl

    encodedPasswordencodedPassword () ()const

    Returns the password of the URL if it is defined; otherwise an empty string is returned. The returned value will have its non-ASCII and other control characters percent-encoded, as in toEncoded().

    See also setEncodedPassword() and toEncoded().

    Look up this member in the source code.

    Toggle details QByteArray QUrl

    encodedPathencodedPath () ()const

    Returns the path of the URL if it is defined; otherwise an empty string is returned. The returned value will have its non-ASCII and other control characters percent-encoded, as in toEncoded().

    See also setEncodedPath() and toEncoded().

    Look up this member in the source code.

    Toggle details QByteArray QUrl

    encodedQueryencodedQuery () ()const

    Returns the query string of the URL in percent encoded form.

    See also setEncodedQuery().

    Look up this member in the source code.

    Toggle details QByteArray QUrl

    encodedQueryItemValueencodedQueryItemValue ( const QByteArray &key ...) ( const QByteArray &key )const

    Returns the first query string value whose key is equal to key from the URL.

    Note: if the encoded key does not match the encoded version of the query, this function will not work. That is, if the encoded query of this URL is "search=Qt%20Rules", calling this function with key = "%73earch" will return an empty string.

    See also queryItemValue() and allQueryItemValues().

    Look up this member in the source code.

    Toggle details QList <QPair <QByteArray , QByteArray > > QUrl

    encodedQueryItemsencodedQueryItems (...) ()const

    Returns the query string of the URL, as a map of encoded keys and values.

    See also setEncodedQueryItems(), setQueryItems(), and setEncodedQuery().

    Look up this member in the source code.

    Toggle details QByteArray QUrl

    encodedUserNameencodedUserName () ()const

    Returns the user name of the URL if it is defined; otherwise an empty string is returned. The returned value will have its non-ASCII and other control characters percent-encoded, as in toEncoded().

    See also setEncodedUserName().

    Look up this member in the source code.

    Toggle details QString QUrl

    errorStringerrorString () ()const

    Returns a text string that explains why an URL is invalid in the case being; otherwise returns an empty string.

    Look up this member in the source code.

    Toggle details QString QUrl

    fragmentfragment () ()const

    Returns the fragment of the URL.

    See also setFragment().

    Look up this member in the source code.

    Toggle details QString QUrl

    fromAcefromAce ( const QByteArray &domain ) ( const QByteArray &domain ) [static]

    Returns the Unicode form of the given domain name domain, which is encoded in the ASCII Compatible Encoding (ACE). 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. It is part of the Internationalizing Domain Names in Applications (IDNA) specification, which allows for domain names (like "example.com") to be written using international characters.

    Look up this member in the source code.

    Toggle details QUrl QUrl

    fromEncodedfromEncoded ( const QByteArray &input ) ( const QByteArray &input ) [static]

    Parses input and returns the corresponding QUrl. input is assumed to be in encoded form, containing only ASCII characters.

    The URL is parsed using TolerantMode.

    See also toEncoded() and setUrl().

    Look up this member in the source code.

    Toggle details QUrl QUrl

    fromEncodedfromEncoded ( const QByteArray &input , ParsingMode parsingMode ...) ( const QByteArray &input , ParsingMode parsingMode ) [static]

    This is an overloaded function.

    Parses the URL using parsingMode.

    See also toEncoded() and setUrl().

    Look up this member in the source code.

    Toggle details QUrl QUrl

    fromLocalFilefromLocalFile ( const QString &localFile ) ( const QString &localFile ) [static]

    Returns a QUrl representation of localFile, interpreted as a local file.

    See also toLocalFile().

    Look up this member in the source code.

    Toggle details QString QUrl

    fromPercentEncodingfromPercentEncoding ( const QByteArray &input ...) ( const QByteArray &input ) [static]

    Returns a decoded copy of input. input is first decoded from percent encoding, then converted from UTF-8 to unicode.

    Look up this member in the source code.

    Toggle details QUrl QUrl

    fromUserInputfromUserInput ( const QString &userInput ) ( const QString &userInput ) [static]

    Returns a valid URL from a user supplied userInput string if one can be deducted. In the case that is not possible, an invalid QUrl() is returned.

    Most applications that can browse the web, allow the user to input a URL 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 web related 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().

    Examples:

    • qt.nokia.com becomes http://qt.nokia.com
    • ftp.qt.nokia.com becomes ftp://ftp.qt.nokia.com
    • hostname becomes http://hostname
    • /home/user/test.html becomes file:///home/user/test.html

    Tips to avoid erroneous character conversion when dealing with

    URLs and strings:

    Look up this member in the source code.

    Toggle details bool QUrl

    hasEncodedQueryItemhasEncodedQueryItem ( const QByteArray &key ) ( const QByteArray &key )const

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

    Note: if the encoded key does not match the encoded version of the query, this function will return false. That is, if the encoded query of this URL is "search=Qt%20Rules", calling this function with key = "%73earch" will return false.

    See also hasQueryItem().

    Look up this member in the source code.

    Toggle details bool QUrl

    hasFragmenthasFragment () ()const

    Returns true if this URL contains a fragment (i.e., if # was seen on it).

    See also fragment() and setFragment().

    Look up this member in the source code.

    Toggle details bool QUrl

    hasQueryhasQuery () ()const

    Returns true if this URL contains a Query (i.e., if ? was seen on it).

    See also hasQueryItem() and encodedQuery().

    Look up this member in the source code.

    Toggle details bool QUrl

    hasQueryItemhasQueryItem ( const QString &key ) ( const QString &key )const

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

    See also hasEncodedQueryItem().

    Look up this member in the source code.

    Toggle details QString QUrl

    hosthost () ()const

    Returns the host of the URL if it is defined; otherwise an empty string is returned.

    See also setHost().

    Look up this member in the source code.

    Toggle details QStringList QUrl

    idnWhitelistidnWhitelist () () [static]

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

    Look up this member in the source code.

    Toggle details bool QUrl

    isEmptyisEmpty () ()const

    Returns true if the URL has no data; otherwise returns false.

    Look up this member in the source code.

    Toggle details bool QUrl

    isParentOfisParentOf ( const QUrl &childUrl ) ( const QUrl &childUrl )const

    Returns true if this URL is a parent of childUrl. childUrl is a child of this URL if the two URLs share the same scheme and authority, and this URL's path is a parent of the path of childUrl.

    Look up this member in the source code.

    Toggle details bool QUrl

    isRelativeisRelative () ()const

    Returns true if the URL is relative; otherwise returns false. A URL is relative if its scheme is undefined; this function is therefore equivalent to calling scheme().isEmpty().

    Look up this member in the source code.

    Toggle details bool QUrl

    isValidisValid () ()const

    Returns true if the URL is 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.

    1. bool checkUrl(const QUrl &url)  {
    2.     if (!url.isValid())  {
    3.         qDebug(QString("Invalid URL: %1").arg(url.toString()));
    4.         return false;
    5.     }
    6.  
    7.     return true;
    8. }

    Look up this member in the source code.

    Toggle details QString QUrl

    passwordpassword () ()const

    Returns the password of the URL if it is defined; otherwise an empty string is returned.

    See also setPassword().

    Look up this member in the source code.

    Toggle details QString QUrl

    pathpath () ()const

    Returns the path of the URL.

    See also setPath().

    Look up this member in the source code.

    Toggle details int QUrl

    portport () ()const

    Returns the port of the URL, or -1 if the port is unspecified.

    See also setPort().

    Look up this member in the source code.

    Toggle details int QUrl

    portport ( int defaultPort ) ( int defaultPort )const

    This is an overloaded function.

    Returns the port of the URL, or defaultPort if the port is unspecified.

    Example:

    1.                     QFtp ftp;
    2. ftp.connectToHost(url.host(), url.port(21));

    Look up this member in the source code.

    Toggle details QString QUrl

    queryItemValuequeryItemValue ( const QString &key ) ( const QString &key )const

    Returns the first query string value whose key is equal to key from the URL.

    Note: This method does not decode spaces plus (+) signs as spaces (ASCII 0x20), like HTML forms do. If you need that kind of decoding, you must use QUrl::encodedQueryItemValue and decode the data yourself.

    See also allQueryItemValues().

    Look up this member in the source code.

    Toggle details QList <QPair <QString , QString > > QUrl

    queryItemsqueryItems () ()const

    Returns the query string of the URL, as a map of keys and values.

    Note: This method does not decode spaces plus (+) signs as spaces (ASCII 0x20), like HTML forms do. If you need that kind of decoding, you must use QUrl::encodedQueryItems and decode the data yourself.

    See also setQueryItems() and setEncodedQuery().

    Look up this member in the source code.

    Toggle details char QUrl

    queryPairDelimiterqueryPairDelimiter () ()const

    Returns the character used to delimit between key-value pairs in the query string of the URL.

    Look up this member in the source code.

    Toggle details char QUrl

    queryValueDelimiterqueryValueDelimiter () ()const

    Returns the character used to delimit between keys and values in the query string of the URL.

    Look up this member in the source code.

    Toggle details void QUrl

    removeAllEncodedQueryItemsremoveAllEncodedQueryItems ( const QByteArray &key ...) ( const QByteArray &key )

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

    Note: if the encoded key does not match the encoded version of the query, this function will not work. That is, if the encoded query of this URL is "search=Qt%20Rules", calling this function with key = "%73earch" will do nothing.

    See also removeQueryItem().

    Look up this member in the source code.

    Toggle details void QUrl

    removeAllQueryItemsremoveAllQueryItems ( const QString &key ) ( const QString &key )

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

    See also removeQueryItem().

    Look up this member in the source code.

    Toggle details void QUrl

    removeEncodedQueryItemremoveEncodedQueryItem ( const QByteArray &key ( const QByteArray &key )

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

    Note: if the encoded key does not match the encoded version of the query, this function will not work. That is, if the encoded query of this URL is "search=Qt%20Rules", calling this function with key = "%73earch" will do nothing.

    See also removeQueryItem() and removeAllQueryItems().

    Look up this member in the source code.

    Toggle details void QUrl

    removeQueryItemremoveQueryItem ( const QString &key ) ( const QString &key )

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

    See also removeAllQueryItems().

    Look up this member in the source code.

    Toggle details QUrl QUrl

    resolvedresolved ( const QUrl &relative ) ( const QUrl &relative )const

    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:

    1.                     QUrl baseUrl("http://qt.nokia.com/support");
    2. QUrl relativeUrl("../products/solutions");
    3. qDebug(baseUrl.resolved(relativeUrl).toString());
    4. // prints "http://qt.nokia.com/products/solutions"

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

    Look up this member in the source code.

    Toggle details QString QUrl

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

    See also setScheme() and isRelative().

    Look up this member in the source code.

    Toggle details void QUrl

    setAuthoritysetAuthority ( const QString &authority ) ( const QString &authority )

    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:

    See also authority().

    Look up this member in the source code.

    Toggle details void QUrl

    setEncodedFragmentsetEncodedFragment ( const QByteArray &fragment ...) ( const QByteArray &fragment )

    Sets the URL's fragment to the percent-encoded 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 QByteArray() (a null QByteArray) will unset the fragment. Passing an argument of QByteArray("") (an empty but not null QByteArray) will set the fragment to an empty string (as if the original URL had a lone "#").

    See also setFragment() and encodedFragment().

    Look up this member in the source code.

    Toggle details void QUrl

    setEncodedHostsetEncodedHost ( const QByteArray &host ) ( const QByteArray &host )

    Sets the URL's host to the ACE- or percent-encoded host. The host is part of the user info element in the authority of the URL, as described in setAuthority().

    See also setHost(), encodedHost(), setAuthority(), and fromAce().

    Look up this member in the source code.

    Toggle details void QUrl

    setEncodedPasswordsetEncodedPassword ( const QByteArray &password ...) ( const QByteArray &password )

    Sets the URL's password to the percent-encoded password. The password is part of the user info element in the authority of the URL, as described in setUserInfo().

    Note: this function does not verify that password is properly encoded. It is the caller's responsibility to ensure that the any delimiters (such as colons or slashes) are properly encoded.

    See also setPassword(), encodedPassword(), and setUserInfo().

    Look up this member in the source code.

    Toggle details void QUrl

    setEncodedPathsetEncodedPath ( const QByteArray &path ) ( const QByteArray &path )

    Sets the URL's path to the percent-encoded 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:

    Note: this function does not verify that path is properly encoded. It is the caller's responsibility to ensure that the any delimiters (such as '?' and '#') are properly encoded.

    See also setPath(), encodedPath(), and setUserInfo().

    Look up this member in the source code.

    Toggle details void QUrl

    setEncodedQuerysetEncodedQuery ( const QByteArray &query ) ( const QByteArray &query )

    Sets the query string of the URL to query. The string is inserted as-is, and no further encoding is performed when calling toEncoded().

    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 QByteArray() to query (a null QByteArray) unsets the query completely. However, passing a value of QByteArray("") will set the query to an empty value, as if the original URL had a lone "?".

    See also encodedQuery() and hasQuery().

    Look up this member in the source code.

    Toggle details void QUrl

    setEncodedQueryItemssetEncodedQueryItems ( const QList <QPair <QByteArray , QByteArray > > &query ...) ( const QList <QPair <QByteArray , QByteArray > > &query )

    Sets the query string of the URL to the encoded version of query. The contents of query are converted to a string internally, each pair delimited by the character returned by pairDelimiter(), and the key and value are delimited by valueDelimiter().

    Note: this function does not verify that the key-value pairs are properly encoded. It is the caller's responsibility to ensure that the query delimiters are properly encoded, if any.

    See also setQueryDelimiters(), encodedQueryItems(), and setQueryItems().

    Look up this member in the source code.

    Toggle details void QUrl

    setEncodedUrlsetEncodedUrl ( const QByteArray &encodedUrl ) ( const QByteArray &encodedUrl )

    Constructs a URL by parsing the contents of encodedUrl.

    encodedUrl is assumed to be a URL string in percent encoded form, containing only ASCII characters.

    Use isValid() to determine if a valid URL was constructed.

    See also setUrl().

    Look up this member in the source code.

    Toggle details void QUrl

    setEncodedUrlsetEncodedUrl ( const QByteArray &encodedUrl , ParsingMode parsingMode ...) ( const QByteArray &encodedUrl , ParsingMode parsingMode )

    Constructs a URL by parsing the contents of encodedUrl using the given parsingMode.

    Look up this member in the source code.

    Toggle details void QUrl

    setEncodedUserNamesetEncodedUserName ( const QByteArray &userName ...) ( const QByteArray &userName )

    Sets the URL's user name to the percent-encoded userName. The userName is part of the user info element in the authority of the URL, as described in setUserInfo().

    Note: this function does not verify that userName is properly encoded. It is the caller's responsibility to ensure that the any delimiters (such as colons or slashes) are properly encoded.

    See also setUserName(), encodedUserName(), and setUserInfo().

    Look up this member in the source code.

    Toggle details void QUrl

    setFragmentsetFragment ( const QString &fragment ) ( const QString &fragment )

    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 "#").

    See also fragment() and hasFragment().

    Look up this member in the source code.

    Toggle details void QUrl

    setHostsetHost ( const QString &host ) ( const QString &host )

    Sets the host of the URL to host. The host is part of the authority.

    See also host() and setAuthority().

    Look up this member in the source code.

    Toggle details void QUrl

    setIdnWhitelistsetIdnWhitelist ( const QStringList &list ) ( const QStringList &list ) [static]

    Sets the whitelist of Top-Level Domains (TLDs) that are allowed to have non-ASCII characters in domains to the value of list.

    Qt has comes 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.

    See also idnWhitelist().

    Look up this member in the source code.

    Toggle details void QUrl

    setPasswordsetPassword ( const QString &password ) ( const QString &password )

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

    See also password() and setUserInfo().

    Look up this member in the source code.

    Toggle details void QUrl

    setPathsetPath ( const QString &path ) ( const QString &path )

    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:

    See also path().

    Look up this member in the source code.

    Toggle details void QUrl

    setPortsetPort ( int port ) ( 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.

    See also port().

    Look up this member in the source code.

    Toggle details void QUrl

    setQueryDelimiterssetQueryDelimiters ( charvalueDelimiter , charpairDelimiter ...) ( charvalueDelimiter , charpairDelimiter )

    Sets the characters used for delimiting between keys and values, and between key-value pairs in the URL's query string. The default value delimiter is '=' and the default pair delimiter is '&'.

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

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

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

    Calling this function does not change the delimiters of the current query string. It only affects queryItems(), setQueryItems() and addQueryItems().

    Look up this member in the source code.

    Toggle details void QUrl

    setQueryItemssetQueryItems ( const QList <QPair <QString , QString > > &query ...) ( const QList <QPair <QString , QString > > &query )

    Sets the query string of the URL to an encoded version of query. The contents of query are converted to a string internally, each pair delimited by the character returned by pairDelimiter(), and the key and value are delimited by valueDelimiter().

    Note: This method does not encode spaces (ASCII 0x20) as plus (+) signs, like HTML forms do. If you need that kind of encoding, you must encode the value yourself and use QUrl::setEncodedQueryItems.

    See also setQueryDelimiters(), queryItems(), and setEncodedQueryItems().

    Look up this member in the source code.

    Toggle details void QUrl

    setSchemesetScheme ( const QString &scheme ) ( const QString &scheme )

    Sets the scheme of the URL to scheme. As a scheme can only contain ASCII characters, no conversion or encoding is done on the input.

    The scheme describes the type (or protocol) of the URL. It's represented by one or more ASCII characters at the start the URL, and is followed by a ':'. The following example shows a URL where the scheme is "ftp":

    The scheme can also be empty, in which case the URL is interpreted as relative.

    See also scheme() and isRelative().

    Look up this member in the source code.

    Toggle details void QUrl

    setUrlsetUrl ( const QString &url ) ( const QString &url )

    Constructs a URL by parsing the contents of url.

    url is assumed to be in unicode format, with no percent encoding.

    Calling isValid() will tell whether or not a valid URL was constructed.

    See also setEncodedUrl().

    Look up this member in the source code.

    Toggle details void QUrl

    setUrlsetUrl ( const QString &url , ParsingMode parsingMode ...) ( const QString &url , ParsingMode parsingMode )

    This is an overloaded function.

    Parses url using the parsing mode parsingMode.

    See also setEncodedUrl().

    Look up this member in the source code.

    Toggle details void QUrl

    setUserInfosetUserInfo ( const QString &userInfo ) ( const QString &userInfo )

    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:

    See also userInfo(), setUserName(), setPassword(), and setAuthority().

    Look up this member in the source code.

    Toggle details void QUrl

    setUserNamesetUserName ( const QString &userName ) ( const QString &userName )

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

    See also setEncodedUserName(), userName(), and setUserInfo().

    Look up this member in the source code.

    Toggle details QByteArray QUrl

    toAcetoAce ( const QString &domain ) ( const QString &domain ) [static]

    Returns the ASCII Compatible Encoding of the given domain name domain. 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. It is part of the Internationalizing Domain Names in Applications (IDNA) specification, which allows for domain names (like "example.com") to be written using international characters.

    This function return an empty QByteArra if domain is not a valid hostname. Note, in particular, that IPv6 literals are not valid domain names.

    Look up this member in the source code.

    Toggle details QByteArray QUrl

    toEncodedtoEncoded ( FormattingOptions options=None ...) ( FormattingOptions options=None )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.

    Look up this member in the source code.

    Toggle details QString QUrl

    toLocalFiletoLocalFile () ()const

    Returns the path of this URL formatted as a local file path.

    See also fromLocalFile().

    Look up this member in the source code.

    Toggle details QByteArray QUrl

    toPercentEncodingtoPercentEncoding ( const QString &input , const QByteArray &exclude=QByteArray() , const QByteArray &include=QByteArray() ...) ( const QString &input , const QByteArray &exclude=QByteArray() , const QByteArray &include=QByteArray() ) [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: ALPHA / DIGIT / "-" / "." / "_" / "~"

    1.                     QByteArray ba = QUrl::toPercentEncoding(" {a fishy string?}", " {}", "s");
    2. qDebug(ba.constData());
    3. // prints " {a fi%73hy %73tring%3F}"

    Look up this member in the source code.

    Toggle details QString QUrl

    toStringtoString ( FormattingOptions options=None ( FormattingOptions options=None )const

    Returns the human-displayable string representation of the URL. The output can be customized by passing flags with options.

    See also FormattingOptions and toEncoded().

    Look up this member in the source code.

    Toggle details QString QUrl

    userInfouserInfo () ()const

    Returns the user info of the URL, or an empty string if the user info is undefined.

    See also setUserInfo().

    Look up this member in the source code.

    Toggle details QString QUrl

    userNameuserName () ()const

    Returns the user name of the URL if it is defined; otherwise an empty string is returned.

    See also setUserName() and encodedUserName().

    Look up this member in the source code.

    Toggle details bool QUrl

    operator!=operator!= ( const QUrl &url ) ( const QUrl &url )const

    Returns true if this URL and the given url are not equal; otherwise returns false.

    Look up this member in the source code.

    Toggle details QUrl & QUrl

    operator=operator= ( const QUrl &url ) ( const QUrl &url )

    Assigns the specified url to this object.

    Look up this member in the source code.

    Toggle details QUrl & QUrl

    operator=operator= ( const QString &url ) ( const QString &url )

    Assigns the specified url to this object.

    Look up this member in the source code.

    Toggle details bool QUrl

    operator==operator== ( const QUrl &url ) ( const QUrl &url )const

    Returns true if this URL and the given url are equal; otherwise returns false.

    Look up this member in the source code.

    Toggle details QString QUrl

    fromPunycodefromPunycode ( const QByteArray &pc ) ( const QByteArray &pc ) [static] Obsolete function

    Returns the Punycode decoded representation of pc.

    Punycode is a Unicode encoding used for internationalized domain names, as defined in RFC3492. If you want to convert a domain from its ASCII-compatible encoding to the Unicode representation, use fromAce().

    Look up this member in the source code.

    Toggle details QByteArray QUrl

    toPunycodetoPunycode ( const QString &uc ) ( const QString &uc ) [static] Obsolete function

    Returns a uc in Punycode encoding.

    Punycode is a Unicode encoding used for internationalized domain names, as defined in RFC3492. If you want to convert a domain name from Unicode to its ASCII-compatible representation, use toAce().

    Look up this member in the source code.

    Toggle details void QUrl

    addPathaddPath ( const QString &p ) ( const QString &p ) Qt3-support

    Use setPath() instead.

    Look up this member in the source code.

    Toggle details bool QUrl

    cdUpcdUp () () Qt3-support

    Use resolved("..") instead.

    For example, if you have code like

    1. QUrl url("http://example.com/Developer/");
    2. url.cdUp();

    you can rewrite it as

    1.                     QUrl url("http://example.com/Developer/");
    2. url = url.resolved("..");

    Look up this member in the source code.

    Toggle details void QUrl

    decodedecode ( QString &url ) ( QString &url ) [static] Qt3-support

    Use fromPercentEncoding() instead.

    Look up this member in the source code.

    Toggle details QString QUrl

    dirPathdirPath () ()const Qt3-support

    Use QFileInfo(path()).absolutePath() or QFileInfo(path()) instead.

    Look up this member in the source code.

    Toggle details void QUrl

    encodeencode ( QString &url ) ( QString &url ) [static] Qt3-support

    Use toPercentEncoding() instead.

    Look up this member in the source code.

    Toggle details QString QUrl

    fileNamefileName () ()const Qt3-support

    Use QFileInfo(path()).fileName() instead.

    See also setFileName().

    Look up this member in the source code.

    Toggle details bool QUrl

    hasHosthasHost () ()const Qt3-support

    Use !host().isEmpty() instead.

    Look up this member in the source code.

    Toggle details bool QUrl

    hasPasswordhasPassword () ()const Qt3-support

    Use !password().isEmpty() instead.

    Look up this member in the source code.

    Toggle details bool QUrl

    hasPathhasPath () ()const Qt3-support

    Use !path().isEmpty() instead.

    Look up this member in the source code.

    Toggle details bool QUrl

    hasPorthasPort () ()const Qt3-support

    Use port() != -1 instead.

    Look up this member in the source code.

    Toggle details bool QUrl

    hasRefhasRef () ()const Qt3-support

    Use !fragment().isEmpty() instead.

    Look up this member in the source code.

    Toggle details bool QUrl

    hasUserhasUser () ()const Qt3-support

    Use !userName().isEmpty() instead.

    Look up this member in the source code.

    Toggle details bool QUrl

    isRelativeUrlisRelativeUrl ( const QString &url ) ( const QString &url ) [static] Qt3-support

    Use isRelative() instead.

    Look up this member in the source code.

    Toggle details QString QUrl

    protocolprotocol () ()const Qt3-support

    Use scheme() instead.

    See also setProtocol().

    Look up this member in the source code.

    Toggle details QString QUrl

    queryquery () ()const Qt3-support

    Use encodedQuery() instead.

    See also setQuery().

    Look up this member in the source code.

    Toggle details QString QUrl

    refref () ()const Qt3-support

    Use fragment() instead.

    See also setRef().

    Look up this member in the source code.

    Toggle details void QUrl

    resetreset () ()[protected] Qt3-support

    Use clear() instead.

    Look up this member in the source code.

    Toggle details void QUrl

    setFileNamesetFileName ( const QString &txt ) ( const QString &txt ) Qt3-support

    Use setPath() instead.

    See also fileName().

    Look up this member in the source code.

    Toggle details void QUrl

    setProtocolsetProtocol ( const QString &s ) ( const QString &s ) Qt3-support

    Use setScheme() instead.

    See also protocol().

    Look up this member in the source code.

    Toggle details void QUrl

    setQuerysetQuery ( const QString &txt ) ( const QString &txt ) Qt3-support

    Use setEncodedQuery() instead.

    See also query().

    Look up this member in the source code.

    Toggle details void QUrl

    setRefsetRef ( const QString &txt ) ( const QString &txt ) Qt3-support

    Use setFragment() instead.

    See also ref().

    Look up this member in the source code.

    Toggle details void QUrl

    setUsersetUser ( const QString &s ) ( const QString &s ) Qt3-support

    Use setUserName() instead.

    See also user().

    Look up this member in the source code.

    Toggle details QString QUrl

    useruser () ()const Qt3-support

    Use userName() instead.

    See also setUser().

    Look up this member in the source code.

    Toggle details QUrl

    operator QStringoperator QString () ()const Qt3-support

    Use toString() instead.

    Look up this member in the source code.

    Macros

    Toggle detailsQT_NO_URL_CAST_FROM_STRINGQT_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

    1. url = filename; // probably not what you want

    you can rewrite it as

    1. url = QUrl::fromLocalFile(filename);
    2. url = baseurl.resolved(QUrl(filename));

    See also QT_NO_CAST_FROM_ASCII.

      Notes provided by the Qt Community
      Best Practice
      • 5

      Votes: 2

      Coverage: Qt library 4.7, 4.8

      Picture of tucnak tucnak

      Ant Farmer
      9 notes

      QUrl::toPercentEncoding(..)

      As far as we understood, QUrl::toPercentEncoding(..) does not working correctly – it’s not transform url.

      Bug has been sent to Qt Bug Tracker. In Qt 5 it will be fixed. But now, you should to implement your own toPercentEncoding.

      [Revisions]