|
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.FileReply</title> |
|
6 <style> |
|
7 body { |
|
8 background: #EDECE6; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #85774A; } |
|
14 h2 { color: white; background: #85774A; } |
|
15 h3 { color: white; background: #9D936E; } |
|
16 h4 { color: white; background: #9D936E; } |
|
17 |
|
18 a { color: #BA6D36; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>eric5.Helpviewer.Network.FileReply</h1> |
|
24 <p> |
|
25 Module implementing a network reply class for directory resources. |
|
26 </p> |
|
27 <h3>Global Attributes</h3> |
|
28 <table> |
|
29 <tr><td>dirListPage_html</td></tr> |
|
30 </table> |
|
31 <h3>Classes</h3> |
|
32 <table> |
|
33 <tr> |
|
34 <td><a href="#FileReply">FileReply</a></td> |
|
35 <td>Class implementing a network reply for directory 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="FileReply" ID="FileReply"></a> |
|
44 <h2>FileReply</h2> |
|
45 <p> |
|
46 Class implementing a network reply for directory 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>Class Methods</h3> |
|
55 <table> |
|
56 <tr><td>None</td></tr> |
|
57 </table> |
|
58 <h3>Methods</h3> |
|
59 <table> |
|
60 <tr> |
|
61 <td><a href="#FileReply.__init__">FileReply</a></td> |
|
62 <td>Constructor</td> |
|
63 </tr><tr> |
|
64 <td><a href="#FileReply.__cssLinkClass">__cssLinkClass</a></td> |
|
65 <td>Private method to generate a link class with an icon.</td> |
|
66 </tr><tr> |
|
67 <td><a href="#FileReply.__loadDirectory">__loadDirectory</a></td> |
|
68 <td>Private slot loading the directory and preparing the listing page.</td> |
|
69 </tr><tr> |
|
70 <td><a href="#FileReply.abort">abort</a></td> |
|
71 <td>Public slot to abort the operation.</td> |
|
72 </tr><tr> |
|
73 <td><a href="#FileReply.bytesAvailable">bytesAvailable</a></td> |
|
74 <td>Public method to determined the bytes available for being read.</td> |
|
75 </tr><tr> |
|
76 <td><a href="#FileReply.isSequential">isSequential</a></td> |
|
77 <td>Public method to check for sequential access.</td> |
|
78 </tr><tr> |
|
79 <td><a href="#FileReply.readData">readData</a></td> |
|
80 <td>Protected method to retrieve data from the reply object.</td> |
|
81 </tr> |
|
82 </table> |
|
83 <h3>Static Methods</h3> |
|
84 <table> |
|
85 <tr><td>None</td></tr> |
|
86 </table> |
|
87 <a NAME="FileReply.__init__" ID="FileReply.__init__"></a> |
|
88 <h4>FileReply (Constructor)</h4> |
|
89 <b>FileReply</b>(<i>url, parent=None</i>) |
|
90 <p> |
|
91 Constructor |
|
92 </p><dl> |
|
93 <dt><i>url</i></dt> |
|
94 <dd> |
|
95 requested FTP URL (QUrl) |
|
96 </dd><dt><i>parent</i></dt> |
|
97 <dd> |
|
98 reference to the parent object (QObject) |
|
99 </dd> |
|
100 </dl><a NAME="FileReply.__cssLinkClass" ID="FileReply.__cssLinkClass"></a> |
|
101 <h4>FileReply.__cssLinkClass</h4> |
|
102 <b>__cssLinkClass</b>(<i>icon, size=32</i>) |
|
103 <p> |
|
104 Private method to generate a link class with an icon. |
|
105 </p><dl> |
|
106 <dt><i>icon</i></dt> |
|
107 <dd> |
|
108 icon to be included (QIcon) |
|
109 </dd><dt><i>size</i></dt> |
|
110 <dd> |
|
111 size of the icon to be generated (integer) |
|
112 </dd> |
|
113 </dl><dl> |
|
114 <dt>Returns:</dt> |
|
115 <dd> |
|
116 CSS class string (string) |
|
117 </dd> |
|
118 </dl><a NAME="FileReply.__loadDirectory" ID="FileReply.__loadDirectory"></a> |
|
119 <h4>FileReply.__loadDirectory</h4> |
|
120 <b>__loadDirectory</b>(<i></i>) |
|
121 <p> |
|
122 Private slot loading the directory and preparing the listing page. |
|
123 </p><a NAME="FileReply.abort" ID="FileReply.abort"></a> |
|
124 <h4>FileReply.abort</h4> |
|
125 <b>abort</b>(<i></i>) |
|
126 <p> |
|
127 Public slot to abort the operation. |
|
128 </p><a NAME="FileReply.bytesAvailable" ID="FileReply.bytesAvailable"></a> |
|
129 <h4>FileReply.bytesAvailable</h4> |
|
130 <b>bytesAvailable</b>(<i></i>) |
|
131 <p> |
|
132 Public method to determined the bytes available for being read. |
|
133 </p><dl> |
|
134 <dt>Returns:</dt> |
|
135 <dd> |
|
136 bytes available (integer) |
|
137 </dd> |
|
138 </dl><a NAME="FileReply.isSequential" ID="FileReply.isSequential"></a> |
|
139 <h4>FileReply.isSequential</h4> |
|
140 <b>isSequential</b>(<i></i>) |
|
141 <p> |
|
142 Public method to check for sequential access. |
|
143 </p><dl> |
|
144 <dt>Returns:</dt> |
|
145 <dd> |
|
146 flag indicating sequential access (boolean) |
|
147 </dd> |
|
148 </dl><a NAME="FileReply.readData" ID="FileReply.readData"></a> |
|
149 <h4>FileReply.readData</h4> |
|
150 <b>readData</b>(<i>maxlen</i>) |
|
151 <p> |
|
152 Protected method to retrieve data from the reply object. |
|
153 </p><dl> |
|
154 <dt><i>maxlen</i></dt> |
|
155 <dd> |
|
156 maximum number of bytes to read (integer) |
|
157 </dd> |
|
158 </dl><dl> |
|
159 <dt>Returns:</dt> |
|
160 <dd> |
|
161 string containing the data (bytes) |
|
162 </dd> |
|
163 </dl> |
|
164 <div align="right"><a href="#top">Up</a></div> |
|
165 <hr /> |
|
166 </body></html> |