src/eric7/Documentation/Source/eric7.PipInterface.PipFileSelectionDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.PipInterface.PipFileSelectionDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.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>mode, install=True, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>mode</i> (str)</dt>
<dd>
mode of the dialog
</dd>
<dt><i>install</i> (bool)</dt>
<dd>
flag indicating an install action
</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>Return:</dt>
<dd>
tuple with the name of the selected file and a flag indicating
            to install to the user install directory
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, bool)
</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>