KDE 4.1 API Reference KDECore
KUrl Class Reference
#include <KUrl>
Detailed Description
Represents and parses a URL.A prototypical URL looks like:
protocol://user:password\@hostname:port/path/to/file.ext#reference
KUrl handles escaping of URLs. This means that the specification of a full URL will differ from the corresponding string that would specify a local file or directory in file-operations like fopen. This is because an URL doesn't allow certain characters and escapes them. (e.g. '#'->"%23", space->"%20") (In a URL the hash-character '#' is used to specify a "reference", i.e. the position within a document).
The constructor KUrl(const QString&) expects a string properly escaped, or at least non-ambiguous. If you have the absolute path you should use KUrl::fromPath(const QString&).
KUrl kurl = KUrl::fromPath("/bar/#foo#"); QString url = kurl.url(); // -> "file:///bar/%23foo%23"
If you have the URL of a local file or directory and need the absolute path, you would use path().
KUrl url( "file:///bar/%23foo%23" ); ... if ( url.isLocalFile() ) QString path = url.path(); // -> "/bar/#foo#"
This must also be considered when you have separated directory and file strings and need to put them together. While you can simply concatenate normal path strings, you must take care if the directory-part is already an escaped URL. (This might be needed if the user specifies a relative path, and your program supplies the rest from elsewhere.)
Wrong:
QString dirUrl = "file:///bar/"; QString fileName = "#foo#"; QString invalidURL = dirUrl + fileName; // -> "file:///bar/#foo#" won't behave like you would expect.
KUrl url( "file:///bar/" ); QString fileName = "#foo#"; url.addPath( fileName ); QString validURL = url.url(); // -> "file:///bar/%23foo%23"
Also consider that some URLs contain the password, but this shouldn't be visible. Your program should use prettyUrl() every time it displays a URL, whether in the GUI or in debug output or...
KUrl url( "ftp://name:password@ftp.faraway.org/bar/%23foo%23"); QString visibleURL = url.prettyUrl(); // -> "ftp://name@ftp.faraway.org/bar/%23foo%23"
Definition at line 111 of file kurl.h.
Public Types | |
| enum | AdjustPathOption { RemoveTrailingSlash, LeaveTrailingSlash, AddTrailingSlash } |
| enum | CleanPathOption { SimplifyDirSeparators = 0x00, KeepDirSeparators = 0x01 } |
| enum | DirectoryOption { ObeyTrailingSlash = 0x02, AppendTrailingSlash = 0x04, IgnoreTrailingSlash = 0x01 } |
| enum | EncodedPathAndQueryOption { PermitEmptyPath = 0x00, AvoidEmptyPath = 0x01 } |
| enum | EqualsOption { CompareWithoutTrailingSlash = 0x01, CompareWithoutFragment = 0x02 } |
| typedef QMap< QString, QString > | MetaDataMap |
| enum | MimeDataFlags { DefaultMimeDataFlags = 0, NoTextExport = 1 } |
| enum | QueryItemsOption { CaseInsensitiveKeys = 1 } |
Public Member Functions | |
| void | addPath (const QString &txt) |
| void | addQueryItem (const QString &_item, const QString &_value) |
| void | adjustPath (AdjustPathOption trailing) |
| bool | cd (const QString &_dir) |
| void | cleanPath (const CleanPathOption &options=SimplifyDirSeparators) |
| bool | cmp (const KUrl &u, bool ignore_trailing=false) const |
| QString | directory (const DirectoryOptions &options=IgnoreTrailingSlash) const |
| QString | encodedHtmlRef () const |
| QString | encodedPathAndQuery (AdjustPathOption trailing=LeaveTrailingSlash, const EncodedPathAndQueryOptions &options=PermitEmptyPath) const |
| bool | equals (const KUrl &u, const EqualsOptions &options=0) const |
| QString | fileEncoding () const |
| QString | fileName (const DirectoryOptions &options=IgnoreTrailingSlash) const |
| bool | hasHost () const |
| bool | hasHTMLRef () const |
| bool | hasPass () const |
| bool | hasPath () const |
| bool | hasRef () const |
| bool | hasSubUrl () const |
| bool | hasUser () const |
| QString | htmlRef () const |
| bool | isLocalFile () const |
| bool | isParentOf (const KUrl &u) const |
| KUrl (const KUrl &_baseurl, const QString &_rel_url) | |
| KUrl (const QUrl &u) | |
| KUrl (const KUrl &u) | |
| KUrl (const QByteArray &urlOrPath) | |
| KUrl (const char *urlOrPath) | |
| KUrl (const QString &urlOrPath) | |
| KUrl () | |
| operator QVariant () const | |
| bool | operator!= (const QString &_u) const |
| bool | operator!= (const KUrl &_u) const |
| KUrl & | operator= (const QString &_url) |
| KUrl & | operator= (const QByteArray &_url) |
| KUrl & | operator= (const char *_url) |
| KUrl & | operator= (const KUrl &_u) |
| bool | operator== (const QString &_u) const |
| bool | operator== (const KUrl &_u) const |
| QString | pass () const |
| QString | path (AdjustPathOption trailing=LeaveTrailingSlash) const |
| QString | pathOrUrl () const |
| void | populateMimeData (QMimeData *mimeData, const MetaDataMap &metaData=MetaDataMap(), MimeDataFlags flags=DefaultMimeDataFlags) const |
| QString | prettyUrl (AdjustPathOption trailing=LeaveTrailingSlash) const |
| QString | protocol () const |
| QString | query () const |
| QString | queryItem (const QString &item) const |
| QMap< QString, QString > | queryItems (const QueryItemsOptions &options=0) const |
| QString | ref () const |
| void | setDirectory (const QString &dir) |
| void | setEncodedPathAndQuery (const QString &_txt) |
| void | setFileEncoding (const QString &encoding) |
| void | setFileName (const QString &_txt) |
| void | setHTMLRef (const QString &_ref) |
| void | setPass (const QString &pass) |
| void | setPath (const QString &path) |
| void | setProtocol (const QString &proto) |
| void | setQuery (const QString &query) |
| void | setRef (const QString &fragment) |
| void | setUser (const QString &user) |
| QString | toLocalFile (AdjustPathOption trailing=LeaveTrailingSlash) const |
| QString | toMimeDataString () const |
| KUrl | upUrl () const |
| QString | url (AdjustPathOption trailing=LeaveTrailingSlash) const |
| QString | user () const |
| ~KUrl () | |
Static Public Member Functions | |
| static QString | decode_string (const QString &str) |
| static QString | encode_string (const QString &str) |
| static QString | encode_string_no_slash (const QString &str) |
| static KUrl | fromMimeDataByteArray (const QByteArray &str) |
| static KUrl | fromPath (const QString &text) |
| static KUrl | fromPathOrUrl (const QString &text) |
| static bool | isRelativeUrl (const QString &_url) |
| static KUrl | join (const List &_list) |
| static QString | relativePath (const QString &base_dir, const QString &path, bool *isParent=0) |
| static QString | relativeUrl (const KUrl &base_url, const KUrl &url) |
| static List | split (const KUrl &_url) |
| static List | split (const QString &_url) |
Related Functions | |
| (Note that these are not member functions.) | |
| bool | urlcmp (const QString &_url1, const QString &_url2, const KUrl::EqualsOptions &options) |
| bool | urlcmp (const QString &_url1, const QString &_url2) |
Classes | |
| class | List |
| KUrl::List is a QList that contains KUrls with a few convenience methods. More... | |
Member Typedef Documentation
Member Enumeration Documentation
option to be used in fileName and directory
- Enumerator:
-
ObeyTrailingSlash This tells whether a trailing '/' should be ignored. If the flag is not set, for both
file:///hallo/torben/andfile:///hallo/torbenthe fileName is "torben" and the path is "hallo"If the flag is set, then everything behind the last '/'is considered to be the filename. So "hallo/torben" will be the path and the filename will be empty.
AppendTrailingSlash tells whether the returned result should end with '/' or not. If the flag is set, '/' is added to the end of the path
If the path is empty or just "/" then this flag has no effect.
This option should only be used in directory(), it has no effect in fileName()
IgnoreTrailingSlash Opposite of ObeyTrailingSlash (default).
| enum KUrl::EqualsOption |
| enum KUrl::MimeDataFlags |
Constructor & Destructor Documentation
| KUrl::KUrl | ( | const QString & | urlOrPath | ) |
| KUrl::KUrl | ( | const char * | urlOrPath | ) | [explicit] |
| KUrl::KUrl | ( | const QByteArray & | urlOrPath | ) | [explicit] |
Constructor taking a QByteArray urlOrPath, which is an _encoded_ representation of the URL, exactly like the usual constructor.
This is useful when the URL, in its encoded form, is strictly ascii.
- Parameters:
-
urlOrPath An encoded URL, or a path.
| KUrl::KUrl | ( | const KUrl & | u | ) |
| KUrl::KUrl | ( | const QUrl & | u | ) |
Constructor allowing relative URLs.
- Parameters:
-
_baseurl The base url. _rel_url A relative or absolute URL. If this is an absolute URL then _baseurlwill be ignored. If this is a relative URL it will be combined with_baseurl. Note that _rel_url should be encoded too, in any case. So do NOT pass a path here (use setPath or addPath instead).
Member Function Documentation
| void KUrl::addPath | ( | const QString & | txt | ) |
Adds to the current path.
Assumes that the current path is a directory. _txt is appended to the current path. The function adds '/' if needed while concatenating. This means it does not matter whether the current path has a trailing '/' or not. If there is none, it becomes appended. If _txt has a leading '/' then this one is stripped.
- Parameters:
-
txt The text to add. It is considered to be decoded.
Reimplemented from QUrl.
Add an additional query item.
To replace an existing query item, the item should first be removed with removeQueryItem()
- Parameters:
-
_item Name of item to add _value Value of item to add
Reimplemented from QUrl.
| void KUrl::adjustPath | ( | AdjustPathOption | trailing | ) |
Add or remove a trailing slash to/from the path.
If the URL has no path, then no '/' is added anyway. And on the other side: If the path is "/", then this character won't be stripped. Reason: "ftp://weis\@host" means something completely different than "ftp://weis\@host/". So adding or stripping the '/' would really alter the URL, while "ftp://host/path" and "ftp://host/path/" mean the same directory.
- Parameters:
-
trailing RemoveTrailingSlash strips any trailing '/' and AddTrailingSlash adds a trailing '/' if there is none yet
Changes the directory by descending into the given directory.
It is assumed the current URL represents a directory. If dir starts with a "/" the current URL will be "protocol://host/dir" otherwise _dir will be appended to the path. _dir can be ".." This function won't strip protocols. That means that when you are in file:///dir/dir2/my.tgz#tar:/ and you do cd("..") you will still be in file:///dir/dir2/my.tgz#tar:/
- Parameters:
-
_dir the directory to change to
- Returns:
- true if successful
| void KUrl::cleanPath | ( | const CleanPathOption & | options = SimplifyDirSeparators |
) |
Resolves "." and ".." components in path.
Some servers seem not to like the removal of extra '/' even though it is against the specification in RFC 2396.
- Parameters:
-
options use KeepDirSeparators if you don't want to remove consecutive occurrences of directory separator
The same as equals(), just with a less obvious name.
Compares this url with u.
- Parameters:
-
u the URL to compare this one with. ignore_trailing set to true to ignore trailing '/' characters.
- Returns:
- true if both urls are the same
- See also:
- operator==. This function should be used if you want to ignore trailing '/' characters.
- Deprecated:
- Use equals() instead.
Decode -style encoding and convert from local encoding to unicode.
Reverse of encode_string()
- Parameters:
-
str String to decode (can be QString()).
- Deprecated:
- use QUrl::fromPercentEncoding(encodedURL) instead, but note that it takes a QByteArray and not a QString. Which makes sense since everything is 7 bit (ascii) when being percent-encoded.
| QString KUrl::directory | ( | const DirectoryOptions & | options = IgnoreTrailingSlash |
) | const |
Returns the directory of the path.
- Parameters:
-
options a set of DirectoryOption flags
- Returns:
- The directory part of the current path. Everything between the last and the second last '/' is returned. For example
file:///hallo/torben/would return "/hallo/torben/" whilefile:///hallo/torbenwould return "hallo/". The returned string is decoded. QString() is returned when there is no path.
Convert unicoded string to local encoding and use -style encoding for all common delimiters / non-ascii characters.
- Parameters:
-
str String to encode (can be QString()).
- Returns:
- the encoded string
- Deprecated:
- use QUrl::toPercentEncoding instead, but note that it returns a QByteArray and not a QString. Which makes sense since everything is 7 bit (ascii) after being percent-encoded.
Convert unicoded string to local encoding and use -style encoding for all common delimiters / non-ascii characters as well as the slash '/'.
- Parameters:
-
str String to encode
- Deprecated:
- use QUrl::toPercentEncoding(str,"/") instead, but note that it returns a QByteArray and not a QString. Which makes sense since everything is 7 bit (ascii) after being percent-encoded.
| QString KUrl::encodedHtmlRef | ( | ) | const |
| QString KUrl::encodedPathAndQuery | ( | AdjustPathOption | trailing = LeaveTrailingSlash, |
|
| const EncodedPathAndQueryOptions & | options = PermitEmptyPath | |||
| ) | const |
| QString KUrl::fileEncoding | ( | ) | const |
Returns encoding information from url, the content of the "charset" parameter.
- Returns:
- An encoding suitable for QTextCodec::codecForName() or QString() if not encoding was specified.
| QString KUrl::fileName | ( | const DirectoryOptions & | options = IgnoreTrailingSlash |
) | const |
| KUrl KUrl::fromMimeDataByteArray | ( | const QByteArray & | str | ) | [static] |
Creates a KUrl from a string, using the standard conventions for mime data (drag-n-drop or copy-n-paste).
Internally used by KUrl::List::fromMimeData, which is probably what you want to use instead.
- Deprecated:
- Since KDE4 you can pass both urls and paths to the KUrl constructors. Use KUrl(text) instead.
| bool KUrl::hasHost | ( | ) | const |
| bool KUrl::hasHTMLRef | ( | ) | const |
| bool KUrl::hasPass | ( | ) | const |
| bool KUrl::hasPath | ( | ) | const |
| bool KUrl::hasRef | ( | ) | const |
Checks whether the URL has a reference part.
- Returns:
- true if the URL has a reference part. In a URL like http://www.kde.org/kdebase.tar#tar:/README it would return true, too.
| bool KUrl::hasSubUrl | ( | ) | const |
| bool KUrl::hasUser | ( | ) | const |
| QString KUrl::htmlRef | ( | ) | const |
Returns the HTML reference (the part of the URL after "#").
- Returns:
- The HTML-style reference.
- See also:
- split
| bool KUrl::isLocalFile | ( | ) | const |
Checks whether the given URL is parent of this URL.
For instance, ftp://host/dir/ is a parent of ftp://host/dir/subdir/subsubdir/.
- Returns:
- true if this url is a parent of
u(or the same URL asu)
| KUrl::operator QVariant | ( | ) | const |
| KUrl& KUrl::operator= | ( | const QString & | _url | ) | [inline] |
| KUrl& KUrl::operator= | ( | const QByteArray & | _url | ) | [inline] |
| KUrl& KUrl::operator= | ( | const char * | _url | ) | [inline] |
| KUrl & KUrl::operator= | ( | const KUrl & | _u | ) |
| bool KUrl::operator== | ( | const QString & | _u | ) | const |
| bool KUrl::operator== | ( | const KUrl & | _u | ) | const |
| QString KUrl::pass | ( | ) | const |
| QString KUrl::path | ( | AdjustPathOption | trailing = LeaveTrailingSlash |
) | const |
| QString KUrl::pathOrUrl | ( | ) | const |
Return the URL as a string, which will be either the URL (as prettyUrl would return) or, when the URL is a local file without query or ref, the path.
Use this method, to display URLs to the user. You can give the result of pathOrUrl back to the KUrl constructor, it accepts both paths and urls.
- Returns:
- the new KUrl
| void KUrl::populateMimeData | ( | QMimeData * | mimeData, | |
| const MetaDataMap & | metaData = MetaDataMap(), |
|||
| MimeDataFlags | flags = DefaultMimeDataFlags | |||
| ) | const |
Adds URL data into the given QMimeData.
By default, populateMimeData also exports the URL as plain text, for e.g. dropping onto a text editor. But in some cases this might not be wanted, e.g. if adding other mime data which provides better plain text data.
WARNING: do not call this method multiple times, use KUrl::List::populateMimeData instead.
- Parameters:
-
mimeData the QMimeData instance used to drag or copy this URL metaData KIO metadata shipped in the mime data, which is used for instance to set a correct HTTP referrer (some websites require it for downloading e.g. an image) flags set NoTextExport to prevent setting plain/text data into mimeDataIn such a case, setExportAsText( false ) should be called.
| QString KUrl::prettyUrl | ( | AdjustPathOption | trailing = LeaveTrailingSlash |
) | const |
Returns the URL as string in human-friendly format.
Example:
http://localhost:8080/test.cgi?test=hello world&name=fred
- Parameters:
-
trailing use to add or remove a trailing slash to/from the path. see adjustPath.
- Returns:
- A human readable URL, with no non-necessary encodings/escaped characters. Password will not be shown.
- See also:
- url()