You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
514 lines
32 KiB
514 lines
32 KiB
13 years ago
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||
5 months ago
|
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/tqurloperator.cpp:88 -->
|
||
|
13 years ago
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||
|
|
<title>TQUrlOperator Class</title>
|
||
|
|
<style type="text/css"><!--
|
||
|
|
fn { margin-left: 1cm; text-indent: -1cm; }
|
||
|
|
a:link { color: #004faf; text-decoration: none }
|
||
|
|
a:visited { color: #672967; text-decoration: none }
|
||
|
|
body { background: #ffffff; color: black; }
|
||
|
|
--></style>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||
|
|
<tr bgcolor="#E5E5E5">
|
||
|
|
<td valign=center>
|
||
|
|
<a href="index.html">
|
||
|
|
<font color="#004faf">Home</font></a>
|
||
|
|
| <a href="classes.html">
|
||
|
|
<font color="#004faf">All Classes</font></a>
|
||
|
|
| <a href="mainclasses.html">
|
||
|
|
<font color="#004faf">Main Classes</font></a>
|
||
|
|
| <a href="annotated.html">
|
||
|
|
<font color="#004faf">Annotated</font></a>
|
||
|
|
| <a href="groups.html">
|
||
|
|
<font color="#004faf">Grouped Classes</font></a>
|
||
|
|
| <a href="functions.html">
|
||
|
|
<font color="#004faf">Functions</font></a>
|
||
|
|
</td>
|
||
|
|
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQUrlOperator Class Reference<br><small>[<a href="network.html">network module</a>]</small></h1>
|
||
|
|
|
||
|
|
<p>The TQUrlOperator class provides common operations on URLs.
|
||
|
|
<a href="#details">More...</a>
|
||
|
5 months ago
|
<p><tt>#include <<a href="tqurloperator-h.html">tqurloperator.h</a>></tt>
|
||
|
|
<p>Inherits <a href="tqobject.html">TQObject</a> and <a href="tqurl.html">TQUrl</a>.
|
||
|
|
<p><a href="tqurloperator-members.html">List of all member functions.</a>
|
||
|
13 years ago
|
<h2>Public Members</h2>
|
||
|
|
<ul>
|
||
|
|
<li class=fn><a href="#TQUrlOperator"><b>TQUrlOperator</b></a> ()</li>
|
||
|
|
<li class=fn><a href="#TQUrlOperator-2"><b>TQUrlOperator</b></a> ( const TQString & url )</li>
|
||
|
|
<li class=fn><a href="#TQUrlOperator-3"><b>TQUrlOperator</b></a> ( const TQUrlOperator & url )</li>
|
||
|
|
<li class=fn><a href="#TQUrlOperator-4"><b>TQUrlOperator</b></a> ( const TQUrlOperator & url, const TQString & relUrl, bool checkSlash = FALSE )</li>
|
||
|
|
<li class=fn>virtual <a href="#~TQUrlOperator"><b>~TQUrlOperator</b></a> ()</li>
|
||
|
|
<li class=fn>virtual const TQNetworkOperation * <a href="#listChildren"><b>listChildren</b></a> ()</li>
|
||
|
|
<li class=fn>virtual const TQNetworkOperation * <a href="#mkdir"><b>mkdir</b></a> ( const TQString & dirname )</li>
|
||
|
|
<li class=fn>virtual const TQNetworkOperation * <a href="#remove"><b>remove</b></a> ( const TQString & filename )</li>
|
||
|
|
<li class=fn>virtual const TQNetworkOperation * <a href="#rename"><b>rename</b></a> ( const TQString & oldname, const TQString & newname )</li>
|
||
|
|
<li class=fn>virtual const TQNetworkOperation * <a href="#get"><b>get</b></a> ( const TQString & location = TQString::null )</li>
|
||
|
|
<li class=fn>virtual const TQNetworkOperation * <a href="#put"><b>put</b></a> ( const TQByteArray & data, const TQString & location = TQString::null )</li>
|
||
|
|
<li class=fn>virtual TQPtrList<TQNetworkOperation> <a href="#copy"><b>copy</b></a> ( const TQString & from, const TQString & to, bool move = FALSE, bool toPath = TRUE )</li>
|
||
|
|
<li class=fn>virtual void <a href="#copy-2"><b>copy</b></a> ( const TQStringList & files, const TQString & dest, bool move = FALSE )</li>
|
||
|
|
<li class=fn>virtual bool <a href="#isDir"><b>isDir</b></a> ( bool * ok = 0 )</li>
|
||
|
|
<li class=fn>virtual void <a href="#setNameFilter"><b>setNameFilter</b></a> ( const TQString & nameFilter )</li>
|
||
|
|
<li class=fn>TQString <a href="#nameFilter"><b>nameFilter</b></a> () const</li>
|
||
|
|
<li class=fn>virtual TQUrlInfo <a href="#info"><b>info</b></a> ( const TQString & entry ) const</li>
|
||
|
|
<li class=fn>virtual void <a href="#stop"><b>stop</b></a> ()</li>
|
||
|
|
</ul>
|
||
|
|
<h2>Signals</h2>
|
||
|
|
<ul>
|
||
|
|
<li class=fn>void <a href="#newChildren"><b>newChildren</b></a> ( const TQValueList<TQUrlInfo> & i, TQNetworkOperation * op )</li>
|
||
|
|
<li class=fn>void <a href="#finished"><b>finished</b></a> ( TQNetworkOperation * op )</li>
|
||
|
|
<li class=fn>void <a href="#start"><b>start</b></a> ( TQNetworkOperation * op )</li>
|
||
|
|
<li class=fn>void <a href="#createdDirectory"><b>createdDirectory</b></a> ( const TQUrlInfo & i, TQNetworkOperation * op )</li>
|
||
|
|
<li class=fn>void <a href="#removed"><b>removed</b></a> ( TQNetworkOperation * op )</li>
|
||
|
|
<li class=fn>void <a href="#itemChanged"><b>itemChanged</b></a> ( TQNetworkOperation * op )</li>
|
||
|
|
<li class=fn>void <a href="#data"><b>data</b></a> ( const TQByteArray & data, TQNetworkOperation * op )</li>
|
||
|
|
<li class=fn>void <a href="#dataTransferProgress"><b>dataTransferProgress</b></a> ( int bytesDone, int bytesTotal, TQNetworkOperation * op )</li>
|
||
|
|
<li class=fn>void <a href="#startedNextCopy"><b>startedNextCopy</b></a> ( const TQPtrList<TQNetworkOperation> & lst )</li>
|
||
|
|
<li class=fn>void <a href="#connectionStateChanged"><b>connectionStateChanged</b></a> ( int state, const TQString & data )</li>
|
||
|
|
</ul>
|
||
|
|
<h2>Protected Members</h2>
|
||
|
|
<ul>
|
||
|
|
<li class=fn>virtual void <a href="#clearEntries"><b>clearEntries</b></a> ()</li>
|
||
|
|
<li class=fn>void <a href="#getNetworkProtocol"><b>getNetworkProtocol</b></a> ()</li>
|
||
|
|
<li class=fn>void <a href="#deleteNetworkProtocol"><b>deleteNetworkProtocol</b></a> ()</li>
|
||
|
|
</ul>
|
||
|
|
<h2>Related Functions</h2>
|
||
|
|
<ul>
|
||
|
12 years ago
|
<li class=fn>void <a href="#qInitNetworkProtocols"><b>tqInitNetworkProtocols</b></a> ()</li>
|
||
|
13 years ago
|
</ul>
|
||
|
|
<hr><a name="details"></a><h2>Detailed Description</h2>
|
||
|
|
|
||
|
|
|
||
|
|
<p> The TQUrlOperator class provides common operations on URLs.
|
||
|
|
|
||
|
|
<p>
|
||
|
|
|
||
|
|
|
||
|
|
<p>
|
||
|
|
<p> This class operates on hierarchical structures (such as
|
||
|
|
filesystems) using URLs. Its API facilitates all the common
|
||
|
|
operations:
|
||
|
|
<center><table cellpadding="4" cellspacing="2" border="0">
|
||
|
|
<tr bgcolor="#a2c511"> <th valign="top">Operation <th valign="top">Function
|
||
|
|
<tr bgcolor="#f0f0f0"> <td valign="top">List files <td valign="top"><a href="#listChildren">listChildren</a>()
|
||
|
|
<tr bgcolor="#d0d0d0"> <td valign="top">Make a directory <td valign="top"><a href="#mkdir">mkdir</a>()
|
||
|
|
<tr bgcolor="#f0f0f0"> <td valign="top">Remove a file <td valign="top"><a href="#remove">remove</a>()
|
||
|
|
<tr bgcolor="#d0d0d0"> <td valign="top">Rename a file <td valign="top"><a href="#rename">rename</a>()
|
||
|
|
<tr bgcolor="#f0f0f0"> <td valign="top">Get a file <td valign="top"><a href="#get">get</a>()
|
||
|
|
<tr bgcolor="#d0d0d0"> <td valign="top">Put a file <td valign="top"><a href="#put">put</a>()
|
||
|
|
<tr bgcolor="#f0f0f0"> <td valign="top">Copy a file <td valign="top"><a href="#copy">copy</a>()
|
||
|
|
</table></center>
|
||
|
|
<p> You can obtain additional information about the URL with <a href="#isDir">isDir</a>()
|
||
|
|
and <a href="#info">info</a>(). If a directory is to be traversed using
|
||
|
|
<a href="#listChildren">listChildren</a>(), a name filter can be set with <a href="#setNameFilter">setNameFilter</a>().
|
||
|
|
<p> A TQUrlOperator can be used like this, for example to download a
|
||
|
|
file (and assuming that the FTP protocol is <a href="#qInitNetworkProtocols">registered</a>):
|
||
|
|
<pre>
|
||
|
|
TQUrlOperator *op = new TQUrlOperator();
|
||
|
|
op-><a href="#copy">copy</a>( TQString("ftp://ftp.trolltech.com/qt/source/qt-2.1.0.tar.gz"),
|
||
|
|
"file:/tmp" );
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<p> If you want to be notified about success/failure, progress, etc.,
|
||
|
|
you can connect to TQUrlOperator's signals, e.g. to <a href="#start">start</a>(),
|
||
|
|
<a href="#newChildren">newChildren</a>(), <a href="#createdDirectory">createdDirectory</a>(), <a href="#removed">removed</a>(), <a href="#data">data</a>(),
|
||
|
|
<a href="#dataTransferProgress">dataTransferProgress</a>(), <a href="#startedNextCopy">startedNextCopy</a>(),
|
||
|
|
<a href="#connectionStateChanged">connectionStateChanged</a>(), <a href="#finished">finished</a>(), etc. A network operation can
|
||
|
|
be stopped with <a href="#stop">stop</a>().
|
||
|
|
<p> The class uses the functionality of registered network protocols
|
||
|
|
to perform these operations. Depending of the protocol of the URL,
|
||
|
|
it uses an appropriate network protocol class for the operations.
|
||
|
|
Each of the operation functions of TQUrlOperator creates a
|
||
|
5 months ago
|
<a href="tqnetworkoperation.html">TQNetworkOperation</a> object that describes the operation and puts it
|
||
|
13 years ago
|
into the operation queue for the network protocol used. If no
|
||
|
|
suitable protocol could be found (because no implementation of the
|
||
|
|
necessary network protocol is registered), the URL operator emits
|
||
|
|
errors. Not every protocol supports every operation, but error
|
||
|
|
handling deals with this problem.
|
||
|
|
<p> To register the available network protocols, use the
|
||
|
12 years ago
|
<a href="#qInitNetworkProtocols">tqInitNetworkProtocols</a>() function. The protocols currently
|
||
|
13 years ago
|
supported are:
|
||
|
|
<ul>
|
||
|
5 months ago
|
<li> <a href="tqftp.html">FTP</a>,
|
||
|
|
<li> <a href="tqhttp.html">HTTP</a>,
|
||
|
|
<li> <a href="tqlocalfs.html">local file system</a>.
|
||
|
13 years ago
|
</ul>
|
||
|
|
<p> For more information about the TQt Network Architecture see the
|
||
|
|
<a href="network.html">TQt Network Documentation</a>.
|
||
|
5 months ago
|
<p> <p>See also <a href="tqnetworkprotocol.html">TQNetworkProtocol</a>, <a href="tqnetworkoperation.html">TQNetworkOperation</a>, <a href="io.html">Input/Output and Networking</a>, and <a href="misc.html">Miscellaneous Classes</a>.
|
||
|
13 years ago
|
|
||
|
|
<hr><h2>Member Function Documentation</h2>
|
||
|
|
<h3 class=fn><a name="TQUrlOperator"></a>TQUrlOperator::TQUrlOperator ()
|
||
|
|
</h3>
|
||
|
|
Constructs a TQUrlOperator with an empty (i.e. invalid) URL.
|
||
|
|
|
||
|
6 months ago
|
<h3 class=fn><a name="TQUrlOperator-2"></a>TQUrlOperator::TQUrlOperator ( const <a href="tqstring.html">TQString</a> & url )
|
||
|
13 years ago
|
</h3>
|
||
|
|
Constructs a TQUrlOperator using <em>url</em> and parses this string.
|
||
|
|
<p> If you pass strings like "/home/qt" the "file" protocol is
|
||
|
|
assumed.
|
||
|
|
|
||
|
5 months ago
|
<h3 class=fn><a name="TQUrlOperator-3"></a>TQUrlOperator::TQUrlOperator ( const <a href="tqurloperator.html">TQUrlOperator</a> & url )
|
||
|
13 years ago
|
</h3>
|
||
|
|
Constructs a copy of <em>url</em>.
|
||
|
|
|
||
|
5 months ago
|
<h3 class=fn><a name="TQUrlOperator-4"></a>TQUrlOperator::TQUrlOperator ( const <a href="tqurloperator.html">TQUrlOperator</a> & url, const <a href="tqstring.html">TQString</a> & relUrl, bool checkSlash = FALSE )
|
||
|
13 years ago
|
</h3>
|
||
|
|
Constructs a TQUrlOperator. The URL on which this TQUrlOperator
|
||
|
|
operates is constructed out of the arguments <em>url</em>, <em>relUrl</em> and
|
||
|
5 months ago
|
<em>checkSlash</em>: see the corresponding <a href="tqurl.html">TQUrl</a> constructor for an
|
||
|
13 years ago
|
explanation of these arguments.
|
||
|
|
|
||
|
|
<h3 class=fn><a name="~TQUrlOperator"></a>TQUrlOperator::~TQUrlOperator ()<tt> [virtual]</tt>
|
||
|
|
</h3>
|
||
|
|
Destructor.
|
||
|
|
|
||
|
|
<h3 class=fn>void <a name="clearEntries"></a>TQUrlOperator::clearEntries ()<tt> [virtual protected]</tt>
|
||
|
|
</h3>
|
||
|
|
Clears the cache of children.
|
||
|
|
|
||
|
6 months ago
|
<h3 class=fn>void <a name="connectionStateChanged"></a>TQUrlOperator::connectionStateChanged ( int state, const <a href="tqstring.html">TQString</a> & data )<tt> [signal]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
|
||
|
|
<p> This signal is emitted whenever the URL operator's connection
|
||
|
|
state changes. <em>state</em> describes the new state, which is a
|
||
|
5 months ago
|
<a href="tqnetworkprotocol.html#ConnectionState-enum">TQNetworkProtocol::ConnectionState</a> value.
|
||
|
13 years ago
|
<p> <em>data</em> is a string that describes the change of the connection.
|
||
|
|
This can be used to display a message to the user.
|
||
|
|
|
||
|
6 months ago
|
<h3 class=fn><a href="tqptrlist.html">TQPtrList</a><TQNetworkOperation> <a name="copy"></a>TQUrlOperator::copy ( const <a href="tqstring.html">TQString</a> & from, const <a href="tqstring.html">TQString</a> & to, bool move = FALSE, bool toPath = TRUE )<tt> [virtual]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
Copies the file <em>from</em> to <em>to</em>. If <em>move</em> is TRUE, the file is
|
||
|
|
moved (copied and removed). <em>from</em> must point to a file and <em>to</em>
|
||
|
|
must point to a directory (into which <em>from</em> is copied) unless <em>toPath</em> is set to FALSE. If <em>toPath</em> is set to FALSE then the <em>to</em> variable is assumed to be the absolute file path (destination
|
||
|
|
file path + file name). The copying is done using the <a href="#get">get</a>() and
|
||
|
|
<a href="#put">put</a>() operations. If you want to be notified about the progress of
|
||
|
|
the operation, connect to the <a href="#dataTransferProgress">dataTransferProgress</a>() signal. Bear
|
||
|
|
in mind that the get() and put() operations emit this signal
|
||
|
|
through the TQUrlOperator. The number of transferred bytes and the
|
||
|
|
total bytes that you receive as arguments in this signal do not
|
||
|
|
relate to the the whole copy operation; they relate first to the
|
||
|
|
get() and then to the put() operation. Always check what type of
|
||
|
|
operation the signal comes from; this is given in the signal's
|
||
|
|
last argument.
|
||
|
|
<p> At the end, <a href="#finished">finished</a>() (with success or failure) is emitted, so
|
||
|
|
check the state of the network operation object to see whether or
|
||
|
|
not the operation was successful.
|
||
|
|
<p> Because a move or copy operation consists of multiple operations
|
||
|
|
(get(), put() and maybe <a href="#remove">remove</a>()), this function doesn't return a
|
||
|
5 months ago
|
single <a href="tqnetworkoperation.html">TQNetworkOperation</a>, but rather a list of them. They are in
|
||
|
13 years ago
|
the order: <a href="#get">get</a>(), <a href="#put">put</a>() and (if applicable) remove().
|
||
|
|
<p> <p>See also <a href="#get">get</a>() and <a href="#put">put</a>().
|
||
|
|
|
||
|
6 months ago
|
<h3 class=fn>void <a name="copy-2"></a>TQUrlOperator::copy ( const <a href="tqstringlist.html">TQStringList</a> & files, const <a href="tqstring.html">TQString</a> & dest, bool move = FALSE )<tt> [virtual]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
|
||
|
|
<p> Copies the <em>files</em> to the directory <em>dest</em>. If <em>move</em> is TRUE
|
||
|
|
the files are moved, not copied. <em>dest</em> must point to a
|
||
|
|
directory.
|
||
|
|
<p> This function calls <a href="#copy">copy</a>() for each entry in <em>files</em> in turn. You
|
||
|
|
don't get a result from this function; each time a new copy
|
||
|
|
begins, <a href="#startedNextCopy">startedNextCopy</a>() is emitted, with a list of
|
||
|
|
TQNetworkOperations that describe the new copy operation.
|
||
|
|
|
||
|
5 months ago
|
<h3 class=fn>void <a name="createdDirectory"></a>TQUrlOperator::createdDirectory ( const <a href="tqurlinfo.html">TQUrlInfo</a> & i, <a href="tqnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
|
||
|
|
<p> This signal is emitted when <a href="#mkdir">mkdir</a>() succeeds and the directory has
|
||
|
|
been created. <em>i</em> holds the information about the new directory.
|
||
|
|
<p> <em>op</em> is a pointer to the operation object, which contains all the
|
||
|
|
information about the operation, including the state.
|
||
|
|
<tt>op->arg(0)</tt> holds the new directory's name.
|
||
|
5 months ago
|
<p> <p>See also <a href="tqnetworkoperation.html">TQNetworkOperation</a> and <a href="tqnetworkprotocol.html">TQNetworkProtocol</a>.
|
||
|
13 years ago
|
|
||
|
5 months ago
|
<h3 class=fn>void <a name="data"></a>TQUrlOperator::data ( const <a href="tqbytearray.html">TQByteArray</a> & data, <a href="tqnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
|
||
|
|
<p> This signal is emitted when new <em>data</em> has been received after calling
|
||
|
|
<a href="#get">get</a>() or <a href="#put">put</a>().
|
||
|
|
<em>op</em> is a pointer to the operation object which contains all
|
||
|
|
the information about the operation, including the state.
|
||
|
|
<tt>op->arg(0)</tt> holds the name of the file whose data is retrieved
|
||
|
|
and op->rawArg(1) holds the (raw) data.
|
||
|
5 months ago
|
<p> <p>See also <a href="tqnetworkoperation.html">TQNetworkOperation</a> and <a href="tqnetworkprotocol.html">TQNetworkProtocol</a>.
|
||
|
13 years ago
|
|
||
|
5 months ago
|
<h3 class=fn>void <a name="dataTransferProgress"></a>TQUrlOperator::dataTransferProgress ( int bytesDone, int bytesTotal, <a href="tqnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
|
||
|
|
<p> This signal is emitted during data transfer (using <a href="#put">put</a>() or
|
||
|
|
<a href="#get">get</a>()). <em>bytesDone</em> specifies how many bytes of <em>bytesTotal</em> have
|
||
|
|
been transferred. More information about the operation is stored in
|
||
|
|
<em>op</em>, a pointer to the network operation that is processed.
|
||
|
|
<em>bytesTotal</em> may be -1, which means that the total number of bytes
|
||
|
|
is not known.
|
||
|
5 months ago
|
<p> <p>See also <a href="tqnetworkoperation.html">TQNetworkOperation</a> and <a href="tqnetworkprotocol.html">TQNetworkProtocol</a>.
|
||
|
13 years ago
|
|
||
|
|
<h3 class=fn>void <a name="deleteNetworkProtocol"></a>TQUrlOperator::deleteNetworkProtocol ()<tt> [protected]</tt>
|
||
|
|
</h3>
|
||
|
|
Deletes the currently used network protocol.
|
||
|
|
|
||
|
5 months ago
|
<h3 class=fn>void <a name="finished"></a>TQUrlOperator::finished ( <a href="tqnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
|
||
|
|
<p> This signal is emitted when an operation of some sort finishes,
|
||
|
|
whether with success or failure. <em>op</em> is a pointer to the
|
||
|
|
operation object, which contains all the information, including
|
||
|
|
the state, of the operation which has been finished. Check the
|
||
|
|
state and error code of the operation object to see whether or not
|
||
|
|
the operation was successful.
|
||
|
5 months ago
|
<p> <p>See also <a href="tqnetworkoperation.html">TQNetworkOperation</a> and <a href="tqnetworkprotocol.html">TQNetworkProtocol</a>.
|
||
|
13 years ago
|
|
||
|
5 months ago
|
<h3 class=fn>const <a href="tqnetworkoperation.html">TQNetworkOperation</a> * <a name="get"></a>TQUrlOperator::get ( const <a href="tqstring.html">TQString</a> & location = TQString::null )<tt> [virtual]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
Tells the network protocol to get data from <em>location</em> or, if
|
||
|
6 months ago
|
this is <a href="tqstring.html#TQString-null">TQString::null</a>, to get data from the location to which this
|
||
|
5 months ago
|
URL points (see <a href="tqurl.html#fileName">TQUrl::fileName</a>() and <a href="tqurl.html#encodedPathAndQuery">TQUrl::encodedPathAndQuery</a>()).
|
||
|
13 years ago
|
What happens then depends on the network protocol. The <a href="#data">data</a>()
|
||
|
|
signal is emitted when data comes in. Because it's unlikely that
|
||
|
|
all data will come in at once, it is common for multiple data()
|
||
|
|
signals to be emitted. The <a href="#dataTransferProgress">dataTransferProgress</a>() signal is
|
||
|
|
emitted while processing the operation. At the end, <a href="#finished">finished</a>()
|
||
|
|
(with success or failure) is emitted, so check the state of the
|
||
|
|
network operation object to see whether or not the operation was
|
||
|
|
successful.
|
||
|
|
<p> If <em>location</em> is TQString::null, the path of this TQUrlOperator
|
||
|
|
should point to a file when you use this operation. If <em>location</em>
|
||
|
|
is not empty, it can be a relative URL (a child of the path to
|
||
|
|
which the TQUrlOperator points) or an absolute URL.
|
||
|
|
<p> For example, to get a web page you might do something like this:
|
||
|
|
<p> <pre>
|
||
|
|
TQUrlOperator op( "http://www.whatever.org/cgi-bin/search.pl?cmd=Hello" );
|
||
|
|
op.<a href="#get">get</a>();
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<p> For most other operations, the path of the TQUrlOperator must point
|
||
|
|
to a directory. If you want to download a file you could do the
|
||
|
|
following:
|
||
|
|
<p> <pre>
|
||
|
|
TQUrlOperator op( "ftp://ftp.whatever.org/pub" );
|
||
|
|
// do some other stuff like op.<a href="#listChildren">listChildren</a>() or op.<a href="#mkdir">mkdir</a>( "new_dir" )
|
||
|
|
op.<a href="#get">get</a>( "a_file.txt" );
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<p> This will get the data of ftp://ftp.whatever.org/pub/a_file.txt.
|
||
|
|
<p> <em>Never</em> do anything like this:
|
||
|
|
<pre>
|
||
|
|
TQUrlOperator op( "http://www.whatever.org/cgi-bin" );
|
||
|
|
op.<a href="#get">get</a>( "search.pl?cmd=Hello" ); // WRONG!
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<p> If <em>location</em> is not empty and relative it must not contain any
|
||
|
|
queries or references, just the name of a child. So if you need to
|
||
|
|
specify a query or reference, do it as shown in the first example
|
||
|
|
or specify the full URL (such as
|
||
|
|
http://www.whatever.org/cgi-bin/search.pl?cmd=Hello) as <em>location</em>.
|
||
|
|
<p> <p>See also <a href="#copy">copy</a>().
|
||
|
|
|
||
|
|
<h3 class=fn>void <a name="getNetworkProtocol"></a>TQUrlOperator::getNetworkProtocol ()<tt> [protected]</tt>
|
||
|
|
</h3>
|
||
|
|
Finds a network protocol for the URL and deletes the old network protocol.
|
||
|
|
|
||
|
5 months ago
|
<h3 class=fn><a href="tqurlinfo.html">TQUrlInfo</a> <a name="info"></a>TQUrlOperator::info ( const <a href="tqstring.html">TQString</a> & entry ) const<tt> [virtual]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
Returns the URL information for the child <em>entry</em>, or returns an
|
||
|
5 months ago
|
empty <a href="tqurlinfo.html">TQUrlInfo</a> object if there is no information available about
|
||
|
13 years ago
|
<em>entry</em>. Information about <em>entry</em> is only available after a successfully
|
||
|
|
finished <a href="#listChildren">listChildren</a>() operation.
|
||
|
|
|
||
|
|
<h3 class=fn>bool <a name="isDir"></a>TQUrlOperator::isDir ( bool * ok = 0 )<tt> [virtual]</tt>
|
||
|
|
</h3>
|
||
|
|
Returns TRUE if the URL is a directory; otherwise returns FALSE.
|
||
|
|
This may not always work correctly, if the protocol of the URL is
|
||
|
|
something other than file (local filesystem). If you pass a bool
|
||
|
|
pointer as the <em>ok</em> argument, <em>*ok</em> is set to TRUE if the result
|
||
|
|
of this function is known to be correct, and to FALSE otherwise.
|
||
|
|
|
||
|
5 months ago
|
<h3 class=fn>void <a name="itemChanged"></a>TQUrlOperator::itemChanged ( <a href="tqnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
|
||
|
|
<p> This signal is emitted whenever a file which is a child of the URL
|
||
|
|
has been changed, for example by successfully calling <a href="#rename">rename</a>().
|
||
|
|
<em>op</em> is a pointer to the operation object which contains all the
|
||
|
|
information about the operation, including the state.
|
||
|
|
<tt>op->arg(0)</tt> holds the original file name and <tt>op->arg(1)</tt> holds
|
||
|
|
the new file name (if it was changed).
|
||
|
5 months ago
|
<p> <p>See also <a href="tqnetworkoperation.html">TQNetworkOperation</a> and <a href="tqnetworkprotocol.html">TQNetworkProtocol</a>.
|
||
|
13 years ago
|
|
||
|
5 months ago
|
<h3 class=fn>const <a href="tqnetworkoperation.html">TQNetworkOperation</a> * <a name="listChildren"></a>TQUrlOperator::listChildren ()<tt> [virtual]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
Starts listing the children of this URL (e.g. the files in the
|
||
|
|
directory). The <a href="#start">start</a>() signal is emitted before the first entry
|
||
|
|
is listed and <a href="#finished">finished</a>() is emitted after the last one. The
|
||
|
|
<a href="#newChildren">newChildren</a>() signal is emitted for each list of new entries. If
|
||
|
|
an error occurs, the signal finished() is emitted, so be sure to
|
||
|
|
check the state of the network operation pointer.
|
||
|
|
<p> Because the operation may not be executed immediately, a pointer
|
||
|
5 months ago
|
to the <a href="tqnetworkoperation.html">TQNetworkOperation</a> object created by this function is
|
||
|
13 years ago
|
returned. This object contains all the data about the operation
|
||
|
|
and is used to refer to this operation later (e.g. in the signals
|
||
|
|
that are emitted by the TQUrlOperator). The return value can also
|
||
|
|
be 0 if the operation object couldn't be created.
|
||
|
|
<p> The path of this TQUrlOperator must to point to a directory
|
||
|
|
(because the children of this directory will be listed), not to a
|
||
|
|
file.
|
||
|
|
|
||
|
5 months ago
|
<h3 class=fn>const <a href="tqnetworkoperation.html">TQNetworkOperation</a> * <a name="mkdir"></a>TQUrlOperator::mkdir ( const <a href="tqstring.html">TQString</a> & dirname )<tt> [virtual]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
Tries to create a directory (child) with the name <em>dirname</em>. If
|
||
|
|
it is successful, a <a href="#newChildren">newChildren</a>() signal with the new child is
|
||
|
|
emitted, and the <a href="#createdDirectory">createdDirectory</a>() signal with the information
|
||
|
|
about the new child is also emitted. The <a href="#finished">finished</a>() signal (with
|
||
|
|
success or failure) is emitted after the operation has been
|
||
|
|
processed, so check the state of the network operation object to
|
||
|
|
see whether or not the operation was successful.
|
||
|
|
<p> Because the operation will not be executed immediately, a pointer
|
||
|
5 months ago
|
to the <a href="tqnetworkoperation.html">TQNetworkOperation</a> object created by this function is
|
||
|
13 years ago
|
returned. This object contains all the data about the operation
|
||
|
|
and is used to refer to this operation later (e.g. in the signals
|
||
|
|
that are emitted by the TQUrlOperator). The return value can also
|
||
|
|
be 0 if the operation object couldn't be created.
|
||
|
|
<p> The path of this TQUrlOperator must to point to a directory (not a
|
||
|
|
file) because the new directory will be created in this path.
|
||
|
|
|
||
|
6 months ago
|
<h3 class=fn><a href="tqstring.html">TQString</a> <a name="nameFilter"></a>TQUrlOperator::nameFilter () const
|
||
|
13 years ago
|
</h3>
|
||
|
|
Returns the name filter of the URL.
|
||
|
5 months ago
|
<p> <p>See also <a href="#setNameFilter">TQUrlOperator::setNameFilter</a>() and <a href="tqdir.html#nameFilter">TQDir::nameFilter</a>().
|
||
|
13 years ago
|
|
||
|
5 months ago
|
<h3 class=fn>void <a name="newChildren"></a>TQUrlOperator::newChildren ( const <a href="tqvaluelist.html">TQValueList</a><TQUrlInfo> & i, <a href="tqnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
|
||
|
|
<p> This signal is emitted after <a href="#listChildren">listChildren</a>() was called and new
|
||
|
|
children (i.e. files) have been read from a list of files. <em>i</em>
|
||
|
|
holds the information about the new files. <em>op</em> is a pointer
|
||
|
|
to the operation object which contains all the information about
|
||
|
|
the operation, including the state.
|
||
|
5 months ago
|
<p> <p>See also <a href="tqnetworkoperation.html">TQNetworkOperation</a> and <a href="tqnetworkprotocol.html">TQNetworkProtocol</a>.
|
||
|
13 years ago
|
|
||
|
5 months ago
|
<h3 class=fn>const <a href="tqnetworkoperation.html">TQNetworkOperation</a> * <a name="put"></a>TQUrlOperator::put ( const <a href="tqbytearray.html">TQByteArray</a> & data, const <a href="tqstring.html">TQString</a> & location = TQString::null )<tt> [virtual]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
This function tells the network protocol to put <em>data</em> in <em>location</em>. If <em>location</em> is empty (TQString::null), it puts the <em>data</em> in the location to which the URL points. What happens depends
|
||
|
|
on the network protocol. Depending on the network protocol, some
|
||
|
|
data might come back after putting data, in which case the <a href="#data">data</a>()
|
||
|
|
signal is emitted. The <a href="#dataTransferProgress">dataTransferProgress</a>() signal is emitted
|
||
|
|
during processing of the operation. At the end, <a href="#finished">finished</a>() (with
|
||
|
|
success or failure) is emitted, so check the state of the network
|
||
|
|
operation object to see whether or not the operation was
|
||
|
|
successful.
|
||
|
6 months ago
|
<p> If <em>location</em> is <a href="tqstring.html#TQString-null">TQString::null</a>, the path of this TQUrlOperator
|
||
|
13 years ago
|
should point to a file when you use this operation. If <em>location</em>
|
||
|
|
is not empty, it can be a relative (a child of the path to which
|
||
|
|
the TQUrlOperator points) or an absolute URL.
|
||
|
|
<p> For putting some data to a file you can do the following:
|
||
|
|
<p> <pre>
|
||
|
|
TQUrlOperator op( "ftp://ftp.whatever.com/home/me/filename.dat" );
|
||
|
|
op.<a href="#put">put</a>( data );
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<p> For most other operations, the path of the TQUrlOperator must point
|
||
|
|
to a directory. If you want to upload data to a file you could do
|
||
|
|
the following:
|
||
|
|
<p> <pre>
|
||
|
|
TQUrlOperator op( "ftp://ftp.whatever.com/home/me" );
|
||
|
|
// do some other stuff like op.<a href="#listChildren">listChildren</a>() or op.<a href="#mkdir">mkdir</a>( "new_dir" )
|
||
|
|
op.<a href="#put">put</a>( data, "filename.dat" );
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<p> This will upload the data to ftp://ftp.whatever.com/home/me/filename.dat.
|
||
|
|
<p> <p>See also <a href="#copy">copy</a>().
|
||
|
|
|
||
|
5 months ago
|
<h3 class=fn>const <a href="tqnetworkoperation.html">TQNetworkOperation</a> * <a name="remove"></a>TQUrlOperator::remove ( const <a href="tqstring.html">TQString</a> & filename )<tt> [virtual]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
Tries to remove the file (child) <em>filename</em>. If it succeeds the
|
||
|
|
<a href="#removed">removed</a>() signal is emitted. <a href="#finished">finished</a>() (with success or failure)
|
||
|
|
is also emitted after the operation has been processed, so check
|
||
|
|
the state of the network operation object to see whether or not
|
||
|
|
the operation was successful.
|
||
|
|
<p> Because the operation will not be executed immediately, a pointer
|
||
|
5 months ago
|
to the <a href="tqnetworkoperation.html">TQNetworkOperation</a> object created by this function is
|
||
|
13 years ago
|
returned. This object contains all the data about the operation
|
||
|
|
and is used to refer to this operation later (e.g. in the signals
|
||
|
|
that are emitted by the TQUrlOperator). The return value can also
|
||
|
|
be 0 if the operation object couldn't be created.
|
||
|
|
<p> The path of this TQUrlOperator must point to a directory; because
|
||
|
|
if <em>filename</em> is relative, it will try to remove it in this
|
||
|
|
directory.
|
||
|
|
|
||
|
5 months ago
|
<h3 class=fn>void <a name="removed"></a>TQUrlOperator::removed ( <a href="tqnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
|
||
|
|
<p> This signal is emitted when <a href="#remove">remove</a>() has been succesful and the
|
||
|
|
file has been removed.
|
||
|
|
<p> <em>op</em> is a pointer to the operation object which contains all the
|
||
|
|
information about the operation, including the state.
|
||
|
|
<tt>op->arg(0)</tt> holds the name of the file that was removed.
|
||
|
5 months ago
|
<p> <p>See also <a href="tqnetworkoperation.html">TQNetworkOperation</a> and <a href="tqnetworkprotocol.html">TQNetworkProtocol</a>.
|
||
|
13 years ago
|
|
||
|
5 months ago
|
<h3 class=fn>const <a href="tqnetworkoperation.html">TQNetworkOperation</a> * <a name="rename"></a>TQUrlOperator::rename ( const <a href="tqstring.html">TQString</a> & oldname, const <a href="tqstring.html">TQString</a> & newname )<tt> [virtual]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
Tries to rename the file (child) called <em>oldname</em> to <em>newname</em>.
|
||
|
|
If it succeeds, the <a href="#itemChanged">itemChanged</a>() signal is emitted. <a href="#finished">finished</a>()
|
||
|
|
(with success or failure) is also emitted after the operation has
|
||
|
|
been processed, so check the state of the network operation object
|
||
|
|
to see whether or not the operation was successful.
|
||
|
|
<p> Because the operation may not be executed immediately, a pointer
|
||
|
5 months ago
|
to the <a href="tqnetworkoperation.html">TQNetworkOperation</a> object created by this function is
|
||
|
13 years ago
|
returned. This object contains all the data about the operation
|
||
|
|
and is used to refer to this operation later (e.g. in the signals
|
||
|
|
that are emitted by the TQUrlOperator). The return value can also
|
||
|
|
be 0 if the operation object couldn't be created.
|
||
|
|
<p> This path of this TQUrlOperator must to point to a directory
|
||
|
|
because <em>oldname</em> and <em>newname</em> are handled relative to this
|
||
|
|
directory.
|
||
|
|
|
||
|
6 months ago
|
<h3 class=fn>void <a name="setNameFilter"></a>TQUrlOperator::setNameFilter ( const <a href="tqstring.html">TQString</a> & nameFilter )<tt> [virtual]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
Sets the name filter of the URL to <em>nameFilter</em>.
|
||
|
5 months ago
|
<p> <p>See also <a href="tqdir.html#setNameFilter">TQDir::setNameFilter</a>().
|
||
|
13 years ago
|
|
||
|
5 months ago
|
<h3 class=fn>void <a name="start"></a>TQUrlOperator::start ( <a href="tqnetworkoperation.html">TQNetworkOperation</a> * op )<tt> [signal]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
|
||
|
|
<p> Some operations (such as <a href="#listChildren">listChildren</a>()) emit this signal when
|
||
|
|
they start processing the operation. <em>op</em> is a pointer to the
|
||
|
|
operation object which contains all the information about the
|
||
|
|
operation, including the state.
|
||
|
5 months ago
|
<p> <p>See also <a href="tqnetworkoperation.html">TQNetworkOperation</a> and <a href="tqnetworkprotocol.html">TQNetworkProtocol</a>.
|
||
|
13 years ago
|
|
||
|
6 months ago
|
<h3 class=fn>void <a name="startedNextCopy"></a>TQUrlOperator::startedNextCopy ( const <a href="tqptrlist.html">TQPtrList</a><TQNetworkOperation> & lst )<tt> [signal]</tt>
|
||
|
13 years ago
|
</h3>
|
||
|
|
|
||
|
|
<p> This signal is emitted if <a href="#copy">copy</a>() starts a new copy operation. <em>lst</em> contains all TQNetworkOperations related to this copy
|
||
|
|
operation.
|
||
|
|
<p> <p>See also <a href="#copy">copy</a>().
|
||
|
|
|
||
|
|
<h3 class=fn>void <a name="stop"></a>TQUrlOperator::stop ()<tt> [virtual]</tt>
|
||
|
|
</h3>
|
||
|
|
Stops the current network operation and removes all this
|
||
|
|
TQUrlOperator's waiting network operations.
|
||
|
|
|
||
|
|
<hr><h2>Related Functions</h2>
|
||
|
12 years ago
|
<h3 class=fn>void <a name="qInitNetworkProtocols"></a>tqInitNetworkProtocols ()
|
||
|
13 years ago
|
</h3>
|
||
|
|
|
||
|
|
<p> This function registers the network protocols for FTP and HTTP.
|
||
|
|
You must call this function before you use TQUrlOperator for
|
||
|
|
these protocols.
|
||
|
5 months ago
|
<p> This function is declared in <a href="tqnetwork-h.html">tqnetwork.h</a>.
|
||
|
13 years ago
|
|
||
|
|
<!-- eof -->
|
||
|
|
<hr><p>
|
||
|
|
This file is part of the <a href="index.html">TQt toolkit</a>.
|
||
|
|
Copyright © 1995-2007
|
||
|
|
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
|
||
|
|
<table width=100% cellspacing=0 border=0><tr>
|
||
|
|
<td>Copyright © 2007
|
||
|
|
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
|
||
|
|
<td align=right><div align=right>TQt 3.3.8</div>
|
||
|
|
</table></div></address></body>
|
||
|
|
</html>
|