|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.Helpviewer.UrlBar.UrlBar</title> |
|
6 <style> |
|
7 body { |
|
8 background: #EDECE6; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #85774A; } |
|
14 h2 { color: white; background: #85774A; } |
|
15 h3 { color: white; background: #9D936E; } |
|
16 h4 { color: white; background: #9D936E; } |
|
17 |
|
18 a { color: #BA6D36; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>eric5.Helpviewer.UrlBar.UrlBar</h1> |
|
24 <p> |
|
25 Module implementing the URL bar widget. |
|
26 </p> |
|
27 <h3>Global Attributes</h3> |
|
28 <table> |
|
29 <tr><td>None</td></tr> |
|
30 </table> |
|
31 <h3>Classes</h3> |
|
32 <table> |
|
33 <tr> |
|
34 <td><a href="#UrlBar">UrlBar</a></td> |
|
35 <td>Class implementing a line edit for entering URLs.</td> |
|
36 </tr> |
|
37 </table> |
|
38 <h3>Functions</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <hr /><hr /> |
|
43 <a NAME="UrlBar" ID="UrlBar"></a> |
|
44 <h2>UrlBar</h2> |
|
45 <p> |
|
46 Class implementing a line edit for entering URLs. |
|
47 </p> |
|
48 <h3>Derived from</h3> |
|
49 E5LineEdit |
|
50 <h3>Class Attributes</h3> |
|
51 <table> |
|
52 <tr><td>None</td></tr> |
|
53 </table> |
|
54 <h3>Methods</h3> |
|
55 <table> |
|
56 <tr> |
|
57 <td><a href="#UrlBar.__init__">UrlBar</a></td> |
|
58 <td>Constructor</td> |
|
59 </tr><tr> |
|
60 <td><a href="#UrlBar.__browserUrlChanged">__browserUrlChanged</a></td> |
|
61 <td>Private slot to handle a URL change of the associated browser.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#UrlBar.__privacyClicked">__privacyClicked</a></td> |
|
64 <td>Private slot to handle the click of the private mode button.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#UrlBar.__textChanged">__textChanged</a></td> |
|
67 <td>Private slot to handle changes of the text.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#UrlBar.browser">browser</a></td> |
|
70 <td>Public method to get the associated browser (HelpBrowser)</td> |
|
71 </tr><tr> |
|
72 <td><a href="#UrlBar.dragEnterEvent">dragEnterEvent</a></td> |
|
73 <td>Protected method to handle drag enter events.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#UrlBar.dropEvent">dropEvent</a></td> |
|
76 <td>Protected method to handle drop events.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#UrlBar.focusOutEvent">focusOutEvent</a></td> |
|
79 <td>Protected method to handle focus out event.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#UrlBar.keyPressEvent">keyPressEvent</a></td> |
|
82 <td>Protected method to handle key presses.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#UrlBar.mouseDoubleClickEvent">mouseDoubleClickEvent</a></td> |
|
85 <td>Protected method to handle mouse double click events.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#UrlBar.paintEvent">paintEvent</a></td> |
|
88 <td>Protected method handling a paint event.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#UrlBar.preferencesChanged">preferencesChanged</a></td> |
|
91 <td>Public slot to handle a change of preferences.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#UrlBar.setBrowser">setBrowser</a></td> |
|
94 <td>Public method to set the browser connection.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#UrlBar.setPrivateMode">setPrivateMode</a></td> |
|
97 <td>Public method to set the private mode.</td> |
|
98 </tr> |
|
99 </table> |
|
100 <a NAME="UrlBar.__init__" ID="UrlBar.__init__"></a> |
|
101 <h4>UrlBar (Constructor)</h4> |
|
102 <b>UrlBar</b>(<i>mainWindow, parent = None</i>) |
|
103 <p> |
|
104 Constructor |
|
105 </p><dl> |
|
106 <dt><i>mainWindow</i></dt> |
|
107 <dd> |
|
108 reference to the main window (HelpWindow) |
|
109 </dd><dt><i>parent</i></dt> |
|
110 <dd> |
|
111 reference to the parent widget (HelpBrowser) |
|
112 </dd> |
|
113 </dl><a NAME="UrlBar.__browserUrlChanged" ID="UrlBar.__browserUrlChanged"></a> |
|
114 <h4>UrlBar.__browserUrlChanged</h4> |
|
115 <b>__browserUrlChanged</b>(<i>url</i>) |
|
116 <p> |
|
117 Private slot to handle a URL change of the associated browser. |
|
118 </p><dl> |
|
119 <dt><i>url</i></dt> |
|
120 <dd> |
|
121 new URL of the browser (QUrl) |
|
122 </dd> |
|
123 </dl><a NAME="UrlBar.__privacyClicked" ID="UrlBar.__privacyClicked"></a> |
|
124 <h4>UrlBar.__privacyClicked</h4> |
|
125 <b>__privacyClicked</b>(<i></i>) |
|
126 <p> |
|
127 Private slot to handle the click of the private mode button. |
|
128 </p><a NAME="UrlBar.__textChanged" ID="UrlBar.__textChanged"></a> |
|
129 <h4>UrlBar.__textChanged</h4> |
|
130 <b>__textChanged</b>(<i>txt</i>) |
|
131 <p> |
|
132 Private slot to handle changes of the text. |
|
133 </p><dl> |
|
134 <dt><i>txt</i></dt> |
|
135 <dd> |
|
136 current text (string) |
|
137 </dd> |
|
138 </dl><a NAME="UrlBar.browser" ID="UrlBar.browser"></a> |
|
139 <h4>UrlBar.browser</h4> |
|
140 <b>browser</b>(<i></i>) |
|
141 <p> |
|
142 Public method to get the associated browser (HelpBrowser) |
|
143 </p><a NAME="UrlBar.dragEnterEvent" ID="UrlBar.dragEnterEvent"></a> |
|
144 <h4>UrlBar.dragEnterEvent</h4> |
|
145 <b>dragEnterEvent</b>(<i>evt</i>) |
|
146 <p> |
|
147 Protected method to handle drag enter events. |
|
148 </p><dl> |
|
149 <dt><i>evt</i></dt> |
|
150 <dd> |
|
151 reference to the drag enter event (QDragEnterEvent) |
|
152 </dd> |
|
153 </dl><a NAME="UrlBar.dropEvent" ID="UrlBar.dropEvent"></a> |
|
154 <h4>UrlBar.dropEvent</h4> |
|
155 <b>dropEvent</b>(<i>evt</i>) |
|
156 <p> |
|
157 Protected method to handle drop events. |
|
158 </p><dl> |
|
159 <dt><i>evt</i></dt> |
|
160 <dd> |
|
161 reference to the drop event (QDropEvent) |
|
162 </dd> |
|
163 </dl><a NAME="UrlBar.focusOutEvent" ID="UrlBar.focusOutEvent"></a> |
|
164 <h4>UrlBar.focusOutEvent</h4> |
|
165 <b>focusOutEvent</b>(<i>evt</i>) |
|
166 <p> |
|
167 Protected method to handle focus out event. |
|
168 </p><dl> |
|
169 <dt><i>evt</i></dt> |
|
170 <dd> |
|
171 reference to the focus event (QFocusEvent) |
|
172 </dd> |
|
173 </dl><a NAME="UrlBar.keyPressEvent" ID="UrlBar.keyPressEvent"></a> |
|
174 <h4>UrlBar.keyPressEvent</h4> |
|
175 <b>keyPressEvent</b>(<i>evt</i>) |
|
176 <p> |
|
177 Protected method to handle key presses. |
|
178 </p><dl> |
|
179 <dt><i>evt</i></dt> |
|
180 <dd> |
|
181 reference to the key press event (QKeyEvent) |
|
182 </dd> |
|
183 </dl><a NAME="UrlBar.mouseDoubleClickEvent" ID="UrlBar.mouseDoubleClickEvent"></a> |
|
184 <h4>UrlBar.mouseDoubleClickEvent</h4> |
|
185 <b>mouseDoubleClickEvent</b>(<i>evt</i>) |
|
186 <p> |
|
187 Protected method to handle mouse double click events. |
|
188 </p><dl> |
|
189 <dt><i>evt</i></dt> |
|
190 <dd> |
|
191 reference to the mouse event (QMouseEvent) |
|
192 </dd> |
|
193 </dl><a NAME="UrlBar.paintEvent" ID="UrlBar.paintEvent"></a> |
|
194 <h4>UrlBar.paintEvent</h4> |
|
195 <b>paintEvent</b>(<i>evt</i>) |
|
196 <p> |
|
197 Protected method handling a paint event. |
|
198 </p><dl> |
|
199 <dt><i>evt</i></dt> |
|
200 <dd> |
|
201 reference to the paint event (QPaintEvent) |
|
202 </dd> |
|
203 </dl><a NAME="UrlBar.preferencesChanged" ID="UrlBar.preferencesChanged"></a> |
|
204 <h4>UrlBar.preferencesChanged</h4> |
|
205 <b>preferencesChanged</b>(<i></i>) |
|
206 <p> |
|
207 Public slot to handle a change of preferences. |
|
208 </p><a NAME="UrlBar.setBrowser" ID="UrlBar.setBrowser"></a> |
|
209 <h4>UrlBar.setBrowser</h4> |
|
210 <b>setBrowser</b>(<i>browser</i>) |
|
211 <p> |
|
212 Public method to set the browser connection. |
|
213 </p><dl> |
|
214 <dt><i>browser</i></dt> |
|
215 <dd> |
|
216 reference to the browser widegt (HelpBrowser) |
|
217 </dd> |
|
218 </dl><a NAME="UrlBar.setPrivateMode" ID="UrlBar.setPrivateMode"></a> |
|
219 <h4>UrlBar.setPrivateMode</h4> |
|
220 <b>setPrivateMode</b>(<i>on</i>) |
|
221 <p> |
|
222 Public method to set the private mode. |
|
223 </p><dl> |
|
224 <dt><i>on</i></dt> |
|
225 <dd> |
|
226 flag indicating the privacy state (boolean) |
|
227 </dd> |
|
228 </dl> |
|
229 <div align="right"><a href="#top">Up</a></div> |
|
230 <hr /> |
|
231 </body></html> |