Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.Navigation.NavigationBar.html

eric7/Documentation/Source/eric7.WebBrowser.Navigation.NavigationBar.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.Navigation.NavigationBar</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.WebBrowser.Navigation.NavigationBar</h1>
24
25 <p>
26 Module implementing the navigation bar widget.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#NavigationBar">NavigationBar</a></td>
39 <td>Class implementing the navigation bar.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="NavigationBar" ID="NavigationBar"></a>
50 <h2>NavigationBar</h2>
51
52 <p>
53 Class implementing the navigation bar.
54 </p>
55 <h3>Derived from</h3>
56 QWidget
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#NavigationBar.__init__">NavigationBar</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#NavigationBar.__clearHistory">__clearHistory</a></td>
77 <td>Private slot to clear the history of the current web browser tab.</td>
78 </tr>
79 <tr>
80 <td><a href="#NavigationBar.__contextMenuRequested">__contextMenuRequested</a></td>
81 <td>Private method to handle a context menu request.</td>
82 </tr>
83 <tr>
84 <td><a href="#NavigationBar.__goBack">__goBack</a></td>
85 <td>Private slot called to handle the backward button.</td>
86 </tr>
87 <tr>
88 <td><a href="#NavigationBar.__goBackInNewTab">__goBackInNewTab</a></td>
89 <td>Private slot handling a middle click or Ctrl left click of the backward button.</td>
90 </tr>
91 <tr>
92 <td><a href="#NavigationBar.__goForward">__goForward</a></td>
93 <td>Private slot called to handle the forward button.</td>
94 </tr>
95 <tr>
96 <td><a href="#NavigationBar.__goForwardInNewTab">__goForwardInNewTab</a></td>
97 <td>Private slot handling a middle click or Ctrl left click of the forward button.</td>
98 </tr>
99 <tr>
100 <td><a href="#NavigationBar.__goHome">__goHome</a></td>
101 <td>Private slot called to handle the home button.</td>
102 </tr>
103 <tr>
104 <td><a href="#NavigationBar.__goHomeInNewTab">__goHomeInNewTab</a></td>
105 <td>Private slot handling a middle click or Ctrl left click of the home button.</td>
106 </tr>
107 <tr>
108 <td><a href="#NavigationBar.__navigationMenuActionTriggered">__navigationMenuActionTriggered</a></td>
109 <td>Private slot to go to the selected page.</td>
110 </tr>
111 <tr>
112 <td><a href="#NavigationBar.__reload">__reload</a></td>
113 <td>Private slot called to handle the reload button.</td>
114 </tr>
115 <tr>
116 <td><a href="#NavigationBar.__showBackMenu">__showBackMenu</a></td>
117 <td>Private slot showing the backwards navigation menu.</td>
118 </tr>
119 <tr>
120 <td><a href="#NavigationBar.__showForwardMenu">__showForwardMenu</a></td>
121 <td>Private slot showing the forwards navigation menu.</td>
122 </tr>
123 <tr>
124 <td><a href="#NavigationBar.__stopLoad">__stopLoad</a></td>
125 <td>Private slot called to handle loading of the current page.</td>
126 </tr>
127 <tr>
128 <td><a href="#NavigationBar.backButton">backButton</a></td>
129 <td>Public method to get a reference to the back button.</td>
130 </tr>
131 <tr>
132 <td><a href="#NavigationBar.exitFullScreenButton">exitFullScreenButton</a></td>
133 <td>Public method to get a reference to the exit full screen button.</td>
134 </tr>
135 <tr>
136 <td><a href="#NavigationBar.forwardButton">forwardButton</a></td>
137 <td>Public method to get a reference to the forward button.</td>
138 </tr>
139 <tr>
140 <td><a href="#NavigationBar.reloadStopButton">reloadStopButton</a></td>
141 <td>Public method to get a reference to the reload/stop button.</td>
142 </tr>
143 <tr>
144 <td><a href="#NavigationBar.searchEdit">searchEdit</a></td>
145 <td>Public method to get a reference to the web search edit.</td>
146 </tr>
147 <tr>
148 <td><a href="#NavigationBar.superMenuButton">superMenuButton</a></td>
149 <td>Public method to get a reference to the super menu button.</td>
150 </tr>
151 </table>
152 <h3>Static Methods</h3>
153
154 <table>
155 <tr><td>None</td></tr>
156 </table>
157
158 <a NAME="NavigationBar.__init__" ID="NavigationBar.__init__"></a>
159 <h4>NavigationBar (Constructor)</h4>
160 <b>NavigationBar</b>(<i>mainWindow, parent=None</i>)
161
162 <p>
163 Constructor
164 </p>
165 <dl>
166
167 <dt><i>mainWindow</i> (WebBrowserWindow)</dt>
168 <dd>
169 reference to the browser main window
170 </dd>
171 <dt><i>parent</i> (QWidget)</dt>
172 <dd>
173 reference to the parent widget
174 </dd>
175 </dl>
176 <a NAME="NavigationBar.__clearHistory" ID="NavigationBar.__clearHistory"></a>
177 <h4>NavigationBar.__clearHistory</h4>
178 <b>__clearHistory</b>(<i></i>)
179
180 <p>
181 Private slot to clear the history of the current web browser tab.
182 </p>
183 <a NAME="NavigationBar.__contextMenuRequested" ID="NavigationBar.__contextMenuRequested"></a>
184 <h4>NavigationBar.__contextMenuRequested</h4>
185 <b>__contextMenuRequested</b>(<i>pos</i>)
186
187 <p>
188 Private method to handle a context menu request.
189 </p>
190 <dl>
191
192 <dt><i>pos</i> (QPoint)</dt>
193 <dd>
194 position of the request
195 </dd>
196 </dl>
197 <a NAME="NavigationBar.__goBack" ID="NavigationBar.__goBack"></a>
198 <h4>NavigationBar.__goBack</h4>
199 <b>__goBack</b>(<i></i>)
200
201 <p>
202 Private slot called to handle the backward button.
203 </p>
204 <a NAME="NavigationBar.__goBackInNewTab" ID="NavigationBar.__goBackInNewTab"></a>
205 <h4>NavigationBar.__goBackInNewTab</h4>
206 <b>__goBackInNewTab</b>(<i></i>)
207
208 <p>
209 Private slot handling a middle click or Ctrl left click of the
210 backward button.
211 </p>
212 <a NAME="NavigationBar.__goForward" ID="NavigationBar.__goForward"></a>
213 <h4>NavigationBar.__goForward</h4>
214 <b>__goForward</b>(<i></i>)
215
216 <p>
217 Private slot called to handle the forward button.
218 </p>
219 <a NAME="NavigationBar.__goForwardInNewTab" ID="NavigationBar.__goForwardInNewTab"></a>
220 <h4>NavigationBar.__goForwardInNewTab</h4>
221 <b>__goForwardInNewTab</b>(<i></i>)
222
223 <p>
224 Private slot handling a middle click or Ctrl left click of the
225 forward button.
226 </p>
227 <a NAME="NavigationBar.__goHome" ID="NavigationBar.__goHome"></a>
228 <h4>NavigationBar.__goHome</h4>
229 <b>__goHome</b>(<i></i>)
230
231 <p>
232 Private slot called to handle the home button.
233 </p>
234 <a NAME="NavigationBar.__goHomeInNewTab" ID="NavigationBar.__goHomeInNewTab"></a>
235 <h4>NavigationBar.__goHomeInNewTab</h4>
236 <b>__goHomeInNewTab</b>(<i></i>)
237
238 <p>
239 Private slot handling a middle click or Ctrl left click of the
240 home button.
241 </p>
242 <a NAME="NavigationBar.__navigationMenuActionTriggered" ID="NavigationBar.__navigationMenuActionTriggered"></a>
243 <h4>NavigationBar.__navigationMenuActionTriggered</h4>
244 <b>__navigationMenuActionTriggered</b>(<i>act</i>)
245
246 <p>
247 Private slot to go to the selected page.
248 </p>
249 <dl>
250
251 <dt><i>act</i></dt>
252 <dd>
253 reference to the action selected in the navigation menu
254 (QAction)
255 </dd>
256 </dl>
257 <a NAME="NavigationBar.__reload" ID="NavigationBar.__reload"></a>
258 <h4>NavigationBar.__reload</h4>
259 <b>__reload</b>(<i></i>)
260
261 <p>
262 Private slot called to handle the reload button.
263 </p>
264 <a NAME="NavigationBar.__showBackMenu" ID="NavigationBar.__showBackMenu"></a>
265 <h4>NavigationBar.__showBackMenu</h4>
266 <b>__showBackMenu</b>(<i></i>)
267
268 <p>
269 Private slot showing the backwards navigation menu.
270 </p>
271 <a NAME="NavigationBar.__showForwardMenu" ID="NavigationBar.__showForwardMenu"></a>
272 <h4>NavigationBar.__showForwardMenu</h4>
273 <b>__showForwardMenu</b>(<i></i>)
274
275 <p>
276 Private slot showing the forwards navigation menu.
277 </p>
278 <a NAME="NavigationBar.__stopLoad" ID="NavigationBar.__stopLoad"></a>
279 <h4>NavigationBar.__stopLoad</h4>
280 <b>__stopLoad</b>(<i></i>)
281
282 <p>
283 Private slot called to handle loading of the current page.
284 </p>
285 <a NAME="NavigationBar.backButton" ID="NavigationBar.backButton"></a>
286 <h4>NavigationBar.backButton</h4>
287 <b>backButton</b>(<i></i>)
288
289 <p>
290 Public method to get a reference to the back button.
291 </p>
292 <dl>
293 <dt>Return:</dt>
294 <dd>
295 reference to the back button
296 </dd>
297 </dl>
298 <dl>
299 <dt>Return Type:</dt>
300 <dd>
301 QToolButton
302 </dd>
303 </dl>
304 <a NAME="NavigationBar.exitFullScreenButton" ID="NavigationBar.exitFullScreenButton"></a>
305 <h4>NavigationBar.exitFullScreenButton</h4>
306 <b>exitFullScreenButton</b>(<i></i>)
307
308 <p>
309 Public method to get a reference to the exit full screen button.
310 </p>
311 <dl>
312 <dt>Return:</dt>
313 <dd>
314 reference to the exit full screen button
315 </dd>
316 </dl>
317 <dl>
318 <dt>Return Type:</dt>
319 <dd>
320 QToolButton
321 </dd>
322 </dl>
323 <a NAME="NavigationBar.forwardButton" ID="NavigationBar.forwardButton"></a>
324 <h4>NavigationBar.forwardButton</h4>
325 <b>forwardButton</b>(<i></i>)
326
327 <p>
328 Public method to get a reference to the forward button.
329 </p>
330 <dl>
331 <dt>Return:</dt>
332 <dd>
333 reference to the forward button
334 </dd>
335 </dl>
336 <dl>
337 <dt>Return Type:</dt>
338 <dd>
339 QToolButton
340 </dd>
341 </dl>
342 <a NAME="NavigationBar.reloadStopButton" ID="NavigationBar.reloadStopButton"></a>
343 <h4>NavigationBar.reloadStopButton</h4>
344 <b>reloadStopButton</b>(<i></i>)
345
346 <p>
347 Public method to get a reference to the reload/stop button.
348 </p>
349 <dl>
350 <dt>Return:</dt>
351 <dd>
352 reference to the reload/stop button
353 </dd>
354 </dl>
355 <dl>
356 <dt>Return Type:</dt>
357 <dd>
358 QToolButton
359 </dd>
360 </dl>
361 <a NAME="NavigationBar.searchEdit" ID="NavigationBar.searchEdit"></a>
362 <h4>NavigationBar.searchEdit</h4>
363 <b>searchEdit</b>(<i></i>)
364
365 <p>
366 Public method to get a reference to the web search edit.
367 </p>
368 <dl>
369 <dt>Return:</dt>
370 <dd>
371 reference to the web search edit
372 </dd>
373 </dl>
374 <dl>
375 <dt>Return Type:</dt>
376 <dd>
377 WebBrowserWebSearchWidget
378 </dd>
379 </dl>
380 <a NAME="NavigationBar.superMenuButton" ID="NavigationBar.superMenuButton"></a>
381 <h4>NavigationBar.superMenuButton</h4>
382 <b>superMenuButton</b>(<i></i>)
383
384 <p>
385 Public method to get a reference to the super menu button.
386 </p>
387 <dl>
388 <dt>Return:</dt>
389 <dd>
390 reference to the super menu button
391 </dd>
392 </dl>
393 <dl>
394 <dt>Return Type:</dt>
395 <dd>
396 QToolButton
397 </dd>
398 </dl>
399 <div align="right"><a href="#top">Up</a></div>
400 <hr />
401 </body></html>

Mercurial Repository: eric

eric ide

mercurial