diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpTocWidget.html --- a/eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpTocWidget.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpTocWidget.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,47 +18,61 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.WebBrowser.QtHelp.HelpTocWidget</h1> + <p> Module implementing a window for showing the QtHelp TOC. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#HelpTocWidget">HelpTocWidget</a></td> <td>Class implementing a window for showing the QtHelp TOC.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="HelpTocWidget" ID="HelpTocWidget"></a> <h2>HelpTocWidget</h2> + <p> Class implementing a window for showing the QtHelp TOC. -</p><h3>Signals</h3> +</p> +<h3>Signals</h3> <dl> + <dt>escapePressed()</dt> <dd> emitted when the ESC key was pressed -</dd><dt>newBackgroundTab(QUrl, str)</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> +<dt>newTab(QUrl, str)</dt> <dd> emitted to open an entry in a new tab -</dd><dt>newWindow(QUrl, str)</dt> +</dd> +<dt>newWindow(QUrl, str)</dt> <dd> emitted to open an entry in a new window -</dd><dt>openUrl(QUrl, str)</dt> +</dd> +<dt>openUrl(QUrl, str)</dt> <dd> emitted to open an entry in the current tab </dd> @@ -66,132 +80,179 @@ <h3>Derived from</h3> QWidget <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#HelpTocWidget.__init__">HelpTocWidget</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#HelpTocWidget.__contentsCreated">__contentsCreated</a></td> <td>Private slot to be run after the contents was generated.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HelpTocWidget.__expandTOC">__expandTOC</a></td> <td>Private slot to expand the table of contents.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HelpTocWidget.__linkActivated">__linkActivated</a></td> <td>Private slot handling the activation of an entry.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HelpTocWidget.__showContextMenu">__showContextMenu</a></td> <td>Private slot showing the context menu.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HelpTocWidget.expandToDepth">expandToDepth</a></td> <td>Public slot to expand the table of contents to a specific depth.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HelpTocWidget.focusInEvent">focusInEvent</a></td> <td>Protected method handling focus in events.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HelpTocWidget.keyPressEvent">keyPressEvent</a></td> <td>Protected method handling key press events.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HelpTocWidget.syncToContent">syncToContent</a></td> <td>Public method to sync the TOC to the displayed page.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="HelpTocWidget.__init__" ID="HelpTocWidget.__init__"></a> <h4>HelpTocWidget (Constructor)</h4> <b>HelpTocWidget</b>(<i>engine, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>engine</i></dt> <dd> reference to the help engine (QHelpEngine) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="HelpTocWidget.__contentsCreated" ID="HelpTocWidget.__contentsCreated"></a> +</dl> +<a NAME="HelpTocWidget.__contentsCreated" ID="HelpTocWidget.__contentsCreated"></a> <h4>HelpTocWidget.__contentsCreated</h4> <b>__contentsCreated</b>(<i></i>) + <p> Private slot to be run after the contents was generated. -</p><a NAME="HelpTocWidget.__expandTOC" ID="HelpTocWidget.__expandTOC"></a> +</p> +<a NAME="HelpTocWidget.__expandTOC" ID="HelpTocWidget.__expandTOC"></a> <h4>HelpTocWidget.__expandTOC</h4> <b>__expandTOC</b>(<i></i>) + <p> Private slot to expand the table of contents. -</p><a NAME="HelpTocWidget.__linkActivated" ID="HelpTocWidget.__linkActivated"></a> +</p> +<a NAME="HelpTocWidget.__linkActivated" ID="HelpTocWidget.__linkActivated"></a> <h4>HelpTocWidget.__linkActivated</h4> <b>__linkActivated</b>(<i>url</i>) + <p> Private slot handling the activation of an entry. -</p><dl> +</p> +<dl> + <dt><i>url</i> (QUrl)</dt> <dd> URL of the activated entry </dd> -</dl><a NAME="HelpTocWidget.__showContextMenu" ID="HelpTocWidget.__showContextMenu"></a> +</dl> +<a NAME="HelpTocWidget.__showContextMenu" ID="HelpTocWidget.__showContextMenu"></a> <h4>HelpTocWidget.__showContextMenu</h4> <b>__showContextMenu</b>(<i>pos</i>) + <p> Private slot showing the context menu. -</p><dl> +</p> +<dl> + <dt><i>pos</i></dt> <dd> position to show the menu at (QPoint) </dd> -</dl><a NAME="HelpTocWidget.expandToDepth" ID="HelpTocWidget.expandToDepth"></a> +</dl> +<a NAME="HelpTocWidget.expandToDepth" ID="HelpTocWidget.expandToDepth"></a> <h4>HelpTocWidget.expandToDepth</h4> <b>expandToDepth</b>(<i>depth</i>) + <p> Public slot to expand the table of contents to a specific depth. -</p><dl> +</p> +<dl> + <dt><i>depth</i></dt> <dd> depth to expand to (integer) </dd> -</dl><a NAME="HelpTocWidget.focusInEvent" ID="HelpTocWidget.focusInEvent"></a> +</dl> +<a NAME="HelpTocWidget.focusInEvent" ID="HelpTocWidget.focusInEvent"></a> <h4>HelpTocWidget.focusInEvent</h4> <b>focusInEvent</b>(<i>evt</i>) + <p> Protected method handling focus in events. -</p><dl> +</p> +<dl> + <dt><i>evt</i></dt> <dd> reference to the focus event object (QFocusEvent) </dd> -</dl><a NAME="HelpTocWidget.keyPressEvent" ID="HelpTocWidget.keyPressEvent"></a> +</dl> +<a NAME="HelpTocWidget.keyPressEvent" ID="HelpTocWidget.keyPressEvent"></a> <h4>HelpTocWidget.keyPressEvent</h4> <b>keyPressEvent</b>(<i>evt</i>) + <p> Protected method handling key press events. -</p><dl> +</p> +<dl> + <dt><i>evt</i></dt> <dd> reference to the key press event (QKeyEvent) </dd> -</dl><a NAME="HelpTocWidget.syncToContent" ID="HelpTocWidget.syncToContent"></a> +</dl> +<a NAME="HelpTocWidget.syncToContent" ID="HelpTocWidget.syncToContent"></a> <h4>HelpTocWidget.syncToContent</h4> <b>syncToContent</b>(<i>url</i>) + <p> Public method to sync the TOC to the displayed page. -</p><dl> +</p> +<dl> + <dt><i>url</i></dt> <dd> URL of the displayed page (QUrl) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating a successful synchronization (boolean)