--- a/Documentation/Source/eric6.WebBrowser.QtHelp.HelpIndexWidget.html Thu Jul 14 18:56:39 2016 +0200 +++ b/Documentation/Source/eric6.WebBrowser.QtHelp.HelpIndexWidget.html Sun Jul 17 15:36:11 2016 +0200 @@ -48,13 +48,19 @@ <dt>escapePressed()</dt> <dd> emitted when the ESC key was pressed -</dd><dt>linkActivated(QUrl)</dt> +</dd><dt>newBackgroundTab(QUrl, str)</dt> +<dd> +emitted to open an entry in a + new background tab +</dd><dt>newTab(QUrl, str)</dt> <dd> -emitted when an index entry is activated -</dd><dt>linksActivated(links, keyword)</dt> +emitted to open an entry in a new tab +</dd><dt>newWindow(QUrl, str)</dt> <dd> -emitted when an index entry - referencing multiple targets is activated +emitted to open an entry in a new window +</dd><dt>openUrl(QUrl, str)</dt> +<dd> +emitted to open an entry in the current tab </dd> </dl> <h3>Derived from</h3> @@ -85,6 +91,12 @@ <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.__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> @@ -98,29 +110,29 @@ </table> <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a> <h4>HelpIndexWidget (Constructor)</h4> -<b>HelpIndexWidget</b>(<i>engine, mainWindow, parent=None</i>) +<b>HelpIndexWidget</b>(<i>engine, parent=None</i>) <p> Constructor </p><dl> <dt><i>engine</i></dt> <dd> reference to the help engine (QHelpEngine) -</dd><dt><i>mainWindow</i></dt> -<dd> -reference to the main window object (QMainWindow) </dd><dt><i>parent</i></dt> <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>) +<b>__activated</b>(<i>idx, midButton=False</i>) <p> Private slot to handle the activation of a keyword entry. </p><dl> -<dt><i>idx</i></dt> +<dt><i>idx</i> (QModelIndex)</dt> <dd> -index of the activated entry (QModelIndex) +index of the activated entry +</dd><dt><i>midButton</i> (bool)</dt> +<dd> +flag indicating a middle mouse button release </dd> </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> <h4>HelpIndexWidget.__disableSearchEdit</h4> @@ -142,6 +154,40 @@ <dd> filter to be used (string) </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>)