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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9141
7085ece52151
child 9509
c06561080e32
diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXConfigDialog.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXConfigDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,155 @@
+<!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>SupportedSchemas</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.__editMetaData">__editMetaData</a></td>
+<td>Private slot to open a dialog for editing the SBOM metadata.</td>
+</tr>
+<tr>
+<td><a href="#CycloneDXConfigDialog.__repopulateSchemaVersionComboBox">__repopulateSchemaVersionComboBox</a></td>
+<td>Private slot to repopulate the schema 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>
+</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.__editMetaData" ID="CycloneDXConfigDialog.__editMetaData"></a>
+<h4>CycloneDXConfigDialog.__editMetaData</h4>
+<b>__editMetaData</b>(<i></i>)
+
+<p>
+        Private slot to open a dialog for editing the SBOM metadata.
+</p>
+<a NAME="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox" ID="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox"></a>
+<h4>CycloneDXConfigDialog.__repopulateSchemaVersionComboBox</h4>
+<b>__repopulateSchemaVersionComboBox</b>(<i></i>)
+
+<p>
+        Private slot to repopulate the schema 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 file name, the
+            file format, the schema version, the path of the SBOM file to be
+            written, a flag indicating to include vulnerability information,
+            a flag indicating to include dependency information and a
+            dictionary containing the SBOM meta data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str, str, str, str, bool, bool, dict)
+</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>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial