Updated source docu.

Sat, 19 May 2018 16:41:22 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 19 May 2018 16:41:22 +0200
changeset 6298
2be37423974e
parent 6297
85e20e9b4d55
child 6299
feb3cf2cbde3

Updated source docu.

Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipFileSelectionDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipRequirementsSelectionDialog.html file | annotate | diff | comparison | revisions
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Sat May 19 16:38:28 2018 +0200
+++ b/Documentation/Help/source.qhp	Sat May 19 16:41:22 2018 +0200
@@ -19630,7 +19630,6 @@
       <file>eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html</file>
       <file>eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html</file>
       <file>eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html</file>
-      <file>eric6.Plugins.UiExtensionPlugins.PipInterface.PipRequirementsSelectionDialog.html</file>
       <file>eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html</file>
       <file>eric6.Plugins.UiExtensionPlugins.Translator.ConfigurationPage.TranslatorPage.html</file>
       <file>eric6.Plugins.UiExtensionPlugins.Translator.Translator.html</file>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipFileSelectionDialog.html	Sat May 19 16:41:22 2018 +0200
@@ -0,0 +1,119 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.Plugins.UiExtensionPlugins.PipInterface.PipFileSelectionDialog</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.PipFileSelectionDialog</h1>
+<p>
+Module implementing a dialog to enter a file to be processed.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PipFileSelectionDialog">PipFileSelectionDialog</a></td>
+<td>Class implementing a dialog to enter a file to be processed.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="PipFileSelectionDialog" ID="PipFileSelectionDialog"></a>
+<h2>PipFileSelectionDialog</h2>
+<p>
+    Class implementing a dialog to enter a file to be processed.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_PipFileSelectionDialog
+<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="#PipFileSelectionDialog.__init__">PipFileSelectionDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#PipFileSelectionDialog.getData">getData</a></td>
+<td>Public method to get the entered data.</td>
+</tr><tr>
+<td><a href="#PipFileSelectionDialog.on_filePicker_textChanged">on_filePicker_textChanged</a></td>
+<td>Private slot to handle entering the name of a file.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="PipFileSelectionDialog.__init__" ID="PipFileSelectionDialog.__init__"></a>
+<h4>PipFileSelectionDialog (Constructor)</h4>
+<b>PipFileSelectionDialog</b>(<i>plugin, mode, parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>plugin</i> (PipInterfacePlugin)</dt>
+<dd>
+reference to the plugin object
+</dd><dt><i>mode</i> (str)</dt>
+<dd>
+mode of the dialog
+</dd><dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl><a NAME="PipFileSelectionDialog.getData" ID="PipFileSelectionDialog.getData"></a>
+<h4>PipFileSelectionDialog.getData</h4>
+<b>getData</b>(<i></i>)
+<p>
+        Public method to get the entered data.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+tuple with the pip command and the name of the
+            selected file
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
+</dd>
+</dl><a NAME="PipFileSelectionDialog.on_filePicker_textChanged" ID="PipFileSelectionDialog.on_filePicker_textChanged"></a>
+<h4>PipFileSelectionDialog.on_filePicker_textChanged</h4>
+<b>on_filePicker_textChanged</b>(<i>txt</i>)
+<p>
+        Private slot to handle entering the name of a file.
+</p><dl>
+<dt><i>txt</i> (str)</dt>
+<dd>
+name of the file
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipRequirementsSelectionDialog.html	Sat May 19 16:38:28 2018 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,120 +0,0 @@
-<!DOCTYPE html>
-<html><head>
-<title>eric6.Plugins.UiExtensionPlugins.PipInterface.PipRequirementsSelectionDialog</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.PipRequirementsSelectionDialog</h1>
-<p>
-Module implementing a dialog to enter a requirements file.
-</p>
-<h3>Global Attributes</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Classes</h3>
-<table>
-<tr>
-<td><a href="#PipRequirementsSelectionDialog">PipRequirementsSelectionDialog</a></td>
-<td>Class implementing a dialog to enter a requirements file.</td>
-</tr>
-</table>
-<h3>Functions</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<hr /><hr />
-<a NAME="PipRequirementsSelectionDialog" ID="PipRequirementsSelectionDialog"></a>
-<h2>PipRequirementsSelectionDialog</h2>
-<p>
-    Class implementing a dialog to enter a requirements file.
-</p>
-<h3>Derived from</h3>
-QDialog, Ui_PipRequirementsSelectionDialog
-<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="#PipRequirementsSelectionDialog.__init__">PipRequirementsSelectionDialog</a></td>
-<td>Constructor</td>
-</tr><tr>
-<td><a href="#PipRequirementsSelectionDialog.getData">getData</a></td>
-<td>Public method to get the entered data.</td>
-</tr><tr>
-<td><a href="#PipRequirementsSelectionDialog.on_fileButton_clicked">on_fileButton_clicked</a></td>
-<td>Private slot to enter the requirements file via a file selection dialog.</td>
-</tr><tr>
-<td><a href="#PipRequirementsSelectionDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td>
-<td>Private slot handling entering the name of a requirements file.</td>
-</tr>
-</table>
-<h3>Static Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<a NAME="PipRequirementsSelectionDialog.__init__" ID="PipRequirementsSelectionDialog.__init__"></a>
-<h4>PipRequirementsSelectionDialog (Constructor)</h4>
-<b>PipRequirementsSelectionDialog</b>(<i>plugin, parent=None</i>)
-<p>
-        Constructor
-</p><dl>
-<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="PipRequirementsSelectionDialog.getData" ID="PipRequirementsSelectionDialog.getData"></a>
-<h4>PipRequirementsSelectionDialog.getData</h4>
-<b>getData</b>(<i></i>)
-<p>
-        Public method to get the entered data.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-tuple with the pip command (string) and the name of the
-            requirements file (string)
-</dd>
-</dl><a NAME="PipRequirementsSelectionDialog.on_fileButton_clicked" ID="PipRequirementsSelectionDialog.on_fileButton_clicked"></a>
-<h4>PipRequirementsSelectionDialog.on_fileButton_clicked</h4>
-<b>on_fileButton_clicked</b>(<i></i>)
-<p>
-        Private slot to enter the requirements file via a file selection
-        dialog.
-</p><a NAME="PipRequirementsSelectionDialog.on_requirementsEdit_textChanged" ID="PipRequirementsSelectionDialog.on_requirementsEdit_textChanged"></a>
-<h4>PipRequirementsSelectionDialog.on_requirementsEdit_textChanged</h4>
-<b>on_requirementsEdit_textChanged</b>(<i>txt</i>)
-<p>
-        Private slot handling entering the name of a requirements file.
-</p><dl>
-<dt><i>txt</i></dt>
-<dd>
-name of the requirements file (string)
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr />
-</body></html>
\ No newline at end of file

eric ide

mercurial