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