Documentation/Source/eric5.Preferences.ConfigurationPages.HelpDocumentationPage.html

<!DOCTYPE html>
<html><head>
<title>eric5.Preferences.ConfigurationPages.HelpDocumentationPage</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>eric5.Preferences.ConfigurationPages.HelpDocumentationPage</h1>
<p>
Module implementing the Help Documentation configuration page.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#HelpDocumentationPage">HelpDocumentationPage</a></td>
<td>Class implementing the Help Documentation configuration page.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr>
<td><a href="#create">create</a></td>
<td>Module function to create the configuration page.</td>
</tr>
</table>
<hr /><hr />
<a NAME="HelpDocumentationPage" ID="HelpDocumentationPage"></a>
<h2>HelpDocumentationPage</h2>
<p>
    Class implementing the Help Documentation configuration page.
</p>
<h3>Derived from</h3>
ConfigurationPageBase, Ui_HelpDocumentationPage
<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="#HelpDocumentationPage.__init__">HelpDocumentationPage</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#HelpDocumentationPage.on_pyqt4DocDirButton_clicked">on_pyqt4DocDirButton_clicked</a></td>
<td>Private slot to select the PyQt4 documentation directory.</td>
</tr><tr>
<td><a href="#HelpDocumentationPage.on_pyqt5DocDirButton_clicked">on_pyqt5DocDirButton_clicked</a></td>
<td>Private slot to select the PyQt5 documentation directory.</td>
</tr><tr>
<td><a href="#HelpDocumentationPage.on_pysideDocDirButton_clicked">on_pysideDocDirButton_clicked</a></td>
<td>Private slot to select the PySide documentation directory.</td>
</tr><tr>
<td><a href="#HelpDocumentationPage.on_python2DocDirButton_clicked">on_python2DocDirButton_clicked</a></td>
<td>Private slot to select the Python 2 documentation directory.</td>
</tr><tr>
<td><a href="#HelpDocumentationPage.on_pythonDocDirButton_clicked">on_pythonDocDirButton_clicked</a></td>
<td>Private slot to select the Python 3 documentation directory.</td>
</tr><tr>
<td><a href="#HelpDocumentationPage.on_qt4DocDirButton_clicked">on_qt4DocDirButton_clicked</a></td>
<td>Private slot to select the Qt4 documentation directory.</td>
</tr><tr>
<td><a href="#HelpDocumentationPage.on_qt5DocDirButton_clicked">on_qt5DocDirButton_clicked</a></td>
<td>Private slot to select the Qt5 documentation directory.</td>
</tr><tr>
<td><a href="#HelpDocumentationPage.save">save</a></td>
<td>Public slot to save the Help Documentation configuration.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="HelpDocumentationPage.__init__" ID="HelpDocumentationPage.__init__"></a>
<h4>HelpDocumentationPage (Constructor)</h4>
<b>HelpDocumentationPage</b>(<i></i>)
<p>
        Constructor
</p><a NAME="HelpDocumentationPage.on_pyqt4DocDirButton_clicked" ID="HelpDocumentationPage.on_pyqt4DocDirButton_clicked"></a>
<h4>HelpDocumentationPage.on_pyqt4DocDirButton_clicked</h4>
<b>on_pyqt4DocDirButton_clicked</b>(<i></i>)
<p>
        Private slot to select the PyQt4 documentation directory.
</p><a NAME="HelpDocumentationPage.on_pyqt5DocDirButton_clicked" ID="HelpDocumentationPage.on_pyqt5DocDirButton_clicked"></a>
<h4>HelpDocumentationPage.on_pyqt5DocDirButton_clicked</h4>
<b>on_pyqt5DocDirButton_clicked</b>(<i></i>)
<p>
        Private slot to select the PyQt5 documentation directory.
</p><a NAME="HelpDocumentationPage.on_pysideDocDirButton_clicked" ID="HelpDocumentationPage.on_pysideDocDirButton_clicked"></a>
<h4>HelpDocumentationPage.on_pysideDocDirButton_clicked</h4>
<b>on_pysideDocDirButton_clicked</b>(<i></i>)
<p>
        Private slot to select the PySide documentation directory.
</p><a NAME="HelpDocumentationPage.on_python2DocDirButton_clicked" ID="HelpDocumentationPage.on_python2DocDirButton_clicked"></a>
<h4>HelpDocumentationPage.on_python2DocDirButton_clicked</h4>
<b>on_python2DocDirButton_clicked</b>(<i></i>)
<p>
        Private slot to select the Python 2 documentation directory.
</p><a NAME="HelpDocumentationPage.on_pythonDocDirButton_clicked" ID="HelpDocumentationPage.on_pythonDocDirButton_clicked"></a>
<h4>HelpDocumentationPage.on_pythonDocDirButton_clicked</h4>
<b>on_pythonDocDirButton_clicked</b>(<i></i>)
<p>
        Private slot to select the Python 3 documentation directory.
</p><a NAME="HelpDocumentationPage.on_qt4DocDirButton_clicked" ID="HelpDocumentationPage.on_qt4DocDirButton_clicked"></a>
<h4>HelpDocumentationPage.on_qt4DocDirButton_clicked</h4>
<b>on_qt4DocDirButton_clicked</b>(<i></i>)
<p>
        Private slot to select the Qt4 documentation directory.
</p><a NAME="HelpDocumentationPage.on_qt5DocDirButton_clicked" ID="HelpDocumentationPage.on_qt5DocDirButton_clicked"></a>
<h4>HelpDocumentationPage.on_qt5DocDirButton_clicked</h4>
<b>on_qt5DocDirButton_clicked</b>(<i></i>)
<p>
        Private slot to select the Qt5 documentation directory.
</p><a NAME="HelpDocumentationPage.save" ID="HelpDocumentationPage.save"></a>
<h4>HelpDocumentationPage.save</h4>
<b>save</b>(<i></i>)
<p>
        Public slot to save the Help Documentation configuration.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="create" ID="create"></a>
<h2>create</h2>
<b>create</b>(<i>dlg</i>)
<p>
    Module function to create the configuration page.
</p><dl>
<dt><i>dlg</i></dt>
<dd>
reference to the configuration dialog
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
reference to the instantiated page (ConfigurationPageBase)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>