diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.PipInterface.PipPackageDetailsDialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.PipInterface.PipPackageDetailsDialog.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,259 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.PipInterface.PipPackageDetailsDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.PipInterface.PipPackageDetailsDialog</h1> + +<p> +Module implementing a dialog to show details about a package. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#PipPackageDetailsDialog">PipPackageDetailsDialog</a></td> +<td>Class implementing a dialog to show details about a package.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="PipPackageDetailsDialog" ID="PipPackageDetailsDialog"></a> +<h2>PipPackageDetailsDialog</h2> + +<p> + Class implementing a dialog to show details about a package. +</p> +<h3>Derived from</h3> +QDialog, Ui_PipPackageDetailsDialog +<h3>Class Attributes</h3> + +<table> +<tr><td>ButtonInstall</td></tr><tr><td>ButtonRemove</td></tr><tr><td>ButtonUpgrade</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#PipPackageDetailsDialog.__init__">PipPackageDetailsDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#PipPackageDetailsDialog.__formatSize">__formatSize</a></td> +<td>Private slot to format the size.</td> +</tr> +<tr> +<td><a href="#PipPackageDetailsDialog.__formatUploadDate">__formatUploadDate</a></td> +<td>Private method to format the upload date.</td> +</tr> +<tr> +<td><a href="#PipPackageDetailsDialog.__populateDetails">__populateDetails</a></td> +<td>Private method to populate the details tab.</td> +</tr> +<tr> +<td><a href="#PipPackageDetailsDialog.__populateDownloadUrls">__populateDownloadUrls</a></td> +<td>Private method to populate the download URLs tab.</td> +</tr> +<tr> +<td><a href="#PipPackageDetailsDialog.__populateRequiresProvides">__populateRequiresProvides</a></td> +<td>Private method to populate the requires/provides tab.</td> +</tr> +<tr> +<td><a href="#PipPackageDetailsDialog.__sanitize">__sanitize</a></td> +<td>Private method to clean-up the given text.</td> +</tr> +<tr> +<td><a href="#PipPackageDetailsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot handling the user pressing an action button.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="PipPackageDetailsDialog.__init__" ID="PipPackageDetailsDialog.__init__"></a> +<h4>PipPackageDetailsDialog (Constructor)</h4> +<b>PipPackageDetailsDialog</b>(<i>detailsData, buttonsMode=0, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>detailsData</i> (dict)</dt> +<dd> +package details +</dd> +<dt><i>buttonsMode</i> (int (optional))</dt> +<dd> +flags telling which convenience buttons to enable + (defaults to 0) +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="PipPackageDetailsDialog.__formatSize" ID="PipPackageDetailsDialog.__formatSize"></a> +<h4>PipPackageDetailsDialog.__formatSize</h4> +<b>__formatSize</b>(<i>size</i>) + +<p> + Private slot to format the size. +</p> +<dl> + +<dt><i>size</i> (int)</dt> +<dd> +size to be formatted +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +formatted size +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="PipPackageDetailsDialog.__formatUploadDate" ID="PipPackageDetailsDialog.__formatUploadDate"></a> +<h4>PipPackageDetailsDialog.__formatUploadDate</h4> +<b>__formatUploadDate</b>(<i>datetime</i>) + +<p> + Private method to format the upload date. +</p> +<dl> + +<dt><i>datetime</i> (xmlrpc.DateTime or str)</dt> +<dd> +upload date and time +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +formatted date string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="PipPackageDetailsDialog.__populateDetails" ID="PipPackageDetailsDialog.__populateDetails"></a> +<h4>PipPackageDetailsDialog.__populateDetails</h4> +<b>__populateDetails</b>(<i>detailsData</i>) + +<p> + Private method to populate the details tab. +</p> +<dl> + +<dt><i>detailsData</i> (dict)</dt> +<dd> +package details +</dd> +</dl> +<a NAME="PipPackageDetailsDialog.__populateDownloadUrls" ID="PipPackageDetailsDialog.__populateDownloadUrls"></a> +<h4>PipPackageDetailsDialog.__populateDownloadUrls</h4> +<b>__populateDownloadUrls</b>(<i>downloadsData</i>) + +<p> + Private method to populate the download URLs tab. +</p> +<dl> + +<dt><i>downloadsData</i> (dict)</dt> +<dd> +downloads information +</dd> +</dl> +<a NAME="PipPackageDetailsDialog.__populateRequiresProvides" ID="PipPackageDetailsDialog.__populateRequiresProvides"></a> +<h4>PipPackageDetailsDialog.__populateRequiresProvides</h4> +<b>__populateRequiresProvides</b>(<i>detailsData</i>) + +<p> + Private method to populate the requires/provides tab. +</p> +<dl> + +<dt><i>detailsData</i> (dict)</dt> +<dd> +package details +</dd> +</dl> +<a NAME="PipPackageDetailsDialog.__sanitize" ID="PipPackageDetailsDialog.__sanitize"></a> +<h4>PipPackageDetailsDialog.__sanitize</h4> +<b>__sanitize</b>(<i>text, forUrl=False</i>) + +<p> + Private method to clean-up the given text. +</p> +<dl> + +<dt><i>text</i> (str)</dt> +<dd> +raw text +</dd> +<dt><i>forUrl</i> (bool)</dt> +<dd> +flag indicating to sanitize an URL text +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +processed text +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="PipPackageDetailsDialog.on_buttonBox_clicked" ID="PipPackageDetailsDialog.on_buttonBox_clicked"></a> +<h4>PipPackageDetailsDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) + +<p> + Private slot handling the user pressing an action button. +</p> +<dl> + +<dt><i>button</i> (QAbstractButton)</dt> +<dd> +button activated by the user +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file