eric6/Documentation/Source/eric6.Helpviewer.UrlBar.UrlBar.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.UrlBar.UrlBar</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.Helpviewer.UrlBar.UrlBar</h1>
23 <p>
24 Module implementing the URL 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="#UrlBar">UrlBar</a></td>
34 <td>Class implementing a line edit for entering URLs.</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="UrlBar" ID="UrlBar"></a>
43 <h2>UrlBar</h2>
44 <p>
45 Class implementing a line edit for entering URLs.
46 </p>
47 <h3>Derived from</h3>
48 E5LineEdit
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="#UrlBar.__init__">UrlBar</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#UrlBar.__bookmarkChanged">__bookmarkChanged</a></td>
64 <td>Private slot to handle bookmark or speed dial changes.</td>
65 </tr><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><tr>
69 <td><a href="#UrlBar.__checkBookmark">__checkBookmark</a></td>
70 <td>Private slot to check the current URL for the bookmarked state.</td>
71 </tr><tr>
72 <td><a href="#UrlBar.__loadFinished">__loadFinished</a></td>
73 <td>Private slot to set some data after the page was loaded.</td>
74 </tr><tr>
75 <td><a href="#UrlBar.__loadStarted">__loadStarted</a></td>
76 <td>Private slot to perform actions before the page is loaded.</td>
77 </tr><tr>
78 <td><a href="#UrlBar.__privacyClicked">__privacyClicked</a></td>
79 <td>Private slot to handle the click of the private mode button.</td>
80 </tr><tr>
81 <td><a href="#UrlBar.__rssClicked">__rssClicked</a></td>
82 <td>Private slot to handle clicking the RSS icon.</td>
83 </tr><tr>
84 <td><a href="#UrlBar.__showBookmarkInfo">__showBookmarkInfo</a></td>
85 <td>Private slot to show a dialog with some bookmark info.</td>
86 </tr><tr>
87 <td><a href="#UrlBar.__textChanged">__textChanged</a></td>
88 <td>Private slot to handle changes of the text.</td>
89 </tr><tr>
90 <td><a href="#UrlBar.browser">browser</a></td>
91 <td>Public method to get the associated browser.</td>
92 </tr><tr>
93 <td><a href="#UrlBar.dragEnterEvent">dragEnterEvent</a></td>
94 <td>Protected method to handle drag enter events.</td>
95 </tr><tr>
96 <td><a href="#UrlBar.dropEvent">dropEvent</a></td>
97 <td>Protected method to handle drop events.</td>
98 </tr><tr>
99 <td><a href="#UrlBar.focusOutEvent">focusOutEvent</a></td>
100 <td>Protected method to handle focus out event.</td>
101 </tr><tr>
102 <td><a href="#UrlBar.keyPressEvent">keyPressEvent</a></td>
103 <td>Protected method to handle key presses.</td>
104 </tr><tr>
105 <td><a href="#UrlBar.mouseDoubleClickEvent">mouseDoubleClickEvent</a></td>
106 <td>Protected method to handle mouse double click events.</td>
107 </tr><tr>
108 <td><a href="#UrlBar.mousePressEvent">mousePressEvent</a></td>
109 <td>Protected method called by a mouse press event.</td>
110 </tr><tr>
111 <td><a href="#UrlBar.paintEvent">paintEvent</a></td>
112 <td>Protected method handling a paint event.</td>
113 </tr><tr>
114 <td><a href="#UrlBar.preferencesChanged">preferencesChanged</a></td>
115 <td>Public slot to handle a change of preferences.</td>
116 </tr><tr>
117 <td><a href="#UrlBar.setBrowser">setBrowser</a></td>
118 <td>Public method to set the browser connection.</td>
119 </tr><tr>
120 <td><a href="#UrlBar.setPrivateMode">setPrivateMode</a></td>
121 <td>Public method to set the private mode.</td>
122 </tr>
123 </table>
124 <h3>Static Methods</h3>
125 <table>
126 <tr><td>None</td></tr>
127 </table>
128 <a NAME="UrlBar.__init__" ID="UrlBar.__init__"></a>
129 <h4>UrlBar (Constructor)</h4>
130 <b>UrlBar</b>(<i>mainWindow, parent=None</i>)
131 <p>
132 Constructor
133 </p><dl>
134 <dt><i>mainWindow</i></dt>
135 <dd>
136 reference to the main window (HelpWindow)
137 </dd><dt><i>parent</i></dt>
138 <dd>
139 reference to the parent widget (HelpBrowser)
140 </dd>
141 </dl><a NAME="UrlBar.__bookmarkChanged" ID="UrlBar.__bookmarkChanged"></a>
142 <h4>UrlBar.__bookmarkChanged</h4>
143 <b>__bookmarkChanged</b>(<i></i>)
144 <p>
145 Private slot to handle bookmark or speed dial changes.
146 </p><a NAME="UrlBar.__browserUrlChanged" ID="UrlBar.__browserUrlChanged"></a>
147 <h4>UrlBar.__browserUrlChanged</h4>
148 <b>__browserUrlChanged</b>(<i>url</i>)
149 <p>
150 Private slot to handle a URL change of the associated browser.
151 </p><dl>
152 <dt><i>url</i></dt>
153 <dd>
154 new URL of the browser (QUrl)
155 </dd>
156 </dl><a NAME="UrlBar.__checkBookmark" ID="UrlBar.__checkBookmark"></a>
157 <h4>UrlBar.__checkBookmark</h4>
158 <b>__checkBookmark</b>(<i></i>)
159 <p>
160 Private slot to check the current URL for the bookmarked state.
161 </p><a NAME="UrlBar.__loadFinished" ID="UrlBar.__loadFinished"></a>
162 <h4>UrlBar.__loadFinished</h4>
163 <b>__loadFinished</b>(<i>ok</i>)
164 <p>
165 Private slot to set some data after the page was loaded.
166 </p><dl>
167 <dt><i>ok</i></dt>
168 <dd>
169 flag indicating a successful load (boolean)
170 </dd>
171 </dl><a NAME="UrlBar.__loadStarted" ID="UrlBar.__loadStarted"></a>
172 <h4>UrlBar.__loadStarted</h4>
173 <b>__loadStarted</b>(<i></i>)
174 <p>
175 Private slot to perform actions before the page is loaded.
176 </p><a NAME="UrlBar.__privacyClicked" ID="UrlBar.__privacyClicked"></a>
177 <h4>UrlBar.__privacyClicked</h4>
178 <b>__privacyClicked</b>(<i></i>)
179 <p>
180 Private slot to handle the click of the private mode button.
181 </p><a NAME="UrlBar.__rssClicked" ID="UrlBar.__rssClicked"></a>
182 <h4>UrlBar.__rssClicked</h4>
183 <b>__rssClicked</b>(<i></i>)
184 <p>
185 Private slot to handle clicking the RSS icon.
186 </p><a NAME="UrlBar.__showBookmarkInfo" ID="UrlBar.__showBookmarkInfo"></a>
187 <h4>UrlBar.__showBookmarkInfo</h4>
188 <b>__showBookmarkInfo</b>(<i></i>)
189 <p>
190 Private slot to show a dialog with some bookmark info.
191 </p><a NAME="UrlBar.__textChanged" ID="UrlBar.__textChanged"></a>
192 <h4>UrlBar.__textChanged</h4>
193 <b>__textChanged</b>(<i>txt</i>)
194 <p>
195 Private slot to handle changes of the text.
196 </p><dl>
197 <dt><i>txt</i></dt>
198 <dd>
199 current text (string)
200 </dd>
201 </dl><a NAME="UrlBar.browser" ID="UrlBar.browser"></a>
202 <h4>UrlBar.browser</h4>
203 <b>browser</b>(<i></i>)
204 <p>
205 Public method to get the associated browser.
206 </p><dl>
207 <dt>Returns:</dt>
208 <dd>
209 reference to the associated browser (HelpBrowser)
210 </dd>
211 </dl><a NAME="UrlBar.dragEnterEvent" ID="UrlBar.dragEnterEvent"></a>
212 <h4>UrlBar.dragEnterEvent</h4>
213 <b>dragEnterEvent</b>(<i>evt</i>)
214 <p>
215 Protected method to handle drag enter events.
216 </p><dl>
217 <dt><i>evt</i></dt>
218 <dd>
219 reference to the drag enter event (QDragEnterEvent)
220 </dd>
221 </dl><a NAME="UrlBar.dropEvent" ID="UrlBar.dropEvent"></a>
222 <h4>UrlBar.dropEvent</h4>
223 <b>dropEvent</b>(<i>evt</i>)
224 <p>
225 Protected method to handle drop events.
226 </p><dl>
227 <dt><i>evt</i></dt>
228 <dd>
229 reference to the drop event (QDropEvent)
230 </dd>
231 </dl><a NAME="UrlBar.focusOutEvent" ID="UrlBar.focusOutEvent"></a>
232 <h4>UrlBar.focusOutEvent</h4>
233 <b>focusOutEvent</b>(<i>evt</i>)
234 <p>
235 Protected method to handle focus out event.
236 </p><dl>
237 <dt><i>evt</i></dt>
238 <dd>
239 reference to the focus event (QFocusEvent)
240 </dd>
241 </dl><a NAME="UrlBar.keyPressEvent" ID="UrlBar.keyPressEvent"></a>
242 <h4>UrlBar.keyPressEvent</h4>
243 <b>keyPressEvent</b>(<i>evt</i>)
244 <p>
245 Protected method to handle key presses.
246 </p><dl>
247 <dt><i>evt</i></dt>
248 <dd>
249 reference to the key press event (QKeyEvent)
250 </dd>
251 </dl><a NAME="UrlBar.mouseDoubleClickEvent" ID="UrlBar.mouseDoubleClickEvent"></a>
252 <h4>UrlBar.mouseDoubleClickEvent</h4>
253 <b>mouseDoubleClickEvent</b>(<i>evt</i>)
254 <p>
255 Protected method to handle mouse double click events.
256 </p><dl>
257 <dt><i>evt</i></dt>
258 <dd>
259 reference to the mouse event (QMouseEvent)
260 </dd>
261 </dl><a NAME="UrlBar.mousePressEvent" ID="UrlBar.mousePressEvent"></a>
262 <h4>UrlBar.mousePressEvent</h4>
263 <b>mousePressEvent</b>(<i>evt</i>)
264 <p>
265 Protected method called by a mouse press event.
266 </p><dl>
267 <dt><i>evt</i></dt>
268 <dd>
269 reference to the mouse event (QMouseEvent)
270 </dd>
271 </dl><a NAME="UrlBar.paintEvent" ID="UrlBar.paintEvent"></a>
272 <h4>UrlBar.paintEvent</h4>
273 <b>paintEvent</b>(<i>evt</i>)
274 <p>
275 Protected method handling a paint event.
276 </p><dl>
277 <dt><i>evt</i></dt>
278 <dd>
279 reference to the paint event (QPaintEvent)
280 </dd>
281 </dl><a NAME="UrlBar.preferencesChanged" ID="UrlBar.preferencesChanged"></a>
282 <h4>UrlBar.preferencesChanged</h4>
283 <b>preferencesChanged</b>(<i></i>)
284 <p>
285 Public slot to handle a change of preferences.
286 </p><a NAME="UrlBar.setBrowser" ID="UrlBar.setBrowser"></a>
287 <h4>UrlBar.setBrowser</h4>
288 <b>setBrowser</b>(<i>browser</i>)
289 <p>
290 Public method to set the browser connection.
291 </p><dl>
292 <dt><i>browser</i></dt>
293 <dd>
294 reference to the browser widegt (HelpBrowser)
295 </dd>
296 </dl><a NAME="UrlBar.setPrivateMode" ID="UrlBar.setPrivateMode"></a>
297 <h4>UrlBar.setPrivateMode</h4>
298 <b>setPrivateMode</b>(<i>on</i>)
299 <p>
300 Public method to set the private mode.
301 </p><dl>
302 <dt><i>on</i></dt>
303 <dd>
304 flag indicating the privacy state (boolean)
305 </dd>
306 </dl>
307 <div align="right"><a href="#top">Up</a></div>
308 <hr />
309 </body></html>

eric ide

mercurial