Mercurial Repositories > eric / file diff

diff: eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpIndexWidget.html

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

branch
eric7
changeset 8422
bb5da74c1b3f
parent 8372
e0227a7c850e
child 8575
423c4db4101e
--- a/eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpIndexWidget.html	Thu Jun 10 19:32:22 2021 +0200
+++ b/eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpIndexWidget.html	Sun Jun 13 19:03:43 2021 +0200
@@ -102,6 +102,14 @@
 <td>Private slot to enable the search edit.</td>
 </tr>
 <tr>
+<td><a href="#HelpIndexWidget.__documentActivated">__documentActivated</a></td>
+<td>Private slot to handle the activation of a keyword entry.</td>
+</tr>
+<tr>
+<td><a href="#HelpIndexWidget.__documentsActivated">__documentsActivated</a></td>
+<td>Private slot to handle the activation of an entry with multiple help documents.</td>
+</tr>
+<tr>
 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td>
 <td>Private slot to enable the search edit.</td>
 </tr>
@@ -110,16 +118,8 @@
 <td>Private slot to filter the indexes according to the given filter.</td>
 </tr>
 <tr>
-<td><a href="#HelpIndexWidget.__linkActivated">__linkActivated</a></td>
-<td>Private slot to handle the activation of a keyword entry.</td>
-</tr>
-<tr>
-<td><a href="#HelpIndexWidget.__linksActivated">__linksActivated</a></td>
-<td>Private slot to handle the activation of an entry with multiple links.</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>
+<td><a href="#HelpIndexWidget.__selectDocument">__selectDocument</a></td>
+<td>Private method to give the user a chance to select among the given documents.</td>
 </tr>
 <tr>
 <td><a href="#HelpIndexWidget.__showContextMenu">__showContextMenu</a></td>
@@ -149,13 +149,13 @@
 </p>
 <dl>
 
-<dt><i>engine</i></dt>
+<dt><i>engine</i> (QHelpEngine)</dt>
 <dd>
-reference to the help engine (QHelpEngine)
+reference to the help engine
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
 </dd>
 </dl>
 <a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a>
@@ -165,6 +165,48 @@
 <p>
         Private slot to enable the search edit.
 </p>
+<a NAME="HelpIndexWidget.__documentActivated" ID="HelpIndexWidget.__documentActivated"></a>
+<h4>HelpIndexWidget.__documentActivated</h4>
+<b>__documentActivated</b>(<i>document, keyword, modifiers=None</i>)
+
+<p>
+        Private slot to handle the activation of a keyword entry.
+</p>
+<dl>
+
+<dt><i>document</i> (QHelpLink)</dt>
+<dd>
+reference to a data structure containing the
+            document info
+</dd>
+<dt><i>keyword</i> (str)</dt>
+<dd>
+keyword for the URL
+</dd>
+<dt><i>modifiers</i> (Qt.KeyboardModifiers or None)</dt>
+<dd>
+keyboard modifiers
+</dd>
+</dl>
+<a NAME="HelpIndexWidget.__documentsActivated" ID="HelpIndexWidget.__documentsActivated"></a>
+<h4>HelpIndexWidget.__documentsActivated</h4>
+<b>__documentsActivated</b>(<i>documents, keyword</i>)
+
+<p>
+        Private slot to handle the activation of an entry with multiple help
+        documents.
+</p>
+<dl>
+
+<dt><i>documents</i> (list of QHelpLink)</dt>
+<dd>
+list of help document link data structures
+</dd>
+<dt><i>keyword</i> (str)</dt>
+<dd>
+keyword for the entry
+</dd>
+</dl>
 <a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a>
 <h4>HelpIndexWidget.__enableSearchEdit</h4>
 <b>__enableSearchEdit</b>(<i></i>)
@@ -181,80 +223,40 @@
 </p>
 <dl>
 
-<dt><i>indexFilter</i></dt>
+<dt><i>indexFilter</i> (str)</dt>
 <dd>
-filter to be used (string)
+filter to be used
 </dd>
 </dl>
-<a NAME="HelpIndexWidget.__linkActivated" ID="HelpIndexWidget.__linkActivated"></a>
-<h4>HelpIndexWidget.__linkActivated</h4>
-<b>__linkActivated</b>(<i>url, keyword, modifiers=None</i>)
+<a NAME="HelpIndexWidget.__selectDocument" ID="HelpIndexWidget.__selectDocument"></a>
+<h4>HelpIndexWidget.__selectDocument</h4>
+<b>__selectDocument</b>(<i>documents, keyword</i>)
 
 <p>
-        Private slot to handle the activation of a keyword entry.
+        Private method to give the user a chance to select among the
+        given documents.
 </p>
 <dl>
 
-<dt><i>url</i> (QUrl)</dt>
+<dt><i>documents</i> (list of QHelpLink)</dt>
 <dd>
-URL of the selected entry
+list of help document link data structures
 </dd>
 <dt><i>keyword</i> (str)</dt>
 <dd>
-keyword for the URL
-</dd>
-<dt><i>modifiers</i> (Qt.KeyboardModifiers or None)</dt>
-<dd>
-keyboard modifiers
-</dd>
-</dl>
-<a NAME="HelpIndexWidget.__linksActivated" ID="HelpIndexWidget.__linksActivated"></a>
-<h4>HelpIndexWidget.__linksActivated</h4>
-<b>__linksActivated</b>(<i>links, keyword</i>)
-
-<p>
-        Private slot to handle the activation of an entry with multiple links.
-</p>
-<dl>
-
-<dt><i>links</i> (dict of key:str and value:QUrl)</dt>
-<dd>
-dictionary containing the links
-</dd>
-<dt><i>keyword</i> (str)</dt>
-<dd>
-keyword for the entry
-</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
+keyword for the documents
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-selected link
+selected document
 </dd>
 </dl>
 <dl>
 <dt>Return Type:</dt>
 <dd>
-QUrl
+QHelpLink
 </dd>
 </dl>
 <a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a>
@@ -266,9 +268,9 @@
 </p>
 <dl>
 
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (QPoint)</dt>
 <dd>
-position to show the menu at (QPoint)
+position to show the menu at
 </dd>
 </dl>
 <a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a>
@@ -280,19 +282,25 @@
 </p>
 <dl>
 
-<dt><i>watched</i></dt>
+<dt><i>watched</i> (QObject)</dt>
 <dd>
-the QObject being watched (QObject)
+the QObject being watched
 </dd>
-<dt><i>event</i></dt>
+<dt><i>event</i> (QEvent)</dt>
 <dd>
-the event that occurred (QEvent)
+the event that occurred
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating whether the event was handled (boolean)
+flag indicating whether the event was handled
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a>
@@ -304,9 +312,9 @@
 </p>
 <dl>
 
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QFocusEvent)</dt>
 <dd>
-reference to the focus event object (QFocusEvent)
+reference to the focus event object
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial