Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Preferences.ProgramsDialog.html
eric6/Documentation/Source/eric6.Preferences.ProgramsDialog.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Preferences.ProgramsDialog</h1> | |
| 23 <p> | |
| 24 Module implementing the Programs page. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#ProgramsDialog">ProgramsDialog</a></td> | |
| 34 <td>Class implementing the Programs page.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="ProgramsDialog" ID="ProgramsDialog"></a> | |
| 43 <h2>ProgramsDialog</h2> | |
| 44 <p> | |
| 45 Class implementing the Programs page. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QDialog, Ui_ProgramsDialog | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#ProgramsDialog.__init__">ProgramsDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ProgramsDialog.__createEntry">__createEntry</a></td> | |
| 64 <td>Private method to generate a program entry.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ProgramsDialog.__createProgramEntry">__createProgramEntry</a></td> | |
| 67 <td>Private method to generate a program entry.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#ProgramsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 70 <td>Private slot called by a button of the button box clicked.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#ProgramsDialog.on_programsSearchButton_clicked">on_programsSearchButton_clicked</a></td> | |
| 73 <td>Private slot to search for all supported/required programs.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#ProgramsDialog.show">show</a></td> | |
| 76 <td>Public slot to show the dialog.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <h3>Static Methods</h3> | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 <a NAME="ProgramsDialog.__init__" ID="ProgramsDialog.__init__"></a> | |
| 84 <h4>ProgramsDialog (Constructor)</h4> | |
| 85 <b>ProgramsDialog</b>(<i>parent=None</i>) | |
| 86 <p> | |
| 87 Constructor | |
| 88 </p><dl> | |
| 89 <dt><i>parent</i></dt> | |
| 90 <dd> | |
| 91 The parent widget of this dialog. (QWidget) | |
| 92 </dd> | |
| 93 </dl><a NAME="ProgramsDialog.__createEntry" ID="ProgramsDialog.__createEntry"></a> | |
| 94 <h4>ProgramsDialog.__createEntry</h4> | |
| 95 <b>__createEntry</b>(<i>description, entryText, entryVersion</i>) | |
| 96 <p> | |
| 97 Private method to generate a program entry. | |
| 98 </p><dl> | |
| 99 <dt><i>description</i></dt> | |
| 100 <dd> | |
| 101 descriptive text (string) | |
| 102 </dd><dt><i>entryText</i></dt> | |
| 103 <dd> | |
| 104 text to show (string) | |
| 105 </dd><dt><i>entryVersion</i></dt> | |
| 106 <dd> | |
| 107 version string to show (string). | |
| 108 </dd> | |
| 109 </dl><a NAME="ProgramsDialog.__createProgramEntry" ID="ProgramsDialog.__createProgramEntry"></a> | |
| 110 <h4>ProgramsDialog.__createProgramEntry</h4> | |
| 111 <b>__createProgramEntry</b>(<i>description, exe, versionCommand="", versionStartsWith="", versionPosition=0, version="", versionCleanup=None, versionRe=None, exeModule=None</i>) | |
| 112 <p> | |
| 113 Private method to generate a program entry. | |
| 114 </p><dl> | |
| 115 <dt><i>description</i></dt> | |
| 116 <dd> | |
| 117 descriptive text (string) | |
| 118 </dd><dt><i>exe</i></dt> | |
| 119 <dd> | |
| 120 name of the executable program (string) | |
| 121 </dd><dt><i>versionCommand</i></dt> | |
| 122 <dd> | |
| 123 command line switch to get the version info | |
| 124 (str). If this is empty, the given version will be shown. | |
| 125 </dd><dt><i>versionStartsWith</i></dt> | |
| 126 <dd> | |
| 127 start of line identifying version info | |
| 128 (string) | |
| 129 </dd><dt><i>versionPosition</i></dt> | |
| 130 <dd> | |
| 131 index of part containing the version info | |
| 132 (integer) | |
| 133 </dd><dt><i>version=</i></dt> | |
| 134 <dd> | |
| 135 version string to show (string) | |
| 136 </dd><dt><i>versionCleanup=</i></dt> | |
| 137 <dd> | |
| 138 tuple of two integers giving string positions | |
| 139 start and stop for the version string (tuple of integers) | |
| 140 </dd><dt><i>versionRe=</i></dt> | |
| 141 <dd> | |
| 142 regexp to determine the line identifying version | |
| 143 info (string). Takes precedence over versionStartsWith. | |
| 144 </dd><dt><i>exeModule=</i></dt> | |
| 145 <dd> | |
| 146 list of command line parameters to execute a module | |
| 147 with the program given in exe (e.g. to execute a Python module) | |
| 148 (list of str) | |
| 149 </dd> | |
| 150 </dl><dl> | |
| 151 <dt>Returns:</dt> | |
| 152 <dd> | |
| 153 version string of detected or given version (string) | |
| 154 </dd> | |
| 155 </dl><a NAME="ProgramsDialog.on_buttonBox_clicked" ID="ProgramsDialog.on_buttonBox_clicked"></a> | |
| 156 <h4>ProgramsDialog.on_buttonBox_clicked</h4> | |
| 157 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 158 <p> | |
| 159 Private slot called by a button of the button box clicked. | |
| 160 </p><dl> | |
| 161 <dt><i>button</i></dt> | |
| 162 <dd> | |
| 163 button that was clicked (QAbstractButton) | |
| 164 </dd> | |
| 165 </dl><a NAME="ProgramsDialog.on_programsSearchButton_clicked" ID="ProgramsDialog.on_programsSearchButton_clicked"></a> | |
| 166 <h4>ProgramsDialog.on_programsSearchButton_clicked</h4> | |
| 167 <b>on_programsSearchButton_clicked</b>(<i></i>) | |
| 168 <p> | |
| 169 Private slot to search for all supported/required programs. | |
| 170 </p><a NAME="ProgramsDialog.show" ID="ProgramsDialog.show"></a> | |
| 171 <h4>ProgramsDialog.show</h4> | |
| 172 <b>show</b>(<i></i>) | |
| 173 <p> | |
| 174 Public slot to show the dialog. | |
| 175 </p> | |
| 176 <div align="right"><a href="#top">Up</a></div> | |
| 177 <hr /> | |
| 178 </body></html> |
