Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.Preferences.ToolConfigurationDialog.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.ToolConfigurationDialog</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.ToolConfigurationDialog</h1>
23 <p>
24 Module implementing a configuration dialog for the tools menu.
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="#ToolConfigurationDialog">ToolConfigurationDialog</a></td>
34 <td>Class implementing a configuration dialog for the tools menu.</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="ToolConfigurationDialog" ID="ToolConfigurationDialog"></a>
43 <h2>ToolConfigurationDialog</h2>
44 <p>
45 Class implementing a configuration dialog for the tools menu.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_ToolConfigurationDialog
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="#ToolConfigurationDialog.__init__">ToolConfigurationDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#ToolConfigurationDialog.__findModeIndex">__findModeIndex</a></td>
64 <td>Private method to find the mode index by its short name.</td>
65 </tr><tr>
66 <td><a href="#ToolConfigurationDialog.__swap">__swap</a></td>
67 <td>Private method used two swap two list entries given by their index.</td>
68 </tr><tr>
69 <td><a href="#ToolConfigurationDialog.__toolEntryChanged">__toolEntryChanged</a></td>
70 <td>Private slot to perform actions when a tool entry was changed.</td>
71 </tr><tr>
72 <td><a href="#ToolConfigurationDialog.getToollist">getToollist</a></td>
73 <td>Public method to retrieve the tools list.</td>
74 </tr><tr>
75 <td><a href="#ToolConfigurationDialog.on_addButton_clicked">on_addButton_clicked</a></td>
76 <td>Private slot to add a new entry.</td>
77 </tr><tr>
78 <td><a href="#ToolConfigurationDialog.on_argumentsEdit_textChanged">on_argumentsEdit_textChanged</a></td>
79 <td>Private slot called, when the arguments string was changed.</td>
80 </tr><tr>
81 <td><a href="#ToolConfigurationDialog.on_changeButton_clicked">on_changeButton_clicked</a></td>
82 <td>Private slot to change an entry.</td>
83 </tr><tr>
84 <td><a href="#ToolConfigurationDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
85 <td>Private slot to delete the selected entry.</td>
86 </tr><tr>
87 <td><a href="#ToolConfigurationDialog.on_downButton_clicked">on_downButton_clicked</a></td>
88 <td>Private slot to move an entry down in the list.</td>
89 </tr><tr>
90 <td><a href="#ToolConfigurationDialog.on_executablePicker_pathSelected">on_executablePicker_pathSelected</a></td>
91 <td>Private slot to check the executable after it has been selected.</td>
92 </tr><tr>
93 <td><a href="#ToolConfigurationDialog.on_executablePicker_textChanged">on_executablePicker_textChanged</a></td>
94 <td>Private slot called, when the executable was changed.</td>
95 </tr><tr>
96 <td><a href="#ToolConfigurationDialog.on_iconPicker_textChanged">on_iconPicker_textChanged</a></td>
97 <td>Private slot called, when the icon path was changed.</td>
98 </tr><tr>
99 <td><a href="#ToolConfigurationDialog.on_menuEdit_textChanged">on_menuEdit_textChanged</a></td>
100 <td>Private slot called, when the menu text was changed.</td>
101 </tr><tr>
102 <td><a href="#ToolConfigurationDialog.on_newButton_clicked">on_newButton_clicked</a></td>
103 <td>Private slot to clear all entry fields.</td>
104 </tr><tr>
105 <td><a href="#ToolConfigurationDialog.on_redirectCombo_currentIndexChanged">on_redirectCombo_currentIndexChanged</a></td>
106 <td>Private slot called, when the redirection mode was changed.</td>
107 </tr><tr>
108 <td><a href="#ToolConfigurationDialog.on_separatorButton_clicked">on_separatorButton_clicked</a></td>
109 <td>Private slot to add a menu separator.</td>
110 </tr><tr>
111 <td><a href="#ToolConfigurationDialog.on_toolsList_currentRowChanged">on_toolsList_currentRowChanged</a></td>
112 <td>Private slot to set the lineedits depending on the selected entry.</td>
113 </tr><tr>
114 <td><a href="#ToolConfigurationDialog.on_upButton_clicked">on_upButton_clicked</a></td>
115 <td>Private slot to move an entry up in the list.</td>
116 </tr>
117 </table>
118 <h3>Static Methods</h3>
119 <table>
120 <tr><td>None</td></tr>
121 </table>
122 <a NAME="ToolConfigurationDialog.__init__" ID="ToolConfigurationDialog.__init__"></a>
123 <h4>ToolConfigurationDialog (Constructor)</h4>
124 <b>ToolConfigurationDialog</b>(<i>toollist, parent=None</i>)
125 <p>
126 Constructor
127 </p><dl>
128 <dt><i>toollist</i></dt>
129 <dd>
130 list of configured tools
131 </dd><dt><i>parent</i></dt>
132 <dd>
133 parent widget (QWidget)
134 </dd>
135 </dl><a NAME="ToolConfigurationDialog.__findModeIndex" ID="ToolConfigurationDialog.__findModeIndex"></a>
136 <h4>ToolConfigurationDialog.__findModeIndex</h4>
137 <b>__findModeIndex</b>(<i>shortName</i>)
138 <p>
139 Private method to find the mode index by its short name.
140 </p><dl>
141 <dt><i>shortName</i></dt>
142 <dd>
143 short name of the mode (string)
144 </dd>
145 </dl><dl>
146 <dt>Returns:</dt>
147 <dd>
148 index of the mode (integer)
149 </dd>
150 </dl><a NAME="ToolConfigurationDialog.__swap" ID="ToolConfigurationDialog.__swap"></a>
151 <h4>ToolConfigurationDialog.__swap</h4>
152 <b>__swap</b>(<i>itm1, itm2</i>)
153 <p>
154 Private method used two swap two list entries given by their index.
155 </p><dl>
156 <dt><i>itm1</i></dt>
157 <dd>
158 index of first entry (int)
159 </dd><dt><i>itm2</i></dt>
160 <dd>
161 index of second entry (int)
162 </dd>
163 </dl><a NAME="ToolConfigurationDialog.__toolEntryChanged" ID="ToolConfigurationDialog.__toolEntryChanged"></a>
164 <h4>ToolConfigurationDialog.__toolEntryChanged</h4>
165 <b>__toolEntryChanged</b>(<i></i>)
166 <p>
167 Private slot to perform actions when a tool entry was changed.
168 </p><a NAME="ToolConfigurationDialog.getToollist" ID="ToolConfigurationDialog.getToollist"></a>
169 <h4>ToolConfigurationDialog.getToollist</h4>
170 <b>getToollist</b>(<i></i>)
171 <p>
172 Public method to retrieve the tools list.
173 </p><dl>
174 <dt>Returns:</dt>
175 <dd>
176 a list of tuples containing the menu text, the executable,
177 the executables arguments and a redirection flag
178 </dd>
179 </dl><a NAME="ToolConfigurationDialog.on_addButton_clicked" ID="ToolConfigurationDialog.on_addButton_clicked"></a>
180 <h4>ToolConfigurationDialog.on_addButton_clicked</h4>
181 <b>on_addButton_clicked</b>(<i></i>)
182 <p>
183 Private slot to add a new entry.
184 </p><a NAME="ToolConfigurationDialog.on_argumentsEdit_textChanged" ID="ToolConfigurationDialog.on_argumentsEdit_textChanged"></a>
185 <h4>ToolConfigurationDialog.on_argumentsEdit_textChanged</h4>
186 <b>on_argumentsEdit_textChanged</b>(<i>text</i>)
187 <p>
188 Private slot called, when the arguments string was changed.
189 </p><dl>
190 <dt><i>text</i></dt>
191 <dd>
192 the new text (string) (ignored)
193 </dd>
194 </dl><a NAME="ToolConfigurationDialog.on_changeButton_clicked" ID="ToolConfigurationDialog.on_changeButton_clicked"></a>
195 <h4>ToolConfigurationDialog.on_changeButton_clicked</h4>
196 <b>on_changeButton_clicked</b>(<i></i>)
197 <p>
198 Private slot to change an entry.
199 </p><a NAME="ToolConfigurationDialog.on_deleteButton_clicked" ID="ToolConfigurationDialog.on_deleteButton_clicked"></a>
200 <h4>ToolConfigurationDialog.on_deleteButton_clicked</h4>
201 <b>on_deleteButton_clicked</b>(<i></i>)
202 <p>
203 Private slot to delete the selected entry.
204 </p><a NAME="ToolConfigurationDialog.on_downButton_clicked" ID="ToolConfigurationDialog.on_downButton_clicked"></a>
205 <h4>ToolConfigurationDialog.on_downButton_clicked</h4>
206 <b>on_downButton_clicked</b>(<i></i>)
207 <p>
208 Private slot to move an entry down in the list.
209 </p><a NAME="ToolConfigurationDialog.on_executablePicker_pathSelected" ID="ToolConfigurationDialog.on_executablePicker_pathSelected"></a>
210 <h4>ToolConfigurationDialog.on_executablePicker_pathSelected</h4>
211 <b>on_executablePicker_pathSelected</b>(<i>path</i>)
212 <p>
213 Private slot to check the executable after it has been selected.
214 </p><dl>
215 <dt><i>path</i> (str)</dt>
216 <dd>
217 path of the executable
218 </dd>
219 </dl><a NAME="ToolConfigurationDialog.on_executablePicker_textChanged" ID="ToolConfigurationDialog.on_executablePicker_textChanged"></a>
220 <h4>ToolConfigurationDialog.on_executablePicker_textChanged</h4>
221 <b>on_executablePicker_textChanged</b>(<i>text</i>)
222 <p>
223 Private slot called, when the executable was changed.
224 </p><dl>
225 <dt><i>text</i></dt>
226 <dd>
227 the new text (string) (ignored)
228 </dd>
229 </dl><a NAME="ToolConfigurationDialog.on_iconPicker_textChanged" ID="ToolConfigurationDialog.on_iconPicker_textChanged"></a>
230 <h4>ToolConfigurationDialog.on_iconPicker_textChanged</h4>
231 <b>on_iconPicker_textChanged</b>(<i>text</i>)
232 <p>
233 Private slot called, when the icon path was changed.
234 </p><dl>
235 <dt><i>text</i></dt>
236 <dd>
237 the new text (string) (ignored)
238 </dd>
239 </dl><a NAME="ToolConfigurationDialog.on_menuEdit_textChanged" ID="ToolConfigurationDialog.on_menuEdit_textChanged"></a>
240 <h4>ToolConfigurationDialog.on_menuEdit_textChanged</h4>
241 <b>on_menuEdit_textChanged</b>(<i>text</i>)
242 <p>
243 Private slot called, when the menu text was changed.
244 </p><dl>
245 <dt><i>text</i></dt>
246 <dd>
247 the new text (string) (ignored)
248 </dd>
249 </dl><a NAME="ToolConfigurationDialog.on_newButton_clicked" ID="ToolConfigurationDialog.on_newButton_clicked"></a>
250 <h4>ToolConfigurationDialog.on_newButton_clicked</h4>
251 <b>on_newButton_clicked</b>(<i></i>)
252 <p>
253 Private slot to clear all entry fields.
254 </p><a NAME="ToolConfigurationDialog.on_redirectCombo_currentIndexChanged" ID="ToolConfigurationDialog.on_redirectCombo_currentIndexChanged"></a>
255 <h4>ToolConfigurationDialog.on_redirectCombo_currentIndexChanged</h4>
256 <b>on_redirectCombo_currentIndexChanged</b>(<i>index</i>)
257 <p>
258 Private slot called, when the redirection mode was changed.
259 </p><dl>
260 <dt><i>index</i></dt>
261 <dd>
262 the selected mode index (integer) (ignored)
263 </dd>
264 </dl><a NAME="ToolConfigurationDialog.on_separatorButton_clicked" ID="ToolConfigurationDialog.on_separatorButton_clicked"></a>
265 <h4>ToolConfigurationDialog.on_separatorButton_clicked</h4>
266 <b>on_separatorButton_clicked</b>(<i></i>)
267 <p>
268 Private slot to add a menu separator.
269 </p><a NAME="ToolConfigurationDialog.on_toolsList_currentRowChanged" ID="ToolConfigurationDialog.on_toolsList_currentRowChanged"></a>
270 <h4>ToolConfigurationDialog.on_toolsList_currentRowChanged</h4>
271 <b>on_toolsList_currentRowChanged</b>(<i>row</i>)
272 <p>
273 Private slot to set the lineedits depending on the selected entry.
274 </p><dl>
275 <dt><i>row</i></dt>
276 <dd>
277 the row of the selected entry (integer)
278 </dd>
279 </dl><a NAME="ToolConfigurationDialog.on_upButton_clicked" ID="ToolConfigurationDialog.on_upButton_clicked"></a>
280 <h4>ToolConfigurationDialog.on_upButton_clicked</h4>
281 <b>on_upButton_clicked</b>(<i></i>)
282 <p>
283 Private slot to move an entry up in the list.
284 </p>
285 <div align="right"><a href="#top">Up</a></div>
286 <hr />
287 </body></html>

Mercurial Repository: eric

eric ide

mercurial