42 <h3>Class Attributes</h3> |
42 <h3>Class Attributes</h3> |
43 <table> |
43 <table> |
44 <tr><td>DefaultFileFormat</td></tr> |
44 <tr><td>DefaultFileFormat</td></tr> |
45 <tr><td>DefaultFileNames</td></tr> |
45 <tr><td>DefaultFileNames</td></tr> |
46 <tr><td>Sources</td></tr> |
46 <tr><td>Sources</td></tr> |
47 <tr><td>SupportedSchemas</td></tr> |
47 <tr><td>SupportedSpecs</td></tr> |
48 </table> |
48 </table> |
49 |
49 |
50 <h3>Class Methods</h3> |
50 <h3>Class Methods</h3> |
51 <table> |
51 <table> |
52 <tr><td>None</td></tr> |
52 <tr><td>None</td></tr> |
57 <tr> |
57 <tr> |
58 <td><a href="#CycloneDXConfigDialog.__init__">CycloneDXConfigDialog</a></td> |
58 <td><a href="#CycloneDXConfigDialog.__init__">CycloneDXConfigDialog</a></td> |
59 <td>Constructor</td> |
59 <td>Constructor</td> |
60 </tr> |
60 </tr> |
61 <tr> |
61 <tr> |
62 <td><a href="#CycloneDXConfigDialog.__editMetaData">__editMetaData</a></td> |
62 <td><a href="#CycloneDXConfigDialog.__repopulateSpecVersionComboBox">__repopulateSpecVersionComboBox</a></td> |
63 <td>Private slot to open a dialog for editing the SBOM metadata.</td> |
63 <td>Private slot to repopulate the spec version selector.</td> |
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#CycloneDXConfigDialog.__repopulateSchemaVersionComboBox">__repopulateSchemaVersionComboBox</a></td> |
|
67 <td>Private slot to repopulate the schema version selector.</td> |
|
68 </tr> |
64 </tr> |
69 <tr> |
65 <tr> |
70 <td><a href="#CycloneDXConfigDialog.getData">getData</a></td> |
66 <td><a href="#CycloneDXConfigDialog.getData">getData</a></td> |
71 <td>Public method to get the SBOM configuration data.</td> |
67 <td>Public method to get the SBOM configuration data.</td> |
72 </tr> |
68 </tr> |
73 <tr> |
69 <tr> |
74 <td><a href="#CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged">on_fileFormatComboBox_currentTextChanged</a></td> |
70 <td><a href="#CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged">on_fileFormatComboBox_currentTextChanged</a></td> |
75 <td>Private slot to handle the selection of a SBOM file format.</td> |
71 <td>Private slot to handle the selection of a SBOM file format.</td> |
|
72 </tr> |
|
73 <tr> |
|
74 <td><a href="#CycloneDXConfigDialog.on_poetryButton_toggled">on_poetryButton_toggled</a></td> |
|
75 <td>Private slot handling a change of the 'Poetry' button state.</td> |
76 </tr> |
76 </tr> |
77 </table> |
77 </table> |
78 |
78 |
79 <h3>Static Methods</h3> |
79 <h3>Static Methods</h3> |
80 <table> |
80 <table> |
98 <dt><i>parent</i> (QWidget (optional))</dt> |
98 <dt><i>parent</i> (QWidget (optional))</dt> |
99 <dd> |
99 <dd> |
100 reference to the parent widget (defaults to None) |
100 reference to the parent widget (defaults to None) |
101 </dd> |
101 </dd> |
102 </dl> |
102 </dl> |
103 <a NAME="CycloneDXConfigDialog.__editMetaData" ID="CycloneDXConfigDialog.__editMetaData"></a> |
103 <a NAME="CycloneDXConfigDialog.__repopulateSpecVersionComboBox" ID="CycloneDXConfigDialog.__repopulateSpecVersionComboBox"></a> |
104 <h4>CycloneDXConfigDialog.__editMetaData</h4> |
104 <h4>CycloneDXConfigDialog.__repopulateSpecVersionComboBox</h4> |
105 <b>__editMetaData</b>(<i></i>) |
105 <b>__repopulateSpecVersionComboBox</b>(<i></i>) |
106 <p> |
106 <p> |
107 Private slot to open a dialog for editing the SBOM metadata. |
107 Private slot to repopulate the spec version selector. |
108 </p> |
|
109 |
|
110 <a NAME="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox" ID="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox"></a> |
|
111 <h4>CycloneDXConfigDialog.__repopulateSchemaVersionComboBox</h4> |
|
112 <b>__repopulateSchemaVersionComboBox</b>(<i></i>) |
|
113 <p> |
|
114 Private slot to repopulate the schema version selector. |
|
115 </p> |
108 </p> |
116 |
109 |
117 <a NAME="CycloneDXConfigDialog.getData" ID="CycloneDXConfigDialog.getData"></a> |
110 <a NAME="CycloneDXConfigDialog.getData" ID="CycloneDXConfigDialog.getData"></a> |
118 <h4>CycloneDXConfigDialog.getData</h4> |
111 <h4>CycloneDXConfigDialog.getData</h4> |
119 <b>getData</b>(<i></i>) |
112 <b>getData</b>(<i></i>) |
122 </p> |
115 </p> |
123 |
116 |
124 <dl> |
117 <dl> |
125 <dt>Return:</dt> |
118 <dt>Return:</dt> |
126 <dd> |
119 <dd> |
127 tuple containing the input source, the input file name, the |
120 tuple containing the input source, the input path name, the |
128 file format, the schema version, the path of the SBOM file to be |
121 file format, the schema version, the path of the SBOM file to be |
129 written, a flag indicating to include vulnerability information, |
122 written, the path to the pyproject.toml file and the type of the |
130 a flag indicating to include dependency information, a flag indicating |
123 main component. |
131 to generate readable output and a dictionary containing the SBOM meta data |
|
132 </dd> |
124 </dd> |
133 </dl> |
125 </dl> |
134 <dl> |
126 <dl> |
135 <dt>Return Type:</dt> |
127 <dt>Return Type:</dt> |
136 <dd> |
128 <dd> |
137 tuple of (str, str, str, str, str, bool, bool, bool, dict) |
129 tuple of (str, str, str, str, str, str, str) |
138 </dd> |
130 </dd> |
139 </dl> |
131 </dl> |
140 <a NAME="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged" ID="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged"></a> |
132 <a NAME="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged" ID="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged"></a> |
141 <h4>CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged</h4> |
133 <h4>CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged</h4> |
142 <b>on_fileFormatComboBox_currentTextChanged</b>(<i>fileFormat</i>) |
134 <b>on_fileFormatComboBox_currentTextChanged</b>(<i>fileFormat</i>) |
149 <dt><i>fileFormat</i> (str)</dt> |
141 <dt><i>fileFormat</i> (str)</dt> |
150 <dd> |
142 <dd> |
151 selected format |
143 selected format |
152 </dd> |
144 </dd> |
153 </dl> |
145 </dl> |
|
146 <a NAME="CycloneDXConfigDialog.on_poetryButton_toggled" ID="CycloneDXConfigDialog.on_poetryButton_toggled"></a> |
|
147 <h4>CycloneDXConfigDialog.on_poetryButton_toggled</h4> |
|
148 <b>on_poetryButton_toggled</b>(<i>checked</i>) |
|
149 <p> |
|
150 Private slot handling a change of the 'Poetry' button state. |
|
151 </p> |
|
152 |
|
153 <dl> |
|
154 |
|
155 <dt><i>checked</i> (bool)</dt> |
|
156 <dd> |
|
157 state of the button |
|
158 </dd> |
|
159 </dl> |
154 <div align="right"><a href="#top">Up</a></div> |
160 <div align="right"><a href="#top">Up</a></div> |
155 <hr /> |
161 <hr /> |
156 </body></html> |
162 </body></html> |