diff -r 7ef7d47a0ad5 -r e6af0dcfbb35 Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html Sat Dec 09 18:32:08 2017 +0100
@@ -0,0 +1,312 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog</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.PipSearchDialog</h1>
+<p>
+Module implementing a dialog to search PyPI.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PipSearchDialog">PipSearchDialog</a></td>
+<td>Class implementing a dialog to search PyPI.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="PipSearchDialog" ID="PipSearchDialog"></a>
+<h2>PipSearchDialog</h2>
+<p>
+ Class implementing a dialog to search PyPI.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_PipSearchDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>Stopwords</td></tr><tr><td>VersionRole</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PipSearchDialog.__init__">PipSearchDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.__detailsError">__detailsError</a></td>
+<td>Private method handling a details error.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.__displayPackageDetails">__displayPackageDetails</a></td>
+<td>Private method to display the returned package details.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.__finish">__finish</a></td>
+<td>Private slot performing the finishing actions.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.__getPackageDownloadsData">__getPackageDownloadsData</a></td>
+<td>Private method to store the details data and get downloads information.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.__install">__install</a></td>
+<td>Private slot to install the selected packages.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.__processSearchResult">__processSearchResult</a></td>
+<td>Private method to process the search result data from PyPI.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.__score">__score</a></td>
+<td>Private method to calculate some score for a search result.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.__search">__search</a></td>
+<td>Private method to perform the search.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.__searchError">__searchError</a></td>
+<td>Private method handling a search error.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.__showDetails">__showDetails</a></td>
+<td>Private slot to show details about the selected package.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.__transformHits">__transformHits</a></td>
+<td>Private method to convert the list returned from pypi into a packages list.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.closeEvent">closeEvent</a></td>
+<td>Protected slot implementing a close event handler.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot called by a button of the button box clicked.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
+<td>Private slot reacting on an item activation.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.on_resultList_itemSelectionChanged">on_resultList_itemSelectionChanged</a></td>
+<td>Private slot handling changes of the selection.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.on_searchButton_clicked">on_searchButton_clicked</a></td>
+<td>Private slot handling a press of the search button.</td>
+</tr><tr>
+<td><a href="#PipSearchDialog.on_searchEdit_textChanged">on_searchEdit_textChanged</a></td>
+<td>Private slot handling a change of the search term.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="PipSearchDialog.__init__" ID="PipSearchDialog.__init__"></a>
+<h4>PipSearchDialog (Constructor)</h4>
+<b>PipSearchDialog</b>(<i>pip, plugin, parent=None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>pip</i></dt>
+<dd>
+reference to the master object (Pip)
+</dd><dt><i>plugin</i></dt>
+<dd>
+reference to the plugin object (ToolPipPlugin)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="PipSearchDialog.__detailsError" ID="PipSearchDialog.__detailsError"></a>
+<h4>PipSearchDialog.__detailsError</h4>
+<b>__detailsError</b>(<i>errorCode, errorString</i>)
+<p>
+ Private method handling a details error.
+</p><dl>
+<dt><i>errorCode</i></dt>
+<dd>
+code of the error (integer)
+</dd><dt><i>errorString</i></dt>
+<dd>
+error message (string)
+</dd>
+</dl><a NAME="PipSearchDialog.__displayPackageDetails" ID="PipSearchDialog.__displayPackageDetails"></a>
+<h4>PipSearchDialog.__displayPackageDetails</h4>
+<b>__displayPackageDetails</b>(<i>data</i>)
+<p>
+ Private method to display the returned package details.
+</p><dl>
+<dt><i>data</i></dt>
+<dd>
+result data (tuple) with downloads information in the first
+ element
+</dd>
+</dl><a NAME="PipSearchDialog.__finish" ID="PipSearchDialog.__finish"></a>
+<h4>PipSearchDialog.__finish</h4>
+<b>__finish</b>(<i></i>)
+<p>
+ Private slot performing the finishing actions.
+</p><a NAME="PipSearchDialog.__getPackageDownloadsData" ID="PipSearchDialog.__getPackageDownloadsData"></a>
+<h4>PipSearchDialog.__getPackageDownloadsData</h4>
+<b>__getPackageDownloadsData</b>(<i>packageVersion, data</i>)
+<p>
+ Private method to store the details data and get downloads
+ information.
+</p><dl>
+<dt><i>packageVersion</i> (str)</dt>
+<dd>
+version info
+</dd><dt><i>data</i> (tuple)</dt>
+<dd>
+result data with package details in the first
+ element
+</dd>
+</dl><a NAME="PipSearchDialog.__install" ID="PipSearchDialog.__install"></a>
+<h4>PipSearchDialog.__install</h4>
+<b>__install</b>(<i></i>)
+<p>
+ Private slot to install the selected packages.
+</p><a NAME="PipSearchDialog.__processSearchResult" ID="PipSearchDialog.__processSearchResult"></a>
+<h4>PipSearchDialog.__processSearchResult</h4>
+<b>__processSearchResult</b>(<i>data</i>)
+<p>
+ Private method to process the search result data from PyPI.
+</p><dl>
+<dt><i>data</i></dt>
+<dd>
+result data (tuple) with hits in the first element
+</dd>
+</dl><a NAME="PipSearchDialog.__score" ID="PipSearchDialog.__score"></a>
+<h4>PipSearchDialog.__score</h4>
+<b>__score</b>(<i>name, summary</i>)
+<p>
+ Private method to calculate some score for a search result.
+</p><dl>
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the returned package
+</dd><dt><i>summary</i> (str)</dt>
+<dd>
+summary text for the package
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+score value
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
+</dl><a NAME="PipSearchDialog.__search" ID="PipSearchDialog.__search"></a>
+<h4>PipSearchDialog.__search</h4>
+<b>__search</b>(<i></i>)
+<p>
+ Private method to perform the search.
+</p><a NAME="PipSearchDialog.__searchError" ID="PipSearchDialog.__searchError"></a>
+<h4>PipSearchDialog.__searchError</h4>
+<b>__searchError</b>(<i>errorCode, errorString</i>)
+<p>
+ Private method handling a search error.
+</p><dl>
+<dt><i>errorCode</i></dt>
+<dd>
+code of the error (integer)
+</dd><dt><i>errorString</i></dt>
+<dd>
+error message (string)
+</dd>
+</dl><a NAME="PipSearchDialog.__showDetails" ID="PipSearchDialog.__showDetails"></a>
+<h4>PipSearchDialog.__showDetails</h4>
+<b>__showDetails</b>(<i></i>)
+<p>
+ Private slot to show details about the selected package.
+</p><a NAME="PipSearchDialog.__transformHits" ID="PipSearchDialog.__transformHits"></a>
+<h4>PipSearchDialog.__transformHits</h4>
+<b>__transformHits</b>(<i>hits</i>)
+<p>
+ Private method to convert the list returned from pypi into a
+ packages list.
+</p><dl>
+<dt><i>hits</i></dt>
+<dd>
+list returned from pypi (list of dict)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+list of packages (list of dict)
+</dd>
+</dl><a NAME="PipSearchDialog.closeEvent" ID="PipSearchDialog.closeEvent"></a>
+<h4>PipSearchDialog.closeEvent</h4>
+<b>closeEvent</b>(<i>e</i>)
+<p>
+ Protected slot implementing a close event handler.
+</p><dl>
+<dt><i>e</i></dt>
+<dd>
+close event (QCloseEvent)
+</dd>
+</dl><a NAME="PipSearchDialog.on_buttonBox_clicked" ID="PipSearchDialog.on_buttonBox_clicked"></a>
+<h4>PipSearchDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
+<p>
+ Private slot called by a button of the button box clicked.
+</p><dl>
+<dt><i>button</i></dt>
+<dd>
+button that was clicked (QAbstractButton)
+</dd>
+</dl><a NAME="PipSearchDialog.on_resultList_itemActivated" ID="PipSearchDialog.on_resultList_itemActivated"></a>
+<h4>PipSearchDialog.on_resultList_itemActivated</h4>
+<b>on_resultList_itemActivated</b>(<i>item, column</i>)
+<p>
+ Private slot reacting on an item activation.
+</p><dl>
+<dt><i>item</i></dt>
+<dd>
+reference to the activated item (QTreeWidgetItem)
+</dd><dt><i>column</i></dt>
+<dd>
+activated column (integer)
+</dd>
+</dl><a NAME="PipSearchDialog.on_resultList_itemSelectionChanged" ID="PipSearchDialog.on_resultList_itemSelectionChanged"></a>
+<h4>PipSearchDialog.on_resultList_itemSelectionChanged</h4>
+<b>on_resultList_itemSelectionChanged</b>(<i></i>)
+<p>
+ Private slot handling changes of the selection.
+</p><a NAME="PipSearchDialog.on_searchButton_clicked" ID="PipSearchDialog.on_searchButton_clicked"></a>
+<h4>PipSearchDialog.on_searchButton_clicked</h4>
+<b>on_searchButton_clicked</b>(<i></i>)
+<p>
+ Private slot handling a press of the search button.
+</p><a NAME="PipSearchDialog.on_searchEdit_textChanged" ID="PipSearchDialog.on_searchEdit_textChanged"></a>
+<h4>PipSearchDialog.on_searchEdit_textChanged</h4>
+<b>on_searchEdit_textChanged</b>(<i>txt</i>)
+<p>
+ Private slot handling a change of the search term.
+</p><dl>
+<dt><i>txt</i></dt>
+<dd>
+search term (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
