Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Preferences.ProgramsDialog.html
eric7/Documentation/Source/eric7.Preferences.ProgramsDialog.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Preferences.ProgramsDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.Preferences.ProgramsDialog</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing the Programs page. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#ProgramsDialog">ProgramsDialog</a></td> | |
| 39 <td>Class implementing the Programs page.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="ProgramsDialog" ID="ProgramsDialog"></a> | |
| 50 <h2>ProgramsDialog</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing the Programs page. | |
| 54 </p> | |
| 55 <h3>Derived from</h3> | |
| 56 QDialog, Ui_ProgramsDialog | |
| 57 <h3>Class Attributes</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>ToolAvailableRole</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 | |
| 64 <table> | |
| 65 <tr><td>None</td></tr> | |
| 66 </table> | |
| 67 <h3>Methods</h3> | |
| 68 | |
| 69 <table> | |
| 70 | |
| 71 <tr> | |
| 72 <td><a href="#ProgramsDialog.__init__">ProgramsDialog</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#ProgramsDialog.__createEntry">__createEntry</a></td> | |
| 77 <td>Private method to generate a program entry.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#ProgramsDialog.__createProgramEntry">__createProgramEntry</a></td> | |
| 81 <td>Private method to generate a program entry.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#ProgramsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 85 <td>Private slot called by a button of the button box clicked.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#ProgramsDialog.on_programsSearchButton_clicked">on_programsSearchButton_clicked</a></td> | |
| 89 <td>Private slot to search for all supported/required programs.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#ProgramsDialog.on_showComboBox_currentIndexChanged">on_showComboBox_currentIndexChanged</a></td> | |
| 93 <td>Private slot to apply the selected show criteria.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#ProgramsDialog.show">show</a></td> | |
| 97 <td>Public slot to show the dialog.</td> | |
| 98 </tr> | |
| 99 </table> | |
| 100 <h3>Static Methods</h3> | |
| 101 | |
| 102 <table> | |
| 103 <tr><td>None</td></tr> | |
| 104 </table> | |
| 105 | |
| 106 <a NAME="ProgramsDialog.__init__" ID="ProgramsDialog.__init__"></a> | |
| 107 <h4>ProgramsDialog (Constructor)</h4> | |
| 108 <b>ProgramsDialog</b>(<i>parent=None</i>) | |
| 109 | |
| 110 <p> | |
| 111 Constructor | |
| 112 </p> | |
| 113 <dl> | |
| 114 | |
| 115 <dt><i>parent</i></dt> | |
| 116 <dd> | |
| 117 The parent widget of this dialog. (QWidget) | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <a NAME="ProgramsDialog.__createEntry" ID="ProgramsDialog.__createEntry"></a> | |
| 121 <h4>ProgramsDialog.__createEntry</h4> | |
| 122 <b>__createEntry</b>(<i>description, entryText, entryVersion</i>) | |
| 123 | |
| 124 <p> | |
| 125 Private method to generate a program entry. | |
| 126 </p> | |
| 127 <dl> | |
| 128 | |
| 129 <dt><i>description</i></dt> | |
| 130 <dd> | |
| 131 descriptive text (string) | |
| 132 </dd> | |
| 133 <dt><i>entryText</i></dt> | |
| 134 <dd> | |
| 135 text to show (string) | |
| 136 </dd> | |
| 137 <dt><i>entryVersion</i></dt> | |
| 138 <dd> | |
| 139 version string to show (string). | |
| 140 </dd> | |
| 141 </dl> | |
| 142 <a NAME="ProgramsDialog.__createProgramEntry" ID="ProgramsDialog.__createProgramEntry"></a> | |
| 143 <h4>ProgramsDialog.__createProgramEntry</h4> | |
| 144 <b>__createProgramEntry</b>(<i>description, exe, versionCommand="", versionStartsWith="", versionPosition=None, version="", versionCleanup=None, versionRe=None, exeModule=None</i>) | |
| 145 | |
| 146 <p> | |
| 147 Private method to generate a program entry. | |
| 148 </p> | |
| 149 <dl> | |
| 150 | |
| 151 <dt><i>description</i></dt> | |
| 152 <dd> | |
| 153 descriptive text (string) | |
| 154 </dd> | |
| 155 <dt><i>exe</i></dt> | |
| 156 <dd> | |
| 157 name of the executable program (string) | |
| 158 </dd> | |
| 159 <dt><i>versionCommand</i></dt> | |
| 160 <dd> | |
| 161 command line switch to get the version info | |
| 162 (str). If this is empty, the given version will be shown. | |
| 163 </dd> | |
| 164 <dt><i>versionStartsWith</i></dt> | |
| 165 <dd> | |
| 166 start of line identifying version info | |
| 167 (string) | |
| 168 </dd> | |
| 169 <dt><i>versionPosition</i></dt> | |
| 170 <dd> | |
| 171 index of part containing the version info | |
| 172 (integer) | |
| 173 </dd> | |
| 174 <dt><i>version</i></dt> | |
| 175 <dd> | |
| 176 version string to show (string) | |
| 177 </dd> | |
| 178 <dt><i>versionCleanup</i></dt> | |
| 179 <dd> | |
| 180 tuple of two integers giving string positions | |
| 181 start and stop for the version string (tuple of integers) | |
| 182 </dd> | |
| 183 <dt><i>versionRe</i></dt> | |
| 184 <dd> | |
| 185 regexp to determine the line identifying version | |
| 186 info (string). Takes precedence over versionStartsWith. | |
| 187 </dd> | |
| 188 <dt><i>exeModule</i></dt> | |
| 189 <dd> | |
| 190 list of command line parameters to execute a module | |
| 191 with the program given in exe (e.g. to execute a Python module) | |
| 192 (list of str) | |
| 193 </dd> | |
| 194 </dl> | |
| 195 <dl> | |
| 196 <dt>Return:</dt> | |
| 197 <dd> | |
| 198 version string of detected or given version (string) | |
| 199 </dd> | |
| 200 </dl> | |
| 201 <a NAME="ProgramsDialog.on_buttonBox_clicked" ID="ProgramsDialog.on_buttonBox_clicked"></a> | |
| 202 <h4>ProgramsDialog.on_buttonBox_clicked</h4> | |
| 203 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 204 | |
| 205 <p> | |
| 206 Private slot called by a button of the button box clicked. | |
| 207 </p> | |
| 208 <dl> | |
| 209 | |
| 210 <dt><i>button</i></dt> | |
| 211 <dd> | |
| 212 button that was clicked (QAbstractButton) | |
| 213 </dd> | |
| 214 </dl> | |
| 215 <a NAME="ProgramsDialog.on_programsSearchButton_clicked" ID="ProgramsDialog.on_programsSearchButton_clicked"></a> | |
| 216 <h4>ProgramsDialog.on_programsSearchButton_clicked</h4> | |
| 217 <b>on_programsSearchButton_clicked</b>(<i></i>) | |
| 218 | |
| 219 <p> | |
| 220 Private slot to search for all supported/required programs. | |
| 221 </p> | |
| 222 <a NAME="ProgramsDialog.on_showComboBox_currentIndexChanged" ID="ProgramsDialog.on_showComboBox_currentIndexChanged"></a> | |
| 223 <h4>ProgramsDialog.on_showComboBox_currentIndexChanged</h4> | |
| 224 <b>on_showComboBox_currentIndexChanged</b>(<i>index</i>) | |
| 225 | |
| 226 <p> | |
| 227 Private slot to apply the selected show criteria. | |
| 228 </p> | |
| 229 <dl> | |
| 230 | |
| 231 <dt><i>index</i> (int)</dt> | |
| 232 <dd> | |
| 233 index of the show criterium | |
| 234 </dd> | |
| 235 </dl> | |
| 236 <a NAME="ProgramsDialog.show" ID="ProgramsDialog.show"></a> | |
| 237 <h4>ProgramsDialog.show</h4> | |
| 238 <b>show</b>(<i></i>) | |
| 239 | |
| 240 <p> | |
| 241 Public slot to show the dialog. | |
| 242 </p> | |
| 243 <div align="right"><a href="#top">Up</a></div> | |
| 244 <hr /> | |
| 245 </body></html> |
