Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Helpviewer.Network.FtpReply.html

Documentation/Source/eric5.Helpviewer.Network.FtpReply.html

changeset 278
c93823b96faa
child 289
baf4c1354c6a
equal deleted inserted replaced
276:4a7e25ee406c 278:c93823b96faa
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Helpviewer.Network.FtpReply</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Helpviewer.Network.FtpReply</h1>
24 <p>
25 Module implementing a network reply class for FTP resources.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>ftpListPage_html</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#FtpReply">FtpReply</a></td>
35 <td>Class implementing a network reply for FTP resources.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="FtpReply" ID="FtpReply"></a>
44 <h2>FtpReply</h2>
45 <p>
46 Class implementing a network reply for FTP resources.
47 </p>
48 <h3>Derived from</h3>
49 QNetworkReply
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#FtpReply.__init__">FtpReply</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#FtpReply.__commandStarted">__commandStarted</a></td>
61 <td>Private slot to handle the start of FTP commands.</td>
62 </tr><tr>
63 <td><a href="#FtpReply.__connectToHost">__connectToHost</a></td>
64 <td>Private slot to start the FTP process by connecting to the host.</td>
65 </tr><tr>
66 <td><a href="#FtpReply.__cssLinkClass">__cssLinkClass</a></td>
67 <td>Private method to generate a link class with an icon.</td>
68 </tr><tr>
69 <td><a href="#FtpReply.__processCommand">__processCommand</a></td>
70 <td>Private slot to handle the end of FTP commands.</td>
71 </tr><tr>
72 <td><a href="#FtpReply.__processData">__processData</a></td>
73 <td>Private slot to process data from the FTP server.</td>
74 </tr><tr>
75 <td><a href="#FtpReply.__processListInfo">__processListInfo</a></td>
76 <td>Private slot to process list information from the FTP server.</td>
77 </tr><tr>
78 <td><a href="#FtpReply.__setContent">__setContent</a></td>
79 <td>Private method to set the finish the setup of the data.</td>
80 </tr><tr>
81 <td><a href="#FtpReply.__setListContent">__setListContent</a></td>
82 <td>Private method to prepare the content for the reader.</td>
83 </tr><tr>
84 <td><a href="#FtpReply.abort">abort</a></td>
85 <td>Public slot to abort the operation.</td>
86 </tr><tr>
87 <td><a href="#FtpReply.bytesAvailable">bytesAvailable</a></td>
88 <td>Public method to determined the bytes available for being read.</td>
89 </tr><tr>
90 <td><a href="#FtpReply.isSequential">isSequential</a></td>
91 <td>Public method to check for sequential access.</td>
92 </tr><tr>
93 <td><a href="#FtpReply.readData">readData</a></td>
94 <td>Protected method to retrieve data from the reply object.</td>
95 </tr>
96 </table>
97 <a NAME="FtpReply.__init__" ID="FtpReply.__init__"></a>
98 <h4>FtpReply (Constructor)</h4>
99 <b>FtpReply</b>(<i>url, parent = None</i>)
100 <p>
101 Constructor
102 </p><dl>
103 <dt><i>url</i></dt>
104 <dd>
105 requested FTP URL (QUrl)
106 </dd><dt><i>parent</i></dt>
107 <dd>
108 reference to the parent object (QObject)
109 </dd>
110 </dl><a NAME="FtpReply.__commandStarted" ID="FtpReply.__commandStarted"></a>
111 <h4>FtpReply.__commandStarted</h4>
112 <b>__commandStarted</b>(<i>id</i>)
113 <p>
114 Private slot to handle the start of FTP commands.
115 </p><dl>
116 <dt><i>id</i></dt>
117 <dd>
118 id of the command to be processed (integer) (ignored)
119 </dd>
120 </dl><a NAME="FtpReply.__connectToHost" ID="FtpReply.__connectToHost"></a>
121 <h4>FtpReply.__connectToHost</h4>
122 <b>__connectToHost</b>(<i></i>)
123 <p>
124 Private slot to start the FTP process by connecting to the host.
125 </p><a NAME="FtpReply.__cssLinkClass" ID="FtpReply.__cssLinkClass"></a>
126 <h4>FtpReply.__cssLinkClass</h4>
127 <b>__cssLinkClass</b>(<i>icon, size = 32</i>)
128 <p>
129 Private method to generate a link class with an icon.
130 </p><dl>
131 <dt><i>icon</i></dt>
132 <dd>
133 icon to be included (QIcon)
134 </dd><dt><i>size</i></dt>
135 <dd>
136 size of the icon to be generated (integer)
137 </dd>
138 </dl><dl>
139 <dt>Returns:</dt>
140 <dd>
141 CSS class string (string)
142 </dd>
143 </dl><a NAME="FtpReply.__processCommand" ID="FtpReply.__processCommand"></a>
144 <h4>FtpReply.__processCommand</h4>
145 <b>__processCommand</b>(<i>id, error</i>)
146 <p>
147 Private slot to handle the end of FTP commands.
148 </p><dl>
149 <dt><i>id</i></dt>
150 <dd>
151 id of the command to be processed (integer) (ignored)
152 </dd><dt><i>error</i></dt>
153 <dd>
154 flag indicating an error condition (boolean)
155 </dd>
156 </dl><a NAME="FtpReply.__processData" ID="FtpReply.__processData"></a>
157 <h4>FtpReply.__processData</h4>
158 <b>__processData</b>(<i></i>)
159 <p>
160 Private slot to process data from the FTP server.
161 </p><a NAME="FtpReply.__processListInfo" ID="FtpReply.__processListInfo"></a>
162 <h4>FtpReply.__processListInfo</h4>
163 <b>__processListInfo</b>(<i>urlInfo</i>)
164 <p>
165 Private slot to process list information from the FTP server.
166 </p><dl>
167 <dt><i>urlInfo</i></dt>
168 <dd>
169 reference to the information object (QUrlInfo)
170 </dd>
171 </dl><a NAME="FtpReply.__setContent" ID="FtpReply.__setContent"></a>
172 <h4>FtpReply.__setContent</h4>
173 <b>__setContent</b>(<i></i>)
174 <p>
175 Private method to set the finish the setup of the data.
176 </p><a NAME="FtpReply.__setListContent" ID="FtpReply.__setListContent"></a>
177 <h4>FtpReply.__setListContent</h4>
178 <b>__setListContent</b>(<i></i>)
179 <p>
180 Private method to prepare the content for the reader.
181 </p><a NAME="FtpReply.abort" ID="FtpReply.abort"></a>
182 <h4>FtpReply.abort</h4>
183 <b>abort</b>(<i></i>)
184 <p>
185 Public slot to abort the operation.
186 </p><a NAME="FtpReply.bytesAvailable" ID="FtpReply.bytesAvailable"></a>
187 <h4>FtpReply.bytesAvailable</h4>
188 <b>bytesAvailable</b>(<i></i>)
189 <p>
190 Public method to determined the bytes available for being read.
191 </p><dl>
192 <dt>Returns:</dt>
193 <dd>
194 bytes available (integer)
195 </dd>
196 </dl><a NAME="FtpReply.isSequential" ID="FtpReply.isSequential"></a>
197 <h4>FtpReply.isSequential</h4>
198 <b>isSequential</b>(<i></i>)
199 <p>
200 Public method to check for sequential access.
201 </p><dl>
202 <dt>Returns:</dt>
203 <dd>
204 flag indicating sequential access (boolean)
205 </dd>
206 </dl><a NAME="FtpReply.readData" ID="FtpReply.readData"></a>
207 <h4>FtpReply.readData</h4>
208 <b>readData</b>(<i>maxlen</i>)
209 <p>
210 Protected method to retrieve data from the reply object.
211 </p><dl>
212 <dt><i>maxlen</i></dt>
213 <dd>
214 maximum number of bytes to read (integer)
215 </dd>
216 </dl><dl>
217 <dt>Returns:</dt>
218 <dd>
219 string containing the data (bytes)
220 </dd>
221 </dl>
222 <div align="right"><a href="#top">Up</a></div>
223 <hr />
224 </body></html>

Mercurial Repository: eric

eric ide

mercurial