diff -r 2f22b20ea9ad -r 321c2003745d Documentation/Source/eric6.Helpviewer.HelpIndexWidget.html --- a/Documentation/Source/eric6.Helpviewer.HelpIndexWidget.html Mon Oct 17 18:57:24 2016 +0200 +++ b/Documentation/Source/eric6.Helpviewer.HelpIndexWidget.html Mon Oct 17 19:51:51 2016 +0200 @@ -73,9 +73,6 @@ <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td> <td>Constructor</td> </tr><tr> -<td><a href="#HelpIndexWidget.__activated">__activated</a></td> -<td>Private slot to handle the activation of a keyword entry.</td> -</tr><tr> <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td> <td>Private slot to enable the search edit.</td> </tr><tr> @@ -85,6 +82,18 @@ <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td> <td>Private slot to filter the indices according to the given filter.</td> </tr><tr> +<td><a href="#HelpIndexWidget.__linkActivated">__linkActivated</a></td> +<td>Private slot to handle the activation of a keyword entry.</td> +</tr><tr> +<td><a href="#HelpIndexWidget.__linksActivated">__linksActivated</a></td> +<td>Private slot to handle the activation of an entry with multiple links.</td> +</tr><tr> +<td><a href="#HelpIndexWidget.__selectLink">__selectLink</a></td> +<td>Private method to give the user a chance to select among the returned links.</td> +</tr><tr> +<td><a href="#HelpIndexWidget.__showContextMenu">__showContextMenu</a></td> +<td>Private slot showing the context menu.</td> +</tr><tr> <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td> <td>Public method called to filter the event queue.</td> </tr><tr> @@ -112,16 +121,6 @@ <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="HelpIndexWidget.__activated" ID="HelpIndexWidget.__activated"></a> -<h4>HelpIndexWidget.__activated</h4> -<b>__activated</b>(<i>idx</i>) -<p> - Private slot to handle the activation of a keyword entry. -</p><dl> -<dt><i>idx</i></dt> -<dd> -index of the activated entry (QModelIndex) -</dd> </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> <h4>HelpIndexWidget.__disableSearchEdit</h4> <b>__disableSearchEdit</b>(<i></i>) @@ -142,6 +141,69 @@ <dd> filter to be used (string) </dd> +</dl><a NAME="HelpIndexWidget.__linkActivated" ID="HelpIndexWidget.__linkActivated"></a> +<h4>HelpIndexWidget.__linkActivated</h4> +<b>__linkActivated</b>(<i>url, keyword, modifiers=None</i>) +<p> + Private slot to handle the activation of a keyword entry. +</p><dl> +<dt><i>url</i> (QUrl)</dt> +<dd> +URL of the selected entry +</dd><dt><i>keyword</i> (str)</dt> +<dd> +keyword for the URL +</dd><dt><i>modifiers=</i> (Qt.KeyboardModifiers or None)</dt> +<dd> +keyboard modifiers +</dd> +</dl><a NAME="HelpIndexWidget.__linksActivated" ID="HelpIndexWidget.__linksActivated"></a> +<h4>HelpIndexWidget.__linksActivated</h4> +<b>__linksActivated</b>(<i>links, keyword</i>) +<p> + Private slot to handle the activation of an entry with multiple links. +</p><dl> +<dt><i>links</i> (dict of key:str and value:QUrl)</dt> +<dd> +dictionary containing the links +</dd><dt><i>keyword</i> (str)</dt> +<dd> +keyword for the entry +</dd> +</dl><a NAME="HelpIndexWidget.__selectLink" ID="HelpIndexWidget.__selectLink"></a> +<h4>HelpIndexWidget.__selectLink</h4> +<b>__selectLink</b>(<i>links, keyword</i>) +<p> + Private method to give the user a chance to select among the + returned links. +</p><dl> +<dt><i>links</i> (dictionary of str (key) and QUrl (value))</dt> +<dd> +dictionary of document title and URL to select from +</dd><dt><i>keyword</i> (str)</dt> +<dd> +keyword for the link set +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +selected link +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +QUrl +</dd> +</dl><a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a> +<h4>HelpIndexWidget.__showContextMenu</h4> +<b>__showContextMenu</b>(<i>pos</i>) +<p> + Private slot showing the context menu. +</p><dl> +<dt><i>pos</i></dt> +<dd> +position to show the menu at (QPoint) +</dd> </dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a> <h4>HelpIndexWidget.eventFilter</h4> <b>eventFilter</b>(<i>watched, event</i>)