|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.CycloneDXInterface.CycloneDXMetaDataDialog</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.CycloneDXInterface.CycloneDXMetaDataDialog</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing a dialog to edit the metadata of the CycloneDX SBOM. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#CycloneDXMetaDataDialog">CycloneDXMetaDataDialog</a></td> |
|
25 <td>Class implementing a dialog to edit the metadata of the CycloneDX SBOM.</td> |
|
26 </tr> |
|
27 </table> |
|
28 <h3>Functions</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /> |
|
34 <hr /> |
|
35 <a NAME="CycloneDXMetaDataDialog" ID="CycloneDXMetaDataDialog"></a> |
|
36 <h2>CycloneDXMetaDataDialog</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing a dialog to edit the metadata of the CycloneDX SBOM. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 QDialog, Ui_CycloneDXMetaDataDialog |
|
43 <h3>Class Attributes</h3> |
|
44 |
|
45 <table> |
|
46 <tr><td>ComponentTypeMapping</td></tr> |
|
47 </table> |
|
48 <h3>Class Methods</h3> |
|
49 |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Methods</h3> |
|
54 |
|
55 <table> |
|
56 |
|
57 <tr> |
|
58 <td><a href="#CycloneDXMetaDataDialog.__init__">CycloneDXMetaDataDialog</a></td> |
|
59 <td>Constructor</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#CycloneDXMetaDataDialog.__populateComponentTypeSelector">__populateComponentTypeSelector</a></td> |
|
63 <td>Private method to populate the component type selector.</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#CycloneDXMetaDataDialog.__populateLicenseSelector">__populateLicenseSelector</a></td> |
|
67 <td>Private method to populate the license selector with the list of trove license types.</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#CycloneDXMetaDataDialog.__updateOkButton">__updateOkButton</a></td> |
|
71 <td>Private slot to update the enabled state of the OK button.</td> |
|
72 </tr> |
|
73 <tr> |
|
74 <td><a href="#CycloneDXMetaDataDialog.getMetaData">getMetaData</a></td> |
|
75 <td>Public method to get the entered data.</td> |
|
76 </tr> |
|
77 </table> |
|
78 <h3>Static Methods</h3> |
|
79 |
|
80 <table> |
|
81 <tr><td>None</td></tr> |
|
82 </table> |
|
83 |
|
84 <a NAME="CycloneDXMetaDataDialog.__init__" ID="CycloneDXMetaDataDialog.__init__"></a> |
|
85 <h4>CycloneDXMetaDataDialog (Constructor)</h4> |
|
86 <b>CycloneDXMetaDataDialog</b>(<i>metadata=None, parent=None</i>) |
|
87 |
|
88 <p> |
|
89 Constructor |
|
90 </p> |
|
91 <dl> |
|
92 |
|
93 <dt><i>metadata</i> (dict (optional))</dt> |
|
94 <dd> |
|
95 dictionary containing metadata to populate the dialog |
|
96 (defaults to None) |
|
97 </dd> |
|
98 <dt><i>parent</i> (QWidget (optional))</dt> |
|
99 <dd> |
|
100 reference to the parent widget (defaults to None) |
|
101 </dd> |
|
102 </dl> |
|
103 <a NAME="CycloneDXMetaDataDialog.__populateComponentTypeSelector" ID="CycloneDXMetaDataDialog.__populateComponentTypeSelector"></a> |
|
104 <h4>CycloneDXMetaDataDialog.__populateComponentTypeSelector</h4> |
|
105 <b>__populateComponentTypeSelector</b>(<i></i>) |
|
106 |
|
107 <p> |
|
108 Private method to populate the component type selector. |
|
109 </p> |
|
110 <a NAME="CycloneDXMetaDataDialog.__populateLicenseSelector" ID="CycloneDXMetaDataDialog.__populateLicenseSelector"></a> |
|
111 <h4>CycloneDXMetaDataDialog.__populateLicenseSelector</h4> |
|
112 <b>__populateLicenseSelector</b>(<i></i>) |
|
113 |
|
114 <p> |
|
115 Private method to populate the license selector with the list of trove |
|
116 license types. |
|
117 </p> |
|
118 <p> |
|
119 Note: The trove licanese list file was created from querying |
|
120 "https://pypi.org/pypi?%3Aaction=list_classifiers". |
|
121 </p> |
|
122 <a NAME="CycloneDXMetaDataDialog.__updateOkButton" ID="CycloneDXMetaDataDialog.__updateOkButton"></a> |
|
123 <h4>CycloneDXMetaDataDialog.__updateOkButton</h4> |
|
124 <b>__updateOkButton</b>(<i></i>) |
|
125 |
|
126 <p> |
|
127 Private slot to update the enabled state of the OK button. |
|
128 </p> |
|
129 <a NAME="CycloneDXMetaDataDialog.getMetaData" ID="CycloneDXMetaDataDialog.getMetaData"></a> |
|
130 <h4>CycloneDXMetaDataDialog.getMetaData</h4> |
|
131 <b>getMetaData</b>(<i></i>) |
|
132 |
|
133 <p> |
|
134 Public method to get the entered data. |
|
135 </p> |
|
136 <dl> |
|
137 <dt>Return:</dt> |
|
138 <dd> |
|
139 dictionary containing the metadata. |
|
140 </dd> |
|
141 </dl> |
|
142 <dl> |
|
143 <dt>Return Type:</dt> |
|
144 <dd> |
|
145 dict |
|
146 </dd> |
|
147 </dl> |
|
148 <div align="right"><a href="#top">Up</a></div> |
|
149 <hr /> |
|
150 </body></html> |