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

changeset 5722
433187e73c0f
child 5734
d8b99b5fa673
equal deleted inserted replaced
5721:b4d0cddecd64 5722:433187e73c0f
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.__goBack">__goBack</a></td>
67 <td>Private slot called to handle the backward button.</td>
68 </tr><tr>
69 <td><a href="#NavigationBar.__goForward">__goForward</a></td>
70 <td>Private slot called to handle the forward button.</td>
71 </tr><tr>
72 <td><a href="#NavigationBar.__goHome">__goHome</a></td>
73 <td>Private slot called to handle the home button.</td>
74 </tr><tr>
75 <td><a href="#NavigationBar.__navigationMenuActionTriggered">__navigationMenuActionTriggered</a></td>
76 <td>Private slot to go to the selected page.</td>
77 </tr><tr>
78 <td><a href="#NavigationBar.__reload">__reload</a></td>
79 <td>Private slot called to handle the reload button.</td>
80 </tr><tr>
81 <td><a href="#NavigationBar.__showBackMenu">__showBackMenu</a></td>
82 <td>Private slot showing the backwards navigation menu.</td>
83 </tr><tr>
84 <td><a href="#NavigationBar.__showForwardMenu">__showForwardMenu</a></td>
85 <td>Private slot showing the forwards navigation menu.</td>
86 </tr><tr>
87 <td><a href="#NavigationBar.__stopLoad">__stopLoad</a></td>
88 <td>Private slot called to handle loading of the current page.</td>
89 </tr><tr>
90 <td><a href="#NavigationBar.backButton">backButton</a></td>
91 <td>Public method to get a reference to the back button.</td>
92 </tr><tr>
93 <td><a href="#NavigationBar.exitFullScreenButton">exitFullScreenButton</a></td>
94 <td>Public method to get a reference to the exit full screen button.</td>
95 </tr><tr>
96 <td><a href="#NavigationBar.forwardButton">forwardButton</a></td>
97 <td>Public method to get a reference to the forward button.</td>
98 </tr><tr>
99 <td><a href="#NavigationBar.reloadButton">reloadButton</a></td>
100 <td>Public method to get a reference to the reload button.</td>
101 </tr><tr>
102 <td><a href="#NavigationBar.searchEdit">searchEdit</a></td>
103 <td>Public method to get a reference to the web search edit.</td>
104 </tr><tr>
105 <td><a href="#NavigationBar.stopButton">stopButton</a></td>
106 <td>Public method to get a reference to the stop button.</td>
107 </tr>
108 </table>
109 <h3>Static Methods</h3>
110 <table>
111 <tr><td>None</td></tr>
112 </table>
113 <a NAME="NavigationBar.__init__" ID="NavigationBar.__init__"></a>
114 <h4>NavigationBar (Constructor)</h4>
115 <b>NavigationBar</b>(<i>mainWindow, parent=None</i>)
116 <p>
117 Constructor
118 </p><dl>
119 <dt><i>mainWindow</i> (WebBrowserWindow)</dt>
120 <dd>
121 reference to the browser main window
122 </dd><dt><i>parent</i> (QWidget)</dt>
123 <dd>
124 reference to the parent widget
125 </dd>
126 </dl><a NAME="NavigationBar.__clearHistory" ID="NavigationBar.__clearHistory"></a>
127 <h4>NavigationBar.__clearHistory</h4>
128 <b>__clearHistory</b>(<i></i>)
129 <p>
130 Private slot to clear the history of the current web browser tab.
131 </p><a NAME="NavigationBar.__goBack" ID="NavigationBar.__goBack"></a>
132 <h4>NavigationBar.__goBack</h4>
133 <b>__goBack</b>(<i></i>)
134 <p>
135 Private slot called to handle the backward button.
136 </p><a NAME="NavigationBar.__goForward" ID="NavigationBar.__goForward"></a>
137 <h4>NavigationBar.__goForward</h4>
138 <b>__goForward</b>(<i></i>)
139 <p>
140 Private slot called to handle the forward button.
141 </p><a NAME="NavigationBar.__goHome" ID="NavigationBar.__goHome"></a>
142 <h4>NavigationBar.__goHome</h4>
143 <b>__goHome</b>(<i></i>)
144 <p>
145 Private slot called to handle the home button.
146 </p><a NAME="NavigationBar.__navigationMenuActionTriggered" ID="NavigationBar.__navigationMenuActionTriggered"></a>
147 <h4>NavigationBar.__navigationMenuActionTriggered</h4>
148 <b>__navigationMenuActionTriggered</b>(<i>act</i>)
149 <p>
150 Private slot to go to the selected page.
151 </p><dl>
152 <dt><i>act</i></dt>
153 <dd>
154 reference to the action selected in the navigation menu
155 (QAction)
156 </dd>
157 </dl><a NAME="NavigationBar.__reload" ID="NavigationBar.__reload"></a>
158 <h4>NavigationBar.__reload</h4>
159 <b>__reload</b>(<i></i>)
160 <p>
161 Private slot called to handle the reload button.
162 </p><a NAME="NavigationBar.__showBackMenu" ID="NavigationBar.__showBackMenu"></a>
163 <h4>NavigationBar.__showBackMenu</h4>
164 <b>__showBackMenu</b>(<i></i>)
165 <p>
166 Private slot showing the backwards navigation menu.
167 </p><a NAME="NavigationBar.__showForwardMenu" ID="NavigationBar.__showForwardMenu"></a>
168 <h4>NavigationBar.__showForwardMenu</h4>
169 <b>__showForwardMenu</b>(<i></i>)
170 <p>
171 Private slot showing the forwards navigation menu.
172 </p><a NAME="NavigationBar.__stopLoad" ID="NavigationBar.__stopLoad"></a>
173 <h4>NavigationBar.__stopLoad</h4>
174 <b>__stopLoad</b>(<i></i>)
175 <p>
176 Private slot called to handle loading of the current page.
177 </p><a NAME="NavigationBar.backButton" ID="NavigationBar.backButton"></a>
178 <h4>NavigationBar.backButton</h4>
179 <b>backButton</b>(<i></i>)
180 <p>
181 Public method to get a reference to the back button.
182 </p><dl>
183 <dt>Returns:</dt>
184 <dd>
185 reference to the back button
186 </dd>
187 </dl><dl>
188 <dt>Return Type:</dt>
189 <dd>
190 QToolButton
191 </dd>
192 </dl><a NAME="NavigationBar.exitFullScreenButton" ID="NavigationBar.exitFullScreenButton"></a>
193 <h4>NavigationBar.exitFullScreenButton</h4>
194 <b>exitFullScreenButton</b>(<i></i>)
195 <p>
196 Public method to get a reference to the exit full screen button.
197 </p><dl>
198 <dt>Returns:</dt>
199 <dd>
200 reference to the exit full screen button
201 </dd>
202 </dl><dl>
203 <dt>Return Type:</dt>
204 <dd>
205 QToolButton
206 </dd>
207 </dl><a NAME="NavigationBar.forwardButton" ID="NavigationBar.forwardButton"></a>
208 <h4>NavigationBar.forwardButton</h4>
209 <b>forwardButton</b>(<i></i>)
210 <p>
211 Public method to get a reference to the forward button.
212 </p><dl>
213 <dt>Returns:</dt>
214 <dd>
215 reference to the forward button
216 </dd>
217 </dl><dl>
218 <dt>Return Type:</dt>
219 <dd>
220 QToolButton
221 </dd>
222 </dl><a NAME="NavigationBar.reloadButton" ID="NavigationBar.reloadButton"></a>
223 <h4>NavigationBar.reloadButton</h4>
224 <b>reloadButton</b>(<i></i>)
225 <p>
226 Public method to get a reference to the reload button.
227 </p><dl>
228 <dt>Returns:</dt>
229 <dd>
230 reference to the reload button
231 </dd>
232 </dl><dl>
233 <dt>Return Type:</dt>
234 <dd>
235 QToolButton
236 </dd>
237 </dl><a NAME="NavigationBar.searchEdit" ID="NavigationBar.searchEdit"></a>
238 <h4>NavigationBar.searchEdit</h4>
239 <b>searchEdit</b>(<i></i>)
240 <p>
241 Public method to get a reference to the web search edit.
242 </p><dl>
243 <dt>Returns:</dt>
244 <dd>
245 reference to the web search edit
246 </dd>
247 </dl><dl>
248 <dt>Return Type:</dt>
249 <dd>
250 WebBrowserWebSearchWidget
251 </dd>
252 </dl><a NAME="NavigationBar.stopButton" ID="NavigationBar.stopButton"></a>
253 <h4>NavigationBar.stopButton</h4>
254 <b>stopButton</b>(<i></i>)
255 <p>
256 Public method to get a reference to the stop button.
257 </p><dl>
258 <dt>Returns:</dt>
259 <dd>
260 reference to the stop button
261 </dd>
262 </dl><dl>
263 <dt>Return Type:</dt>
264 <dd>
265 QToolButton
266 </dd>
267 </dl>
268 <div align="right"><a href="#top">Up</a></div>
269 <hr />
270 </body></html>

eric ide

mercurial