--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Helpviewer.HelpTocWidget.html Sat Jan 02 18:19:35 2010 +0000
@@ -0,0 +1,189 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric5.Helpviewer.HelpTocWidget</title>
+<style>
+b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n'
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.Helpviewer.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 />
+<a NAME="HelpTocWidget" ID="HelpTocWidget"></a>
+<h2>HelpTocWidget</h2>
+<p>
+ Class implementing a window for showing the QtHelp TOC.
+</p><h4>Signals</h4>
+<dl>
+<dt>escapePressed()</dt>
+<dd>
+emitted when the ESC key was pressed
+</dd><dt>linkActivated(const QUrl&)</dt>
+<dd>
+emitted when a TOC entry is activated
+</dd>
+</dl>
+<h3>Derived from</h3>
+QWidget
+<h3>Class Attributes</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>
+<td><a href="#HelpTocWidget.__expandTOC">__expandTOC</a></td>
+<td>Private slot to expand the table of contents.</td>
+</tr><tr>
+<td><a href="#HelpTocWidget.__showContextMenu">__showContextMenu</a></td>
+<td>Private slot showing the context menu.</td>
+</tr><tr>
+<td><a href="#HelpTocWidget.eventFilter">eventFilter</a></td>
+<td>Public method called to filter the event queue.</td>
+</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>
+<td><a href="#HelpTocWidget.focusInEvent">focusInEvent</a></td>
+<td>Protected method handling focus in events.</td>
+</tr><tr>
+<td><a href="#HelpTocWidget.itemClicked">itemClicked</a></td>
+<td>Public slot handling a click of a TOC entry.</td>
+</tr><tr>
+<td><a href="#HelpTocWidget.keyPressEvent">keyPressEvent</a></td>
+<td>Protected method handling key press events.</td>
+</tr><tr>
+<td><a href="#HelpTocWidget.syncToContent">syncToContent</a></td>
+<td>Public method to sync the TOC to the displayed page.</td>
+</tr>
+</table>
+<a NAME="HelpTocWidget.__init__" ID="HelpTocWidget.__init__"></a>
+<h4>HelpTocWidget (Constructor)</h4>
+<b>HelpTocWidget</b>(<i>engine, mainWindow, 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="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.__showContextMenu" ID="HelpTocWidget.__showContextMenu"></a>
+<h4>HelpTocWidget.__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="HelpTocWidget.eventFilter" ID="HelpTocWidget.eventFilter"></a>
+<h4>HelpTocWidget.eventFilter</h4>
+<b>eventFilter</b>(<i>watched, event</i>)
+<p>
+ Public method called to filter the event queue.
+</p><dl>
+<dt><i>watched</i></dt>
+<dd>
+the QObject being watched (QObject)
+</dd><dt><i>event</i></dt>
+<dd>
+the event that occurred (QEvent)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating whether the event was handled (boolean)
+</dd>
+</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>
+<dt><i>depth</i></dt>
+<dd>
+depth to expand to (integer)
+</dd>
+</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>
+<dt><i>evt</i></dt>
+<dd>
+reference to the focus event object (QFocusEvent)
+</dd>
+</dl><a NAME="HelpTocWidget.itemClicked" ID="HelpTocWidget.itemClicked"></a>
+<h4>HelpTocWidget.itemClicked</h4>
+<b>itemClicked</b>(<i>index</i>)
+<p>
+ Public slot handling a click of a TOC entry.
+</p><dl>
+<dt><i>index</i></dt>
+<dd>
+index of the TOC clicked (QModelIndex)
+</dd>
+</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>
+<dt><i>evt</i></dt>
+<dd>
+reference to the key press event (QKeyEvent)
+</dd>
+</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>
+<dt><i>url</i></dt>
+<dd>
+URL of the displayed page (QUrl)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a successful synchronization (boolean)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
