Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Helpviewer.HelpWebSearchWidget.html

Documentation/Source/eric6.Helpviewer.HelpWebSearchWidget.html

changeset 3673
e26d7d0c1088
child 6123
39cd368143db
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.HelpWebSearchWidget</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.HelpWebSearchWidget</h1>
23 <p>
24 Module implementing a web search widget for the web browser.
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="#HelpWebSearchWidget">HelpWebSearchWidget</a></td>
34 <td>Class implementing a web search widget for the web browser.</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="HelpWebSearchWidget" ID="HelpWebSearchWidget"></a>
43 <h2>HelpWebSearchWidget</h2>
44 <p>
45 Class implementing a web search widget for the web browser.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>search(QUrl)</dt>
49 <dd>
50 emitted when the search should be done
51 </dd>
52 </dl>
53 <h3>Derived from</h3>
54 E5ClearableLineEdit
55 <h3>Class Attributes</h3>
56 <table>
57 <tr><td>None</td></tr>
58 </table>
59 <h3>Class Methods</h3>
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Methods</h3>
64 <table>
65 <tr>
66 <td><a href="#HelpWebSearchWidget.__init__">HelpWebSearchWidget</a></td>
67 <td>Constructor</td>
68 </tr><tr>
69 <td><a href="#HelpWebSearchWidget.__addEngineFromUrl">__addEngineFromUrl</a></td>
70 <td>Private slot to add a search engine given its URL.</td>
71 </tr><tr>
72 <td><a href="#HelpWebSearchWidget.__changeCurrentEngine">__changeCurrentEngine</a></td>
73 <td>Private slot to handle the selection of a search engine.</td>
74 </tr><tr>
75 <td><a href="#HelpWebSearchWidget.__completerActivated">__completerActivated</a></td>
76 <td>Private slot handling the selection of an entry from the completer.</td>
77 </tr><tr>
78 <td><a href="#HelpWebSearchWidget.__completerHighlighted">__completerHighlighted</a></td>
79 <td>Private slot handling the highlighting of an entry of the completer.</td>
80 </tr><tr>
81 <td><a href="#HelpWebSearchWidget.__currentEngineChanged">__currentEngineChanged</a></td>
82 <td>Private slot to track a change of the current search engine.</td>
83 </tr><tr>
84 <td><a href="#HelpWebSearchWidget.__engineImageChanged">__engineImageChanged</a></td>
85 <td>Private slot to handle a change of the current search engine icon.</td>
86 </tr><tr>
87 <td><a href="#HelpWebSearchWidget.__getSuggestions">__getSuggestions</a></td>
88 <td>Private slot to get search suggestions from the configured search engine.</td>
89 </tr><tr>
90 <td><a href="#HelpWebSearchWidget.__loadSearches">__loadSearches</a></td>
91 <td>Private method to load the recently performed web searches.</td>
92 </tr><tr>
93 <td><a href="#HelpWebSearchWidget.__newSuggestions">__newSuggestions</a></td>
94 <td>Private slot to receive a new list of suggestions.</td>
95 </tr><tr>
96 <td><a href="#HelpWebSearchWidget.__searchButtonClicked">__searchButtonClicked</a></td>
97 <td>Private slot to show the search menu via the search button.</td>
98 </tr><tr>
99 <td><a href="#HelpWebSearchWidget.__searchNow">__searchNow</a></td>
100 <td>Private slot to perform the web search.</td>
101 </tr><tr>
102 <td><a href="#HelpWebSearchWidget.__setupCompleterMenu">__setupCompleterMenu</a></td>
103 <td>Private method to create the completer menu.</td>
104 </tr><tr>
105 <td><a href="#HelpWebSearchWidget.__showEnginesMenu">__showEnginesMenu</a></td>
106 <td>Private slot to handle the display of the engines menu.</td>
107 </tr><tr>
108 <td><a href="#HelpWebSearchWidget.__textEdited">__textEdited</a></td>
109 <td>Private slot to handle changes of the search text.</td>
110 </tr><tr>
111 <td><a href="#HelpWebSearchWidget.clear">clear</a></td>
112 <td>Public method to clear all private data.</td>
113 </tr><tr>
114 <td><a href="#HelpWebSearchWidget.mousePressEvent">mousePressEvent</a></td>
115 <td>Protected method called by a mouse press event.</td>
116 </tr><tr>
117 <td><a href="#HelpWebSearchWidget.openSearchManager">openSearchManager</a></td>
118 <td>Public method to get a reference to the opensearch manager object.</td>
119 </tr><tr>
120 <td><a href="#HelpWebSearchWidget.preferencesChanged">preferencesChanged</a></td>
121 <td>Public method to handle the change of preferences.</td>
122 </tr><tr>
123 <td><a href="#HelpWebSearchWidget.saveSearches">saveSearches</a></td>
124 <td>Public method to save the recently performed web searches.</td>
125 </tr>
126 </table>
127 <h3>Static Methods</h3>
128 <table>
129 <tr><td>None</td></tr>
130 </table>
131 <a NAME="HelpWebSearchWidget.__init__" ID="HelpWebSearchWidget.__init__"></a>
132 <h4>HelpWebSearchWidget (Constructor)</h4>
133 <b>HelpWebSearchWidget</b>(<i>parent=None</i>)
134 <p>
135 Constructor
136 </p><dl>
137 <dt><i>parent</i></dt>
138 <dd>
139 reference to the parent widget (QWidget)
140 </dd>
141 </dl><a NAME="HelpWebSearchWidget.__addEngineFromUrl" ID="HelpWebSearchWidget.__addEngineFromUrl"></a>
142 <h4>HelpWebSearchWidget.__addEngineFromUrl</h4>
143 <b>__addEngineFromUrl</b>(<i></i>)
144 <p>
145 Private slot to add a search engine given its URL.
146 </p><a NAME="HelpWebSearchWidget.__changeCurrentEngine" ID="HelpWebSearchWidget.__changeCurrentEngine"></a>
147 <h4>HelpWebSearchWidget.__changeCurrentEngine</h4>
148 <b>__changeCurrentEngine</b>(<i></i>)
149 <p>
150 Private slot to handle the selection of a search engine.
151 </p><a NAME="HelpWebSearchWidget.__completerActivated" ID="HelpWebSearchWidget.__completerActivated"></a>
152 <h4>HelpWebSearchWidget.__completerActivated</h4>
153 <b>__completerActivated</b>(<i>index</i>)
154 <p>
155 Private slot handling the selection of an entry from the completer.
156 </p><dl>
157 <dt><i>index</i></dt>
158 <dd>
159 index of the item (QModelIndex)
160 </dd>
161 </dl><a NAME="HelpWebSearchWidget.__completerHighlighted" ID="HelpWebSearchWidget.__completerHighlighted"></a>
162 <h4>HelpWebSearchWidget.__completerHighlighted</h4>
163 <b>__completerHighlighted</b>(<i>index</i>)
164 <p>
165 Private slot handling the highlighting of an entry of the completer.
166 </p><dl>
167 <dt><i>index</i></dt>
168 <dd>
169 index of the item (QModelIndex)
170 </dd>
171 </dl><dl>
172 <dt>Returns:</dt>
173 <dd>
174 flah indicating a successful highlighting (boolean)
175 </dd>
176 </dl><a NAME="HelpWebSearchWidget.__currentEngineChanged" ID="HelpWebSearchWidget.__currentEngineChanged"></a>
177 <h4>HelpWebSearchWidget.__currentEngineChanged</h4>
178 <b>__currentEngineChanged</b>(<i></i>)
179 <p>
180 Private slot to track a change of the current search engine.
181 </p><a NAME="HelpWebSearchWidget.__engineImageChanged" ID="HelpWebSearchWidget.__engineImageChanged"></a>
182 <h4>HelpWebSearchWidget.__engineImageChanged</h4>
183 <b>__engineImageChanged</b>(<i></i>)
184 <p>
185 Private slot to handle a change of the current search engine icon.
186 </p><a NAME="HelpWebSearchWidget.__getSuggestions" ID="HelpWebSearchWidget.__getSuggestions"></a>
187 <h4>HelpWebSearchWidget.__getSuggestions</h4>
188 <b>__getSuggestions</b>(<i></i>)
189 <p>
190 Private slot to get search suggestions from the configured search
191 engine.
192 </p><a NAME="HelpWebSearchWidget.__loadSearches" ID="HelpWebSearchWidget.__loadSearches"></a>
193 <h4>HelpWebSearchWidget.__loadSearches</h4>
194 <b>__loadSearches</b>(<i></i>)
195 <p>
196 Private method to load the recently performed web searches.
197 </p><a NAME="HelpWebSearchWidget.__newSuggestions" ID="HelpWebSearchWidget.__newSuggestions"></a>
198 <h4>HelpWebSearchWidget.__newSuggestions</h4>
199 <b>__newSuggestions</b>(<i>suggestions</i>)
200 <p>
201 Private slot to receive a new list of suggestions.
202 </p><dl>
203 <dt><i>suggestions</i></dt>
204 <dd>
205 list of suggestions (list of strings)
206 </dd>
207 </dl><a NAME="HelpWebSearchWidget.__searchButtonClicked" ID="HelpWebSearchWidget.__searchButtonClicked"></a>
208 <h4>HelpWebSearchWidget.__searchButtonClicked</h4>
209 <b>__searchButtonClicked</b>(<i></i>)
210 <p>
211 Private slot to show the search menu via the search button.
212 </p><a NAME="HelpWebSearchWidget.__searchNow" ID="HelpWebSearchWidget.__searchNow"></a>
213 <h4>HelpWebSearchWidget.__searchNow</h4>
214 <b>__searchNow</b>(<i></i>)
215 <p>
216 Private slot to perform the web search.
217 </p><a NAME="HelpWebSearchWidget.__setupCompleterMenu" ID="HelpWebSearchWidget.__setupCompleterMenu"></a>
218 <h4>HelpWebSearchWidget.__setupCompleterMenu</h4>
219 <b>__setupCompleterMenu</b>(<i></i>)
220 <p>
221 Private method to create the completer menu.
222 </p><a NAME="HelpWebSearchWidget.__showEnginesMenu" ID="HelpWebSearchWidget.__showEnginesMenu"></a>
223 <h4>HelpWebSearchWidget.__showEnginesMenu</h4>
224 <b>__showEnginesMenu</b>(<i></i>)
225 <p>
226 Private slot to handle the display of the engines menu.
227 </p><a NAME="HelpWebSearchWidget.__textEdited" ID="HelpWebSearchWidget.__textEdited"></a>
228 <h4>HelpWebSearchWidget.__textEdited</h4>
229 <b>__textEdited</b>(<i>txt</i>)
230 <p>
231 Private slot to handle changes of the search text.
232 </p><dl>
233 <dt><i>txt</i></dt>
234 <dd>
235 search text (string)
236 </dd>
237 </dl><a NAME="HelpWebSearchWidget.clear" ID="HelpWebSearchWidget.clear"></a>
238 <h4>HelpWebSearchWidget.clear</h4>
239 <b>clear</b>(<i></i>)
240 <p>
241 Public method to clear all private data.
242 </p><a NAME="HelpWebSearchWidget.mousePressEvent" ID="HelpWebSearchWidget.mousePressEvent"></a>
243 <h4>HelpWebSearchWidget.mousePressEvent</h4>
244 <b>mousePressEvent</b>(<i>evt</i>)
245 <p>
246 Protected method called by a mouse press event.
247 </p><dl>
248 <dt><i>evt</i></dt>
249 <dd>
250 reference to the mouse event (QMouseEvent)
251 </dd>
252 </dl><a NAME="HelpWebSearchWidget.openSearchManager" ID="HelpWebSearchWidget.openSearchManager"></a>
253 <h4>HelpWebSearchWidget.openSearchManager</h4>
254 <b>openSearchManager</b>(<i></i>)
255 <p>
256 Public method to get a reference to the opensearch manager object.
257 </p><dl>
258 <dt>Returns:</dt>
259 <dd>
260 reference to the opensearch manager object (OpenSearchManager)
261 </dd>
262 </dl><a NAME="HelpWebSearchWidget.preferencesChanged" ID="HelpWebSearchWidget.preferencesChanged"></a>
263 <h4>HelpWebSearchWidget.preferencesChanged</h4>
264 <b>preferencesChanged</b>(<i></i>)
265 <p>
266 Public method to handle the change of preferences.
267 </p><a NAME="HelpWebSearchWidget.saveSearches" ID="HelpWebSearchWidget.saveSearches"></a>
268 <h4>HelpWebSearchWidget.saveSearches</h4>
269 <b>saveSearches</b>(<i></i>)
270 <p>
271 Public method to save the recently performed web searches.
272 </p>
273 <div align="right"><a href="#top">Up</a></div>
274 <hr />
275 </body></html>

Mercurial Repository: eric

eric ide

mercurial