Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXConfigDialog.html
src/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXConfigDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 9141
- 7085ece52151
- child 9509
- c06561080e32
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 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.__editMetaData">__editMetaData</a></td> | |
| 63 <td>Private slot to open a dialog for editing the SBOM metadata.</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> | |
| 69 <tr> | |
| 70 <td><a href="#CycloneDXConfigDialog.getData">getData</a></td> | |
| 71 <td>Public method to get the SBOM configuration data.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 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> | |
| 76 </tr> | |
| 77 </table> | |
| 78 <h3>Static Methods</h3> | |
| 79 | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 | |
| 84 <a NAME="CycloneDXConfigDialog.__init__" ID="CycloneDXConfigDialog.__init__"></a> | |
| 85 <h4>CycloneDXConfigDialog (Constructor)</h4> | |
| 86 <b>CycloneDXConfigDialog</b>(<i>environment, parent=None</i>) | |
| 87 | |
| 88 <p> | |
| 89 Constructor | |
| 90 </p> | |
| 91 <dl> | |
| 92 | |
| 93 <dt><i>environment</i> (str)</dt> | |
| 94 <dd> | |
| 95 name of the virtual environment | |
| 96 </dd> | |
| 97 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 98 <dd> | |
| 99 reference to the parent widget (defaults to None) | |
| 100 </dd> | |
| 101 </dl> | |
| 102 <a NAME="CycloneDXConfigDialog.__editMetaData" ID="CycloneDXConfigDialog.__editMetaData"></a> | |
| 103 <h4>CycloneDXConfigDialog.__editMetaData</h4> | |
| 104 <b>__editMetaData</b>(<i></i>) | |
| 105 | |
| 106 <p> | |
| 107 Private slot to open a dialog for editing the SBOM metadata. | |
| 108 </p> | |
| 109 <a NAME="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox" ID="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox"></a> | |
| 110 <h4>CycloneDXConfigDialog.__repopulateSchemaVersionComboBox</h4> | |
| 111 <b>__repopulateSchemaVersionComboBox</b>(<i></i>) | |
| 112 | |
| 113 <p> | |
| 114 Private slot to repopulate the schema version selector. | |
| 115 </p> | |
| 116 <a NAME="CycloneDXConfigDialog.getData" ID="CycloneDXConfigDialog.getData"></a> | |
| 117 <h4>CycloneDXConfigDialog.getData</h4> | |
| 118 <b>getData</b>(<i></i>) | |
| 119 | |
| 120 <p> | |
| 121 Public method to get the SBOM configuration data. | |
| 122 </p> | |
| 123 <dl> | |
| 124 <dt>Return:</dt> | |
| 125 <dd> | |
| 126 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 written, a flag indicating to include vulnerability information, | |
| 129 a flag indicating to include dependency information and a | |
| 130 dictionary containing the SBOM meta data | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <dl> | |
| 134 <dt>Return Type:</dt> | |
| 135 <dd> | |
| 136 tuple of (str, str, str, str, str, bool, bool, dict) | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <a NAME="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged" ID="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged"></a> | |
| 140 <h4>CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged</h4> | |
| 141 <b>on_fileFormatComboBox_currentTextChanged</b>(<i>fileFormat</i>) | |
| 142 | |
| 143 <p> | |
| 144 Private slot to handle the selection of a SBOM file format. | |
| 145 </p> | |
| 146 <dl> | |
| 147 | |
| 148 <dt><i>fileFormat</i> (str)</dt> | |
| 149 <dd> | |
| 150 selected format | |
| 151 </dd> | |
| 152 </dl> | |
| 153 <div align="right"><a href="#top">Up</a></div> | |
| 154 <hr /> | |
| 155 </body></html> |
