--- a/Documentation/Source/eric5.Helpviewer.HelpTocWidget.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Helpviewer.HelpTocWidget.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Helpviewer.HelpTocWidget</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#105;&#110;&#100;&#111;w &#102;&#111;&#114; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#84;&#79;&#67;.
+Module implementing a window for showing the QtHelp TOC.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#HelpTocWidget">HelpTocWidget</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#105;&#110;&#100;&#111;w &#102;&#111;&#114; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#84;&#79;&#67;.</td>
+<td>Class implementing a window for showing the QtHelp TOC.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,15 +43,15 @@
 <a NAME="HelpTocWidget" ID="HelpTocWidget"></a>
 <h2>HelpTocWidget</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#105;&#110;&#100;&#111;w &#102;&#111;&#114; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#84;&#79;&#67;.
+    Class implementing a window for showing the QtHelp TOC.
 </p><h4>Signals</h4>
 <dl>
 <dt>escapePressed()</dt>
 <dd>
-&#101;&#109;&#105;&#116;&#116;&#101;&#100; w&#104;&#101;&#110; &#116;&#104;&#101; &#69;&#83;&#67; &#107;&#101;y w&#97;&#115; &#112;&#114;&#101;&#115;&#115;&#101;&#100;
+emitted when the ESC key was pressed
 </dd><dt>linkActivated(const QUrl&)</dt>
 <dd>
-&#101;&#109;&#105;&#116;&#116;&#101;&#100; w&#104;&#101;&#110; &#97; &#84;&#79;&#67; &#101;&#110;&#116;&#114;y &#105;&#115; &#97;&#99;&#116;&#105;v&#97;&#116;&#101;&#100;
+emitted when a TOC entry is activated
 </dd>
 </dl>
 <h3>Derived from</h3>
@@ -64,136 +64,136 @@
 <table>
 <tr>
 <td><a href="#HelpTocWidget.__init__">HelpTocWidget</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#HelpTocWidget.__expandTOC">__expandTOC</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#101;x&#112;&#97;&#110;&#100; &#116;&#104;&#101; &#116;&#97;&#98;&#108;&#101; &#111;&#102; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115;.</td>
+<td>Private slot to expand the table of contents.</td>
 </tr><tr>
 <td><a href="#HelpTocWidget.__showContextMenu">__showContextMenu</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117;.</td>
+<td>Private slot showing the context menu.</td>
 </tr><tr>
 <td><a href="#HelpTocWidget.eventFilter">eventFilter</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#102;&#105;&#108;&#116;&#101;&#114; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#113;&#117;&#101;&#117;&#101;.</td>
+<td>Public method called to filter the event queue.</td>
 </tr><tr>
 <td><a href="#HelpTocWidget.expandToDepth">expandToDepth</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#101;x&#112;&#97;&#110;&#100; &#116;&#104;&#101; &#116;&#97;&#98;&#108;&#101; &#111;&#102; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#116;&#111; &#97; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#100;&#101;&#112;&#116;&#104;.</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>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#102;&#111;&#99;&#117;&#115; &#105;&#110; &#101;v&#101;&#110;&#116;&#115;.</td>
+<td>Protected method handling focus in events.</td>
 </tr><tr>
 <td><a href="#HelpTocWidget.itemClicked">itemClicked</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#97; &#99;&#108;&#105;&#99;&#107; &#111;&#102; &#97; &#84;&#79;&#67; &#101;&#110;&#116;&#114;y.</td>
+<td>Public slot handling a click of a TOC entry.</td>
 </tr><tr>
 <td><a href="#HelpTocWidget.keyPressEvent">keyPressEvent</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116;&#115;.</td>
+<td>Protected method handling key press events.</td>
 </tr><tr>
 <td><a href="#HelpTocWidget.syncToContent">syncToContent</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;y&#110;&#99; &#116;&#104;&#101; &#84;&#79;&#67; &#116;&#111; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y&#101;&#100; &#112;&#97;&#103;&#101;.</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>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>engine</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#101;&#110;&#103;&#105;&#110;&#101; (&#81;&#72;&#101;&#108;&#112;&#69;&#110;&#103;&#105;&#110;&#101;)
+reference to the help engine (QHelpEngine)
 </dd><dt><i>mainWindow</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#109;&#97;&#105;&#110; w&#105;&#110;&#100;&#111;w &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#77;&#97;&#105;&#110;&#87;&#105;&#110;&#100;&#111;w)
+reference to the main window object (QMainWindow)
 </dd><dt><i>parent</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#101;x&#112;&#97;&#110;&#100; &#116;&#104;&#101; &#116;&#97;&#98;&#108;&#101; &#111;&#102; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115;.
+        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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117;.
+        Private slot showing the context menu.
 </p><dl>
 <dt><i>pos</i></dt>
 <dd>
-&#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#109;&#101;&#110;&#117; &#97;&#116; (&#81;&#80;&#111;&#105;&#110;&#116;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#102;&#105;&#108;&#116;&#101;&#114; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#113;&#117;&#101;&#117;&#101;.
+        Public method called to filter the event queue.
 </p><dl>
 <dt><i>watched</i></dt>
 <dd>
-&#116;&#104;&#101; &#81;&#79;&#98;&#106;&#101;&#99;&#116; &#98;&#101;&#105;&#110;&#103; w&#97;&#116;&#99;&#104;&#101;&#100; (&#81;&#79;&#98;&#106;&#101;&#99;&#116;)
+the QObject being watched (QObject)
 </dd><dt><i>event</i></dt>
 <dd>
-&#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#116;&#104;&#97;&#116; &#111;&#99;&#99;&#117;&#114;&#114;&#101;&#100; (&#81;&#69;v&#101;&#110;&#116;)
+the event that occurred (QEvent)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; w&#104;&#101;&#116;&#104;&#101;&#114; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; w&#97;&#115; &#104;&#97;&#110;&#100;&#108;&#101;&#100; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#101;x&#112;&#97;&#110;&#100; &#116;&#104;&#101; &#116;&#97;&#98;&#108;&#101; &#111;&#102; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#116;&#111; &#97; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#100;&#101;&#112;&#116;&#104;.
+        Public slot to expand the table of contents to a specific depth.
 </p><dl>
 <dt><i>depth</i></dt>
 <dd>
-&#100;&#101;&#112;&#116;&#104; &#116;&#111; &#101;x&#112;&#97;&#110;&#100; &#116;&#111; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#102;&#111;&#99;&#117;&#115; &#105;&#110; &#101;v&#101;&#110;&#116;&#115;.
+        Protected method handling focus in events.
 </p><dl>
 <dt><i>evt</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#102;&#111;&#99;&#117;&#115; &#101;v&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#70;&#111;&#99;&#117;&#115;&#69;v&#101;&#110;&#116;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#97; &#99;&#108;&#105;&#99;&#107; &#111;&#102; &#97; &#84;&#79;&#67; &#101;&#110;&#116;&#114;y.
+        Public slot handling a click of a TOC entry.
 </p><dl>
 <dt><i>index</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;x &#111;&#102; &#116;&#104;&#101; &#84;&#79;&#67; &#99;&#108;&#105;&#99;&#107;&#101;&#100; (&#81;&#77;&#111;&#100;&#101;&#108;&#73;&#110;&#100;&#101;x)
+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>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116;&#115;.
+        Protected method handling key press events.
 </p><dl>
 <dt><i>evt</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116; (&#81;&#75;&#101;y&#69;v&#101;&#110;&#116;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;y&#110;&#99; &#116;&#104;&#101; &#84;&#79;&#67; &#116;&#111; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y&#101;&#100; &#112;&#97;&#103;&#101;.
+        Public method to sync the TOC to the displayed page.
 </p><dl>
 <dt><i>url</i></dt>
 <dd>
-&#85;&#82;&#76; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y&#101;&#100; &#112;&#97;&#103;&#101; (&#81;&#85;&#114;&#108;)
+URL of the displayed page (QUrl)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97; &#115;&#117;&#99;&#99;&#101;&#115;&#115;&#102;&#117;&#108; &#115;y&#110;&#99;&#104;&#114;&#111;&#110;&#105;z&#97;&#116;&#105;&#111;&#110; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating a successful synchronization (boolean)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>