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

changeset 6298
2be37423974e
child 6333
3d4e7155d48f
--- /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

eric ide

mercurial