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

branch
eric7
changeset 9117
c6afba2049cf
child 9123
aefb731a4b4e
equal deleted inserted replaced
9116:698660ef7350 9117:c6afba2049cf
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.CycloneDXInterface.CycloneDXConfigDialog</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.CycloneDXConfigDialog</h1>
10
11 <p>
12 Module implementing a dialog to configure the CycloneDX SBOM generation.
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="#CycloneDXConfigDialog">CycloneDXConfigDialog</a></td>
25 <td>Class implementing a dialog to configure the CycloneDX SBOM generation.</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="CycloneDXConfigDialog" ID="CycloneDXConfigDialog"></a>
36 <h2>CycloneDXConfigDialog</h2>
37
38 <p>
39 Class implementing a dialog to configure the CycloneDX SBOM generation.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_CycloneDXConfigDialog
43 <h3>Class Attributes</h3>
44
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>
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="#CycloneDXConfigDialog.__init__">CycloneDXConfigDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#CycloneDXConfigDialog.getData">getData</a></td>
63 <td>Public method to get the SBOM configuration data.</td>
64 </tr>
65 <tr>
66 <td><a href="#CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged">on_fileFormatComboBox_currentTextChanged</a></td>
67 <td>Private slot to handle the selection of a SBOM file format.</td>
68 </tr>
69 </table>
70 <h3>Static Methods</h3>
71
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75
76 <a NAME="CycloneDXConfigDialog.__init__" ID="CycloneDXConfigDialog.__init__"></a>
77 <h4>CycloneDXConfigDialog (Constructor)</h4>
78 <b>CycloneDXConfigDialog</b>(<i>environment, parent=None</i>)
79
80 <p>
81 Constructor
82 </p>
83 <dl>
84
85 <dt><i>environment</i> (str)</dt>
86 <dd>
87 name of the virtual environment
88 </dd>
89 <dt><i>parent</i> (QWidget (optional))</dt>
90 <dd>
91 reference to the parent widget (defaults to None)
92 </dd>
93 </dl>
94 <a NAME="CycloneDXConfigDialog.getData" ID="CycloneDXConfigDialog.getData"></a>
95 <h4>CycloneDXConfigDialog.getData</h4>
96 <b>getData</b>(<i></i>)
97
98 <p>
99 Public method to get the SBOM configuration data.
100 </p>
101 <dl>
102 <dt>Return:</dt>
103 <dd>
104 tuple containing the input source, the input file name, the
105 file format, the schema version and the path of the SBOM file to
106 be written
107 </dd>
108 </dl>
109 <dl>
110 <dt>Return Type:</dt>
111 <dd>
112 tuple of (str, str, str, str, str)
113 </dd>
114 </dl>
115 <a NAME="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged" ID="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged"></a>
116 <h4>CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged</h4>
117 <b>on_fileFormatComboBox_currentTextChanged</b>(<i>fileFormat</i>)
118
119 <p>
120 Private slot to handle the selection of a SBOM file format.
121 </p>
122 <dl>
123
124 <dt><i>fileFormat</i> (str)</dt>
125 <dd>
126 selected format
127 </dd>
128 </dl>
129 <div align="right"><a href="#top">Up</a></div>
130 <hr />
131 </body></html>

eric ide

mercurial