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

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.Navigation.NavigationBar</h1>
23 <p>
24 Module implementing the navigation bar widget.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#NavigationBar">NavigationBar</a></td>
34 <td>Class implementing the navigation bar.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="NavigationBar" ID="NavigationBar"></a>
43 <h2>NavigationBar</h2>
44 <p>
45 Class implementing the navigation bar.
46 </p>
47 <h3>Derived from</h3>
48 QWidget
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#NavigationBar.__init__">NavigationBar</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#NavigationBar.__clearHistory">__clearHistory</a></td>
64 <td>Private slot to clear the history of the current web browser tab.</td>
65 </tr><tr>
66 <td><a href="#NavigationBar.__contextMenuRequested">__contextMenuRequested</a></td>
67 <td>Private method to handle a context menu request.</td>
68 </tr><tr>
69 <td><a href="#NavigationBar.__goBack">__goBack</a></td>
70 <td>Private slot called to handle the backward button.</td>
71 </tr><tr>
72 <td><a href="#NavigationBar.__goBackInNewTab">__goBackInNewTab</a></td>
73 <td>Private slot handling a middle click or Ctrl left click of the backward button.</td>
74 </tr><tr>
75 <td><a href="#NavigationBar.__goForward">__goForward</a></td>
76 <td>Private slot called to handle the forward button.</td>
77 </tr><tr>
78 <td><a href="#NavigationBar.__goForwardInNewTab">__goForwardInNewTab</a></td>
79 <td>Private slot handling a middle click or Ctrl left click of the forward button.</td>
80 </tr><tr>
81 <td><a href="#NavigationBar.__goHome">__goHome</a></td>
82 <td>Private slot called to handle the home button.</td>
83 </tr><tr>
84 <td><a href="#NavigationBar.__goHomeInNewTab">__goHomeInNewTab</a></td>
85 <td>Private slot handling a middle click or Ctrl left click of the home button.</td>
86 </tr><tr>
87 <td><a href="#NavigationBar.__navigationMenuActionTriggered">__navigationMenuActionTriggered</a></td>
88 <td>Private slot to go to the selected page.</td>
89 </tr><tr>
90 <td><a href="#NavigationBar.__reload">__reload</a></td>
91 <td>Private slot called to handle the reload button.</td>
92 </tr><tr>
93 <td><a href="#NavigationBar.__showBackMenu">__showBackMenu</a></td>
94 <td>Private slot showing the backwards navigation menu.</td>
95 </tr><tr>
96 <td><a href="#NavigationBar.__showForwardMenu">__showForwardMenu</a></td>
97 <td>Private slot showing the forwards navigation menu.</td>
98 </tr><tr>
99 <td><a href="#NavigationBar.__stopLoad">__stopLoad</a></td>
100 <td>Private slot called to handle loading of the current page.</td>
101 </tr><tr>
102 <td><a href="#NavigationBar.backButton">backButton</a></td>
103 <td>Public method to get a reference to the back button.</td>
104 </tr><tr>
105 <td><a href="#NavigationBar.exitFullScreenButton">exitFullScreenButton</a></td>
106 <td>Public method to get a reference to the exit full screen button.</td>
107 </tr><tr>
108 <td><a href="#NavigationBar.forwardButton">forwardButton</a></td>
109 <td>Public method to get a reference to the forward button.</td>
110 </tr><tr>
111 <td><a href="#NavigationBar.reloadStopButton">reloadStopButton</a></td>
112 <td>Public method to get a reference to the reload/stop button.</td>
113 </tr><tr>
114 <td><a href="#NavigationBar.searchEdit">searchEdit</a></td>
115 <td>Public method to get a reference to the web search edit.</td>
116 </tr><tr>
117 <td><a href="#NavigationBar.superMenuButton">superMenuButton</a></td>
118 <td>Public method to get a reference to the super menu button.</td>
119 </tr>
120 </table>
121 <h3>Static Methods</h3>
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125 <a NAME="NavigationBar.__init__" ID="NavigationBar.__init__"></a>
126 <h4>NavigationBar (Constructor)</h4>
127 <b>NavigationBar</b>(<i>mainWindow, parent=None</i>)
128 <p>
129 Constructor
130 </p><dl>
131 <dt><i>mainWindow</i> (WebBrowserWindow)</dt>
132 <dd>
133 reference to the browser main window
134 </dd><dt><i>parent</i> (QWidget)</dt>
135 <dd>
136 reference to the parent widget
137 </dd>
138 </dl><a NAME="NavigationBar.__clearHistory" ID="NavigationBar.__clearHistory"></a>
139 <h4>NavigationBar.__clearHistory</h4>
140 <b>__clearHistory</b>(<i></i>)
141 <p>
142 Private slot to clear the history of the current web browser tab.
143 </p><a NAME="NavigationBar.__contextMenuRequested" ID="NavigationBar.__contextMenuRequested"></a>
144 <h4>NavigationBar.__contextMenuRequested</h4>
145 <b>__contextMenuRequested</b>(<i>pos</i>)
146 <p>
147 Private method to handle a context menu request.
148 </p><dl>
149 <dt><i>pos</i> (QPoint)</dt>
150 <dd>
151 position of the request
152 </dd>
153 </dl><a NAME="NavigationBar.__goBack" ID="NavigationBar.__goBack"></a>
154 <h4>NavigationBar.__goBack</h4>
155 <b>__goBack</b>(<i></i>)
156 <p>
157 Private slot called to handle the backward button.
158 </p><a NAME="NavigationBar.__goBackInNewTab" ID="NavigationBar.__goBackInNewTab"></a>
159 <h4>NavigationBar.__goBackInNewTab</h4>
160 <b>__goBackInNewTab</b>(<i></i>)
161 <p>
162 Private slot handling a middle click or Ctrl left click of the
163 backward button.
164 </p><a NAME="NavigationBar.__goForward" ID="NavigationBar.__goForward"></a>
165 <h4>NavigationBar.__goForward</h4>
166 <b>__goForward</b>(<i></i>)
167 <p>
168 Private slot called to handle the forward button.
169 </p><a NAME="NavigationBar.__goForwardInNewTab" ID="NavigationBar.__goForwardInNewTab"></a>
170 <h4>NavigationBar.__goForwardInNewTab</h4>
171 <b>__goForwardInNewTab</b>(<i></i>)
172 <p>
173 Private slot handling a middle click or Ctrl left click of the
174 forward button.
175 </p><a NAME="NavigationBar.__goHome" ID="NavigationBar.__goHome"></a>
176 <h4>NavigationBar.__goHome</h4>
177 <b>__goHome</b>(<i></i>)
178 <p>
179 Private slot called to handle the home button.
180 </p><a NAME="NavigationBar.__goHomeInNewTab" ID="NavigationBar.__goHomeInNewTab"></a>
181 <h4>NavigationBar.__goHomeInNewTab</h4>
182 <b>__goHomeInNewTab</b>(<i></i>)
183 <p>
184 Private slot handling a middle click or Ctrl left click of the
185 home button.
186 </p><a NAME="NavigationBar.__navigationMenuActionTriggered" ID="NavigationBar.__navigationMenuActionTriggered"></a>
187 <h4>NavigationBar.__navigationMenuActionTriggered</h4>
188 <b>__navigationMenuActionTriggered</b>(<i>act</i>)
189 <p>
190 Private slot to go to the selected page.
191 </p><dl>
192 <dt><i>act</i></dt>
193 <dd>
194 reference to the action selected in the navigation menu
195 (QAction)
196 </dd>
197 </dl><a NAME="NavigationBar.__reload" ID="NavigationBar.__reload"></a>
198 <h4>NavigationBar.__reload</h4>
199 <b>__reload</b>(<i></i>)
200 <p>
201 Private slot called to handle the reload button.
202 </p><a NAME="NavigationBar.__showBackMenu" ID="NavigationBar.__showBackMenu"></a>
203 <h4>NavigationBar.__showBackMenu</h4>
204 <b>__showBackMenu</b>(<i></i>)
205 <p>
206 Private slot showing the backwards navigation menu.
207 </p><a NAME="NavigationBar.__showForwardMenu" ID="NavigationBar.__showForwardMenu"></a>
208 <h4>NavigationBar.__showForwardMenu</h4>
209 <b>__showForwardMenu</b>(<i></i>)
210 <p>
211 Private slot showing the forwards navigation menu.
212 </p><a NAME="NavigationBar.__stopLoad" ID="NavigationBar.__stopLoad"></a>
213 <h4>NavigationBar.__stopLoad</h4>
214 <b>__stopLoad</b>(<i></i>)
215 <p>
216 Private slot called to handle loading of the current page.
217 </p><a NAME="NavigationBar.backButton" ID="NavigationBar.backButton"></a>
218 <h4>NavigationBar.backButton</h4>
219 <b>backButton</b>(<i></i>)
220 <p>
221 Public method to get a reference to the back button.
222 </p><dl>
223 <dt>Returns:</dt>
224 <dd>
225 reference to the back button
226 </dd>
227 </dl><dl>
228 <dt>Return Type:</dt>
229 <dd>
230 QToolButton
231 </dd>
232 </dl><a NAME="NavigationBar.exitFullScreenButton" ID="NavigationBar.exitFullScreenButton"></a>
233 <h4>NavigationBar.exitFullScreenButton</h4>
234 <b>exitFullScreenButton</b>(<i></i>)
235 <p>
236 Public method to get a reference to the exit full screen button.
237 </p><dl>
238 <dt>Returns:</dt>
239 <dd>
240 reference to the exit full screen button
241 </dd>
242 </dl><dl>
243 <dt>Return Type:</dt>
244 <dd>
245 QToolButton
246 </dd>
247 </dl><a NAME="NavigationBar.forwardButton" ID="NavigationBar.forwardButton"></a>
248 <h4>NavigationBar.forwardButton</h4>
249 <b>forwardButton</b>(<i></i>)
250 <p>
251 Public method to get a reference to the forward button.
252 </p><dl>
253 <dt>Returns:</dt>
254 <dd>
255 reference to the forward button
256 </dd>
257 </dl><dl>
258 <dt>Return Type:</dt>
259 <dd>
260 QToolButton
261 </dd>
262 </dl><a NAME="NavigationBar.reloadStopButton" ID="NavigationBar.reloadStopButton"></a>
263 <h4>NavigationBar.reloadStopButton</h4>
264 <b>reloadStopButton</b>(<i></i>)
265 <p>
266 Public method to get a reference to the reload/stop button.
267 </p><dl>
268 <dt>Returns:</dt>
269 <dd>
270 reference to the reload/stop button
271 </dd>
272 </dl><dl>
273 <dt>Return Type:</dt>
274 <dd>
275 QToolButton
276 </dd>
277 </dl><a NAME="NavigationBar.searchEdit" ID="NavigationBar.searchEdit"></a>
278 <h4>NavigationBar.searchEdit</h4>
279 <b>searchEdit</b>(<i></i>)
280 <p>
281 Public method to get a reference to the web search edit.
282 </p><dl>
283 <dt>Returns:</dt>
284 <dd>
285 reference to the web search edit
286 </dd>
287 </dl><dl>
288 <dt>Return Type:</dt>
289 <dd>
290 WebBrowserWebSearchWidget
291 </dd>
292 </dl><a NAME="NavigationBar.superMenuButton" ID="NavigationBar.superMenuButton"></a>
293 <h4>NavigationBar.superMenuButton</h4>
294 <b>superMenuButton</b>(<i></i>)
295 <p>
296 Public method to get a reference to the super menu button.
297 </p><dl>
298 <dt>Returns:</dt>
299 <dd>
300 reference to the super menu button
301 </dd>
302 </dl><dl>
303 <dt>Return Type:</dt>
304 <dd>
305 QToolButton
306 </dd>
307 </dl>
308 <div align="right"><a href="#top">Up</a></div>
309 <hr />
310 </body></html>

eric ide

mercurial