Documentation/Source/eric6.WebBrowser.QtHelp.HelpIndexWidget.html

changeset 4918
71caf42a13d8
child 5038
df7103c3f2a6
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.WebBrowser.QtHelp.HelpIndexWidget.html	Sun Apr 03 17:10:43 2016 +0200
@@ -0,0 +1,176 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.WebBrowser.QtHelp.HelpIndexWidget</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric6.WebBrowser.QtHelp.HelpIndexWidget</h1>
+<p>
+Module implementing a window for showing the QtHelp index.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#HelpIndexWidget">HelpIndexWidget</a></td>
+<td>Class implementing a window for showing the QtHelp index.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="HelpIndexWidget" ID="HelpIndexWidget"></a>
+<h2>HelpIndexWidget</h2>
+<p>
+    Class implementing a window for showing the QtHelp index.
+</p><h3>Signals</h3>
+<dl>
+<dt>escapePressed()</dt>
+<dd>
+emitted when the ESC key was pressed
+</dd><dt>linkActivated(QUrl)</dt>
+<dd>
+emitted when an index entry is activated
+</dd><dt>linksActivated(links, keyword)</dt>
+<dd>
+emitted when an index entry
+        referencing multiple targets is activated
+</dd>
+</dl>
+<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="#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>
+<td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td>
+<td>Private slot to enable the search edit.</td>
+</tr><tr>
+<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.eventFilter">eventFilter</a></td>
+<td>Public method called to filter the event queue.</td>
+</tr><tr>
+<td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td>
+<td>Protected method handling focus in events.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a>
+<h4>HelpIndexWidget (Constructor)</h4>
+<b>HelpIndexWidget</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="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>)
+<p>
+        Private slot to enable the search edit.
+</p><a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a>
+<h4>HelpIndexWidget.__enableSearchEdit</h4>
+<b>__enableSearchEdit</b>(<i></i>)
+<p>
+        Private slot to enable the search edit.
+</p><a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a>
+<h4>HelpIndexWidget.__filterIndices</h4>
+<b>__filterIndices</b>(<i>filter</i>)
+<p>
+        Private slot to filter the indices according to the given filter.
+</p><dl>
+<dt><i>filter</i></dt>
+<dd>
+filter to be used (string)
+</dd>
+</dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a>
+<h4>HelpIndexWidget.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="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a>
+<h4>HelpIndexWidget.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>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial