src/eric7/Documentation/Source/eric7.WebBrowser.UrlBar.UrlBar.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8877
548d45c3f571
child 10478
de9106c55c3d
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.UrlBar.UrlBar</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.UrlBar.UrlBar</h1>
10
11 <p>
12 Module implementing the URL bar widget.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#UrlBar">UrlBar</a></td>
25 <td>Class implementing a line edit for entering URLs.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="UrlBar" ID="UrlBar"></a>
36 <h2>UrlBar</h2>
37
38 <p>
39 Class implementing a line edit for entering URLs.
40 </p>
41 <h3>Derived from</h3>
42 EricClearableLineEdit
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#UrlBar.__init__">UrlBar</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#UrlBar.__bookmarkChanged">__bookmarkChanged</a></td>
63 <td>Private slot to handle bookmark or speed dial changes.</td>
64 </tr>
65 <tr>
66 <td><a href="#UrlBar.__browserUrlChanged">__browserUrlChanged</a></td>
67 <td>Private slot to handle a URL change of the associated browser.</td>
68 </tr>
69 <tr>
70 <td><a href="#UrlBar.__checkBookmark">__checkBookmark</a></td>
71 <td>Private slot to check the current URL for the bookmarked state.</td>
72 </tr>
73 <tr>
74 <td><a href="#UrlBar.__loadFinished">__loadFinished</a></td>
75 <td>Private slot to set some data after the page was loaded.</td>
76 </tr>
77 <tr>
78 <td><a href="#UrlBar.__loadProgress">__loadProgress</a></td>
79 <td>Private slot to track the load progress.</td>
80 </tr>
81 <tr>
82 <td><a href="#UrlBar.__loadStarted">__loadStarted</a></td>
83 <td>Private slot to perform actions before the page is loaded.</td>
84 </tr>
85 <tr>
86 <td><a href="#UrlBar.__rssTriggered">__rssTriggered</a></td>
87 <td>Private slot to handle clicking the RSS icon.</td>
88 </tr>
89 <tr>
90 <td><a href="#UrlBar.__setRssButton">__setRssButton</a></td>
91 <td>Private slot to show the RSS button.</td>
92 </tr>
93 <tr>
94 <td><a href="#UrlBar.__showBookmarkInfo">__showBookmarkInfo</a></td>
95 <td>Private slot to show a dialog with some bookmark info.</td>
96 </tr>
97 <tr>
98 <td><a href="#UrlBar.__showThreatInfo">__showThreatInfo</a></td>
99 <td>Private slot to show the threat info widget.</td>
100 </tr>
101 <tr>
102 <td><a href="#UrlBar.__sslConfigurationChanged">__sslConfigurationChanged</a></td>
103 <td>Private slot to handle a change of the associated web page SSL configuration.</td>
104 </tr>
105 <tr>
106 <td><a href="#UrlBar.browser">browser</a></td>
107 <td>Public method to get the associated browser.</td>
108 </tr>
109 <tr>
110 <td><a href="#UrlBar.dragEnterEvent">dragEnterEvent</a></td>
111 <td>Protected method to handle drag enter events.</td>
112 </tr>
113 <tr>
114 <td><a href="#UrlBar.dropEvent">dropEvent</a></td>
115 <td>Protected method to handle drop events.</td>
116 </tr>
117 <tr>
118 <td><a href="#UrlBar.focusOutEvent">focusOutEvent</a></td>
119 <td>Protected method to handle focus out event.</td>
120 </tr>
121 <tr>
122 <td><a href="#UrlBar.keyPressEvent">keyPressEvent</a></td>
123 <td>Protected method to handle key presses.</td>
124 </tr>
125 <tr>
126 <td><a href="#UrlBar.mouseDoubleClickEvent">mouseDoubleClickEvent</a></td>
127 <td>Protected method to handle mouse double click events.</td>
128 </tr>
129 <tr>
130 <td><a href="#UrlBar.mousePressEvent">mousePressEvent</a></td>
131 <td>Protected method called by a mouse press event.</td>
132 </tr>
133 <tr>
134 <td><a href="#UrlBar.preferencesChanged">preferencesChanged</a></td>
135 <td>Public slot to handle a change of preferences.</td>
136 </tr>
137 <tr>
138 <td><a href="#UrlBar.setBrowser">setBrowser</a></td>
139 <td>Public method to set the browser connection.</td>
140 </tr>
141 </table>
142 <h3>Static Methods</h3>
143
144 <table>
145 <tr><td>None</td></tr>
146 </table>
147
148 <a NAME="UrlBar.__init__" ID="UrlBar.__init__"></a>
149 <h4>UrlBar (Constructor)</h4>
150 <b>UrlBar</b>(<i>mainWindow, parent=None</i>)
151
152 <p>
153 Constructor
154 </p>
155 <dl>
156
157 <dt><i>mainWindow</i> (WebBrowserWindow)</dt>
158 <dd>
159 reference to the main window
160 </dd>
161 <dt><i>parent</i> (WebBrowserView)</dt>
162 <dd>
163 reference to the parent widget
164 </dd>
165 </dl>
166 <a NAME="UrlBar.__bookmarkChanged" ID="UrlBar.__bookmarkChanged"></a>
167 <h4>UrlBar.__bookmarkChanged</h4>
168 <b>__bookmarkChanged</b>(<i></i>)
169
170 <p>
171 Private slot to handle bookmark or speed dial changes.
172 </p>
173 <a NAME="UrlBar.__browserUrlChanged" ID="UrlBar.__browserUrlChanged"></a>
174 <h4>UrlBar.__browserUrlChanged</h4>
175 <b>__browserUrlChanged</b>(<i>url</i>)
176
177 <p>
178 Private slot to handle a URL change of the associated browser.
179 </p>
180 <dl>
181
182 <dt><i>url</i> (QUrl)</dt>
183 <dd>
184 new URL of the browser
185 </dd>
186 </dl>
187 <a NAME="UrlBar.__checkBookmark" ID="UrlBar.__checkBookmark"></a>
188 <h4>UrlBar.__checkBookmark</h4>
189 <b>__checkBookmark</b>(<i></i>)
190
191 <p>
192 Private slot to check the current URL for the bookmarked state.
193 </p>
194 <a NAME="UrlBar.__loadFinished" ID="UrlBar.__loadFinished"></a>
195 <h4>UrlBar.__loadFinished</h4>
196 <b>__loadFinished</b>(<i>ok</i>)
197
198 <p>
199 Private slot to set some data after the page was loaded.
200 </p>
201 <dl>
202
203 <dt><i>ok</i> (bool)</dt>
204 <dd>
205 flag indicating a successful load
206 </dd>
207 </dl>
208 <a NAME="UrlBar.__loadProgress" ID="UrlBar.__loadProgress"></a>
209 <h4>UrlBar.__loadProgress</h4>
210 <b>__loadProgress</b>(<i>progress</i>)
211
212 <p>
213 Private slot to track the load progress.
214 </p>
215 <dl>
216
217 <dt><i>progress</i> (int)</dt>
218 <dd>
219 load progress in percent
220 </dd>
221 </dl>
222 <a NAME="UrlBar.__loadStarted" ID="UrlBar.__loadStarted"></a>
223 <h4>UrlBar.__loadStarted</h4>
224 <b>__loadStarted</b>(<i></i>)
225
226 <p>
227 Private slot to perform actions before the page is loaded.
228 </p>
229 <a NAME="UrlBar.__rssTriggered" ID="UrlBar.__rssTriggered"></a>
230 <h4>UrlBar.__rssTriggered</h4>
231 <b>__rssTriggered</b>(<i></i>)
232
233 <p>
234 Private slot to handle clicking the RSS icon.
235 </p>
236 <a NAME="UrlBar.__setRssButton" ID="UrlBar.__setRssButton"></a>
237 <h4>UrlBar.__setRssButton</h4>
238 <b>__setRssButton</b>(<i></i>)
239
240 <p>
241 Private slot to show the RSS button.
242 </p>
243 <a NAME="UrlBar.__showBookmarkInfo" ID="UrlBar.__showBookmarkInfo"></a>
244 <h4>UrlBar.__showBookmarkInfo</h4>
245 <b>__showBookmarkInfo</b>(<i></i>)
246
247 <p>
248 Private slot to show a dialog with some bookmark info.
249 </p>
250 <a NAME="UrlBar.__showThreatInfo" ID="UrlBar.__showThreatInfo"></a>
251 <h4>UrlBar.__showThreatInfo</h4>
252 <b>__showThreatInfo</b>(<i>pos</i>)
253
254 <p>
255 Private slot to show the threat info widget.
256 </p>
257 <dl>
258
259 <dt><i>pos</i> (QPoint)</dt>
260 <dd>
261 position to show the info at
262 </dd>
263 </dl>
264 <a NAME="UrlBar.__sslConfigurationChanged" ID="UrlBar.__sslConfigurationChanged"></a>
265 <h4>UrlBar.__sslConfigurationChanged</h4>
266 <b>__sslConfigurationChanged</b>(<i></i>)
267
268 <p>
269 Private slot to handle a change of the associated web page SSL
270 configuration.
271 </p>
272 <a NAME="UrlBar.browser" ID="UrlBar.browser"></a>
273 <h4>UrlBar.browser</h4>
274 <b>browser</b>(<i></i>)
275
276 <p>
277 Public method to get the associated browser.
278 </p>
279 <dl>
280 <dt>Return:</dt>
281 <dd>
282 reference to the associated browser
283 </dd>
284 </dl>
285 <dl>
286 <dt>Return Type:</dt>
287 <dd>
288 WebBrowserView
289 </dd>
290 </dl>
291 <a NAME="UrlBar.dragEnterEvent" ID="UrlBar.dragEnterEvent"></a>
292 <h4>UrlBar.dragEnterEvent</h4>
293 <b>dragEnterEvent</b>(<i>evt</i>)
294
295 <p>
296 Protected method to handle drag enter events.
297 </p>
298 <dl>
299
300 <dt><i>evt</i> (QDragEnterEvent)</dt>
301 <dd>
302 reference to the drag enter event
303 </dd>
304 </dl>
305 <a NAME="UrlBar.dropEvent" ID="UrlBar.dropEvent"></a>
306 <h4>UrlBar.dropEvent</h4>
307 <b>dropEvent</b>(<i>evt</i>)
308
309 <p>
310 Protected method to handle drop events.
311 </p>
312 <dl>
313
314 <dt><i>evt</i> (QDropEvent)</dt>
315 <dd>
316 reference to the drop event
317 </dd>
318 </dl>
319 <a NAME="UrlBar.focusOutEvent" ID="UrlBar.focusOutEvent"></a>
320 <h4>UrlBar.focusOutEvent</h4>
321 <b>focusOutEvent</b>(<i>evt</i>)
322
323 <p>
324 Protected method to handle focus out event.
325 </p>
326 <dl>
327
328 <dt><i>evt</i> (QFocusEvent)</dt>
329 <dd>
330 reference to the focus event
331 </dd>
332 </dl>
333 <a NAME="UrlBar.keyPressEvent" ID="UrlBar.keyPressEvent"></a>
334 <h4>UrlBar.keyPressEvent</h4>
335 <b>keyPressEvent</b>(<i>evt</i>)
336
337 <p>
338 Protected method to handle key presses.
339 </p>
340 <dl>
341
342 <dt><i>evt</i> (QKeyEvent)</dt>
343 <dd>
344 reference to the key press event
345 </dd>
346 </dl>
347 <a NAME="UrlBar.mouseDoubleClickEvent" ID="UrlBar.mouseDoubleClickEvent"></a>
348 <h4>UrlBar.mouseDoubleClickEvent</h4>
349 <b>mouseDoubleClickEvent</b>(<i>evt</i>)
350
351 <p>
352 Protected method to handle mouse double click events.
353 </p>
354 <dl>
355
356 <dt><i>evt</i> (QMouseEvent)</dt>
357 <dd>
358 reference to the mouse event
359 </dd>
360 </dl>
361 <a NAME="UrlBar.mousePressEvent" ID="UrlBar.mousePressEvent"></a>
362 <h4>UrlBar.mousePressEvent</h4>
363 <b>mousePressEvent</b>(<i>evt</i>)
364
365 <p>
366 Protected method called by a mouse press event.
367 </p>
368 <dl>
369
370 <dt><i>evt</i> (QMouseEvent)</dt>
371 <dd>
372 reference to the mouse event
373 </dd>
374 </dl>
375 <a NAME="UrlBar.preferencesChanged" ID="UrlBar.preferencesChanged"></a>
376 <h4>UrlBar.preferencesChanged</h4>
377 <b>preferencesChanged</b>(<i></i>)
378
379 <p>
380 Public slot to handle a change of preferences.
381 </p>
382 <a NAME="UrlBar.setBrowser" ID="UrlBar.setBrowser"></a>
383 <h4>UrlBar.setBrowser</h4>
384 <b>setBrowser</b>(<i>browser</i>)
385
386 <p>
387 Public method to set the browser connection.
388 </p>
389 <dl>
390
391 <dt><i>browser</i> (WebBrowserView)</dt>
392 <dd>
393 reference to the browser widget
394 </dd>
395 </dl>
396 <div align="right"><a href="#top">Up</a></div>
397 <hr />
398 </body></html>

eric ide

mercurial