src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.QtPage.html

Tue, 23 Apr 2024 11:26:04 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Tue, 23 Apr 2024 11:26:04 +0200
branch
eric7
changeset 10692
9becf9ca115c
parent 10684
58c7f23ae1cb
permissions
-rw-r--r--

Changed the source code and the source code documentation to improve the indication of unused method/function arguments.

<!DOCTYPE html>
<html><head>
<title>eric7.Preferences.ConfigurationPages.QtPage</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Preferences.ConfigurationPages.QtPage</h1>
<p>
Module implementing the Qt configuration page.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#QtPage">QtPage</a></td>
<td>Class implementing the Qt 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="QtPage" ID="QtPage"></a>
<h2>QtPage</h2>
<p>
    Class implementing the Qt configuration page.
</p>

<h3>Derived from</h3>
ConfigurationPageBase, Ui_QtPage
<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="#QtPage.__init__">QtPage</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#QtPage.__populateAndSetVenvComboBox">__populateAndSetVenvComboBox</a></td>
<td>Private method to populate and set the virtual environment combo boxes.</td>
</tr>
<tr>
<td><a href="#QtPage.__populateAndSetVenvComboBoxes">__populateAndSetVenvComboBoxes</a></td>
<td>Private method to populate the virtual environment combo boxes.</td>
</tr>
<tr>
<td><a href="#QtPage.__showVirtualEnvManager">__showVirtualEnvManager</a></td>
<td>Private method to show the virtual environment manager dialog.</td>
</tr>
<tr>
<td><a href="#QtPage.__updateQtSample">__updateQtSample</a></td>
<td>Private slot to update the Qt tools sample label.</td>
</tr>
<tr>
<td><a href="#QtPage.on_qtPostfixEdit_textChanged">on_qtPostfixEdit_textChanged</a></td>
<td>Private slot to handle a change in the entered Qt directory.</td>
</tr>
<tr>
<td><a href="#QtPage.on_qtPrefixEdit_textChanged">on_qtPrefixEdit_textChanged</a></td>
<td>Private slot to handle a change in the entered Qt directory.</td>
</tr>
<tr>
<td><a href="#QtPage.on_qtToolsDirPicker_editTextChanged">on_qtToolsDirPicker_editTextChanged</a></td>
<td>Private slot handling a change of the Qt Tools directory.</td>
</tr>
<tr>
<td><a href="#QtPage.save">save</a></td>
<td>Public slot to save the Qt configuration.</td>
</tr>
</table>

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


<a NAME="QtPage.__init__" ID="QtPage.__init__"></a>
<h4>QtPage (Constructor)</h4>
<b>QtPage</b>(<i></i>)
<p>
        Constructor
</p>

<a NAME="QtPage.__populateAndSetVenvComboBox" ID="QtPage.__populateAndSetVenvComboBox"></a>
<h4>QtPage.__populateAndSetVenvComboBox</h4>
<b>__populateAndSetVenvComboBox</b>(<i>comboBox, envKey, initial</i>)
<p>
        Private method to populate and set the virtual environment combo boxes.
</p>

<dl>

<dt><i>comboBox</i> (QComboBox)</dt>
<dd>
reference to the combo box to be populated
</dd>
<dt><i>envKey</i> (str)</dt>
<dd>
preferences key for the environment
</dd>
<dt><i>initial</i> (bool)</dt>
<dd>
flag indicating an initial population
</dd>
</dl>
<a NAME="QtPage.__populateAndSetVenvComboBoxes" ID="QtPage.__populateAndSetVenvComboBoxes"></a>
<h4>QtPage.__populateAndSetVenvComboBoxes</h4>
<b>__populateAndSetVenvComboBoxes</b>(<i>initial</i>)
<p>
        Private method to populate the virtual environment combo boxes.
</p>

<dl>

<dt><i>initial</i> (bool)</dt>
<dd>
flag indicating an initial population
</dd>
</dl>
<a NAME="QtPage.__showVirtualEnvManager" ID="QtPage.__showVirtualEnvManager"></a>
<h4>QtPage.__showVirtualEnvManager</h4>
<b>__showVirtualEnvManager</b>(<i></i>)
<p>
        Private method to show the virtual environment manager dialog.
</p>

<a NAME="QtPage.__updateQtSample" ID="QtPage.__updateQtSample"></a>
<h4>QtPage.__updateQtSample</h4>
<b>__updateQtSample</b>(<i></i>)
<p>
        Private slot to update the Qt tools sample label.
</p>

<a NAME="QtPage.on_qtPostfixEdit_textChanged" ID="QtPage.on_qtPostfixEdit_textChanged"></a>
<h4>QtPage.on_qtPostfixEdit_textChanged</h4>
<b>on_qtPostfixEdit_textChanged</b>(<i>_txt</i>)
<p>
        Private slot to handle a change in the entered Qt directory.
</p>

<dl>

<dt><i>_txt</i> (str)</dt>
<dd>
the entered string (unused)
</dd>
</dl>
<a NAME="QtPage.on_qtPrefixEdit_textChanged" ID="QtPage.on_qtPrefixEdit_textChanged"></a>
<h4>QtPage.on_qtPrefixEdit_textChanged</h4>
<b>on_qtPrefixEdit_textChanged</b>(<i>_txt</i>)
<p>
        Private slot to handle a change in the entered Qt directory.
</p>

<dl>

<dt><i>_txt</i> (str)</dt>
<dd>
the entered string (unused)
</dd>
</dl>
<a NAME="QtPage.on_qtToolsDirPicker_editTextChanged" ID="QtPage.on_qtToolsDirPicker_editTextChanged"></a>
<h4>QtPage.on_qtToolsDirPicker_editTextChanged</h4>
<b>on_qtToolsDirPicker_editTextChanged</b>(<i>directory</i>)
<p>
        Private slot handling a change of the Qt Tools directory.
</p>

<dl>

<dt><i>directory</i> (str)</dt>
<dd>
text entered into the Qt Tools directory edit
</dd>
</dl>
<a NAME="QtPage.save" ID="QtPage.save"></a>
<h4>QtPage.save</h4>
<b>save</b>(<i></i>)
<p>
        Public slot to save the Qt 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> (ConfigurationDialog)</dt>
<dd>
reference to the configuration dialog (unused)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the instantiated page
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
ConfigurationPageBase
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial