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

branch
eric7
changeset 8422
bb5da74c1b3f
parent 8372
e0227a7c850e
child 8575
423c4db4101e
--- a/eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpTopicDialog.html	Thu Jun 10 19:32:22 2021 +0200
+++ b/eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpTopicDialog.html	Sun Jun 13 19:03:43 2021 +0200
@@ -73,8 +73,8 @@
 <td>Constructor</td>
 </tr>
 <tr>
-<td><a href="#HelpTopicDialog.link">link</a></td>
-<td>Public method to the link of the selected topic.</td>
+<td><a href="#HelpTopicDialog.document">document</a></td>
+<td>Public method to retrieve the selected help topic.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
@@ -85,38 +85,43 @@
 
 <a NAME="HelpTopicDialog.__init__" ID="HelpTopicDialog.__init__"></a>
 <h4>HelpTopicDialog (Constructor)</h4>
-<b>HelpTopicDialog</b>(<i>parent, keyword, links</i>)
+<b>HelpTopicDialog</b>(<i>parent, keyword, documents</i>)
 
 <p>
         Constructor
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
 </dd>
-<dt><i>keyword</i></dt>
+<dt><i>keyword</i> (str)</dt>
 <dd>
-keyword for the link set (string)
+keyword for the link set
 </dd>
-<dt><i>links</i></dt>
+<dt><i>documents</i> (list of QHelpLink)</dt>
 <dd>
-dictionary with help topic as key (string) and
-            URL as value (QUrl)
+list of help document link data structures
 </dd>
 </dl>
-<a NAME="HelpTopicDialog.link" ID="HelpTopicDialog.link"></a>
-<h4>HelpTopicDialog.link</h4>
-<b>link</b>(<i></i>)
+<a NAME="HelpTopicDialog.document" ID="HelpTopicDialog.document"></a>
+<h4>HelpTopicDialog.document</h4>
+<b>document</b>(<i></i>)
 
 <p>
-        Public method to the link of the selected topic.
+        Public method to retrieve the selected help topic.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
-URL of the selected topic (QUrl)
+help document link for the selected help topic
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QHelpLink
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial