src/eric7/Documentation/Source/eric7.Preferences.ToolGroupConfigurationDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10428
a071d4065202
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Preferences.ToolGroupConfigurationDialog</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.ToolGroupConfigurationDialog</h1>
10
11 <p>
12 Module implementing a configuration dialog for the tools menu.
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="#ToolGroupConfigurationDialog">ToolGroupConfigurationDialog</a></td>
25 <td>Class implementing a configuration dialog for the tool groups.</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="ToolGroupConfigurationDialog" ID="ToolGroupConfigurationDialog"></a>
36 <h2>ToolGroupConfigurationDialog</h2>
37
38 <p>
39 Class implementing a configuration dialog for the tool groups.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_ToolGroupConfigurationDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</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="#ToolGroupConfigurationDialog.__init__">ToolGroupConfigurationDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#ToolGroupConfigurationDialog.__swap">__swap</a></td>
63 <td>Private method used two swap two list entries given by their index.</td>
64 </tr>
65 <tr>
66 <td><a href="#ToolGroupConfigurationDialog.getToolGroups">getToolGroups</a></td>
67 <td>Public method to retrieve the tool groups.</td>
68 </tr>
69 <tr>
70 <td><a href="#ToolGroupConfigurationDialog.on_addButton_clicked">on_addButton_clicked</a></td>
71 <td>Private slot to add a new entry.</td>
72 </tr>
73 <tr>
74 <td><a href="#ToolGroupConfigurationDialog.on_changeButton_clicked">on_changeButton_clicked</a></td>
75 <td>Private slot to change an entry.</td>
76 </tr>
77 <tr>
78 <td><a href="#ToolGroupConfigurationDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
79 <td>Private slot to delete the selected entry.</td>
80 </tr>
81 <tr>
82 <td><a href="#ToolGroupConfigurationDialog.on_downButton_clicked">on_downButton_clicked</a></td>
83 <td>Private slot to move an entry down in the list.</td>
84 </tr>
85 <tr>
86 <td><a href="#ToolGroupConfigurationDialog.on_groupsList_currentRowChanged">on_groupsList_currentRowChanged</a></td>
87 <td>Private slot to set the lineedits depending on the selected entry.</td>
88 </tr>
89 <tr>
90 <td><a href="#ToolGroupConfigurationDialog.on_newButton_clicked">on_newButton_clicked</a></td>
91 <td>Private slot to clear all entry fields.</td>
92 </tr>
93 <tr>
94 <td><a href="#ToolGroupConfigurationDialog.on_upButton_clicked">on_upButton_clicked</a></td>
95 <td>Private slot to move an entry up in the list.</td>
96 </tr>
97 </table>
98 <h3>Static Methods</h3>
99
100 <table>
101 <tr><td>None</td></tr>
102 </table>
103
104 <a NAME="ToolGroupConfigurationDialog.__init__" ID="ToolGroupConfigurationDialog.__init__"></a>
105 <h4>ToolGroupConfigurationDialog (Constructor)</h4>
106 <b>ToolGroupConfigurationDialog</b>(<i>toolGroups, currentGroup, parent=None</i>)
107
108 <p>
109 Constructor
110 </p>
111 <dl>
112
113 <dt><i>toolGroups</i></dt>
114 <dd>
115 list of configured tool groups
116 </dd>
117 <dt><i>currentGroup</i></dt>
118 <dd>
119 number of the active group (integer)
120 </dd>
121 <dt><i>parent</i></dt>
122 <dd>
123 parent widget (QWidget)
124 </dd>
125 </dl>
126 <a NAME="ToolGroupConfigurationDialog.__swap" ID="ToolGroupConfigurationDialog.__swap"></a>
127 <h4>ToolGroupConfigurationDialog.__swap</h4>
128 <b>__swap</b>(<i>itm1, itm2</i>)
129
130 <p>
131 Private method used two swap two list entries given by their index.
132 </p>
133 <dl>
134
135 <dt><i>itm1</i></dt>
136 <dd>
137 index of first entry (int)
138 </dd>
139 <dt><i>itm2</i></dt>
140 <dd>
141 index of second entry (int)
142 </dd>
143 </dl>
144 <a NAME="ToolGroupConfigurationDialog.getToolGroups" ID="ToolGroupConfigurationDialog.getToolGroups"></a>
145 <h4>ToolGroupConfigurationDialog.getToolGroups</h4>
146 <b>getToolGroups</b>(<i></i>)
147
148 <p>
149 Public method to retrieve the tool groups.
150 </p>
151 <dl>
152 <dt>Return:</dt>
153 <dd>
154 a list of lists containing the group name and the
155 tool group entries
156 </dd>
157 </dl>
158 <a NAME="ToolGroupConfigurationDialog.on_addButton_clicked" ID="ToolGroupConfigurationDialog.on_addButton_clicked"></a>
159 <h4>ToolGroupConfigurationDialog.on_addButton_clicked</h4>
160 <b>on_addButton_clicked</b>(<i></i>)
161
162 <p>
163 Private slot to add a new entry.
164 </p>
165 <a NAME="ToolGroupConfigurationDialog.on_changeButton_clicked" ID="ToolGroupConfigurationDialog.on_changeButton_clicked"></a>
166 <h4>ToolGroupConfigurationDialog.on_changeButton_clicked</h4>
167 <b>on_changeButton_clicked</b>(<i></i>)
168
169 <p>
170 Private slot to change an entry.
171 </p>
172 <a NAME="ToolGroupConfigurationDialog.on_deleteButton_clicked" ID="ToolGroupConfigurationDialog.on_deleteButton_clicked"></a>
173 <h4>ToolGroupConfigurationDialog.on_deleteButton_clicked</h4>
174 <b>on_deleteButton_clicked</b>(<i></i>)
175
176 <p>
177 Private slot to delete the selected entry.
178 </p>
179 <a NAME="ToolGroupConfigurationDialog.on_downButton_clicked" ID="ToolGroupConfigurationDialog.on_downButton_clicked"></a>
180 <h4>ToolGroupConfigurationDialog.on_downButton_clicked</h4>
181 <b>on_downButton_clicked</b>(<i></i>)
182
183 <p>
184 Private slot to move an entry down in the list.
185 </p>
186 <a NAME="ToolGroupConfigurationDialog.on_groupsList_currentRowChanged" ID="ToolGroupConfigurationDialog.on_groupsList_currentRowChanged"></a>
187 <h4>ToolGroupConfigurationDialog.on_groupsList_currentRowChanged</h4>
188 <b>on_groupsList_currentRowChanged</b>(<i>row</i>)
189
190 <p>
191 Private slot to set the lineedits depending on the selected entry.
192 </p>
193 <dl>
194
195 <dt><i>row</i></dt>
196 <dd>
197 the row of the selected entry (integer)
198 </dd>
199 </dl>
200 <a NAME="ToolGroupConfigurationDialog.on_newButton_clicked" ID="ToolGroupConfigurationDialog.on_newButton_clicked"></a>
201 <h4>ToolGroupConfigurationDialog.on_newButton_clicked</h4>
202 <b>on_newButton_clicked</b>(<i></i>)
203
204 <p>
205 Private slot to clear all entry fields.
206 </p>
207 <a NAME="ToolGroupConfigurationDialog.on_upButton_clicked" ID="ToolGroupConfigurationDialog.on_upButton_clicked"></a>
208 <h4>ToolGroupConfigurationDialog.on_upButton_clicked</h4>
209 <b>on_upButton_clicked</b>(<i></i>)
210
211 <p>
212 Private slot to move an entry up in the list.
213 </p>
214 <div align="right"><a href="#top">Up</a></div>
215 <hr />
216 </body></html>

eric ide

mercurial