src/eric7/Documentation/Source/eric7.Preferences.ProgramsDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Preferences.ProgramsDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Preferences.ProgramsDialog</h1>

<p>
Module implementing the Programs page.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#ProgramsDialog">ProgramsDialog</a></td>
<td>Class implementing the Programs page.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="ProgramsDialog" ID="ProgramsDialog"></a>
<h2>ProgramsDialog</h2>

<p>
    Class implementing the Programs page.
</p>
<h3>Derived from</h3>
QDialog, Ui_ProgramsDialog
<h3>Class Attributes</h3>

<table>
<tr><td>ToolAvailableRole</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#ProgramsDialog.__init__">ProgramsDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#ProgramsDialog.__createEntry">__createEntry</a></td>
<td>Private method to generate a program entry.</td>
</tr>
<tr>
<td><a href="#ProgramsDialog.__createProgramEntry">__createProgramEntry</a></td>
<td>Private method to generate a program entry.</td>
</tr>
<tr>
<td><a href="#ProgramsDialog.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="#ProgramsDialog.on_programsSearchButton_clicked">on_programsSearchButton_clicked</a></td>
<td>Private slot to search for all supported/required programs.</td>
</tr>
<tr>
<td><a href="#ProgramsDialog.on_showComboBox_currentIndexChanged">on_showComboBox_currentIndexChanged</a></td>
<td>Private slot to apply the selected show criteria.</td>
</tr>
<tr>
<td><a href="#ProgramsDialog.show">show</a></td>
<td>Public slot to show the dialog.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="ProgramsDialog.__init__" ID="ProgramsDialog.__init__"></a>
<h4>ProgramsDialog (Constructor)</h4>
<b>ProgramsDialog</b>(<i>parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
The parent widget of this dialog.
</dd>
</dl>
<a NAME="ProgramsDialog.__createEntry" ID="ProgramsDialog.__createEntry"></a>
<h4>ProgramsDialog.__createEntry</h4>
<b>__createEntry</b>(<i>description, entryText, entryVersion</i>)

<p>
        Private method to generate a program entry.
</p>
<dl>

<dt><i>description</i> (str)</dt>
<dd>
descriptive text
</dd>
<dt><i>entryText</i> (str)</dt>
<dd>
text to show
</dd>
<dt><i>entryVersion</i> (str)</dt>
<dd>
version string to show
</dd>
</dl>
<a NAME="ProgramsDialog.__createProgramEntry" ID="ProgramsDialog.__createProgramEntry"></a>
<h4>ProgramsDialog.__createProgramEntry</h4>
<b>__createProgramEntry</b>(<i>description, exe, versionCommand="", versionStartsWith="", versionPosition=None, version="", versionCleanup=None, versionRe=None, exeModule=None, </i>)

<p>
        Private method to generate a program entry.
</p>
<dl>

<dt><i>description</i> (str)</dt>
<dd>
descriptive text
</dd>
<dt><i>exe</i> (str)</dt>
<dd>
name of the executable program
</dd>
<dt><i>versionCommand</i> (str)</dt>
<dd>
command line switch to get the version info.
            If this is empty, the given version will be shown.
</dd>
<dt><i>versionStartsWith</i> (str)</dt>
<dd>
start of line identifying version info
</dd>
<dt><i>versionPosition</i> (int)</dt>
<dd>
index of part containing the version info
</dd>
<dt><i>version</i> (str)</dt>
<dd>
version string to show
</dd>
<dt><i>versionCleanup</i> (tuple of (int, int))</dt>
<dd>
tuple of two integers giving string positions
            start and stop for the version string
</dd>
<dt><i>versionRe</i> (str)</dt>
<dd>
regexp to determine the line identifying version
            info. Takes precedence over versionStartsWith.
</dd>
<dt><i>exeModule</i> (list of str)</dt>
<dd>
list of command line parameters to execute a module
            with the program given in exe (e.g. to execute a Python module)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
version string of detected or given version
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="ProgramsDialog.on_buttonBox_clicked" ID="ProgramsDialog.on_buttonBox_clicked"></a>
<h4>ProgramsDialog.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> (QAbstractButton)</dt>
<dd>
button that was clicked
</dd>
</dl>
<a NAME="ProgramsDialog.on_programsSearchButton_clicked" ID="ProgramsDialog.on_programsSearchButton_clicked"></a>
<h4>ProgramsDialog.on_programsSearchButton_clicked</h4>
<b>on_programsSearchButton_clicked</b>(<i></i>)

<p>
        Private slot to search for all supported/required programs.
</p>
<a NAME="ProgramsDialog.on_showComboBox_currentIndexChanged" ID="ProgramsDialog.on_showComboBox_currentIndexChanged"></a>
<h4>ProgramsDialog.on_showComboBox_currentIndexChanged</h4>
<b>on_showComboBox_currentIndexChanged</b>(<i>index</i>)

<p>
        Private slot to apply the selected show criteria.
</p>
<dl>

<dt><i>index</i> (int)</dt>
<dd>
index of the show criterium
</dd>
</dl>
<a NAME="ProgramsDialog.show" ID="ProgramsDialog.show"></a>
<h4>ProgramsDialog.show</h4>
<b>show</b>(<i></i>)

<p>
        Public slot to show the dialog.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>