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