TQUrl Class

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# TQUrl Class Reference
[network module]

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

`#include <ntqurl.h>`

Inherited by TQUrlOperator.

List of all member functions.

## Public Members

- TQUrl ()
- TQUrl ( const TQString & url )
- TQUrl ( const TQUrl & url )
- TQUrl ( const TQUrl & url, const TQString & relUrl, bool checkSlash = false )
- virtual ~TQUrl ()
- TQString protocol () const
- virtual void setProtocol ( const TQString & protocol )
- TQString user () const
- virtual void setUser ( const TQString & user )
- bool hasUser () const
- TQString password () const
- virtual void setPassword ( const TQString & pass )
- bool hasPassword () const
- TQString host () const
- virtual void setHost ( const TQString & host )
- bool hasHost () const
- int port () const
- virtual void setPort ( int port )
- bool hasPort () const
- TQString path ( bool correct = true ) const
- virtual void setPath ( const TQString & path )
- bool hasPath () const
- virtual void setEncodedPathAndQuery ( const TQString & pathAndQuery )
- TQString encodedPathAndQuery ()
- virtual void setQuery ( const TQString & txt )
- TQString query () const
- TQString ref () const
- virtual void setRef ( const TQString & txt )
- bool hasRef () const
- bool isValid () const
- bool isLocalFile () const
- virtual void addPath ( const TQString & pa )
- virtual void setFileName ( const TQString & name )
- TQString fileName () const
- TQString dirPath () const
- TQUrl & operator= ( const TQUrl & url )
- TQUrl & operator= ( const TQString & url )
- bool operator== ( const TQUrl & url ) const
- bool operator== ( const TQString & url ) const
- operator TQString () const
- virtual TQString toString ( bool encodedPath = false, bool forcePrependProtocol = true ) const
- virtual bool cdUp ()

## Static Public Members

- void decode ( TQString & url )
- void encode ( TQString & url )
- bool isRelativeUrl ( const TQString & url )

## Protected Members

- virtual void reset ()
- virtual bool parse ( const TQString & url )

## Detailed Description

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

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

TQUrl 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/ntqdockarea.html#lines`

Function | Returns
--- | ---
protocol() | "http"
host() | "doc.trolltech.com"
fileName() | "ntqdockarea.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.

TQUrl is normally used like this:

        TQUrl url( "http://www.trolltech.com" );
        // or
        TQUrl 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 TQUrls and TQStrings, TQUrl implements the necessary cast and assignment operators so you can do following:

        TQUrl url( "http://www.trolltech.com" );
        TQString s = url;
        // or
        TQString s( "http://www.trolltech.com" );
        TQUrl 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 TQUrlOperator.

See also TQUrlOperator, Input/Output and Networking, and Miscellaneous Classes.

## Member Function Documentation

### TQUrl::TQUrl ()

Constructs an empty URL that is invalid.

### TQUrl::TQUrl ( const TQString & url )

Constructs a URL by parsing the string url.

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

### TQUrl::TQUrl ( const TQUrl & url )

Copy constructor. Copies the data of url.

### TQUrl::TQUrl ( const TQUrl & url, const TQString & 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

        TQUrl 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,

        TQUrl 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,

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

### TQUrl::~TQUrl ()`[virtual]`

Destructor.

### void TQUrl::addPath ( const TQString & pa )`[virtual]`

Adds the path pa to the path of the URL.

See also setPath() and hasPath().

### bool TQUrl::cdUp ()`[virtual]`

Changes the directory to one directory up.

See also setPath().

### void TQUrl::decode ( TQString & url )`[static]`

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

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

See also encode().

### TQString TQUrl::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 TQUrl::encode ( TQString & url )`[static]`

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

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

See also decode().

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

### TQString TQUrl::encodedPathAndQuery ()

Returns the encoded path and query.

See also decode().

### TQString TQUrl::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 TQUrl::hasHost () const

Returns true if the URL contains a hostname; otherwise returns false.

See also setHost().

### bool TQUrl::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 TQt.

See also setPassword() and setUser().

### bool TQUrl::hasPath () const

Returns true if the URL contains a path; otherwise returns false.

See also path() and setPath().

### bool TQUrl::hasPort () const

Returns true if the URL contains a port; otherwise returns false.

See also setPort().

### bool TQUrl::hasRef () const

Returns true if the URL has a reference; otherwise returns false.

See also setRef().

### bool TQUrl::hasUser () const

Returns true if the URL contains a username; otherwise returns false.

See also setUser() and setPassword().

### TQString TQUrl::host () const

Returns the hostname of the URL.

See also setHost() and hasHost().

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

### bool TQUrl::isLocalFile () const

Returns true if the URL is a local file; otherwise returns false.

Example: qdir/qdir.cpp.

### bool TQUrl::isRelativeUrl ( const TQString & url )`[static]`

Returns true if url is relative; otherwise returns false.

### bool TQUrl::isValid () const

Returns true if the URL is valid; otherwise returns false. A URL is invalid if it cannot be parsed, for example.

### TQUrl::operator TQString () const

Composes a string version of the URL and returns it.

See also TQUrl::toString().

### TQUrl & TQUrl::operator= ( const TQUrl & url )

Assigns the data of url to this class.

### TQUrl & TQUrl::operator= ( const TQString & 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 TQUrl::operator== ( const TQUrl & url ) const

Compares this URL with url and returns true if they are equal; otherwise returns false.

### bool TQUrl::operator== ( const TQString & 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 TQUrl::parse ( const TQString & url )`[virtual protected]`

Parses the url.

### TQString TQUrl::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 TQt.

See also setPassword() and setUser().

### TQString TQUrl::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 TQUrl::port () const

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

See also setPort().

### TQString TQUrl::protocol () const

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

See also setProtocol().

### TQString TQUrl::query () const

Returns the (encoded) query of the URL.

See also setQuery() and decode().

### TQString TQUrl::ref () const

Returns the (encoded) reference of the URL.

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

### void TQUrl::reset ()`[virtual protected]`

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

### void TQUrl::setEncodedPathAndQuery ( const TQString & pathAndQuery )`[virtual]`

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

See also encode().

### void TQUrl::setFileName ( const TQString & 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 TQUrl::setHost ( const TQString & host )`[virtual]`

Sets the hostname of the URL to host.

See also host() and hasHost().

### void TQUrl::setPassword ( const TQString & 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 TQt.

See also password() and setUser().

### void TQUrl::setPath ( const TQString & path )`[virtual]`

Sets the path of the URL to path.

See also path() and hasPath().

### void TQUrl::setPort ( int port )`[virtual]`

Sets the port of the URL to port.

See also port().

### void TQUrl::setProtocol ( const TQString & protocol )`[virtual]`

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

See also protocol().

### void TQUrl::setQuery ( const TQString & txt )`[virtual]`

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

See also query() and encode().

### void TQUrl::setRef ( const TQString & txt )`[virtual]`

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

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

### void TQUrl::setUser ( const TQString & user )`[virtual]`

Sets the username of the URL to user.

See also user() and setPassword().

### TQString TQUrl::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().

### TQString TQUrl::user () const

Returns the username of the URL.

See also setUser() and setPassword().

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