Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric4.Helpviewer.HelpWebSearchWidget.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
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>eric4.Helpviewer.HelpWebSearchWidget</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Helpviewer.HelpWebSearchWidget</h1>
24 <p>
25 Module implementing a web search widget for the web browser.
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="#HelpWebSearchWidget">HelpWebSearchWidget</a></td>
35 <td>Class implementing a web search widget for the web browser.</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="HelpWebSearchWidget" ID="HelpWebSearchWidget"></a>
44 <h2>HelpWebSearchWidget</h2>
45 <p>
46 Class implementing a web search widget for the web browser.
47 </p><h4>Signals</h4>
48 <dl>
49 <dt>search(url)</dt>
50 <dd>
51 emitted when the search should be done
52 </dd>
53 </dl>
54 <h3>Derived from</h3>
55 QWidget
56 <h3>Class Attributes</h3>
57 <table>
58 <tr><td>_openSearchManager</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#HelpWebSearchWidget.__init__">HelpWebSearchWidget</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#HelpWebSearchWidget.__addEngineFromUrl">__addEngineFromUrl</a></td>
67 <td>Private slot to add a search engine given it's URL.</td>
68 </tr><tr>
69 <td><a href="#HelpWebSearchWidget.__changeCurrentEngine">__changeCurrentEngine</a></td>
70 <td>Private slot to handle the selection of a search engine.</td>
71 </tr><tr>
72 <td><a href="#HelpWebSearchWidget.__completerActivated">__completerActivated</a></td>
73 <td>Private slot handling the selection of an entry from the completer.</td>
74 </tr><tr>
75 <td><a href="#HelpWebSearchWidget.__completerHighlighted">__completerHighlighted</a></td>
76 <td>Private slot handling the highlighting of an entry of the completer.</td>
77 </tr><tr>
78 <td><a href="#HelpWebSearchWidget.__currentEngineChanged">__currentEngineChanged</a></td>
79 <td>Private slot to track a change of the current search engine.</td>
80 </tr><tr>
81 <td><a href="#HelpWebSearchWidget.__engineImageChanged">__engineImageChanged</a></td>
82 <td>Private slot to handle a change of the current search engine icon.</td>
83 </tr><tr>
84 <td><a href="#HelpWebSearchWidget.__getSuggestions">__getSuggestions</a></td>
85 <td>Private slot to get search suggestions from the configured search engine.</td>
86 </tr><tr>
87 <td><a href="#HelpWebSearchWidget.__loadSearches">__loadSearches</a></td>
88 <td>Public 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.openSearchManager">openSearchManager</a></td>
112 <td>Class method to get a reference to the opensearch manager object.</td>
113 </tr><tr>
114 <td><a href="#HelpWebSearchWidget.preferencesChanged">preferencesChanged</a></td>
115 <td>Public method to handle the change of preferences.</td>
116 </tr><tr>
117 <td><a href="#HelpWebSearchWidget.saveSearches">saveSearches</a></td>
118 <td>Public method to save the recently performed web searches.</td>
119 </tr>
120 </table>
121 <a NAME="HelpWebSearchWidget.__init__" ID="HelpWebSearchWidget.__init__"></a>
122 <h4>HelpWebSearchWidget (Constructor)</h4>
123 <b>HelpWebSearchWidget</b>(<i>parent = None</i>)
124 <p>
125 Constructor
126 </p><dl>
127 <dt><i>inactiveText</i></dt>
128 <dd>
129 text to be shown on inactivity (string)
130 </dd><dt><i>parent</i></dt>
131 <dd>
132 reference to the parent widget (QWidget)
133 </dd>
134 </dl><a NAME="HelpWebSearchWidget.__addEngineFromUrl" ID="HelpWebSearchWidget.__addEngineFromUrl"></a>
135 <h4>HelpWebSearchWidget.__addEngineFromUrl</h4>
136 <b>__addEngineFromUrl</b>(<i></i>)
137 <p>
138 Private slot to add a search engine given it's URL.
139 </p><a NAME="HelpWebSearchWidget.__changeCurrentEngine" ID="HelpWebSearchWidget.__changeCurrentEngine"></a>
140 <h4>HelpWebSearchWidget.__changeCurrentEngine</h4>
141 <b>__changeCurrentEngine</b>(<i></i>)
142 <p>
143 Private slot to handle the selection of a search engine.
144 </p><a NAME="HelpWebSearchWidget.__completerActivated" ID="HelpWebSearchWidget.__completerActivated"></a>
145 <h4>HelpWebSearchWidget.__completerActivated</h4>
146 <b>__completerActivated</b>(<i>index</i>)
147 <p>
148 Private slot handling the selection of an entry from the completer.
149 </p><dl>
150 <dt><i>index</i></dt>
151 <dd>
152 index of the item (QModelIndex)
153 </dd>
154 </dl><a NAME="HelpWebSearchWidget.__completerHighlighted" ID="HelpWebSearchWidget.__completerHighlighted"></a>
155 <h4>HelpWebSearchWidget.__completerHighlighted</h4>
156 <b>__completerHighlighted</b>(<i>index</i>)
157 <p>
158 Private slot handling the highlighting of an entry of the completer.
159 </p><dl>
160 <dt><i>index</i></dt>
161 <dd>
162 index of the item (QModelIndex)
163 </dd>
164 </dl><a NAME="HelpWebSearchWidget.__currentEngineChanged" ID="HelpWebSearchWidget.__currentEngineChanged"></a>
165 <h4>HelpWebSearchWidget.__currentEngineChanged</h4>
166 <b>__currentEngineChanged</b>(<i></i>)
167 <p>
168 Private slot to track a change of the current search engine.
169 </p><a NAME="HelpWebSearchWidget.__engineImageChanged" ID="HelpWebSearchWidget.__engineImageChanged"></a>
170 <h4>HelpWebSearchWidget.__engineImageChanged</h4>
171 <b>__engineImageChanged</b>(<i></i>)
172 <p>
173 Private slot to handle a change of the current search engine icon.
174 </p><a NAME="HelpWebSearchWidget.__getSuggestions" ID="HelpWebSearchWidget.__getSuggestions"></a>
175 <h4>HelpWebSearchWidget.__getSuggestions</h4>
176 <b>__getSuggestions</b>(<i></i>)
177 <p>
178 Private slot to get search suggestions from the configured search engine.
179 </p><a NAME="HelpWebSearchWidget.__loadSearches" ID="HelpWebSearchWidget.__loadSearches"></a>
180 <h4>HelpWebSearchWidget.__loadSearches</h4>
181 <b>__loadSearches</b>(<i></i>)
182 <p>
183 Public method to load the recently performed web searches.
184 </p><a NAME="HelpWebSearchWidget.__newSuggestions" ID="HelpWebSearchWidget.__newSuggestions"></a>
185 <h4>HelpWebSearchWidget.__newSuggestions</h4>
186 <b>__newSuggestions</b>(<i>suggestions</i>)
187 <p>
188 Private slot to receive a new list of suggestions.
189 </p><dl>
190 <dt><i>suggestions</i></dt>
191 <dd>
192 list of suggestions (list of strings)
193 </dd>
194 </dl><a NAME="HelpWebSearchWidget.__searchButtonClicked" ID="HelpWebSearchWidget.__searchButtonClicked"></a>
195 <h4>HelpWebSearchWidget.__searchButtonClicked</h4>
196 <b>__searchButtonClicked</b>(<i></i>)
197 <p>
198 Private slot to show the search menu via the search button.
199 </p><a NAME="HelpWebSearchWidget.__searchNow" ID="HelpWebSearchWidget.__searchNow"></a>
200 <h4>HelpWebSearchWidget.__searchNow</h4>
201 <b>__searchNow</b>(<i></i>)
202 <p>
203 Private slot to perform the web search.
204 </p><a NAME="HelpWebSearchWidget.__setupCompleterMenu" ID="HelpWebSearchWidget.__setupCompleterMenu"></a>
205 <h4>HelpWebSearchWidget.__setupCompleterMenu</h4>
206 <b>__setupCompleterMenu</b>(<i></i>)
207 <p>
208 Private method to create the completer menu.
209 </p><a NAME="HelpWebSearchWidget.__showEnginesMenu" ID="HelpWebSearchWidget.__showEnginesMenu"></a>
210 <h4>HelpWebSearchWidget.__showEnginesMenu</h4>
211 <b>__showEnginesMenu</b>(<i></i>)
212 <p>
213 Private slot to handle the display of the engines menu.
214 </p><a NAME="HelpWebSearchWidget.__textEdited" ID="HelpWebSearchWidget.__textEdited"></a>
215 <h4>HelpWebSearchWidget.__textEdited</h4>
216 <b>__textEdited</b>(<i>txt</i>)
217 <p>
218 Private slot to handle changes of the search text.
219 </p><dl>
220 <dt><i>txt</i></dt>
221 <dd>
222 search text (string)
223 </dd>
224 </dl><a NAME="HelpWebSearchWidget.clear" ID="HelpWebSearchWidget.clear"></a>
225 <h4>HelpWebSearchWidget.clear</h4>
226 <b>clear</b>(<i></i>)
227 <p>
228 Public method to clear all private data.
229 </p><a NAME="HelpWebSearchWidget.openSearchManager" ID="HelpWebSearchWidget.openSearchManager"></a>
230 <h4>HelpWebSearchWidget.openSearchManager</h4>
231 <b>openSearchManager</b>(<i></i>)
232 <p>
233 Class method to get a reference to the opensearch manager object.
234 </p><dl>
235 <dt>Returns:</dt>
236 <dd>
237 reference to the opensearch manager object (OpenSearchManager)
238 </dd>
239 </dl><a NAME="HelpWebSearchWidget.preferencesChanged" ID="HelpWebSearchWidget.preferencesChanged"></a>
240 <h4>HelpWebSearchWidget.preferencesChanged</h4>
241 <b>preferencesChanged</b>(<i></i>)
242 <p>
243 Public method to handle the change of preferences.
244 </p><a NAME="HelpWebSearchWidget.saveSearches" ID="HelpWebSearchWidget.saveSearches"></a>
245 <h4>HelpWebSearchWidget.saveSearches</h4>
246 <b>saveSearches</b>(<i></i>)
247 <p>
248 Public method to save the recently performed web searches.
249 </p>
250 <div align="right"><a href="#top">Up</a></div>
251 <hr />
252 </body></html>

Mercurial Repository: eric

eric ide

mercurial