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

branch
eric7
changeset 10479
856476537696
parent 9509
c06561080e32
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.CycloneDXInterface.CycloneDXConfigDialog</h1> 9 <h1>eric7.CycloneDXInterface.CycloneDXConfigDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to configure the CycloneDX SBOM generation. 11 Module implementing a dialog to configure the CycloneDX SBOM generation.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#CycloneDXConfigDialog">CycloneDXConfigDialog</a></td> 22 <td><a href="#CycloneDXConfigDialog">CycloneDXConfigDialog</a></td>
25 <td>Class implementing a dialog to configure the CycloneDX SBOM generation.</td> 23 <td>Class implementing a dialog to configure the CycloneDX SBOM generation.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="CycloneDXConfigDialog" ID="CycloneDXConfigDialog"></a> 34 <a NAME="CycloneDXConfigDialog" ID="CycloneDXConfigDialog"></a>
36 <h2>CycloneDXConfigDialog</h2> 35 <h2>CycloneDXConfigDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to configure the CycloneDX SBOM generation. 37 Class implementing a dialog to configure the CycloneDX SBOM generation.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_CycloneDXConfigDialog 41 QDialog, Ui_CycloneDXConfigDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
43 <table>
44 <tr><td>DefaultFileFormat</td></tr>
45 <tr><td>DefaultFileNames</td></tr>
46 <tr><td>Sources</td></tr>
47 <tr><td>SupportedSchemas</td></tr>
48 </table>
44 49
45 <table>
46 <tr><td>DefaultFileFormat</td></tr><tr><td>DefaultFileNames</td></tr><tr><td>Sources</td></tr><tr><td>SupportedSchemas</td></tr>
47 </table>
48 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
49
50 <table> 51 <table>
51 <tr><td>None</td></tr> 52 <tr><td>None</td></tr>
52 </table> 53 </table>
54
53 <h3>Methods</h3> 55 <h3>Methods</h3>
54
55 <table> 56 <table>
56
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>
73 <tr> 73 <tr>
74 <td><a href="#CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged">on_fileFormatComboBox_currentTextChanged</a></td> 74 <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> 75 <td>Private slot to handle the selection of a SBOM file format.</td>
76 </tr> 76 </tr>
77 </table> 77 </table>
78
78 <h3>Static Methods</h3> 79 <h3>Static Methods</h3>
79
80 <table> 80 <table>
81 <tr><td>None</td></tr> 81 <tr><td>None</td></tr>
82 </table> 82 </table>
83 83
84
84 <a NAME="CycloneDXConfigDialog.__init__" ID="CycloneDXConfigDialog.__init__"></a> 85 <a NAME="CycloneDXConfigDialog.__init__" ID="CycloneDXConfigDialog.__init__"></a>
85 <h4>CycloneDXConfigDialog (Constructor)</h4> 86 <h4>CycloneDXConfigDialog (Constructor)</h4>
86 <b>CycloneDXConfigDialog</b>(<i>environment, parent=None</i>) 87 <b>CycloneDXConfigDialog</b>(<i>environment, parent=None</i>)
87
88 <p> 88 <p>
89 Constructor 89 Constructor
90 </p> 90 </p>
91
91 <dl> 92 <dl>
92 93
93 <dt><i>environment</i> (str)</dt> 94 <dt><i>environment</i> (str)</dt>
94 <dd> 95 <dd>
95 name of the virtual environment 96 name of the virtual environment
100 </dd> 101 </dd>
101 </dl> 102 </dl>
102 <a NAME="CycloneDXConfigDialog.__editMetaData" ID="CycloneDXConfigDialog.__editMetaData"></a> 103 <a NAME="CycloneDXConfigDialog.__editMetaData" ID="CycloneDXConfigDialog.__editMetaData"></a>
103 <h4>CycloneDXConfigDialog.__editMetaData</h4> 104 <h4>CycloneDXConfigDialog.__editMetaData</h4>
104 <b>__editMetaData</b>(<i></i>) 105 <b>__editMetaData</b>(<i></i>)
105
106 <p> 106 <p>
107 Private slot to open a dialog for editing the SBOM metadata. 107 Private slot to open a dialog for editing the SBOM metadata.
108 </p> 108 </p>
109
109 <a NAME="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox" ID="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox"></a> 110 <a NAME="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox" ID="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox"></a>
110 <h4>CycloneDXConfigDialog.__repopulateSchemaVersionComboBox</h4> 111 <h4>CycloneDXConfigDialog.__repopulateSchemaVersionComboBox</h4>
111 <b>__repopulateSchemaVersionComboBox</b>(<i></i>) 112 <b>__repopulateSchemaVersionComboBox</b>(<i></i>)
112
113 <p> 113 <p>
114 Private slot to repopulate the schema version selector. 114 Private slot to repopulate the schema version selector.
115 </p> 115 </p>
116
116 <a NAME="CycloneDXConfigDialog.getData" ID="CycloneDXConfigDialog.getData"></a> 117 <a NAME="CycloneDXConfigDialog.getData" ID="CycloneDXConfigDialog.getData"></a>
117 <h4>CycloneDXConfigDialog.getData</h4> 118 <h4>CycloneDXConfigDialog.getData</h4>
118 <b>getData</b>(<i></i>) 119 <b>getData</b>(<i></i>)
119
120 <p> 120 <p>
121 Public method to get the SBOM configuration data. 121 Public method to get the SBOM configuration data.
122 </p> 122 </p>
123
123 <dl> 124 <dl>
124 <dt>Return:</dt> 125 <dt>Return:</dt>
125 <dd> 126 <dd>
126 tuple containing the input source, the input file name, the 127 tuple containing the input source, the input file name, the
127 file format, the schema version, the path of the SBOM file to be 128 file format, the schema version, the path of the SBOM file to be
137 </dd> 138 </dd>
138 </dl> 139 </dl>
139 <a NAME="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged" ID="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged"></a> 140 <a NAME="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged" ID="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged"></a>
140 <h4>CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged</h4> 141 <h4>CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged</h4>
141 <b>on_fileFormatComboBox_currentTextChanged</b>(<i>fileFormat</i>) 142 <b>on_fileFormatComboBox_currentTextChanged</b>(<i>fileFormat</i>)
142
143 <p> 143 <p>
144 Private slot to handle the selection of a SBOM file format. 144 Private slot to handle the selection of a SBOM file format.
145 </p> 145 </p>
146
146 <dl> 147 <dl>
147 148
148 <dt><i>fileFormat</i> (str)</dt> 149 <dt><i>fileFormat</i> (str)</dt>
149 <dd> 150 <dd>
150 selected format 151 selected format

eric ide

mercurial