From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qurl.html | 478 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 478 insertions(+) create mode 100644 doc/html/qurl.html (limited to 'doc/html/qurl.html') diff --git a/doc/html/qurl.html b/doc/html/qurl.html new file mode 100644 index 0000000..cb97e7a --- /dev/null +++ b/doc/html/qurl.html @@ -0,0 +1,478 @@ + + + + + +QUrl Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

QUrl Class Reference
[network module]

+ +

The QUrl class provides a URL parser and simplifies working with URLs. +More... +

#include <qurl.h> +

Inherited by QUrlOperator. +

List of all member functions. +

Public Members

+ +

Static Public Members

+ +

Protected Members

+ +

Detailed Description

+ + +

The QUrl class provides a URL parser and simplifies working with URLs. + +

+ + +

+

The QUrl class is provided for simple work with URLs. It can +parse, decode, encode, etc. +

QUrl works with the decoded path and encoded query in turn. +

Example: +

http://www.trolltech.com:80/cgi-bin/test%20me.pl?cmd=Hello%20you +

+
Function Returns +
protocol() "http" +
host() "www.trolltech.com" +
port() 80 +
path() "/cgi-bin/test me.pl" +
fileName() "test me.pl" +
query() "cmd=Hello%20you" +
+

Example: +

http://doc.trolltech.com/qdockarea.html#lines +

+
Function Returns +
protocol() "http" +
host() "doc.trolltech.com" +
fileName() "qdockarea.html" +
ref() "lines" +
+

The individual parts of a URL can be set with setProtocol(), +setHost(), setPort(), setPath(), setFileName(), setRef() and +setQuery(). A URL could contain, for example, an ftp address which +requires a user name and password; these can be set with setUser() +and setPassword(). +

Because path is always encoded internally you must not use "%00" +in the path, although this is okay (but not recommended) for the +query. +

QUrl is normally used like this: +

+    QUrl url( "http://www.trolltech.com" );
+    // or
+    QUrl url( "file:/home/myself/Mail", "Inbox" );
+
+ +

You can then access and manipulate the various parts of the URL. +

To make it easy to work with QUrls and QStrings, QUrl implements +the necessary cast and assignment operators so you can do +following: +

+    QUrl url( "http://www.trolltech.com" );
+    QString s = url;
+    // or
+    QString s( "http://www.trolltech.com" );
+    QUrl url( s );
+
+ +

Use the static functions, encode() and decode() to encode or +decode a URL in a string. (They operate on the string in-place.) +The isRelativeUrl() static function returns TRUE if the given +string is a relative URL. +

If you want to use a URL to work on a hierarchical structure (e.g. +a local or remote filesystem), you might want to use the subclass +QUrlOperator. +

See also QUrlOperator, Input/Output and Networking, and Miscellaneous Classes. + +

Member Function Documentation

+

QUrl::QUrl () +

+Constructs an empty URL that is invalid. + +

QUrl::QUrl ( const QString & url ) +

+Constructs a URL by parsing the string url. +

If you pass a string like "/home/qt", the "file" protocol is +assumed. + +

QUrl::QUrl ( const QUrl & url ) +

+Copy constructor. Copies the data of url. + +

QUrl::QUrl ( const QUrl & url, const QString & relUrl, bool checkSlash = FALSE ) +

+Constructs an URL taking url as the base (context) and +relUrl as a relative URL to url. If relUrl is not relative, +relUrl is taken as the new URL. +

For example, the path of +

+    QUrl url( "ftp://ftp.trolltech.com/qt/source", "qt-2.1.0.tar.gz" );
+
+ +will be "/qt/srource/qt-2.1.0.tar.gz". +

On the other hand, +

+    QUrl url( "ftp://ftp.trolltech.com/qt/source", "/usr/local" );
+
+ +will result in a new URL, "ftp://ftp.trolltech.com/usr/local", +because "/usr/local" isn't relative. +

Similarly, +

+    QUrl url( "ftp://ftp.trolltech.com/qt/source", "file:/usr/local" );
+
+ +will result in a new URL, with "/usr/local" as the path +and "file" as the protocol. +

Normally it is expected that the path of url points to a +directory, even if the path has no slash at the end. But if you +want the constructor to handle the last part of the path as a file +name if there is no slash at the end, and to let it be replaced by +the file name of relUrl (if it contains one), set checkSlash +to TRUE. + +

QUrl::~QUrl () [virtual] +

+Destructor. + +

void QUrl::addPath ( const QString & pa ) [virtual] +

+Adds the path pa to the path of the URL. +

See also setPath() and hasPath(). + +

bool QUrl::cdUp () [virtual] +

+Changes the directory to one directory up. +

See also setPath(). + +

void QUrl::decode ( QString & url ) [static] +

+Decodes the url in-place into UTF-8. For example +

+        QString url = "http%3A//www%20trolltech%20com"
+        QUrl::decode( url );
+        // url is now "http://www.trolltech.com"
+
+ +

See also encode(). + +

QString QUrl::dirPath () const +

+Returns the directory path of the URL. This is the part of the +path of the URL without the fileName(). See the documentation of +fileName() for a discussion of what is handled as file name and +what is handled as directory path. +

See also setPath() and hasPath(). + +

Example: network/networkprotocol/nntp.cpp. +

void QUrl::encode ( QString & url ) [static] +

+Encodes the url in-place into UTF-8. For example +

+        QString url = http://www.trolltech.com
+        QUrl::encode( url );
+        // url is now "http%3A//www%20trolltech%20com"
+
+ +

See also decode(). + +

Example: network/archivesearch/archivedialog.ui.h. +

QString QUrl::encodedPathAndQuery () +

+Returns the encoded path and query. +

See also decode(). + +

QString QUrl::fileName () const +

+Returns the file name of the URL. If the path of the URL doesn't +have a slash at the end, the part between the last slash and the +end of the path string is considered to be the file name. If the +path has a slash at the end, an empty string is returned here. +

See also setFileName(). + +

Example: network/networkprotocol/nntp.cpp. +

bool QUrl::hasHost () const +

+Returns TRUE if the URL contains a hostname; otherwise returns +FALSE. +

See also setHost(). + +

bool QUrl::hasPassword () const +

+Returns TRUE if the URL contains a password; otherwise returns +FALSE. +

Warning: Passwords passed in URLs are normally insecure; this +is due to the mechanism, not because of Qt. +

See also setPassword() and setUser(). + +

bool QUrl::hasPath () const +

+Returns TRUE if the URL contains a path; otherwise returns FALSE. +

See also path() and setPath(). + +

bool QUrl::hasPort () const +

+Returns TRUE if the URL contains a port; otherwise returns FALSE. +

See also setPort(). + +

bool QUrl::hasRef () const +

+Returns TRUE if the URL has a reference; otherwise returns FALSE. +

See also setRef(). + +

bool QUrl::hasUser () const +

+Returns TRUE if the URL contains a username; otherwise returns +FALSE. +

See also setUser() and setPassword(). + +

QString QUrl::host () const +

+Returns the hostname of the URL. +

See also setHost() and hasHost(). + +

Example: network/archivesearch/archivedialog.ui.h. +

bool QUrl::isLocalFile () const +

+Returns TRUE if the URL is a local file; otherwise returns FALSE. + +

Example: qdir/qdir.cpp. +

bool QUrl::isRelativeUrl ( const QString & url ) [static] +

+Returns TRUE if url is relative; otherwise returns FALSE. + +

bool QUrl::isValid () const +

+Returns TRUE if the URL is valid; otherwise returns FALSE. A URL +is invalid if it cannot be parsed, for example. + +

QUrl::operator QString () const +

+Composes a string version of the URL and returns it. +

See also QUrl::toString(). + +

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

+Assigns the data of url to this class. + +

QUrl & QUrl::operator= ( const QString & url ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Parses url and assigns the resulting data to this class. +

If you pass a string like "/home/qt" the "file" protocol will be +assumed. + +

bool QUrl::operator== ( const QUrl & url ) const +

+Compares this URL with url and returns TRUE if they are equal; +otherwise returns FALSE. + +

bool QUrl::operator== ( const QString & url ) const +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Compares this URL with url. url is parsed first. Returns +TRUE if url is equal to this url; otherwise returns FALSE. + +

bool QUrl::parse ( const QString & url ) [virtual protected] +

+Parses the url. + +

QString QUrl::password () const +

+Returns the password of the URL. +

Warning: Passwords passed in URLs are normally insecure; this +is due to the mechanism, not because of Qt. +

See also setPassword() and setUser(). + +

QString QUrl::path ( bool correct = TRUE ) const +

+Returns the path of the URL. If correct is TRUE, the path is +cleaned (deals with too many or too few slashes, cleans things +like "/../..", etc). Otherwise path() returns exactly the path +that was parsed or set. +

See also setPath() and hasPath(). + +

Example: qdir/qdir.cpp. +

int QUrl::port () const +

+Returns the port of the URL or -1 if no port has been set. +

See also setPort(). + +

QString QUrl::protocol () const +

+Returns the protocol of the URL. Typically, "file", "http", "ftp", +etc. +

See also setProtocol(). + +

QString QUrl::query () const +

+Returns the (encoded) query of the URL. +

See also setQuery() and decode(). + +

QString QUrl::ref () const +

+Returns the (encoded) reference of the URL. +

See also setRef(), hasRef(), and decode(). + +

void QUrl::reset () [virtual protected] +

+Resets all parts of the URL to their default values and +invalidates it. + +

void QUrl::setEncodedPathAndQuery ( const QString & pathAndQuery ) [virtual] +

+Parses pathAndQuery for a path and query and sets those values. +The whole string must be encoded. +

See also encode(). + +

void QUrl::setFileName ( const QString & name ) [virtual] +

+Sets the file name of the URL to name. If this URL contains a +fileName(), the original file name is replaced by name. +

See the documentation of fileName() for a more detailed discussion +of what is handled as file name and what is handled as a directory +path. +

See also fileName(). + +

void QUrl::setHost ( const QString & host ) [virtual] +

+Sets the hostname of the URL to host. +

See also host() and hasHost(). + +

void QUrl::setPassword ( const QString & pass ) [virtual] +

+Sets the password of the URL to pass. +

Warning: Passwords passed in URLs are normally insecure; this +is due to the mechanism, not because of Qt. +

See also password() and setUser(). + +

void QUrl::setPath ( const QString & path ) [virtual] +

+Sets the path of the URL to path. +

See also path() and hasPath(). + +

void QUrl::setPort ( int port ) [virtual] +

+Sets the port of the URL to port. +

See also port(). + +

void QUrl::setProtocol ( const QString & protocol ) [virtual] +

+Sets the protocol of the URL to protocol. Typically, "file", +"http", "ftp", etc. +

See also protocol(). + +

void QUrl::setQuery ( const QString & txt ) [virtual] +

+Sets the query of the URL to txt. txt must be encoded. +

See also query() and encode(). + +

void QUrl::setRef ( const QString & txt ) [virtual] +

+Sets the reference of the URL to txt. txt must be encoded. +

See also ref(), hasRef(), and encode(). + +

void QUrl::setUser ( const QString & user ) [virtual] +

+Sets the username of the URL to user. +

See also user() and setPassword(). + +

QString QUrl::toString ( bool encodedPath = FALSE, bool forcePrependProtocol = TRUE ) const [virtual] +

+Composes a string version of the URL and returns it. If encodedPath is TRUE the path in the returned string is encoded. If +forcePrependProtocol is TRUE and encodedPath looks like a +local filename, the "file:/" protocol is also prepended. +

See also encode() and decode(). + +

QString QUrl::user () const +

+Returns the username of the URL. +

See also setUser() and setPassword(). + + +

+This file is part of the Qt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
Qt 3.3.8
+
+ -- cgit v1.2.3