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

branch
eric7
changeset 10479
856476537696
parent 10436
f6881d10e995
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.Navigation.NavigationBar</h1> 9 <h1>eric7.WebBrowser.Navigation.NavigationBar</h1>
10
11 <p> 10 <p>
12 Module implementing the navigation bar widget. 11 Module implementing the navigation bar widget.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#NavigationBar">NavigationBar</a></td> 22 <td><a href="#NavigationBar">NavigationBar</a></td>
25 <td>Class implementing the navigation bar.</td> 23 <td>Class implementing the navigation bar.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="NavigationBar" ID="NavigationBar"></a> 34 <a NAME="NavigationBar" ID="NavigationBar"></a>
36 <h2>NavigationBar</h2> 35 <h2>NavigationBar</h2>
37
38 <p> 36 <p>
39 Class implementing the navigation bar. 37 Class implementing the navigation bar.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QWidget 41 QWidget
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#NavigationBar.__init__">NavigationBar</a></td> 55 <td><a href="#NavigationBar.__init__">NavigationBar</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
133 <tr> 130 <tr>
134 <td><a href="#NavigationBar.superMenuButton">superMenuButton</a></td> 131 <td><a href="#NavigationBar.superMenuButton">superMenuButton</a></td>
135 <td>Public method to get a reference to the super menu button.</td> 132 <td>Public method to get a reference to the super menu button.</td>
136 </tr> 133 </tr>
137 </table> 134 </table>
135
138 <h3>Static Methods</h3> 136 <h3>Static Methods</h3>
139 137 <table>
140 <table> 138 <tr><td>None</td></tr>
141 <tr><td>None</td></tr> 139 </table>
142 </table> 140
143 141
144 <a NAME="NavigationBar.__init__" ID="NavigationBar.__init__"></a> 142 <a NAME="NavigationBar.__init__" ID="NavigationBar.__init__"></a>
145 <h4>NavigationBar (Constructor)</h4> 143 <h4>NavigationBar (Constructor)</h4>
146 <b>NavigationBar</b>(<i>mainWindow, parent=None</i>) 144 <b>NavigationBar</b>(<i>mainWindow, parent=None</i>)
147
148 <p> 145 <p>
149 Constructor 146 Constructor
150 </p> 147 </p>
148
151 <dl> 149 <dl>
152 150
153 <dt><i>mainWindow</i> (WebBrowserWindow)</dt> 151 <dt><i>mainWindow</i> (WebBrowserWindow)</dt>
154 <dd> 152 <dd>
155 reference to the browser main window 153 reference to the browser main window
160 </dd> 158 </dd>
161 </dl> 159 </dl>
162 <a NAME="NavigationBar.__clearHistory" ID="NavigationBar.__clearHistory"></a> 160 <a NAME="NavigationBar.__clearHistory" ID="NavigationBar.__clearHistory"></a>
163 <h4>NavigationBar.__clearHistory</h4> 161 <h4>NavigationBar.__clearHistory</h4>
164 <b>__clearHistory</b>(<i></i>) 162 <b>__clearHistory</b>(<i></i>)
165
166 <p> 163 <p>
167 Private slot to clear the history of the current web browser tab. 164 Private slot to clear the history of the current web browser tab.
168 </p> 165 </p>
166
169 <a NAME="NavigationBar.__contextMenuRequested" ID="NavigationBar.__contextMenuRequested"></a> 167 <a NAME="NavigationBar.__contextMenuRequested" ID="NavigationBar.__contextMenuRequested"></a>
170 <h4>NavigationBar.__contextMenuRequested</h4> 168 <h4>NavigationBar.__contextMenuRequested</h4>
171 <b>__contextMenuRequested</b>(<i>pos</i>) 169 <b>__contextMenuRequested</b>(<i>pos</i>)
172
173 <p> 170 <p>
174 Private method to handle a context menu request. 171 Private method to handle a context menu request.
175 </p> 172 </p>
173
176 <dl> 174 <dl>
177 175
178 <dt><i>pos</i> (QPoint)</dt> 176 <dt><i>pos</i> (QPoint)</dt>
179 <dd> 177 <dd>
180 position of the request 178 position of the request
181 </dd> 179 </dd>
182 </dl> 180 </dl>
183 <a NAME="NavigationBar.__goBack" ID="NavigationBar.__goBack"></a> 181 <a NAME="NavigationBar.__goBack" ID="NavigationBar.__goBack"></a>
184 <h4>NavigationBar.__goBack</h4> 182 <h4>NavigationBar.__goBack</h4>
185 <b>__goBack</b>(<i></i>) 183 <b>__goBack</b>(<i></i>)
186
187 <p> 184 <p>
188 Private slot called to handle the backward button. 185 Private slot called to handle the backward button.
189 </p> 186 </p>
187
190 <a NAME="NavigationBar.__goBackInNewTab" ID="NavigationBar.__goBackInNewTab"></a> 188 <a NAME="NavigationBar.__goBackInNewTab" ID="NavigationBar.__goBackInNewTab"></a>
191 <h4>NavigationBar.__goBackInNewTab</h4> 189 <h4>NavigationBar.__goBackInNewTab</h4>
192 <b>__goBackInNewTab</b>(<i></i>) 190 <b>__goBackInNewTab</b>(<i></i>)
193
194 <p> 191 <p>
195 Private slot handling a middle click or Ctrl left click of the 192 Private slot handling a middle click or Ctrl left click of the
196 backward button. 193 backward button.
197 </p> 194 </p>
195
198 <a NAME="NavigationBar.__goForward" ID="NavigationBar.__goForward"></a> 196 <a NAME="NavigationBar.__goForward" ID="NavigationBar.__goForward"></a>
199 <h4>NavigationBar.__goForward</h4> 197 <h4>NavigationBar.__goForward</h4>
200 <b>__goForward</b>(<i></i>) 198 <b>__goForward</b>(<i></i>)
201
202 <p> 199 <p>
203 Private slot called to handle the forward button. 200 Private slot called to handle the forward button.
204 </p> 201 </p>
202
205 <a NAME="NavigationBar.__goForwardInNewTab" ID="NavigationBar.__goForwardInNewTab"></a> 203 <a NAME="NavigationBar.__goForwardInNewTab" ID="NavigationBar.__goForwardInNewTab"></a>
206 <h4>NavigationBar.__goForwardInNewTab</h4> 204 <h4>NavigationBar.__goForwardInNewTab</h4>
207 <b>__goForwardInNewTab</b>(<i></i>) 205 <b>__goForwardInNewTab</b>(<i></i>)
208
209 <p> 206 <p>
210 Private slot handling a middle click or Ctrl left click of the 207 Private slot handling a middle click or Ctrl left click of the
211 forward button. 208 forward button.
212 </p> 209 </p>
210
213 <a NAME="NavigationBar.__goHome" ID="NavigationBar.__goHome"></a> 211 <a NAME="NavigationBar.__goHome" ID="NavigationBar.__goHome"></a>
214 <h4>NavigationBar.__goHome</h4> 212 <h4>NavigationBar.__goHome</h4>
215 <b>__goHome</b>(<i></i>) 213 <b>__goHome</b>(<i></i>)
216
217 <p> 214 <p>
218 Private slot called to handle the home button. 215 Private slot called to handle the home button.
219 </p> 216 </p>
217
220 <a NAME="NavigationBar.__goHomeInNewTab" ID="NavigationBar.__goHomeInNewTab"></a> 218 <a NAME="NavigationBar.__goHomeInNewTab" ID="NavigationBar.__goHomeInNewTab"></a>
221 <h4>NavigationBar.__goHomeInNewTab</h4> 219 <h4>NavigationBar.__goHomeInNewTab</h4>
222 <b>__goHomeInNewTab</b>(<i></i>) 220 <b>__goHomeInNewTab</b>(<i></i>)
223
224 <p> 221 <p>
225 Private slot handling a middle click or Ctrl left click of the 222 Private slot handling a middle click or Ctrl left click of the
226 home button. 223 home button.
227 </p> 224 </p>
225
228 <a NAME="NavigationBar.__navigationMenuActionTriggered" ID="NavigationBar.__navigationMenuActionTriggered"></a> 226 <a NAME="NavigationBar.__navigationMenuActionTriggered" ID="NavigationBar.__navigationMenuActionTriggered"></a>
229 <h4>NavigationBar.__navigationMenuActionTriggered</h4> 227 <h4>NavigationBar.__navigationMenuActionTriggered</h4>
230 <b>__navigationMenuActionTriggered</b>(<i>act</i>) 228 <b>__navigationMenuActionTriggered</b>(<i>act</i>)
231
232 <p> 229 <p>
233 Private slot to go to the selected page. 230 Private slot to go to the selected page.
234 </p> 231 </p>
232
235 <dl> 233 <dl>
236 234
237 <dt><i>act</i> (QAction)</dt> 235 <dt><i>act</i> (QAction)</dt>
238 <dd> 236 <dd>
239 reference to the action selected in the navigation menu 237 reference to the action selected in the navigation menu
240 </dd> 238 </dd>
241 </dl> 239 </dl>
242 <a NAME="NavigationBar.__reload" ID="NavigationBar.__reload"></a> 240 <a NAME="NavigationBar.__reload" ID="NavigationBar.__reload"></a>
243 <h4>NavigationBar.__reload</h4> 241 <h4>NavigationBar.__reload</h4>
244 <b>__reload</b>(<i></i>) 242 <b>__reload</b>(<i></i>)
245
246 <p> 243 <p>
247 Private slot called to handle the reload button. 244 Private slot called to handle the reload button.
248 </p> 245 </p>
246
249 <a NAME="NavigationBar.__showBackMenu" ID="NavigationBar.__showBackMenu"></a> 247 <a NAME="NavigationBar.__showBackMenu" ID="NavigationBar.__showBackMenu"></a>
250 <h4>NavigationBar.__showBackMenu</h4> 248 <h4>NavigationBar.__showBackMenu</h4>
251 <b>__showBackMenu</b>(<i></i>) 249 <b>__showBackMenu</b>(<i></i>)
252
253 <p> 250 <p>
254 Private slot showing the backwards navigation menu. 251 Private slot showing the backwards navigation menu.
255 </p> 252 </p>
253
256 <a NAME="NavigationBar.__showForwardMenu" ID="NavigationBar.__showForwardMenu"></a> 254 <a NAME="NavigationBar.__showForwardMenu" ID="NavigationBar.__showForwardMenu"></a>
257 <h4>NavigationBar.__showForwardMenu</h4> 255 <h4>NavigationBar.__showForwardMenu</h4>
258 <b>__showForwardMenu</b>(<i></i>) 256 <b>__showForwardMenu</b>(<i></i>)
259
260 <p> 257 <p>
261 Private slot showing the forwards navigation menu. 258 Private slot showing the forwards navigation menu.
262 </p> 259 </p>
260
263 <a NAME="NavigationBar.__stopLoad" ID="NavigationBar.__stopLoad"></a> 261 <a NAME="NavigationBar.__stopLoad" ID="NavigationBar.__stopLoad"></a>
264 <h4>NavigationBar.__stopLoad</h4> 262 <h4>NavigationBar.__stopLoad</h4>
265 <b>__stopLoad</b>(<i></i>) 263 <b>__stopLoad</b>(<i></i>)
266
267 <p> 264 <p>
268 Private slot called to handle loading of the current page. 265 Private slot called to handle loading of the current page.
269 </p> 266 </p>
267
270 <a NAME="NavigationBar.backButton" ID="NavigationBar.backButton"></a> 268 <a NAME="NavigationBar.backButton" ID="NavigationBar.backButton"></a>
271 <h4>NavigationBar.backButton</h4> 269 <h4>NavigationBar.backButton</h4>
272 <b>backButton</b>(<i></i>) 270 <b>backButton</b>(<i></i>)
273
274 <p> 271 <p>
275 Public method to get a reference to the back button. 272 Public method to get a reference to the back button.
276 </p> 273 </p>
274
277 <dl> 275 <dl>
278 <dt>Return:</dt> 276 <dt>Return:</dt>
279 <dd> 277 <dd>
280 reference to the back button 278 reference to the back button
281 </dd> 279 </dd>
287 </dd> 285 </dd>
288 </dl> 286 </dl>
289 <a NAME="NavigationBar.exitFullScreenButton" ID="NavigationBar.exitFullScreenButton"></a> 287 <a NAME="NavigationBar.exitFullScreenButton" ID="NavigationBar.exitFullScreenButton"></a>
290 <h4>NavigationBar.exitFullScreenButton</h4> 288 <h4>NavigationBar.exitFullScreenButton</h4>
291 <b>exitFullScreenButton</b>(<i></i>) 289 <b>exitFullScreenButton</b>(<i></i>)
292
293 <p> 290 <p>
294 Public method to get a reference to the exit full screen button. 291 Public method to get a reference to the exit full screen button.
295 </p> 292 </p>
293
296 <dl> 294 <dl>
297 <dt>Return:</dt> 295 <dt>Return:</dt>
298 <dd> 296 <dd>
299 reference to the exit full screen button 297 reference to the exit full screen button
300 </dd> 298 </dd>
306 </dd> 304 </dd>
307 </dl> 305 </dl>
308 <a NAME="NavigationBar.forwardButton" ID="NavigationBar.forwardButton"></a> 306 <a NAME="NavigationBar.forwardButton" ID="NavigationBar.forwardButton"></a>
309 <h4>NavigationBar.forwardButton</h4> 307 <h4>NavigationBar.forwardButton</h4>
310 <b>forwardButton</b>(<i></i>) 308 <b>forwardButton</b>(<i></i>)
311
312 <p> 309 <p>
313 Public method to get a reference to the forward button. 310 Public method to get a reference to the forward button.
314 </p> 311 </p>
312
315 <dl> 313 <dl>
316 <dt>Return:</dt> 314 <dt>Return:</dt>
317 <dd> 315 <dd>
318 reference to the forward button 316 reference to the forward button
319 </dd> 317 </dd>
325 </dd> 323 </dd>
326 </dl> 324 </dl>
327 <a NAME="NavigationBar.reloadStopButton" ID="NavigationBar.reloadStopButton"></a> 325 <a NAME="NavigationBar.reloadStopButton" ID="NavigationBar.reloadStopButton"></a>
328 <h4>NavigationBar.reloadStopButton</h4> 326 <h4>NavigationBar.reloadStopButton</h4>
329 <b>reloadStopButton</b>(<i></i>) 327 <b>reloadStopButton</b>(<i></i>)
330
331 <p> 328 <p>
332 Public method to get a reference to the reload/stop button. 329 Public method to get a reference to the reload/stop button.
333 </p> 330 </p>
331
334 <dl> 332 <dl>
335 <dt>Return:</dt> 333 <dt>Return:</dt>
336 <dd> 334 <dd>
337 reference to the reload/stop button 335 reference to the reload/stop button
338 </dd> 336 </dd>
344 </dd> 342 </dd>
345 </dl> 343 </dl>
346 <a NAME="NavigationBar.searchEdit" ID="NavigationBar.searchEdit"></a> 344 <a NAME="NavigationBar.searchEdit" ID="NavigationBar.searchEdit"></a>
347 <h4>NavigationBar.searchEdit</h4> 345 <h4>NavigationBar.searchEdit</h4>
348 <b>searchEdit</b>(<i></i>) 346 <b>searchEdit</b>(<i></i>)
349
350 <p> 347 <p>
351 Public method to get a reference to the web search edit. 348 Public method to get a reference to the web search edit.
352 </p> 349 </p>
350
353 <dl> 351 <dl>
354 <dt>Return:</dt> 352 <dt>Return:</dt>
355 <dd> 353 <dd>
356 reference to the web search edit 354 reference to the web search edit
357 </dd> 355 </dd>
363 </dd> 361 </dd>
364 </dl> 362 </dl>
365 <a NAME="NavigationBar.superMenuButton" ID="NavigationBar.superMenuButton"></a> 363 <a NAME="NavigationBar.superMenuButton" ID="NavigationBar.superMenuButton"></a>
366 <h4>NavigationBar.superMenuButton</h4> 364 <h4>NavigationBar.superMenuButton</h4>
367 <b>superMenuButton</b>(<i></i>) 365 <b>superMenuButton</b>(<i></i>)
368
369 <p> 366 <p>
370 Public method to get a reference to the super menu button. 367 Public method to get a reference to the super menu button.
371 </p> 368 </p>
369
372 <dl> 370 <dl>
373 <dt>Return:</dt> 371 <dt>Return:</dt>
374 <dd> 372 <dd>
375 reference to the super menu button 373 reference to the super menu button
376 </dd> 374 </dd>

eric ide

mercurial