src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpTopicDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.QtHelpInterface.HelpTopicDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QtHelpInterface.HelpTopicDialog</h1>
<p>
Module implementing a dialog to select a help topic to display.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HelpTopicDialog">HelpTopicDialog</a></td>
<td>Class implementing a dialog to select a help topic to display.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="HelpTopicDialog" ID="HelpTopicDialog"></a>
<h2>HelpTopicDialog</h2>
<p>
    Class implementing a dialog to select a help topic to display.
</p>

<h3>Derived from</h3>
QDialog, Ui_HelpTopicDialog
<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="#HelpTopicDialog.__init__">HelpTopicDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HelpTopicDialog.document">document</a></td>
<td>Public method to retrieve the selected help topic.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="HelpTopicDialog.__init__" ID="HelpTopicDialog.__init__"></a>
<h4>HelpTopicDialog (Constructor)</h4>
<b>HelpTopicDialog</b>(<i>parent, helpKeyword, documents</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
<dt><i>helpKeyword</i> (str)</dt>
<dd>
keyword for the link set
</dd>
<dt><i>documents</i> (list of QHelpLink)</dt>
<dd>
list of help document link data structures
</dd>
</dl>
<a NAME="HelpTopicDialog.document" ID="HelpTopicDialog.document"></a>
<h4>HelpTopicDialog.document</h4>
<b>document</b>(<i></i>)
<p>
        Public method to retrieve the selected help topic.
</p>

<dl>
<dt>Return:</dt>
<dd>
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>
<hr />
</body></html>