Mercurial Repositories > eric / file comparison

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

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

changeset 6942
2602857055c5
parent 6176
8927e74527bc
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
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.__completerActivated">__completerActivated</a></td>
70 <td>Private slot handling the selection of an entry from the completer.</td>
71 </tr><tr>
72 <td><a href="#HelpWebSearchWidget.__completerHighlighted">__completerHighlighted</a></td>
73 <td>Private slot handling the highlighting of an entry of the completer.</td>
74 </tr><tr>
75 <td><a href="#HelpWebSearchWidget.__currentEngineChanged">__currentEngineChanged</a></td>
76 <td>Private slot to track a change of the current search engine.</td>
77 </tr><tr>
78 <td><a href="#HelpWebSearchWidget.__engineImageChanged">__engineImageChanged</a></td>
79 <td>Private slot to handle a change of the current search engine icon.</td>
80 </tr><tr>
81 <td><a href="#HelpWebSearchWidget.__getSuggestions">__getSuggestions</a></td>
82 <td>Private slot to get search suggestions from the configured search engine.</td>
83 </tr><tr>
84 <td><a href="#HelpWebSearchWidget.__handleEnginesMenuActionTriggered">__handleEnginesMenuActionTriggered</a></td>
85 <td>Private slot to handle an action of the menu being triggered.</td>
86 </tr><tr>
87 <td><a href="#HelpWebSearchWidget.__loadSearches">__loadSearches</a></td>
88 <td>Private method to load the recently performed web searches.</td>
89 </tr><tr>
90 <td><a href="#HelpWebSearchWidget.__newSuggestions">__newSuggestions</a></td>
91 <td>Private slot to receive a new list of suggestions.</td>
92 </tr><tr>
93 <td><a href="#HelpWebSearchWidget.__searchButtonClicked">__searchButtonClicked</a></td>
94 <td>Private slot to show the search menu via the search button.</td>
95 </tr><tr>
96 <td><a href="#HelpWebSearchWidget.__searchNow">__searchNow</a></td>
97 <td>Private slot to perform the web search.</td>
98 </tr><tr>
99 <td><a href="#HelpWebSearchWidget.__setupCompleterMenu">__setupCompleterMenu</a></td>
100 <td>Private method to create the completer menu.</td>
101 </tr><tr>
102 <td><a href="#HelpWebSearchWidget.__showEnginesMenu">__showEnginesMenu</a></td>
103 <td>Private slot to handle the display of the engines menu.</td>
104 </tr><tr>
105 <td><a href="#HelpWebSearchWidget.__textEdited">__textEdited</a></td>
106 <td>Private slot to handle changes of the search text.</td>
107 </tr><tr>
108 <td><a href="#HelpWebSearchWidget.clear">clear</a></td>
109 <td>Public method to clear all private data.</td>
110 </tr><tr>
111 <td><a href="#HelpWebSearchWidget.mousePressEvent">mousePressEvent</a></td>
112 <td>Protected method called by a mouse press event.</td>
113 </tr><tr>
114 <td><a href="#HelpWebSearchWidget.openSearchManager">openSearchManager</a></td>
115 <td>Public method to get a reference to the opensearch manager object.</td>
116 </tr><tr>
117 <td><a href="#HelpWebSearchWidget.preferencesChanged">preferencesChanged</a></td>
118 <td>Public method to handle the change of preferences.</td>
119 </tr><tr>
120 <td><a href="#HelpWebSearchWidget.saveSearches">saveSearches</a></td>
121 <td>Public method to save the recently performed web searches.</td>
122 </tr>
123 </table>
124 <h3>Static Methods</h3>
125 <table>
126 <tr><td>None</td></tr>
127 </table>
128 <a NAME="HelpWebSearchWidget.__init__" ID="HelpWebSearchWidget.__init__"></a>
129 <h4>HelpWebSearchWidget (Constructor)</h4>
130 <b>HelpWebSearchWidget</b>(<i>parent=None</i>)
131 <p>
132 Constructor
133 </p><dl>
134 <dt><i>parent</i></dt>
135 <dd>
136 reference to the parent widget (QWidget)
137 </dd>
138 </dl><a NAME="HelpWebSearchWidget.__completerActivated" ID="HelpWebSearchWidget.__completerActivated"></a>
139 <h4>HelpWebSearchWidget.__completerActivated</h4>
140 <b>__completerActivated</b>(<i>index</i>)
141 <p>
142 Private slot handling the selection of an entry from the completer.
143 </p><dl>
144 <dt><i>index</i></dt>
145 <dd>
146 index of the item (QModelIndex)
147 </dd>
148 </dl><a NAME="HelpWebSearchWidget.__completerHighlighted" ID="HelpWebSearchWidget.__completerHighlighted"></a>
149 <h4>HelpWebSearchWidget.__completerHighlighted</h4>
150 <b>__completerHighlighted</b>(<i>index</i>)
151 <p>
152 Private slot handling the highlighting of an entry of the completer.
153 </p><dl>
154 <dt><i>index</i></dt>
155 <dd>
156 index of the item (QModelIndex)
157 </dd>
158 </dl><dl>
159 <dt>Returns:</dt>
160 <dd>
161 flah indicating a successful highlighting (boolean)
162 </dd>
163 </dl><a NAME="HelpWebSearchWidget.__currentEngineChanged" ID="HelpWebSearchWidget.__currentEngineChanged"></a>
164 <h4>HelpWebSearchWidget.__currentEngineChanged</h4>
165 <b>__currentEngineChanged</b>(<i></i>)
166 <p>
167 Private slot to track a change of the current search engine.
168 </p><a NAME="HelpWebSearchWidget.__engineImageChanged" ID="HelpWebSearchWidget.__engineImageChanged"></a>
169 <h4>HelpWebSearchWidget.__engineImageChanged</h4>
170 <b>__engineImageChanged</b>(<i></i>)
171 <p>
172 Private slot to handle a change of the current search engine icon.
173 </p><a NAME="HelpWebSearchWidget.__getSuggestions" ID="HelpWebSearchWidget.__getSuggestions"></a>
174 <h4>HelpWebSearchWidget.__getSuggestions</h4>
175 <b>__getSuggestions</b>(<i></i>)
176 <p>
177 Private slot to get search suggestions from the configured search
178 engine.
179 </p><a NAME="HelpWebSearchWidget.__handleEnginesMenuActionTriggered" ID="HelpWebSearchWidget.__handleEnginesMenuActionTriggered"></a>
180 <h4>HelpWebSearchWidget.__handleEnginesMenuActionTriggered</h4>
181 <b>__handleEnginesMenuActionTriggered</b>(<i>action</i>)
182 <p>
183 Private slot to handle an action of the menu being triggered.
184 </p><dl>
185 <dt><i>action</i> (QAction)</dt>
186 <dd>
187 reference to the action that triggered
188 </dd>
189 </dl><a NAME="HelpWebSearchWidget.__loadSearches" ID="HelpWebSearchWidget.__loadSearches"></a>
190 <h4>HelpWebSearchWidget.__loadSearches</h4>
191 <b>__loadSearches</b>(<i></i>)
192 <p>
193 Private method to load the recently performed web searches.
194 </p><a NAME="HelpWebSearchWidget.__newSuggestions" ID="HelpWebSearchWidget.__newSuggestions"></a>
195 <h4>HelpWebSearchWidget.__newSuggestions</h4>
196 <b>__newSuggestions</b>(<i>suggestions</i>)
197 <p>
198 Private slot to receive a new list of suggestions.
199 </p><dl>
200 <dt><i>suggestions</i></dt>
201 <dd>
202 list of suggestions (list of strings)
203 </dd>
204 </dl><a NAME="HelpWebSearchWidget.__searchButtonClicked" ID="HelpWebSearchWidget.__searchButtonClicked"></a>
205 <h4>HelpWebSearchWidget.__searchButtonClicked</h4>
206 <b>__searchButtonClicked</b>(<i></i>)
207 <p>
208 Private slot to show the search menu via the search button.
209 </p><a NAME="HelpWebSearchWidget.__searchNow" ID="HelpWebSearchWidget.__searchNow"></a>
210 <h4>HelpWebSearchWidget.__searchNow</h4>
211 <b>__searchNow</b>(<i></i>)
212 <p>
213 Private slot to perform the web search.
214 </p><a NAME="HelpWebSearchWidget.__setupCompleterMenu" ID="HelpWebSearchWidget.__setupCompleterMenu"></a>
215 <h4>HelpWebSearchWidget.__setupCompleterMenu</h4>
216 <b>__setupCompleterMenu</b>(<i></i>)
217 <p>
218 Private method to create the completer menu.
219 </p><a NAME="HelpWebSearchWidget.__showEnginesMenu" ID="HelpWebSearchWidget.__showEnginesMenu"></a>
220 <h4>HelpWebSearchWidget.__showEnginesMenu</h4>
221 <b>__showEnginesMenu</b>(<i></i>)
222 <p>
223 Private slot to handle the display of the engines menu.
224 </p><a NAME="HelpWebSearchWidget.__textEdited" ID="HelpWebSearchWidget.__textEdited"></a>
225 <h4>HelpWebSearchWidget.__textEdited</h4>
226 <b>__textEdited</b>(<i>txt</i>)
227 <p>
228 Private slot to handle changes of the search text.
229 </p><dl>
230 <dt><i>txt</i></dt>
231 <dd>
232 search text (string)
233 </dd>
234 </dl><a NAME="HelpWebSearchWidget.clear" ID="HelpWebSearchWidget.clear"></a>
235 <h4>HelpWebSearchWidget.clear</h4>
236 <b>clear</b>(<i></i>)
237 <p>
238 Public method to clear all private data.
239 </p><a NAME="HelpWebSearchWidget.mousePressEvent" ID="HelpWebSearchWidget.mousePressEvent"></a>
240 <h4>HelpWebSearchWidget.mousePressEvent</h4>
241 <b>mousePressEvent</b>(<i>evt</i>)
242 <p>
243 Protected method called by a mouse press event.
244 </p><dl>
245 <dt><i>evt</i></dt>
246 <dd>
247 reference to the mouse event (QMouseEvent)
248 </dd>
249 </dl><a NAME="HelpWebSearchWidget.openSearchManager" ID="HelpWebSearchWidget.openSearchManager"></a>
250 <h4>HelpWebSearchWidget.openSearchManager</h4>
251 <b>openSearchManager</b>(<i></i>)
252 <p>
253 Public method to get a reference to the opensearch manager object.
254 </p><dl>
255 <dt>Returns:</dt>
256 <dd>
257 reference to the opensearch manager object (OpenSearchManager)
258 </dd>
259 </dl><a NAME="HelpWebSearchWidget.preferencesChanged" ID="HelpWebSearchWidget.preferencesChanged"></a>
260 <h4>HelpWebSearchWidget.preferencesChanged</h4>
261 <b>preferencesChanged</b>(<i></i>)
262 <p>
263 Public method to handle the change of preferences.
264 </p><a NAME="HelpWebSearchWidget.saveSearches" ID="HelpWebSearchWidget.saveSearches"></a>
265 <h4>HelpWebSearchWidget.saveSearches</h4>
266 <b>saveSearches</b>(<i></i>)
267 <p>
268 Public method to save the recently performed web searches.
269 </p>
270 <div align="right"><a href="#top">Up</a></div>
271 <hr />
272 </body></html>

Mercurial Repository: eric

eric ide

mercurial