--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxPackagesInputDialog.html Fri Jun 28 17:24:18 2024 +0200 @@ -0,0 +1,135 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Pipx_Interface.PipxInterface.PipxPackagesInputDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_Pipx_Interface.PipxInterface.PipxPackagesInputDialog</h1> +<p> +Module implementing a dialog to enter package specifications. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PipxPackagesInputDialog">PipxPackagesInputDialog</a></td> +<td>Class implementing a dialog to enter package specifications and installation options.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="PipxPackagesInputDialog" ID="PipxPackagesInputDialog"></a> +<h2>PipxPackagesInputDialog</h2> +<p> + Class implementing a dialog to enter package specifications and installation + options. +</p> + +<h3>Derived from</h3> +QDialog, Ui_PipxPackagesInputDialog +<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="#PipxPackagesInputDialog.__init__">PipxPackagesInputDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#PipxPackagesInputDialog.getData">getData</a></td> +<td>Public method to get the entered data.</td> +</tr> +<tr> +<td><a href="#PipxPackagesInputDialog.on_packagesEdit_textChanged">on_packagesEdit_textChanged</a></td> +<td>Private slot handling entering package names.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="PipxPackagesInputDialog.__init__" ID="PipxPackagesInputDialog.__init__"></a> +<h4>PipxPackagesInputDialog (Constructor)</h4> +<b>PipxPackagesInputDialog</b>(<i>title, install=True, parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>title</i> (str)</dt> +<dd> +dialog title +</dd> +<dt><i>install</i> (bool)</dt> +<dd> +flag indicating an install action +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="PipxPackagesInputDialog.getData" ID="PipxPackagesInputDialog.getData"></a> +<h4>PipxPackagesInputDialog.getData</h4> +<b>getData</b>(<i></i>) +<p> + Public method to get the entered data. +</p> + +<dl> +<dt>Return:</dt> +<dd> +tuple with the list of package specifications, 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="PipxPackagesInputDialog.on_packagesEdit_textChanged" ID="PipxPackagesInputDialog.on_packagesEdit_textChanged"></a> +<h4>PipxPackagesInputDialog.on_packagesEdit_textChanged</h4> +<b>on_packagesEdit_textChanged</b>(<i>txt</i>) +<p> + Private slot handling entering package names. +</p> + +<dl> + +<dt><i>txt</i> (str)</dt> +<dd> +name of the requirements file +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>