Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.WebBrowser.QtHelp.HelpIndexWidget.html
Documentation/Source/eric6.WebBrowser.QtHelp.HelpIndexWidget.html
- changeset 5038
- df7103c3f2a6
- parent 4918
- 71caf42a13d8
- child 5252
- 321c2003745d
equal
deleted
inserted
replaced
| 5037:b2b37d7c0791 | 5038:df7103c3f2a6 |
|---|---|
| 46 </p><h3>Signals</h3> | 46 </p><h3>Signals</h3> |
| 47 <dl> | 47 <dl> |
| 48 <dt>escapePressed()</dt> | 48 <dt>escapePressed()</dt> |
| 49 <dd> | 49 <dd> |
| 50 emitted when the ESC key was pressed | 50 emitted when the ESC key was pressed |
| 51 </dd><dt>linkActivated(QUrl)</dt> | 51 </dd><dt>newBackgroundTab(QUrl, str)</dt> |
| 52 <dd> | 52 <dd> |
| 53 emitted when an index entry is activated | 53 emitted to open an entry in a |
| 54 </dd><dt>linksActivated(links, keyword)</dt> | 54 new background tab |
| 55 <dd> | 55 </dd><dt>newTab(QUrl, str)</dt> |
| 56 emitted when an index entry | 56 <dd> |
| 57 referencing multiple targets is activated | 57 emitted to open an entry in a new tab |
| 58 </dd><dt>newWindow(QUrl, str)</dt> | |
| 59 <dd> | |
| 60 emitted to open an entry in a new window | |
| 61 </dd><dt>openUrl(QUrl, str)</dt> | |
| 62 <dd> | |
| 63 emitted to open an entry in the current tab | |
| 58 </dd> | 64 </dd> |
| 59 </dl> | 65 </dl> |
| 60 <h3>Derived from</h3> | 66 <h3>Derived from</h3> |
| 61 QWidget | 67 QWidget |
| 62 <h3>Class Attributes</h3> | 68 <h3>Class Attributes</h3> |
| 83 <td>Private slot to enable the search edit.</td> | 89 <td>Private slot to enable the search edit.</td> |
| 84 </tr><tr> | 90 </tr><tr> |
| 85 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td> | 91 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td> |
| 86 <td>Private slot to filter the indices according to the given filter.</td> | 92 <td>Private slot to filter the indices according to the given filter.</td> |
| 87 </tr><tr> | 93 </tr><tr> |
| 94 <td><a href="#HelpIndexWidget.__selectLink">__selectLink</a></td> | |
| 95 <td>Private method to give the user a chance to select among the returned links.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#HelpIndexWidget.__showContextMenu">__showContextMenu</a></td> | |
| 98 <td>Private slot showing the context menu.</td> | |
| 99 </tr><tr> | |
| 88 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td> | 100 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td> |
| 89 <td>Public method called to filter the event queue.</td> | 101 <td>Public method called to filter the event queue.</td> |
| 90 </tr><tr> | 102 </tr><tr> |
| 91 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td> | 103 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td> |
| 92 <td>Protected method handling focus in events.</td> | 104 <td>Protected method handling focus in events.</td> |
| 96 <table> | 108 <table> |
| 97 <tr><td>None</td></tr> | 109 <tr><td>None</td></tr> |
| 98 </table> | 110 </table> |
| 99 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a> | 111 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a> |
| 100 <h4>HelpIndexWidget (Constructor)</h4> | 112 <h4>HelpIndexWidget (Constructor)</h4> |
| 101 <b>HelpIndexWidget</b>(<i>engine, mainWindow, parent=None</i>) | 113 <b>HelpIndexWidget</b>(<i>engine, parent=None</i>) |
| 102 <p> | 114 <p> |
| 103 Constructor | 115 Constructor |
| 104 </p><dl> | 116 </p><dl> |
| 105 <dt><i>engine</i></dt> | 117 <dt><i>engine</i></dt> |
| 106 <dd> | 118 <dd> |
| 107 reference to the help engine (QHelpEngine) | 119 reference to the help engine (QHelpEngine) |
| 108 </dd><dt><i>mainWindow</i></dt> | |
| 109 <dd> | |
| 110 reference to the main window object (QMainWindow) | |
| 111 </dd><dt><i>parent</i></dt> | 120 </dd><dt><i>parent</i></dt> |
| 112 <dd> | 121 <dd> |
| 113 reference to the parent widget (QWidget) | 122 reference to the parent widget (QWidget) |
| 114 </dd> | 123 </dd> |
| 115 </dl><a NAME="HelpIndexWidget.__activated" ID="HelpIndexWidget.__activated"></a> | 124 </dl><a NAME="HelpIndexWidget.__activated" ID="HelpIndexWidget.__activated"></a> |
| 116 <h4>HelpIndexWidget.__activated</h4> | 125 <h4>HelpIndexWidget.__activated</h4> |
| 117 <b>__activated</b>(<i>idx</i>) | 126 <b>__activated</b>(<i>idx, midButton=False</i>) |
| 118 <p> | 127 <p> |
| 119 Private slot to handle the activation of a keyword entry. | 128 Private slot to handle the activation of a keyword entry. |
| 120 </p><dl> | 129 </p><dl> |
| 121 <dt><i>idx</i></dt> | 130 <dt><i>idx</i> (QModelIndex)</dt> |
| 122 <dd> | 131 <dd> |
| 123 index of the activated entry (QModelIndex) | 132 index of the activated entry |
| 133 </dd><dt><i>midButton</i> (bool)</dt> | |
| 134 <dd> | |
| 135 flag indicating a middle mouse button release | |
| 124 </dd> | 136 </dd> |
| 125 </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> | 137 </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> |
| 126 <h4>HelpIndexWidget.__disableSearchEdit</h4> | 138 <h4>HelpIndexWidget.__disableSearchEdit</h4> |
| 127 <b>__disableSearchEdit</b>(<i></i>) | 139 <b>__disableSearchEdit</b>(<i></i>) |
| 128 <p> | 140 <p> |
| 140 </p><dl> | 152 </p><dl> |
| 141 <dt><i>filter</i></dt> | 153 <dt><i>filter</i></dt> |
| 142 <dd> | 154 <dd> |
| 143 filter to be used (string) | 155 filter to be used (string) |
| 144 </dd> | 156 </dd> |
| 157 </dl><a NAME="HelpIndexWidget.__selectLink" ID="HelpIndexWidget.__selectLink"></a> | |
| 158 <h4>HelpIndexWidget.__selectLink</h4> | |
| 159 <b>__selectLink</b>(<i>links, keyword</i>) | |
| 160 <p> | |
| 161 Private method to give the user a chance to select among the | |
| 162 returned links. | |
| 163 </p><dl> | |
| 164 <dt><i>links</i> (dictionary of str (key) and QUrl (value))</dt> | |
| 165 <dd> | |
| 166 dictionary of document title and URL to select from | |
| 167 </dd><dt><i>keyword</i> (str)</dt> | |
| 168 <dd> | |
| 169 keyword for the link set | |
| 170 </dd> | |
| 171 </dl><dl> | |
| 172 <dt>Returns:</dt> | |
| 173 <dd> | |
| 174 selected link | |
| 175 </dd> | |
| 176 </dl><dl> | |
| 177 <dt>Return Type:</dt> | |
| 178 <dd> | |
| 179 QUrl | |
| 180 </dd> | |
| 181 </dl><a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a> | |
| 182 <h4>HelpIndexWidget.__showContextMenu</h4> | |
| 183 <b>__showContextMenu</b>(<i>pos</i>) | |
| 184 <p> | |
| 185 Private slot showing the context menu. | |
| 186 </p><dl> | |
| 187 <dt><i>pos</i></dt> | |
| 188 <dd> | |
| 189 position to show the menu at (QPoint) | |
| 190 </dd> | |
| 145 </dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a> | 191 </dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a> |
| 146 <h4>HelpIndexWidget.eventFilter</h4> | 192 <h4>HelpIndexWidget.eventFilter</h4> |
| 147 <b>eventFilter</b>(<i>watched, event</i>) | 193 <b>eventFilter</b>(<i>watched, event</i>) |
| 148 <p> | 194 <p> |
| 149 Public method called to filter the event queue. | 195 Public method called to filter the event queue. |
