eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXMetaDataDialog.html

branch
eric7
changeset 9141
7085ece52151
child 9175
21e2be5f0b41
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXMetaDataDialog.html	Thu Jun 09 16:13:18 2022 +0200
@@ -0,0 +1,150 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.CycloneDXInterface.CycloneDXMetaDataDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.CycloneDXInterface.CycloneDXMetaDataDialog</h1>
+
+<p>
+Module implementing a dialog to edit the metadata of the CycloneDX SBOM.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#CycloneDXMetaDataDialog">CycloneDXMetaDataDialog</a></td>
+<td>Class implementing a dialog to edit the metadata of the CycloneDX SBOM.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="CycloneDXMetaDataDialog" ID="CycloneDXMetaDataDialog"></a>
+<h2>CycloneDXMetaDataDialog</h2>
+
+<p>
+    Class implementing a dialog to edit the metadata of the CycloneDX SBOM.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_CycloneDXMetaDataDialog
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>ComponentTypeMapping</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#CycloneDXMetaDataDialog.__init__">CycloneDXMetaDataDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#CycloneDXMetaDataDialog.__populateComponentTypeSelector">__populateComponentTypeSelector</a></td>
+<td>Private method to populate the component type selector.</td>
+</tr>
+<tr>
+<td><a href="#CycloneDXMetaDataDialog.__populateLicenseSelector">__populateLicenseSelector</a></td>
+<td>Private method to populate the license selector with the list of trove license types.</td>
+</tr>
+<tr>
+<td><a href="#CycloneDXMetaDataDialog.__updateOkButton">__updateOkButton</a></td>
+<td>Private slot to update the enabled state of the OK button.</td>
+</tr>
+<tr>
+<td><a href="#CycloneDXMetaDataDialog.getMetaData">getMetaData</a></td>
+<td>Public method to get the entered data.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="CycloneDXMetaDataDialog.__init__" ID="CycloneDXMetaDataDialog.__init__"></a>
+<h4>CycloneDXMetaDataDialog (Constructor)</h4>
+<b>CycloneDXMetaDataDialog</b>(<i>metadata=None, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>metadata</i> (dict (optional))</dt>
+<dd>
+dictionary containing metadata to populate the dialog
+            (defaults to None)
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="CycloneDXMetaDataDialog.__populateComponentTypeSelector" ID="CycloneDXMetaDataDialog.__populateComponentTypeSelector"></a>
+<h4>CycloneDXMetaDataDialog.__populateComponentTypeSelector</h4>
+<b>__populateComponentTypeSelector</b>(<i></i>)
+
+<p>
+        Private method to populate the component type selector.
+</p>
+<a NAME="CycloneDXMetaDataDialog.__populateLicenseSelector" ID="CycloneDXMetaDataDialog.__populateLicenseSelector"></a>
+<h4>CycloneDXMetaDataDialog.__populateLicenseSelector</h4>
+<b>__populateLicenseSelector</b>(<i></i>)
+
+<p>
+        Private method to populate the license selector with the list of trove
+        license types.
+</p>
+<p>
+        Note: The trove licanese list file was created from querying
+        "https://pypi.org/pypi?%3Aaction=list_classifiers".
+</p>
+<a NAME="CycloneDXMetaDataDialog.__updateOkButton" ID="CycloneDXMetaDataDialog.__updateOkButton"></a>
+<h4>CycloneDXMetaDataDialog.__updateOkButton</h4>
+<b>__updateOkButton</b>(<i></i>)
+
+<p>
+        Private slot to update the enabled state of the OK button.
+</p>
+<a NAME="CycloneDXMetaDataDialog.getMetaData" ID="CycloneDXMetaDataDialog.getMetaData"></a>
+<h4>CycloneDXMetaDataDialog.getMetaData</h4>
+<b>getMetaData</b>(<i></i>)
+
+<p>
+        Public method to get the entered data.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the metadata.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial