Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Preferences.ProgramsDialog.html

eric6/Documentation/Source/eric6.Preferences.ProgramsDialog.html

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

Mercurial Repository: eric

eric ide

mercurial