src/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXConfigDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.CycloneDXInterface.CycloneDXConfigDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.CycloneDXInterface.CycloneDXConfigDialog</h1>
<p>
Module implementing a dialog to configure the CycloneDX SBOM generation.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#CycloneDXConfigDialog">CycloneDXConfigDialog</a></td>
<td>Class implementing a dialog to configure the CycloneDX SBOM generation.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="CycloneDXConfigDialog" ID="CycloneDXConfigDialog"></a>
<h2>CycloneDXConfigDialog</h2>
<p>
    Class implementing a dialog to configure the CycloneDX SBOM generation.
</p>

<h3>Derived from</h3>
QDialog, Ui_CycloneDXConfigDialog
<h3>Class Attributes</h3>
<table>
<tr><td>DefaultFileFormat</td></tr>
<tr><td>DefaultFileNames</td></tr>
<tr><td>Sources</td></tr>
<tr><td>SupportedSpecs</td></tr>
</table>

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

<h3>Methods</h3>
<table>
<tr>
<td><a href="#CycloneDXConfigDialog.__init__">CycloneDXConfigDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#CycloneDXConfigDialog.__repopulateSpecVersionComboBox">__repopulateSpecVersionComboBox</a></td>
<td>Private slot to repopulate the spec version selector.</td>
</tr>
<tr>
<td><a href="#CycloneDXConfigDialog.getData">getData</a></td>
<td>Public method to get the SBOM configuration data.</td>
</tr>
<tr>
<td><a href="#CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged">on_fileFormatComboBox_currentTextChanged</a></td>
<td>Private slot to handle the selection of a SBOM file format.</td>
</tr>
<tr>
<td><a href="#CycloneDXConfigDialog.on_poetryButton_toggled">on_poetryButton_toggled</a></td>
<td>Private slot handling a change of the 'Poetry' button state.</td>
</tr>
</table>

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


<a NAME="CycloneDXConfigDialog.__init__" ID="CycloneDXConfigDialog.__init__"></a>
<h4>CycloneDXConfigDialog (Constructor)</h4>
<b>CycloneDXConfigDialog</b>(<i>environment, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>environment</i> (str)</dt>
<dd>
name of the virtual environment
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="CycloneDXConfigDialog.__repopulateSpecVersionComboBox" ID="CycloneDXConfigDialog.__repopulateSpecVersionComboBox"></a>
<h4>CycloneDXConfigDialog.__repopulateSpecVersionComboBox</h4>
<b>__repopulateSpecVersionComboBox</b>(<i></i>)
<p>
        Private slot to repopulate the spec version selector.
</p>

<a NAME="CycloneDXConfigDialog.getData" ID="CycloneDXConfigDialog.getData"></a>
<h4>CycloneDXConfigDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to get the SBOM configuration data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple containing the input source, the input path name, the
            file format, the schema version, the path of the SBOM file to be
            written, the path to the pyproject.toml file and the type of the
            main component.
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str, str, str, str, str, str)
</dd>
</dl>
<a NAME="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged" ID="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged"></a>
<h4>CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged</h4>
<b>on_fileFormatComboBox_currentTextChanged</b>(<i>fileFormat</i>)
<p>
        Private slot to handle the selection of a SBOM file format.
</p>

<dl>

<dt><i>fileFormat</i> (str)</dt>
<dd>
selected format
</dd>
</dl>
<a NAME="CycloneDXConfigDialog.on_poetryButton_toggled" ID="CycloneDXConfigDialog.on_poetryButton_toggled"></a>
<h4>CycloneDXConfigDialog.on_poetryButton_toggled</h4>
<b>on_poetryButton_toggled</b>(<i>checked</i>)
<p>
        Private slot handling a change of the 'Poetry' button state.
</p>

<dl>

<dt><i>checked</i> (bool)</dt>
<dd>
state of the button
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>