Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpSearchWidget.html
eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpSearchWidget.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.WebBrowser.QtHelp.HelpSearchWidget</h1> | 23 <h1>eric6.WebBrowser.QtHelp.HelpSearchWidget</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a window for showing the QtHelp index. | 26 Module implementing a window for showing the QtHelp index. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 31 <table> | 34 |
| 35 <table> | |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#HelpSearchWidget">HelpSearchWidget</a></td> | 38 <td><a href="#HelpSearchWidget">HelpSearchWidget</a></td> |
| 34 <td>Class implementing a window for showing the QtHelp index.</td> | 39 <td>Class implementing a window for showing the QtHelp index.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 38 <table> | 43 |
| 39 <tr><td>None</td></tr> | 44 <table> |
| 40 </table> | 45 <tr><td>None</td></tr> |
| 41 <hr /><hr /> | 46 </table> |
| 47 <hr /> | |
| 48 <hr /> | |
| 42 <a NAME="HelpSearchWidget" ID="HelpSearchWidget"></a> | 49 <a NAME="HelpSearchWidget" ID="HelpSearchWidget"></a> |
| 43 <h2>HelpSearchWidget</h2> | 50 <h2>HelpSearchWidget</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing a window for showing the QtHelp index. | 53 Class implementing a window for showing the QtHelp index. |
| 46 </p><h3>Signals</h3> | 54 </p> |
| 47 <dl> | 55 <h3>Signals</h3> |
| 56 <dl> | |
| 57 | |
| 48 <dt>escapePressed()</dt> | 58 <dt>escapePressed()</dt> |
| 49 <dd> | 59 <dd> |
| 50 emitted when the ESC key was pressed | 60 emitted when the ESC key was pressed |
| 51 </dd><dt>newBackgroundTab(QUrl, str)</dt> | 61 </dd> |
| 62 <dt>newBackgroundTab(QUrl, str)</dt> | |
| 52 <dd> | 63 <dd> |
| 53 emitted to open a search result entry | 64 emitted to open a search result entry |
| 54 in a new background tab | 65 in a new background tab |
| 55 </dd><dt>newTab(QUrl, str)</dt> | 66 </dd> |
| 67 <dt>newTab(QUrl, str)</dt> | |
| 56 <dd> | 68 <dd> |
| 57 emitted to open a search result entry in a | 69 emitted to open a search result entry in a |
| 58 new tab | 70 new tab |
| 59 </dd><dt>newWindow(QUrl, str)</dt> | 71 </dd> |
| 72 <dt>newWindow(QUrl, str)</dt> | |
| 60 <dd> | 73 <dd> |
| 61 emitted to open a search result entry in a | 74 emitted to open a search result entry in a |
| 62 new window | 75 new window |
| 63 </dd><dt>openUrl(QUrl, str)</dt> | 76 </dd> |
| 77 <dt>openUrl(QUrl, str)</dt> | |
| 64 <dd> | 78 <dd> |
| 65 emitted to open a search result entry in the | 79 emitted to open a search result entry in the |
| 66 current tab | 80 current tab |
| 67 </dd> | 81 </dd> |
| 68 </dl> | 82 </dl> |
| 69 <h3>Derived from</h3> | 83 <h3>Derived from</h3> |
| 70 QWidget | 84 QWidget |
| 71 <h3>Class Attributes</h3> | 85 <h3>Class Attributes</h3> |
| 86 | |
| 72 <table> | 87 <table> |
| 73 <tr><td>None</td></tr> | 88 <tr><td>None</td></tr> |
| 74 </table> | 89 </table> |
| 75 <h3>Class Methods</h3> | 90 <h3>Class Methods</h3> |
| 91 | |
| 76 <table> | 92 <table> |
| 77 <tr><td>None</td></tr> | 93 <tr><td>None</td></tr> |
| 78 </table> | 94 </table> |
| 79 <h3>Methods</h3> | 95 <h3>Methods</h3> |
| 80 <table> | 96 |
| 97 <table> | |
| 98 | |
| 81 <tr> | 99 <tr> |
| 82 <td><a href="#HelpSearchWidget.__init__">HelpSearchWidget</a></td> | 100 <td><a href="#HelpSearchWidget.__init__">HelpSearchWidget</a></td> |
| 83 <td>Constructor</td> | 101 <td>Constructor</td> |
| 84 </tr><tr> | 102 </tr> |
| 103 <tr> | |
| 85 <td><a href="#HelpSearchWidget.__linkActivated">__linkActivated</a></td> | 104 <td><a href="#HelpSearchWidget.__linkActivated">__linkActivated</a></td> |
| 86 <td>Private slot handling the activation of an entry.</td> | 105 <td>Private slot handling the activation of an entry.</td> |
| 87 </tr><tr> | 106 </tr> |
| 107 <tr> | |
| 88 <td><a href="#HelpSearchWidget.__search">__search</a></td> | 108 <td><a href="#HelpSearchWidget.__search">__search</a></td> |
| 89 <td>Private slot to perform a search of the database.</td> | 109 <td>Private slot to perform a search of the database.</td> |
| 90 </tr><tr> | 110 </tr> |
| 111 <tr> | |
| 91 <td><a href="#HelpSearchWidget.__searchingFinished">__searchingFinished</a></td> | 112 <td><a href="#HelpSearchWidget.__searchingFinished">__searchingFinished</a></td> |
| 92 <td>Private slot to handle the end of the search.</td> | 113 <td>Private slot to handle the end of the search.</td> |
| 93 </tr><tr> | 114 </tr> |
| 115 <tr> | |
| 94 <td><a href="#HelpSearchWidget.__searchingStarted">__searchingStarted</a></td> | 116 <td><a href="#HelpSearchWidget.__searchingStarted">__searchingStarted</a></td> |
| 95 <td>Private slot to handle the start of a search.</td> | 117 <td>Private slot to handle the start of a search.</td> |
| 96 </tr><tr> | 118 </tr> |
| 119 <tr> | |
| 97 <td><a href="#HelpSearchWidget.contextMenuEvent">contextMenuEvent</a></td> | 120 <td><a href="#HelpSearchWidget.contextMenuEvent">contextMenuEvent</a></td> |
| 98 <td>Protected method handling context menu events.</td> | 121 <td>Protected method handling context menu events.</td> |
| 99 </tr><tr> | 122 </tr> |
| 123 <tr> | |
| 100 <td><a href="#HelpSearchWidget.keyPressEvent">keyPressEvent</a></td> | 124 <td><a href="#HelpSearchWidget.keyPressEvent">keyPressEvent</a></td> |
| 101 <td>Protected method handling key press events.</td> | 125 <td>Protected method handling key press events.</td> |
| 102 </tr> | 126 </tr> |
| 103 </table> | 127 </table> |
| 104 <h3>Static Methods</h3> | 128 <h3>Static Methods</h3> |
| 105 <table> | 129 |
| 106 <tr><td>None</td></tr> | 130 <table> |
| 107 </table> | 131 <tr><td>None</td></tr> |
| 132 </table> | |
| 133 | |
| 108 <a NAME="HelpSearchWidget.__init__" ID="HelpSearchWidget.__init__"></a> | 134 <a NAME="HelpSearchWidget.__init__" ID="HelpSearchWidget.__init__"></a> |
| 109 <h4>HelpSearchWidget (Constructor)</h4> | 135 <h4>HelpSearchWidget (Constructor)</h4> |
| 110 <b>HelpSearchWidget</b>(<i>engine, parent=None</i>) | 136 <b>HelpSearchWidget</b>(<i>engine, parent=None</i>) |
| 137 | |
| 111 <p> | 138 <p> |
| 112 Constructor | 139 Constructor |
| 113 </p><dl> | 140 </p> |
| 141 <dl> | |
| 142 | |
| 114 <dt><i>engine</i></dt> | 143 <dt><i>engine</i></dt> |
| 115 <dd> | 144 <dd> |
| 116 reference to the help search engine (QHelpSearchEngine) | 145 reference to the help search engine (QHelpSearchEngine) |
| 117 </dd><dt><i>parent</i></dt> | 146 </dd> |
| 147 <dt><i>parent</i></dt> | |
| 118 <dd> | 148 <dd> |
| 119 reference to the parent widget (QWidget) | 149 reference to the parent widget (QWidget) |
| 120 </dd> | 150 </dd> |
| 121 </dl><a NAME="HelpSearchWidget.__linkActivated" ID="HelpSearchWidget.__linkActivated"></a> | 151 </dl> |
| 152 <a NAME="HelpSearchWidget.__linkActivated" ID="HelpSearchWidget.__linkActivated"></a> | |
| 122 <h4>HelpSearchWidget.__linkActivated</h4> | 153 <h4>HelpSearchWidget.__linkActivated</h4> |
| 123 <b>__linkActivated</b>(<i>url</i>) | 154 <b>__linkActivated</b>(<i>url</i>) |
| 155 | |
| 124 <p> | 156 <p> |
| 125 Private slot handling the activation of an entry. | 157 Private slot handling the activation of an entry. |
| 126 </p><dl> | 158 </p> |
| 159 <dl> | |
| 160 | |
| 127 <dt><i>url</i> (QUrl)</dt> | 161 <dt><i>url</i> (QUrl)</dt> |
| 128 <dd> | 162 <dd> |
| 129 URL of the activated entry | 163 URL of the activated entry |
| 130 </dd> | 164 </dd> |
| 131 </dl><a NAME="HelpSearchWidget.__search" ID="HelpSearchWidget.__search"></a> | 165 </dl> |
| 166 <a NAME="HelpSearchWidget.__search" ID="HelpSearchWidget.__search"></a> | |
| 132 <h4>HelpSearchWidget.__search</h4> | 167 <h4>HelpSearchWidget.__search</h4> |
| 133 <b>__search</b>(<i></i>) | 168 <b>__search</b>(<i></i>) |
| 169 | |
| 134 <p> | 170 <p> |
| 135 Private slot to perform a search of the database. | 171 Private slot to perform a search of the database. |
| 136 </p><a NAME="HelpSearchWidget.__searchingFinished" ID="HelpSearchWidget.__searchingFinished"></a> | 172 </p> |
| 173 <a NAME="HelpSearchWidget.__searchingFinished" ID="HelpSearchWidget.__searchingFinished"></a> | |
| 137 <h4>HelpSearchWidget.__searchingFinished</h4> | 174 <h4>HelpSearchWidget.__searchingFinished</h4> |
| 138 <b>__searchingFinished</b>(<i>hits</i>) | 175 <b>__searchingFinished</b>(<i>hits</i>) |
| 176 | |
| 139 <p> | 177 <p> |
| 140 Private slot to handle the end of the search. | 178 Private slot to handle the end of the search. |
| 141 </p><dl> | 179 </p> |
| 180 <dl> | |
| 181 | |
| 142 <dt><i>hits</i></dt> | 182 <dt><i>hits</i></dt> |
| 143 <dd> | 183 <dd> |
| 144 number of hits (integer) (unused) | 184 number of hits (integer) (unused) |
| 145 </dd> | 185 </dd> |
| 146 </dl><a NAME="HelpSearchWidget.__searchingStarted" ID="HelpSearchWidget.__searchingStarted"></a> | 186 </dl> |
| 187 <a NAME="HelpSearchWidget.__searchingStarted" ID="HelpSearchWidget.__searchingStarted"></a> | |
| 147 <h4>HelpSearchWidget.__searchingStarted</h4> | 188 <h4>HelpSearchWidget.__searchingStarted</h4> |
| 148 <b>__searchingStarted</b>(<i></i>) | 189 <b>__searchingStarted</b>(<i></i>) |
| 190 | |
| 149 <p> | 191 <p> |
| 150 Private slot to handle the start of a search. | 192 Private slot to handle the start of a search. |
| 151 </p><a NAME="HelpSearchWidget.contextMenuEvent" ID="HelpSearchWidget.contextMenuEvent"></a> | 193 </p> |
| 194 <a NAME="HelpSearchWidget.contextMenuEvent" ID="HelpSearchWidget.contextMenuEvent"></a> | |
| 152 <h4>HelpSearchWidget.contextMenuEvent</h4> | 195 <h4>HelpSearchWidget.contextMenuEvent</h4> |
| 153 <b>contextMenuEvent</b>(<i>evt</i>) | 196 <b>contextMenuEvent</b>(<i>evt</i>) |
| 197 | |
| 154 <p> | 198 <p> |
| 155 Protected method handling context menu events. | 199 Protected method handling context menu events. |
| 156 </p><dl> | 200 </p> |
| 201 <dl> | |
| 202 | |
| 157 <dt><i>evt</i></dt> | 203 <dt><i>evt</i></dt> |
| 158 <dd> | 204 <dd> |
| 159 reference to the context menu event (QContextMenuEvent) | 205 reference to the context menu event (QContextMenuEvent) |
| 160 </dd> | 206 </dd> |
| 161 </dl><a NAME="HelpSearchWidget.keyPressEvent" ID="HelpSearchWidget.keyPressEvent"></a> | 207 </dl> |
| 208 <a NAME="HelpSearchWidget.keyPressEvent" ID="HelpSearchWidget.keyPressEvent"></a> | |
| 162 <h4>HelpSearchWidget.keyPressEvent</h4> | 209 <h4>HelpSearchWidget.keyPressEvent</h4> |
| 163 <b>keyPressEvent</b>(<i>evt</i>) | 210 <b>keyPressEvent</b>(<i>evt</i>) |
| 211 | |
| 164 <p> | 212 <p> |
| 165 Protected method handling key press events. | 213 Protected method handling key press events. |
| 166 </p><dl> | 214 </p> |
| 215 <dl> | |
| 216 | |
| 167 <dt><i>evt</i></dt> | 217 <dt><i>evt</i></dt> |
| 168 <dd> | 218 <dd> |
| 169 reference to the key press event (QKeyEvent) | 219 reference to the key press event (QKeyEvent) |
| 170 </dd> | 220 </dd> |
| 171 </dl> | 221 </dl> |
