Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html

changeset 6011
e6af0dcfbb35
child 6047
39586a2de99d
diff -r 7ef7d47a0ad5 -r e6af0dcfbb35 Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html	Sat Dec 09 18:32:08 2017 +0100
@@ -0,0 +1,183 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog</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>eric6.Plugins.UiExtensionPlugins.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 documentation goes here.</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 documentation goes here.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_PipPackageDetailsDialog
+<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="#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>
+</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, downloadsData, parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>detailsData</i></dt>
+<dd>
+package details (dict)
+</dd><dt><i>downloadsData</i></dt>
+<dd>
+downloads information (dict)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</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></dt>
+<dd>
+size to be formatted (integer)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+formatted size (string)
+</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></dt>
+<dd>
+upload date and time (xmlrpc.DateTime)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+formatted date string (string)
+</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></dt>
+<dd>
+package details (dict)
+</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></dt>
+<dd>
+downloads information (dict)
+</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></dt>
+<dd>
+package details (dict)
+</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></dt>
+<dd>
+raw text (string)
+</dd><dt><i>forUrl</i></dt>
+<dd>
+flag indicating to sanitize an URL text (boolean)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+processed text (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial