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