PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLint.PyLintConfigDialog.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Checker_PyLint.PyLint.PyLintConfigDialog</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>Plugin_Checker_PyLint.PyLint.PyLintConfigDialog</h1>

<p>
Module implementing a dialog to configure the PyLint process.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#PyLintConfigDialog">PyLintConfigDialog</a></td>
<td>Class implementing a dialog to configure the PyLint process.</td>
</tr>
</table>
<h3>Functions</h3>

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

<p>
    Class implementing a dialog to configure the PyLint process.
</p>
<h3>Derived from</h3>
QDialog, Ui_PyLintConfigDialog
<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="#PyLintConfigDialog.__init__">PyLintConfigDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#PyLintConfigDialog.__createConfigDone">__createConfigDone</a></td>
<td>Private slot to handle the the finished signal of the pylint process.</td>
</tr>
<tr>
<td><a href="#PyLintConfigDialog.__initializeDefaults">__initializeDefaults</a></td>
<td>Private method to set the default values.</td>
</tr>
<tr>
<td><a href="#PyLintConfigDialog.__readStderr">__readStderr</a></td>
<td>Private slot to handle the readyReadStandardError signal of the pylint process.</td>
</tr>
<tr>
<td><a href="#PyLintConfigDialog.__readStdout">__readStdout</a></td>
<td>Private slot to handle the readyReadStandardOutput signal of the pylint process.</td>
</tr>
<tr>
<td><a href="#PyLintConfigDialog.accept">accept</a></td>
<td>Public slot called by the Ok button.</td>
</tr>
<tr>
<td><a href="#PyLintConfigDialog.generateParameters">generateParameters</a></td>
<td>Public method that generates the commandline parameters.</td>
</tr>
<tr>
<td><a href="#PyLintConfigDialog.on_configButton_clicked">on_configButton_clicked</a></td>
<td>Private slot to handle the generation of a sample configuration.</td>
</tr>
<tr>
<td><a href="#PyLintConfigDialog.on_configfileButton_clicked">on_configfileButton_clicked</a></td>
<td>Private slot to select the configuration file.</td>
</tr>
<tr>
<td><a href="#PyLintConfigDialog.on_reportfileButton_clicked">on_reportfileButton_clicked</a></td>
<td>Private slot to select the report file.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

<a NAME="PyLintConfigDialog.__init__" ID="PyLintConfigDialog.__init__"></a>
<h4>PyLintConfigDialog (Constructor)</h4>
<b>PyLintConfigDialog</b>(<i>ppath, exe, parms, version</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>ppath</i></dt>
<dd>
project path (string or QString)
            Used to set the default path for the rcfile selection dialog
</dd>
<dt><i>exe</i></dt>
<dd>
name of the pylint executable (string)
</dd>
<dt><i>parms</i></dt>
<dd>
parameters to set in the dialog
</dd>
<dt><i>version</i></dt>
<dd>
pylint version (string)
</dd>
</dl>
<a NAME="PyLintConfigDialog.__createConfigDone" ID="PyLintConfigDialog.__createConfigDone"></a>
<h4>PyLintConfigDialog.__createConfigDone</h4>
<b>__createConfigDone</b>(<i>exitCode, exitStatus</i>)

<p>
        Private slot to handle the the finished signal of the pylint process.
</p>
<dl>

<dt><i>exitCode</i></dt>
<dd>
exit code of the process (integer)
</dd>
<dt><i>exitStatus</i></dt>
<dd>
exit status of the process (QProcess.ExitStatus)
</dd>
</dl>
<a NAME="PyLintConfigDialog.__initializeDefaults" ID="PyLintConfigDialog.__initializeDefaults"></a>
<h4>PyLintConfigDialog.__initializeDefaults</h4>
<b>__initializeDefaults</b>(<i></i>)

<p>
        Private method to set the default values.
</p>
<p>
        These are needed later on to generate the commandline
        parameters.
</p>
<a NAME="PyLintConfigDialog.__readStderr" ID="PyLintConfigDialog.__readStderr"></a>
<h4>PyLintConfigDialog.__readStderr</h4>
<b>__readStderr</b>(<i></i>)

<p>
        Private slot to handle the readyReadStandardError signal of the
        pylint process.
</p>
<a NAME="PyLintConfigDialog.__readStdout" ID="PyLintConfigDialog.__readStdout"></a>
<h4>PyLintConfigDialog.__readStdout</h4>
<b>__readStdout</b>(<i></i>)

<p>
        Private slot to handle the readyReadStandardOutput signal of the
        pylint process.
</p>
<a NAME="PyLintConfigDialog.accept" ID="PyLintConfigDialog.accept"></a>
<h4>PyLintConfigDialog.accept</h4>
<b>accept</b>(<i></i>)

<p>
        Public slot called by the Ok button.
</p>
<p>
        It saves the values in the parameters dictionary.
</p>
<a NAME="PyLintConfigDialog.generateParameters" ID="PyLintConfigDialog.generateParameters"></a>
<h4>PyLintConfigDialog.generateParameters</h4>
<b>generateParameters</b>(<i></i>)

<p>
        Public method that generates the commandline parameters.
</p>
<p>
        It generates a QStringList to be used
        to set the QProcess arguments for the pylint call and
        a list containing the non default parameters. The second
        list can be passed back upon object generation to overwrite
        the default settings.
</p>
<p>
        <b>Note</b>: The arguments list contains the name of the pylint
        executable as the first parameter.
</p>
<dl>
<dt>Return:</dt>
<dd>
a tuple of the commandline parameters and non default
            parameters (list of strings, dictionary)
</dd>
</dl>
<a NAME="PyLintConfigDialog.on_configButton_clicked" ID="PyLintConfigDialog.on_configButton_clicked"></a>
<h4>PyLintConfigDialog.on_configButton_clicked</h4>
<b>on_configButton_clicked</b>(<i></i>)

<p>
        Private slot to handle the generation of a sample configuration.
</p>
<a NAME="PyLintConfigDialog.on_configfileButton_clicked" ID="PyLintConfigDialog.on_configfileButton_clicked"></a>
<h4>PyLintConfigDialog.on_configfileButton_clicked</h4>
<b>on_configfileButton_clicked</b>(<i></i>)

<p>
        Private slot to select the configuration file.
</p>
<p>
        It displays a file selection dialog to select the configuration file.
</p>
<a NAME="PyLintConfigDialog.on_reportfileButton_clicked" ID="PyLintConfigDialog.on_reportfileButton_clicked"></a>
<h4>PyLintConfigDialog.on_reportfileButton_clicked</h4>
<b>on_reportfileButton_clicked</b>(<i></i>)

<p>
        Private slot to select the report file.
</p>
<p>
        It displays a file selection dialog to select the report file.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>