Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.Tools.WebBrowserTools.html

eric6/Documentation/Source/eric6.WebBrowser.Tools.WebBrowserTools.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7721
331ecfa0e716
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.Tools.WebBrowserTools</h1> 23 <h1>eric6.WebBrowser.Tools.WebBrowserTools</h1>
24
23 <p> 25 <p>
24 Module implementing tool functions for the web browser. 26 Module implementing tool functions for the web browser.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
32 <tr><td>None</td></tr> 36 <tr><td>None</td></tr>
33 </table> 37 </table>
34 <h3>Functions</h3> 38 <h3>Functions</h3>
39
35 <table> 40 <table>
41
36 <tr> 42 <tr>
37 <td><a href="#containsSpace">containsSpace</a></td> 43 <td><a href="#containsSpace">containsSpace</a></td>
38 <td>Function to check, if a string contains whitespace characters.</td> 44 <td>Function to check, if a string contains whitespace characters.</td>
39 </tr><tr> 45 </tr>
46 <tr>
40 <td><a href="#ensureUniqueFilename">ensureUniqueFilename</a></td> 47 <td><a href="#ensureUniqueFilename">ensureUniqueFilename</a></td>
41 <td>Module function to generate an unique file name based on a pattern.</td> 48 <td>Module function to generate an unique file name based on a pattern.</td>
42 </tr><tr> 49 </tr>
50 <tr>
43 <td><a href="#filterCharsFromFilename">filterCharsFromFilename</a></td> 51 <td><a href="#filterCharsFromFilename">filterCharsFromFilename</a></td>
44 <td>Module function to filter illegal characters.</td> 52 <td>Module function to filter illegal characters.</td>
45 </tr><tr> 53 </tr>
54 <tr>
46 <td><a href="#getFileNameFromUrl">getFileNameFromUrl</a></td> 55 <td><a href="#getFileNameFromUrl">getFileNameFromUrl</a></td>
47 <td>Module function to generate a file name based on the given URL.</td> 56 <td>Module function to generate a file name based on the given URL.</td>
48 </tr><tr> 57 </tr>
58 <tr>
49 <td><a href="#getWebEngineVersions">getWebEngineVersions</a></td> 59 <td><a href="#getWebEngineVersions">getWebEngineVersions</a></td>
50 <td>Module function to extract the web engine version from the default user agent string.</td> 60 <td>Module function to extract the web engine version from the default user agent string.</td>
51 </tr><tr> 61 </tr>
62 <tr>
52 <td><a href="#pixmapFromByteArray">pixmapFromByteArray</a></td> 63 <td><a href="#pixmapFromByteArray">pixmapFromByteArray</a></td>
53 <td>Module function to convert a byte array to a pixmap.</td> 64 <td>Module function to convert a byte array to a pixmap.</td>
54 </tr><tr> 65 </tr>
66 <tr>
55 <td><a href="#pixmapToByteArray">pixmapToByteArray</a></td> 67 <td><a href="#pixmapToByteArray">pixmapToByteArray</a></td>
56 <td>Module function to convert a pixmap to a byte array containing the pixmap as a PNG encoded as base64.</td> 68 <td>Module function to convert a pixmap to a byte array containing the pixmap as a PNG encoded as base64.</td>
57 </tr><tr> 69 </tr>
70 <tr>
58 <td><a href="#pixmapToDataUrl">pixmapToDataUrl</a></td> 71 <td><a href="#pixmapToDataUrl">pixmapToDataUrl</a></td>
59 <td>Module function to convert a pixmap to a data: URL.</td> 72 <td>Module function to convert a pixmap to a data: URL.</td>
60 </tr><tr> 73 </tr>
74 <tr>
61 <td><a href="#readAllFileByteContents">readAllFileByteContents</a></td> 75 <td><a href="#readAllFileByteContents">readAllFileByteContents</a></td>
62 <td>Function to read the bytes contents of the given file.</td> 76 <td>Function to read the bytes contents of the given file.</td>
63 </tr><tr> 77 </tr>
78 <tr>
64 <td><a href="#readAllFileContents">readAllFileContents</a></td> 79 <td><a href="#readAllFileContents">readAllFileContents</a></td>
65 <td>Function to read the string contents of the given file.</td> 80 <td>Function to read the string contents of the given file.</td>
66 </tr> 81 </tr>
67 </table> 82 </table>
68 <hr /><hr /> 83 <hr />
84 <hr />
69 <a NAME="containsSpace" ID="containsSpace"></a> 85 <a NAME="containsSpace" ID="containsSpace"></a>
70 <h2>containsSpace</h2> 86 <h2>containsSpace</h2>
71 <b>containsSpace</b>(<i>string</i>) 87 <b>containsSpace</b>(<i>string</i>)
88
72 <p> 89 <p>
73 Function to check, if a string contains whitespace characters. 90 Function to check, if a string contains whitespace characters.
74 </p><dl> 91 </p>
92 <dl>
93
75 <dt><i>string</i> (str)</dt> 94 <dt><i>string</i> (str)</dt>
76 <dd> 95 <dd>
77 string to be checked 96 string to be checked
78 </dd> 97 </dd>
79 </dl><dl> 98 </dl>
99 <dl>
80 <dt>Returns:</dt> 100 <dt>Returns:</dt>
81 <dd> 101 <dd>
82 flag indicating the presence of at least one whitespace character 102 flag indicating the presence of at least one whitespace character
83 </dd> 103 </dd>
84 </dl><dl> 104 </dl>
105 <dl>
85 <dt>Return Type:</dt> 106 <dt>Return Type:</dt>
86 <dd> 107 <dd>
87 bool 108 bool
88 </dd> 109 </dd>
89 </dl> 110 </dl>
90 <div align="right"><a href="#top">Up</a></div> 111 <div align="right"><a href="#top">Up</a></div>
91 <hr /><hr /> 112 <hr />
113 <hr />
92 <a NAME="ensureUniqueFilename" ID="ensureUniqueFilename"></a> 114 <a NAME="ensureUniqueFilename" ID="ensureUniqueFilename"></a>
93 <h2>ensureUniqueFilename</h2> 115 <h2>ensureUniqueFilename</h2>
94 <b>ensureUniqueFilename</b>(<i>name, appendFormat="({0})"</i>) 116 <b>ensureUniqueFilename</b>(<i>name, appendFormat="({0})"</i>)
117
95 <p> 118 <p>
96 Module function to generate an unique file name based on a pattern. 119 Module function to generate an unique file name based on a pattern.
97 </p><dl> 120 </p>
121 <dl>
122
98 <dt><i>name</i></dt> 123 <dt><i>name</i></dt>
99 <dd> 124 <dd>
100 desired file name (string) 125 desired file name (string)
101 </dd><dt><i>appendFormat</i></dt> 126 </dd>
127 <dt><i>appendFormat</i></dt>
102 <dd> 128 <dd>
103 format pattern to be used to make the unique name 129 format pattern to be used to make the unique name
104 (string) 130 (string)
105 </dd> 131 </dd>
106 </dl><dl> 132 </dl>
133 <dl>
107 <dt>Returns:</dt> 134 <dt>Returns:</dt>
108 <dd> 135 <dd>
109 unique file name 136 unique file name
110 </dd> 137 </dd>
111 </dl> 138 </dl>
112 <div align="right"><a href="#top">Up</a></div> 139 <div align="right"><a href="#top">Up</a></div>
113 <hr /><hr /> 140 <hr />
141 <hr />
114 <a NAME="filterCharsFromFilename" ID="filterCharsFromFilename"></a> 142 <a NAME="filterCharsFromFilename" ID="filterCharsFromFilename"></a>
115 <h2>filterCharsFromFilename</h2> 143 <h2>filterCharsFromFilename</h2>
116 <b>filterCharsFromFilename</b>(<i>name</i>) 144 <b>filterCharsFromFilename</b>(<i>name</i>)
145
117 <p> 146 <p>
118 Module function to filter illegal characters. 147 Module function to filter illegal characters.
119 </p><dl> 148 </p>
149 <dl>
150
120 <dt><i>name</i></dt> 151 <dt><i>name</i></dt>
121 <dd> 152 <dd>
122 name to be sanitized (string) 153 name to be sanitized (string)
123 </dd> 154 </dd>
124 </dl><dl> 155 </dl>
156 <dl>
125 <dt>Returns:</dt> 157 <dt>Returns:</dt>
126 <dd> 158 <dd>
127 sanitized name (string) 159 sanitized name (string)
128 </dd> 160 </dd>
129 </dl> 161 </dl>
130 <div align="right"><a href="#top">Up</a></div> 162 <div align="right"><a href="#top">Up</a></div>
131 <hr /><hr /> 163 <hr />
164 <hr />
132 <a NAME="getFileNameFromUrl" ID="getFileNameFromUrl"></a> 165 <a NAME="getFileNameFromUrl" ID="getFileNameFromUrl"></a>
133 <h2>getFileNameFromUrl</h2> 166 <h2>getFileNameFromUrl</h2>
134 <b>getFileNameFromUrl</b>(<i>url</i>) 167 <b>getFileNameFromUrl</b>(<i>url</i>)
168
135 <p> 169 <p>
136 Module function to generate a file name based on the given URL. 170 Module function to generate a file name based on the given URL.
137 </p><dl> 171 </p>
172 <dl>
173
138 <dt><i>url</i></dt> 174 <dt><i>url</i></dt>
139 <dd> 175 <dd>
140 URL (QUrl) 176 URL (QUrl)
141 </dd> 177 </dd>
142 </dl><dl> 178 </dl>
179 <dl>
143 <dt>Returns:</dt> 180 <dt>Returns:</dt>
144 <dd> 181 <dd>
145 file name (string) 182 file name (string)
146 </dd> 183 </dd>
147 </dl> 184 </dl>
148 <div align="right"><a href="#top">Up</a></div> 185 <div align="right"><a href="#top">Up</a></div>
149 <hr /><hr /> 186 <hr />
187 <hr />
150 <a NAME="getWebEngineVersions" ID="getWebEngineVersions"></a> 188 <a NAME="getWebEngineVersions" ID="getWebEngineVersions"></a>
151 <h2>getWebEngineVersions</h2> 189 <h2>getWebEngineVersions</h2>
152 <b>getWebEngineVersions</b>(<i></i>) 190 <b>getWebEngineVersions</b>(<i></i>)
191
153 <p> 192 <p>
154 Module function to extract the web engine version from the default user 193 Module function to extract the web engine version from the default user
155 agent string. 194 agent string.
156 </p><dl> 195 </p>
196 <dl>
157 <dt>Returns:</dt> 197 <dt>Returns:</dt>
158 <dd> 198 <dd>
159 tuple containing the Chrome version and the QtWebEngine version 199 tuple containing the Chrome version and the QtWebEngine version
160 </dd> 200 </dd>
161 </dl><dl> 201 </dl>
202 <dl>
162 <dt>Return Type:</dt> 203 <dt>Return Type:</dt>
163 <dd> 204 <dd>
164 tuple of str 205 tuple of str
165 </dd> 206 </dd>
166 </dl> 207 </dl>
167 <div align="right"><a href="#top">Up</a></div> 208 <div align="right"><a href="#top">Up</a></div>
168 <hr /><hr /> 209 <hr />
210 <hr />
169 <a NAME="pixmapFromByteArray" ID="pixmapFromByteArray"></a> 211 <a NAME="pixmapFromByteArray" ID="pixmapFromByteArray"></a>
170 <h2>pixmapFromByteArray</h2> 212 <h2>pixmapFromByteArray</h2>
171 <b>pixmapFromByteArray</b>(<i>data</i>) 213 <b>pixmapFromByteArray</b>(<i>data</i>)
214
172 <p> 215 <p>
173 Module function to convert a byte array to a pixmap. 216 Module function to convert a byte array to a pixmap.
174 </p><dl> 217 </p>
218 <dl>
219
175 <dt><i>data</i> (bytes or QByteArray)</dt> 220 <dt><i>data</i> (bytes or QByteArray)</dt>
176 <dd> 221 <dd>
177 data for the pixmap 222 data for the pixmap
178 </dd> 223 </dd>
179 </dl><dl> 224 </dl>
225 <dl>
180 <dt>Returns:</dt> 226 <dt>Returns:</dt>
181 <dd> 227 <dd>
182 extracted pixmap 228 extracted pixmap
183 </dd> 229 </dd>
184 </dl><dl> 230 </dl>
231 <dl>
185 <dt>Return Type:</dt> 232 <dt>Return Type:</dt>
186 <dd> 233 <dd>
187 QPixmap 234 QPixmap
188 </dd> 235 </dd>
189 </dl> 236 </dl>
190 <div align="right"><a href="#top">Up</a></div> 237 <div align="right"><a href="#top">Up</a></div>
191 <hr /><hr /> 238 <hr />
239 <hr />
192 <a NAME="pixmapToByteArray" ID="pixmapToByteArray"></a> 240 <a NAME="pixmapToByteArray" ID="pixmapToByteArray"></a>
193 <h2>pixmapToByteArray</h2> 241 <h2>pixmapToByteArray</h2>
194 <b>pixmapToByteArray</b>(<i>pixmap</i>) 242 <b>pixmapToByteArray</b>(<i>pixmap</i>)
243
195 <p> 244 <p>
196 Module function to convert a pixmap to a byte array containing the pixmap 245 Module function to convert a pixmap to a byte array containing the pixmap
197 as a PNG encoded as base64. 246 as a PNG encoded as base64.
198 </p><dl> 247 </p>
248 <dl>
249
199 <dt><i>pixmap</i> (QPixmap)</dt> 250 <dt><i>pixmap</i> (QPixmap)</dt>
200 <dd> 251 <dd>
201 pixmap to be converted 252 pixmap to be converted
202 </dd> 253 </dd>
203 </dl><dl> 254 </dl>
255 <dl>
204 <dt>Returns:</dt> 256 <dt>Returns:</dt>
205 <dd> 257 <dd>
206 byte array containing the pixmap 258 byte array containing the pixmap
207 </dd> 259 </dd>
208 </dl><dl> 260 </dl>
261 <dl>
209 <dt>Return Type:</dt> 262 <dt>Return Type:</dt>
210 <dd> 263 <dd>
211 QByteArray 264 QByteArray
212 </dd> 265 </dd>
213 </dl> 266 </dl>
214 <div align="right"><a href="#top">Up</a></div> 267 <div align="right"><a href="#top">Up</a></div>
215 <hr /><hr /> 268 <hr />
269 <hr />
216 <a NAME="pixmapToDataUrl" ID="pixmapToDataUrl"></a> 270 <a NAME="pixmapToDataUrl" ID="pixmapToDataUrl"></a>
217 <h2>pixmapToDataUrl</h2> 271 <h2>pixmapToDataUrl</h2>
218 <b>pixmapToDataUrl</b>(<i>pixmap</i>) 272 <b>pixmapToDataUrl</b>(<i>pixmap</i>)
273
219 <p> 274 <p>
220 Module function to convert a pixmap to a data: URL. 275 Module function to convert a pixmap to a data: URL.
221 </p><dl> 276 </p>
277 <dl>
278
222 <dt><i>pixmap</i> (QPixmap)</dt> 279 <dt><i>pixmap</i> (QPixmap)</dt>
223 <dd> 280 <dd>
224 pixmap to be converted 281 pixmap to be converted
225 </dd> 282 </dd>
226 </dl><dl> 283 </dl>
284 <dl>
227 <dt>Returns:</dt> 285 <dt>Returns:</dt>
228 <dd> 286 <dd>
229 data: URL 287 data: URL
230 </dd> 288 </dd>
231 </dl><dl> 289 </dl>
290 <dl>
232 <dt>Return Type:</dt> 291 <dt>Return Type:</dt>
233 <dd> 292 <dd>
234 QUrl 293 QUrl
235 </dd> 294 </dd>
236 </dl> 295 </dl>
237 <div align="right"><a href="#top">Up</a></div> 296 <div align="right"><a href="#top">Up</a></div>
238 <hr /><hr /> 297 <hr />
298 <hr />
239 <a NAME="readAllFileByteContents" ID="readAllFileByteContents"></a> 299 <a NAME="readAllFileByteContents" ID="readAllFileByteContents"></a>
240 <h2>readAllFileByteContents</h2> 300 <h2>readAllFileByteContents</h2>
241 <b>readAllFileByteContents</b>(<i>filename</i>) 301 <b>readAllFileByteContents</b>(<i>filename</i>)
302
242 <p> 303 <p>
243 Function to read the bytes contents of the given file. 304 Function to read the bytes contents of the given file.
244 </p><dl> 305 </p>
306 <dl>
307
245 <dt><i>filename</i> (str)</dt> 308 <dt><i>filename</i> (str)</dt>
246 <dd> 309 <dd>
247 name of the file 310 name of the file
248 </dd> 311 </dd>
249 </dl><dl> 312 </dl>
313 <dl>
250 <dt>Returns:</dt> 314 <dt>Returns:</dt>
251 <dd> 315 <dd>
252 contents of the file 316 contents of the file
253 </dd> 317 </dd>
254 </dl><dl> 318 </dl>
319 <dl>
255 <dt>Return Type:</dt> 320 <dt>Return Type:</dt>
256 <dd> 321 <dd>
257 str 322 str
258 </dd> 323 </dd>
259 </dl> 324 </dl>
260 <div align="right"><a href="#top">Up</a></div> 325 <div align="right"><a href="#top">Up</a></div>
261 <hr /><hr /> 326 <hr />
327 <hr />
262 <a NAME="readAllFileContents" ID="readAllFileContents"></a> 328 <a NAME="readAllFileContents" ID="readAllFileContents"></a>
263 <h2>readAllFileContents</h2> 329 <h2>readAllFileContents</h2>
264 <b>readAllFileContents</b>(<i>filename</i>) 330 <b>readAllFileContents</b>(<i>filename</i>)
331
265 <p> 332 <p>
266 Function to read the string contents of the given file. 333 Function to read the string contents of the given file.
267 </p><dl> 334 </p>
335 <dl>
336
268 <dt><i>filename</i> (str)</dt> 337 <dt><i>filename</i> (str)</dt>
269 <dd> 338 <dd>
270 name of the file 339 name of the file
271 </dd> 340 </dd>
272 </dl><dl> 341 </dl>
342 <dl>
273 <dt>Returns:</dt> 343 <dt>Returns:</dt>
274 <dd> 344 <dd>
275 contents of the file 345 contents of the file
276 </dd> 346 </dd>
277 </dl><dl> 347 </dl>
348 <dl>
278 <dt>Return Type:</dt> 349 <dt>Return Type:</dt>
279 <dd> 350 <dd>
280 str 351 str
281 </dd> 352 </dd>
282 </dl> 353 </dl>

Mercurial Repository: eric

eric ide

mercurial