tip/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxSpecInputDialog.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Pipx_Interface.PipxInterface.PipxSpecInputDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Pipx_Interface.PipxInterface.PipxSpecInputDialog</h1>
<p>
Module implementing a dialog to enter the data for an 'install-all' operation.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#PipxSpecInputDialog">PipxSpecInputDialog</a></td>
<td>Class implementing a dialog to enter the data for an 'install-all' operation.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="PipxSpecInputDialog" ID="PipxSpecInputDialog"></a>
<h2>PipxSpecInputDialog</h2>
<p>
    Class implementing a dialog to enter the data for an 'install-all' operation.
</p>

<h3>Derived from</h3>
QDialog, Ui_PipxSpecInputDialog
<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="#PipxSpecInputDialog.__init__">PipxSpecInputDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#PipxSpecInputDialog.getData">getData</a></td>
<td>Public method to get the entered data.</td>
</tr>
<tr>
<td><a href="#PipxSpecInputDialog.on_specFilePicker_textChanged">on_specFilePicker_textChanged</a></td>
<td>Private slot handling entering a file path.</td>
</tr>
</table>

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


<a NAME="PipxSpecInputDialog.__init__" ID="PipxSpecInputDialog.__init__"></a>
<h4>PipxSpecInputDialog (Constructor)</h4>
<b>PipxSpecInputDialog</b>(<i>title, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>title</i> (str)</dt>
<dd>
dialog title
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="PipxSpecInputDialog.getData" ID="PipxSpecInputDialog.getData"></a>
<h4>PipxSpecInputDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to get the entered data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple with the file path of the spec metadata file, the desired Python
            interpreter version, a flag indicating to fetch a missing interpreter
            from GitHub, a flag indicating to force the installation and a flag
            indicating to give access to the system site-packages directory.
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (list of str, str, bool, bool, bool)
</dd>
</dl>
<a NAME="PipxSpecInputDialog.on_specFilePicker_textChanged" ID="PipxSpecInputDialog.on_specFilePicker_textChanged"></a>
<h4>PipxSpecInputDialog.on_specFilePicker_textChanged</h4>
<b>on_specFilePicker_textChanged</b>(<i>txt</i>)
<p>
        Private slot handling entering a file path.
</p>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
path of the spec metadata file
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>