Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Preferences.ShortcutsDialog.html

Documentation/Source/eric4.Preferences.ShortcutsDialog.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Preferences.ShortcutsDialog</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Preferences.ShortcutsDialog</h1>
24 <p>
25 Module implementing a dialog for the configuration of eric4s keyboard shortcuts.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#ShortcutsDialog">ShortcutsDialog</a></td>
35 <td>Class implementing a dialog for the configuration of eric4s keyboard shortcuts.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="ShortcutsDialog" ID="ShortcutsDialog"></a>
44 <h2>ShortcutsDialog</h2>
45 <p>
46 Class implementing a dialog for the configuration of eric4s keyboard shortcuts.
47 </p>
48 <h3>Derived from</h3>
49 QDialog, Ui_ShortcutsDialog
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>noCheckRole</td></tr><tr><td>objectNameRole</td></tr><tr><td>objectTypeRole</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#ShortcutsDialog.__init__">ShortcutsDialog</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#ShortcutsDialog.__checkShortcut">__checkShortcut</a></td>
61 <td>Private method to check a keysequence for uniqueness.</td>
62 </tr><tr>
63 <td><a href="#ShortcutsDialog.__generateCategoryItem">__generateCategoryItem</a></td>
64 <td>Private method to generate a category item.</td>
65 </tr><tr>
66 <td><a href="#ShortcutsDialog.__generateShortcutItem">__generateShortcutItem</a></td>
67 <td>Private method to generate a keyboard shortcut item.</td>
68 </tr><tr>
69 <td><a href="#ShortcutsDialog.__resizeColumns">__resizeColumns</a></td>
70 <td>Private method to resize the list columns.</td>
71 </tr><tr>
72 <td><a href="#ShortcutsDialog.__resort">__resort</a></td>
73 <td>Private method to resort the tree.</td>
74 </tr><tr>
75 <td><a href="#ShortcutsDialog.__saveCategoryActions">__saveCategoryActions</a></td>
76 <td>Private method to save the actions for a category.</td>
77 </tr><tr>
78 <td><a href="#ShortcutsDialog.__shortcutChanged">__shortcutChanged</a></td>
79 <td>Private slot to handle the shortcutChanged signal of the shortcut dialog.</td>
80 </tr><tr>
81 <td><a href="#ShortcutsDialog.on_actionButton_toggled">on_actionButton_toggled</a></td>
82 <td>Private slot called, when the action radio button is toggled.</td>
83 </tr><tr>
84 <td><a href="#ShortcutsDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
85 <td>Private slot to handle the OK button press.</td>
86 </tr><tr>
87 <td><a href="#ShortcutsDialog.on_clearSearchButton_clicked">on_clearSearchButton_clicked</a></td>
88 <td>Private slot called by a click of the clear search button.</td>
89 </tr><tr>
90 <td><a href="#ShortcutsDialog.on_searchEdit_textChanged">on_searchEdit_textChanged</a></td>
91 <td>Private slot called, when the text in the search edit changes.</td>
92 </tr><tr>
93 <td><a href="#ShortcutsDialog.on_shortcutButton_toggled">on_shortcutButton_toggled</a></td>
94 <td>Private slot called, when the shortcuts radio button is toggled.</td>
95 </tr><tr>
96 <td><a href="#ShortcutsDialog.on_shortcutsList_itemChanged">on_shortcutsList_itemChanged</a></td>
97 <td>Private slot to handle the edit of a shortcut key.</td>
98 </tr><tr>
99 <td><a href="#ShortcutsDialog.on_shortcutsList_itemClicked">on_shortcutsList_itemClicked</a></td>
100 <td>Private slot to handle a click in the shortcuts list.</td>
101 </tr><tr>
102 <td><a href="#ShortcutsDialog.on_shortcutsList_itemDoubleClicked">on_shortcutsList_itemDoubleClicked</a></td>
103 <td>Private slot to handle a double click in the shortcuts list.</td>
104 </tr><tr>
105 <td><a href="#ShortcutsDialog.populate">populate</a></td>
106 <td>Public method to populate the dialog.</td>
107 </tr>
108 </table>
109 <a NAME="ShortcutsDialog.__init__" ID="ShortcutsDialog.__init__"></a>
110 <h4>ShortcutsDialog (Constructor)</h4>
111 <b>ShortcutsDialog</b>(<i>parent = None, name = None, modal = False</i>)
112 <p>
113 Constructor
114 </p><dl>
115 <dt><i>parent</i></dt>
116 <dd>
117 The parent widget of this dialog. (QWidget)
118 </dd><dt><i>name</i></dt>
119 <dd>
120 The name of this dialog. (string)
121 </dd><dt><i>modal</i></dt>
122 <dd>
123 Flag indicating a modal dialog. (boolean)
124 </dd>
125 </dl><a NAME="ShortcutsDialog.__checkShortcut" ID="ShortcutsDialog.__checkShortcut"></a>
126 <h4>ShortcutsDialog.__checkShortcut</h4>
127 <b>__checkShortcut</b>(<i>keysequence, objectType, origTopItem</i>)
128 <p>
129 Private method to check a keysequence for uniqueness.
130 </p><dl>
131 <dt><i>keysequence</i></dt>
132 <dd>
133 the keysequence to check (QKeySequence)
134 </dd><dt><i>objectType</i></dt>
135 <dd>
136 type of the object (string). Entries with the same
137 object type are not checked for uniqueness.
138 </dd><dt><i>origTopItem</i></dt>
139 <dd>
140 refrence to the parent of the item to be checked
141 (QTreeWidgetItem)
142 </dd>
143 </dl><dl>
144 <dt>Returns:</dt>
145 <dd>
146 flag indicating uniqueness (boolean)
147 </dd>
148 </dl><a NAME="ShortcutsDialog.__generateCategoryItem" ID="ShortcutsDialog.__generateCategoryItem"></a>
149 <h4>ShortcutsDialog.__generateCategoryItem</h4>
150 <b>__generateCategoryItem</b>(<i>title</i>)
151 <p>
152 Private method to generate a category item.
153 </p><dl>
154 <dt><i>title</i></dt>
155 <dd>
156 title for the item (string)
157 </dd>
158 </dl><dl>
159 <dt>Returns:</dt>
160 <dd>
161 reference to the category item (QTreeWidgetItem)
162 </dd>
163 </dl><a NAME="ShortcutsDialog.__generateShortcutItem" ID="ShortcutsDialog.__generateShortcutItem"></a>
164 <h4>ShortcutsDialog.__generateShortcutItem</h4>
165 <b>__generateShortcutItem</b>(<i>category, action, noCheck = False, objectType = None</i>)
166 <p>
167 Private method to generate a keyboard shortcut item.
168 </p><dl>
169 <dt><i>category</i></dt>
170 <dd>
171 reference to the category item (QTreeWidgetItem)
172 </dd><dt><i>action</i></dt>
173 <dd>
174 reference to the keyboard action (E4Action)
175 </dd><dt><i>noCheck=</i></dt>
176 <dd>
177 flag indicating that no uniqueness check should
178 be performed (boolean)
179 </dd><dt><i>objectType=</i></dt>
180 <dd>
181 type of the object (string). Objects of the same type
182 are not checked for duplicate shortcuts.
183 </dd>
184 </dl><a NAME="ShortcutsDialog.__resizeColumns" ID="ShortcutsDialog.__resizeColumns"></a>
185 <h4>ShortcutsDialog.__resizeColumns</h4>
186 <b>__resizeColumns</b>(<i></i>)
187 <p>
188 Private method to resize the list columns.
189 </p><a NAME="ShortcutsDialog.__resort" ID="ShortcutsDialog.__resort"></a>
190 <h4>ShortcutsDialog.__resort</h4>
191 <b>__resort</b>(<i></i>)
192 <p>
193 Private method to resort the tree.
194 </p><a NAME="ShortcutsDialog.__saveCategoryActions" ID="ShortcutsDialog.__saveCategoryActions"></a>
195 <h4>ShortcutsDialog.__saveCategoryActions</h4>
196 <b>__saveCategoryActions</b>(<i>category, actions</i>)
197 <p>
198 Private method to save the actions for a category.
199 </p><dl>
200 <dt><i>category</i></dt>
201 <dd>
202 reference to the category item (QTreeWidgetItem)
203 </dd><dt><i>actions</i></dt>
204 <dd>
205 list of actions for the category (list of E4Action)
206 </dd>
207 </dl><a NAME="ShortcutsDialog.__shortcutChanged" ID="ShortcutsDialog.__shortcutChanged"></a>
208 <h4>ShortcutsDialog.__shortcutChanged</h4>
209 <b>__shortcutChanged</b>(<i>keysequence, altKeysequence, noCheck, objectType</i>)
210 <p>
211 Private slot to handle the shortcutChanged signal of the shortcut dialog.
212 </p><dl>
213 <dt><i>keysequence</i></dt>
214 <dd>
215 the keysequence of the changed action (QKeySequence)
216 </dd><dt><i>altKeysequence</i></dt>
217 <dd>
218 the alternative keysequence of the changed
219 action (QKeySequence)
220 </dd><dt><i>noCheck</i></dt>
221 <dd>
222 flag indicating that no uniqueness check should
223 be performed (boolean)
224 </dd><dt><i>objectType</i></dt>
225 <dd>
226 type of the object (string).
227 </dd>
228 </dl><a NAME="ShortcutsDialog.on_actionButton_toggled" ID="ShortcutsDialog.on_actionButton_toggled"></a>
229 <h4>ShortcutsDialog.on_actionButton_toggled</h4>
230 <b>on_actionButton_toggled</b>(<i>checked</i>)
231 <p>
232 Private slot called, when the action radio button is toggled.
233 </p><dl>
234 <dt><i>checked</i></dt>
235 <dd>
236 state of the action radio button (boolean)
237 </dd>
238 </dl><a NAME="ShortcutsDialog.on_buttonBox_accepted" ID="ShortcutsDialog.on_buttonBox_accepted"></a>
239 <h4>ShortcutsDialog.on_buttonBox_accepted</h4>
240 <b>on_buttonBox_accepted</b>(<i></i>)
241 <p>
242 Private slot to handle the OK button press.
243 </p><a NAME="ShortcutsDialog.on_clearSearchButton_clicked" ID="ShortcutsDialog.on_clearSearchButton_clicked"></a>
244 <h4>ShortcutsDialog.on_clearSearchButton_clicked</h4>
245 <b>on_clearSearchButton_clicked</b>(<i></i>)
246 <p>
247 Private slot called by a click of the clear search button.
248 </p><a NAME="ShortcutsDialog.on_searchEdit_textChanged" ID="ShortcutsDialog.on_searchEdit_textChanged"></a>
249 <h4>ShortcutsDialog.on_searchEdit_textChanged</h4>
250 <b>on_searchEdit_textChanged</b>(<i>txt</i>)
251 <p>
252 Private slot called, when the text in the search edit changes.
253 </p><dl>
254 <dt><i>txt</i></dt>
255 <dd>
256 text of the search edit (string)
257 </dd>
258 </dl><a NAME="ShortcutsDialog.on_shortcutButton_toggled" ID="ShortcutsDialog.on_shortcutButton_toggled"></a>
259 <h4>ShortcutsDialog.on_shortcutButton_toggled</h4>
260 <b>on_shortcutButton_toggled</b>(<i>checked</i>)
261 <p>
262 Private slot called, when the shortcuts radio button is toggled.
263 </p><dl>
264 <dt><i>checked</i></dt>
265 <dd>
266 state of the shortcuts radio button (boolean)
267 </dd>
268 </dl><a NAME="ShortcutsDialog.on_shortcutsList_itemChanged" ID="ShortcutsDialog.on_shortcutsList_itemChanged"></a>
269 <h4>ShortcutsDialog.on_shortcutsList_itemChanged</h4>
270 <b>on_shortcutsList_itemChanged</b>(<i>itm, column</i>)
271 <p>
272 Private slot to handle the edit of a shortcut key.
273 </p><dl>
274 <dt><i>itm</i></dt>
275 <dd>
276 reference to the item changed (QTreeWidgetItem)
277 </dd><dt><i>column</i></dt>
278 <dd>
279 column changed (integer)
280 </dd>
281 </dl><a NAME="ShortcutsDialog.on_shortcutsList_itemClicked" ID="ShortcutsDialog.on_shortcutsList_itemClicked"></a>
282 <h4>ShortcutsDialog.on_shortcutsList_itemClicked</h4>
283 <b>on_shortcutsList_itemClicked</b>(<i>itm, column</i>)
284 <p>
285 Private slot to handle a click in the shortcuts list.
286 </p><dl>
287 <dt><i>itm</i></dt>
288 <dd>
289 the list item that was clicked (QTreeWidgetItem)
290 </dd><dt><i>column</i></dt>
291 <dd>
292 the list item was clicked in (integer)
293 </dd>
294 </dl><a NAME="ShortcutsDialog.on_shortcutsList_itemDoubleClicked" ID="ShortcutsDialog.on_shortcutsList_itemDoubleClicked"></a>
295 <h4>ShortcutsDialog.on_shortcutsList_itemDoubleClicked</h4>
296 <b>on_shortcutsList_itemDoubleClicked</b>(<i>itm, column</i>)
297 <p>
298 Private slot to handle a double click in the shortcuts list.
299 </p><dl>
300 <dt><i>itm</i></dt>
301 <dd>
302 the list item that was double clicked (QTreeWidgetItem)
303 </dd><dt><i>column</i></dt>
304 <dd>
305 the list item was double clicked in (integer)
306 </dd>
307 </dl><a NAME="ShortcutsDialog.populate" ID="ShortcutsDialog.populate"></a>
308 <h4>ShortcutsDialog.populate</h4>
309 <b>populate</b>(<i></i>)
310 <p>
311 Public method to populate the dialog.
312 </p>
313 <div align="right"><a href="#top">Up</a></div>
314 <hr />
315 </body></html>

Mercurial Repository: eric

eric ide

mercurial