Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.Preferences.ToolConfigurationDialog.html

changeset 3673
e26d7d0c1088
child 4602
48cc4820e2c2
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
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_executableButton_clicked">on_executableButton_clicked</a></td>
91 <td>Private slot to handle the executable selection via a file selection dialog.</td>
92 </tr><tr>
93 <td><a href="#ToolConfigurationDialog.on_executableEdit_textChanged">on_executableEdit_textChanged</a></td>
94 <td>Private slot called, when the executable was changed.</td>
95 </tr><tr>
96 <td><a href="#ToolConfigurationDialog.on_iconButton_clicked">on_iconButton_clicked</a></td>
97 <td>Private slot to handle the icon selection via a file selection dialog.</td>
98 </tr><tr>
99 <td><a href="#ToolConfigurationDialog.on_iconEdit_textChanged">on_iconEdit_textChanged</a></td>
100 <td>Private slot called, when the icon path was changed.</td>
101 </tr><tr>
102 <td><a href="#ToolConfigurationDialog.on_menuEdit_textChanged">on_menuEdit_textChanged</a></td>
103 <td>Private slot called, when the menu text was changed.</td>
104 </tr><tr>
105 <td><a href="#ToolConfigurationDialog.on_newButton_clicked">on_newButton_clicked</a></td>
106 <td>Private slot to clear all entry fields.</td>
107 </tr><tr>
108 <td><a href="#ToolConfigurationDialog.on_redirectCombo_currentIndexChanged">on_redirectCombo_currentIndexChanged</a></td>
109 <td>Private slot called, when the redirection mode was changed.</td>
110 </tr><tr>
111 <td><a href="#ToolConfigurationDialog.on_separatorButton_clicked">on_separatorButton_clicked</a></td>
112 <td>Private slot to add a menu separator.</td>
113 </tr><tr>
114 <td><a href="#ToolConfigurationDialog.on_toolsList_currentRowChanged">on_toolsList_currentRowChanged</a></td>
115 <td>Private slot to set the lineedits depending on the selected entry.</td>
116 </tr><tr>
117 <td><a href="#ToolConfigurationDialog.on_upButton_clicked">on_upButton_clicked</a></td>
118 <td>Private slot to move an entry up in the list.</td>
119 </tr>
120 </table>
121 <h3>Static Methods</h3>
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125 <a NAME="ToolConfigurationDialog.__init__" ID="ToolConfigurationDialog.__init__"></a>
126 <h4>ToolConfigurationDialog (Constructor)</h4>
127 <b>ToolConfigurationDialog</b>(<i>toollist, parent=None</i>)
128 <p>
129 Constructor
130 </p><dl>
131 <dt><i>toollist</i></dt>
132 <dd>
133 list of configured tools
134 </dd><dt><i>parent</i></dt>
135 <dd>
136 parent widget (QWidget)
137 </dd>
138 </dl><a NAME="ToolConfigurationDialog.__findModeIndex" ID="ToolConfigurationDialog.__findModeIndex"></a>
139 <h4>ToolConfigurationDialog.__findModeIndex</h4>
140 <b>__findModeIndex</b>(<i>shortName</i>)
141 <p>
142 Private method to find the mode index by its short name.
143 </p><dl>
144 <dt><i>shortName</i></dt>
145 <dd>
146 short name of the mode (string)
147 </dd>
148 </dl><dl>
149 <dt>Returns:</dt>
150 <dd>
151 index of the mode (integer)
152 </dd>
153 </dl><a NAME="ToolConfigurationDialog.__swap" ID="ToolConfigurationDialog.__swap"></a>
154 <h4>ToolConfigurationDialog.__swap</h4>
155 <b>__swap</b>(<i>itm1, itm2</i>)
156 <p>
157 Private method used two swap two list entries given by their index.
158 </p><dl>
159 <dt><i>itm1</i></dt>
160 <dd>
161 index of first entry (int)
162 </dd><dt><i>itm2</i></dt>
163 <dd>
164 index of second entry (int)
165 </dd>
166 </dl><a NAME="ToolConfigurationDialog.__toolEntryChanged" ID="ToolConfigurationDialog.__toolEntryChanged"></a>
167 <h4>ToolConfigurationDialog.__toolEntryChanged</h4>
168 <b>__toolEntryChanged</b>(<i></i>)
169 <p>
170 Private slot to perform actions when a tool entry was changed.
171 </p><a NAME="ToolConfigurationDialog.getToollist" ID="ToolConfigurationDialog.getToollist"></a>
172 <h4>ToolConfigurationDialog.getToollist</h4>
173 <b>getToollist</b>(<i></i>)
174 <p>
175 Public method to retrieve the tools list.
176 </p><dl>
177 <dt>Returns:</dt>
178 <dd>
179 a list of tuples containing the menu text, the executable,
180 the executables arguments and a redirection flag
181 </dd>
182 </dl><a NAME="ToolConfigurationDialog.on_addButton_clicked" ID="ToolConfigurationDialog.on_addButton_clicked"></a>
183 <h4>ToolConfigurationDialog.on_addButton_clicked</h4>
184 <b>on_addButton_clicked</b>(<i></i>)
185 <p>
186 Private slot to add a new entry.
187 </p><a NAME="ToolConfigurationDialog.on_argumentsEdit_textChanged" ID="ToolConfigurationDialog.on_argumentsEdit_textChanged"></a>
188 <h4>ToolConfigurationDialog.on_argumentsEdit_textChanged</h4>
189 <b>on_argumentsEdit_textChanged</b>(<i>text</i>)
190 <p>
191 Private slot called, when the arguments string was changed.
192 </p><dl>
193 <dt><i>text</i></dt>
194 <dd>
195 the new text (string) (ignored)
196 </dd>
197 </dl><a NAME="ToolConfigurationDialog.on_changeButton_clicked" ID="ToolConfigurationDialog.on_changeButton_clicked"></a>
198 <h4>ToolConfigurationDialog.on_changeButton_clicked</h4>
199 <b>on_changeButton_clicked</b>(<i></i>)
200 <p>
201 Private slot to change an entry.
202 </p><a NAME="ToolConfigurationDialog.on_deleteButton_clicked" ID="ToolConfigurationDialog.on_deleteButton_clicked"></a>
203 <h4>ToolConfigurationDialog.on_deleteButton_clicked</h4>
204 <b>on_deleteButton_clicked</b>(<i></i>)
205 <p>
206 Private slot to delete the selected entry.
207 </p><a NAME="ToolConfigurationDialog.on_downButton_clicked" ID="ToolConfigurationDialog.on_downButton_clicked"></a>
208 <h4>ToolConfigurationDialog.on_downButton_clicked</h4>
209 <b>on_downButton_clicked</b>(<i></i>)
210 <p>
211 Private slot to move an entry down in the list.
212 </p><a NAME="ToolConfigurationDialog.on_executableButton_clicked" ID="ToolConfigurationDialog.on_executableButton_clicked"></a>
213 <h4>ToolConfigurationDialog.on_executableButton_clicked</h4>
214 <b>on_executableButton_clicked</b>(<i></i>)
215 <p>
216 Private slot to handle the executable selection via a file selection
217 dialog.
218 </p><a NAME="ToolConfigurationDialog.on_executableEdit_textChanged" ID="ToolConfigurationDialog.on_executableEdit_textChanged"></a>
219 <h4>ToolConfigurationDialog.on_executableEdit_textChanged</h4>
220 <b>on_executableEdit_textChanged</b>(<i>text</i>)
221 <p>
222 Private slot called, when the executable was changed.
223 </p><dl>
224 <dt><i>text</i></dt>
225 <dd>
226 the new text (string) (ignored)
227 </dd>
228 </dl><a NAME="ToolConfigurationDialog.on_iconButton_clicked" ID="ToolConfigurationDialog.on_iconButton_clicked"></a>
229 <h4>ToolConfigurationDialog.on_iconButton_clicked</h4>
230 <b>on_iconButton_clicked</b>(<i></i>)
231 <p>
232 Private slot to handle the icon selection via a file selection dialog.
233 </p><a NAME="ToolConfigurationDialog.on_iconEdit_textChanged" ID="ToolConfigurationDialog.on_iconEdit_textChanged"></a>
234 <h4>ToolConfigurationDialog.on_iconEdit_textChanged</h4>
235 <b>on_iconEdit_textChanged</b>(<i>text</i>)
236 <p>
237 Private slot called, when the icon path was changed.
238 </p><dl>
239 <dt><i>text</i></dt>
240 <dd>
241 the new text (string) (ignored)
242 </dd>
243 </dl><a NAME="ToolConfigurationDialog.on_menuEdit_textChanged" ID="ToolConfigurationDialog.on_menuEdit_textChanged"></a>
244 <h4>ToolConfigurationDialog.on_menuEdit_textChanged</h4>
245 <b>on_menuEdit_textChanged</b>(<i>text</i>)
246 <p>
247 Private slot called, when the menu text was changed.
248 </p><dl>
249 <dt><i>text</i></dt>
250 <dd>
251 the new text (string) (ignored)
252 </dd>
253 </dl><a NAME="ToolConfigurationDialog.on_newButton_clicked" ID="ToolConfigurationDialog.on_newButton_clicked"></a>
254 <h4>ToolConfigurationDialog.on_newButton_clicked</h4>
255 <b>on_newButton_clicked</b>(<i></i>)
256 <p>
257 Private slot to clear all entry fields.
258 </p><a NAME="ToolConfigurationDialog.on_redirectCombo_currentIndexChanged" ID="ToolConfigurationDialog.on_redirectCombo_currentIndexChanged"></a>
259 <h4>ToolConfigurationDialog.on_redirectCombo_currentIndexChanged</h4>
260 <b>on_redirectCombo_currentIndexChanged</b>(<i>index</i>)
261 <p>
262 Private slot called, when the redirection mode was changed.
263 </p><dl>
264 <dt><i>index</i></dt>
265 <dd>
266 the selected mode index (integer) (ignored)
267 </dd>
268 </dl><a NAME="ToolConfigurationDialog.on_separatorButton_clicked" ID="ToolConfigurationDialog.on_separatorButton_clicked"></a>
269 <h4>ToolConfigurationDialog.on_separatorButton_clicked</h4>
270 <b>on_separatorButton_clicked</b>(<i></i>)
271 <p>
272 Private slot to add a menu separator.
273 </p><a NAME="ToolConfigurationDialog.on_toolsList_currentRowChanged" ID="ToolConfigurationDialog.on_toolsList_currentRowChanged"></a>
274 <h4>ToolConfigurationDialog.on_toolsList_currentRowChanged</h4>
275 <b>on_toolsList_currentRowChanged</b>(<i>row</i>)
276 <p>
277 Private slot to set the lineedits depending on the selected entry.
278 </p><dl>
279 <dt><i>row</i></dt>
280 <dd>
281 the row of the selected entry (integer)
282 </dd>
283 </dl><a NAME="ToolConfigurationDialog.on_upButton_clicked" ID="ToolConfigurationDialog.on_upButton_clicked"></a>
284 <h4>ToolConfigurationDialog.on_upButton_clicked</h4>
285 <b>on_upButton_clicked</b>(<i></i>)
286 <p>
287 Private slot to move an entry up in the list.
288 </p>
289 <div align="right"><a href="#top">Up</a></div>
290 <hr />
291 </body></html>

Mercurial Repository: eric

eric ide

mercurial