--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Helpviewer.Network.FtpReply.html Mon May 24 18:38:54 2010 +0200 @@ -0,0 +1,224 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>eric5.Helpviewer.Network.FtpReply</title> +<style> +body { + background:white; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #4FA4FF; } +h2 { color: white; background: #4FA4FF; } +h3 { color: white; background: #00557F; } +h4 { color: white; background: #00557F; } + +a { color: #AA5500; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.Helpviewer.Network.FtpReply</h1> +<p> +Module implementing a network reply class for FTP resources. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>ftpListPage_html</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#FtpReply">FtpReply</a></td> +<td>Class implementing a network reply for FTP resources.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="FtpReply" ID="FtpReply"></a> +<h2>FtpReply</h2> +<p> + Class implementing a network reply for FTP resources. +</p> +<h3>Derived from</h3> +QNetworkReply +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#FtpReply.__init__">FtpReply</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#FtpReply.__commandStarted">__commandStarted</a></td> +<td>Private slot to handle the start of FTP commands.</td> +</tr><tr> +<td><a href="#FtpReply.__connectToHost">__connectToHost</a></td> +<td>Private slot to start the FTP process by connecting to the host.</td> +</tr><tr> +<td><a href="#FtpReply.__cssLinkClass">__cssLinkClass</a></td> +<td>Private method to generate a link class with an icon.</td> +</tr><tr> +<td><a href="#FtpReply.__processCommand">__processCommand</a></td> +<td>Private slot to handle the end of FTP commands.</td> +</tr><tr> +<td><a href="#FtpReply.__processData">__processData</a></td> +<td>Private slot to process data from the FTP server.</td> +</tr><tr> +<td><a href="#FtpReply.__processListInfo">__processListInfo</a></td> +<td>Private slot to process list information from the FTP server.</td> +</tr><tr> +<td><a href="#FtpReply.__setContent">__setContent</a></td> +<td>Private method to set the finish the setup of the data.</td> +</tr><tr> +<td><a href="#FtpReply.__setListContent">__setListContent</a></td> +<td>Private method to prepare the content for the reader.</td> +</tr><tr> +<td><a href="#FtpReply.abort">abort</a></td> +<td>Public slot to abort the operation.</td> +</tr><tr> +<td><a href="#FtpReply.bytesAvailable">bytesAvailable</a></td> +<td>Public method to determined the bytes available for being read.</td> +</tr><tr> +<td><a href="#FtpReply.isSequential">isSequential</a></td> +<td>Public method to check for sequential access.</td> +</tr><tr> +<td><a href="#FtpReply.readData">readData</a></td> +<td>Protected method to retrieve data from the reply object.</td> +</tr> +</table> +<a NAME="FtpReply.__init__" ID="FtpReply.__init__"></a> +<h4>FtpReply (Constructor)</h4> +<b>FtpReply</b>(<i>url, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>url</i></dt> +<dd> +requested FTP URL (QUrl) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent object (QObject) +</dd> +</dl><a NAME="FtpReply.__commandStarted" ID="FtpReply.__commandStarted"></a> +<h4>FtpReply.__commandStarted</h4> +<b>__commandStarted</b>(<i>id</i>) +<p> + Private slot to handle the start of FTP commands. +</p><dl> +<dt><i>id</i></dt> +<dd> +id of the command to be processed (integer) (ignored) +</dd> +</dl><a NAME="FtpReply.__connectToHost" ID="FtpReply.__connectToHost"></a> +<h4>FtpReply.__connectToHost</h4> +<b>__connectToHost</b>(<i></i>) +<p> + Private slot to start the FTP process by connecting to the host. +</p><a NAME="FtpReply.__cssLinkClass" ID="FtpReply.__cssLinkClass"></a> +<h4>FtpReply.__cssLinkClass</h4> +<b>__cssLinkClass</b>(<i>icon, size = 32</i>) +<p> + Private method to generate a link class with an icon. +</p><dl> +<dt><i>icon</i></dt> +<dd> +icon to be included (QIcon) +</dd><dt><i>size</i></dt> +<dd> +size of the icon to be generated (integer) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +CSS class string (string) +</dd> +</dl><a NAME="FtpReply.__processCommand" ID="FtpReply.__processCommand"></a> +<h4>FtpReply.__processCommand</h4> +<b>__processCommand</b>(<i>id, error</i>) +<p> + Private slot to handle the end of FTP commands. +</p><dl> +<dt><i>id</i></dt> +<dd> +id of the command to be processed (integer) (ignored) +</dd><dt><i>error</i></dt> +<dd> +flag indicating an error condition (boolean) +</dd> +</dl><a NAME="FtpReply.__processData" ID="FtpReply.__processData"></a> +<h4>FtpReply.__processData</h4> +<b>__processData</b>(<i></i>) +<p> + Private slot to process data from the FTP server. +</p><a NAME="FtpReply.__processListInfo" ID="FtpReply.__processListInfo"></a> +<h4>FtpReply.__processListInfo</h4> +<b>__processListInfo</b>(<i>urlInfo</i>) +<p> + Private slot to process list information from the FTP server. +</p><dl> +<dt><i>urlInfo</i></dt> +<dd> +reference to the information object (QUrlInfo) +</dd> +</dl><a NAME="FtpReply.__setContent" ID="FtpReply.__setContent"></a> +<h4>FtpReply.__setContent</h4> +<b>__setContent</b>(<i></i>) +<p> + Private method to set the finish the setup of the data. +</p><a NAME="FtpReply.__setListContent" ID="FtpReply.__setListContent"></a> +<h4>FtpReply.__setListContent</h4> +<b>__setListContent</b>(<i></i>) +<p> + Private method to prepare the content for the reader. +</p><a NAME="FtpReply.abort" ID="FtpReply.abort"></a> +<h4>FtpReply.abort</h4> +<b>abort</b>(<i></i>) +<p> + Public slot to abort the operation. +</p><a NAME="FtpReply.bytesAvailable" ID="FtpReply.bytesAvailable"></a> +<h4>FtpReply.bytesAvailable</h4> +<b>bytesAvailable</b>(<i></i>) +<p> + Public method to determined the bytes available for being read. +</p><dl> +<dt>Returns:</dt> +<dd> +bytes available (integer) +</dd> +</dl><a NAME="FtpReply.isSequential" ID="FtpReply.isSequential"></a> +<h4>FtpReply.isSequential</h4> +<b>isSequential</b>(<i></i>) +<p> + Public method to check for sequential access. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating sequential access (boolean) +</dd> +</dl><a NAME="FtpReply.readData" ID="FtpReply.readData"></a> +<h4>FtpReply.readData</h4> +<b>readData</b>(<i>maxlen</i>) +<p> + Protected method to retrieve data from the reply object. +</p><dl> +<dt><i>maxlen</i></dt> +<dd> +maximum number of bytes to read (integer) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +string containing the data (bytes) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file