eric6/Documentation/Source/eric6.Preferences.ShortcutDialog.html

branch
maintenance
changeset 7286
7eb04391adf7
parent 7273
391d6b7b1eff
child 7989
a21d673a8f99
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
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.ShortcutDialog</h1> 23 <h1>eric6.Preferences.ShortcutDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog for the configuration of a keyboard shortcut. 26 Module implementing a dialog for the configuration of a keyboard shortcut.
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="#ShortcutDialog">ShortcutDialog</a></td> 38 <td><a href="#ShortcutDialog">ShortcutDialog</a></td>
34 <td>Class implementing a dialog for the configuration of a keyboard shortcut.</td> 39 <td>Class implementing a dialog for the configuration of a keyboard shortcut.</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="ShortcutDialog" ID="ShortcutDialog"></a> 49 <a NAME="ShortcutDialog" ID="ShortcutDialog"></a>
43 <h2>ShortcutDialog</h2> 50 <h2>ShortcutDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog for the configuration of a keyboard shortcut. 53 Class implementing a dialog for the configuration of a keyboard shortcut.
46 </p><h3>Signals</h3> 54 </p>
47 <dl> 55 <h3>Signals</h3>
56 <dl>
57
48 <dt>shortcutChanged(QKeySequence, QKeySequence, bool, string)</dt> 58 <dt>shortcutChanged(QKeySequence, QKeySequence, bool, string)</dt>
49 <dd> 59 <dd>
50 emitted 60 emitted
51 after the OK button was pressed 61 after the OK button was pressed
52 </dd> 62 </dd>
53 </dl> 63 </dl>
54 <h3>Derived from</h3> 64 <h3>Derived from</h3>
55 QDialog, Ui_ShortcutDialog 65 QDialog, Ui_ShortcutDialog
56 <h3>Class Attributes</h3> 66 <h3>Class Attributes</h3>
67
57 <table> 68 <table>
58 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
59 </table> 70 </table>
60 <h3>Class Methods</h3> 71 <h3>Class Methods</h3>
72
61 <table> 73 <table>
62 <tr><td>None</td></tr> 74 <tr><td>None</td></tr>
63 </table> 75 </table>
64 <h3>Methods</h3> 76 <h3>Methods</h3>
65 <table> 77
78 <table>
79
66 <tr> 80 <tr>
67 <td><a href="#ShortcutDialog.__init__">ShortcutDialog</a></td> 81 <td><a href="#ShortcutDialog.__init__">ShortcutDialog</a></td>
68 <td>Constructor</td> 82 <td>Constructor</td>
69 </tr><tr> 83 </tr>
84 <tr>
70 <td><a href="#ShortcutDialog.__clear">__clear</a></td> 85 <td><a href="#ShortcutDialog.__clear">__clear</a></td>
71 <td>Private slot to handle the Clear button press.</td> 86 <td>Private slot to handle the Clear button press.</td>
72 </tr><tr> 87 </tr>
88 <tr>
73 <td><a href="#ShortcutDialog.__setKeyEditText">__setKeyEditText</a></td> 89 <td><a href="#ShortcutDialog.__setKeyEditText">__setKeyEditText</a></td>
74 <td>Private method to set the text of a key edit.</td> 90 <td>Private method to set the text of a key edit.</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#ShortcutDialog.__typeChanged">__typeChanged</a></td> 93 <td><a href="#ShortcutDialog.__typeChanged">__typeChanged</a></td>
77 <td>Private slot to handle the change of the shortcuts type.</td> 94 <td>Private slot to handle the change of the shortcuts type.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#ShortcutDialog.eventFilter">eventFilter</a></td> 97 <td><a href="#ShortcutDialog.eventFilter">eventFilter</a></td>
80 <td>Public method called to filter the event queue.</td> 98 <td>Public method called to filter the event queue.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#ShortcutDialog.keyPressEvent">keyPressEvent</a></td> 101 <td><a href="#ShortcutDialog.keyPressEvent">keyPressEvent</a></td>
83 <td>Protected method to handle a key press event.</td> 102 <td>Protected method to handle a key press event.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#ShortcutDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> 105 <td><a href="#ShortcutDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
86 <td>Private slot to handle the OK button press.</td> 106 <td>Private slot to handle the OK button press.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#ShortcutDialog.setKeys">setKeys</a></td> 109 <td><a href="#ShortcutDialog.setKeys">setKeys</a></td>
89 <td>Public method to set the key to be configured.</td> 110 <td>Public method to set the key to be configured.</td>
90 </tr> 111 </tr>
91 </table> 112 </table>
92 <h3>Static Methods</h3> 113 <h3>Static Methods</h3>
93 <table> 114
94 <tr><td>None</td></tr> 115 <table>
95 </table> 116 <tr><td>None</td></tr>
117 </table>
118
96 <a NAME="ShortcutDialog.__init__" ID="ShortcutDialog.__init__"></a> 119 <a NAME="ShortcutDialog.__init__" ID="ShortcutDialog.__init__"></a>
97 <h4>ShortcutDialog (Constructor)</h4> 120 <h4>ShortcutDialog (Constructor)</h4>
98 <b>ShortcutDialog</b>(<i>parent=None, name=None, modal=False</i>) 121 <b>ShortcutDialog</b>(<i>parent=None, name=None, modal=False</i>)
122
99 <p> 123 <p>
100 Constructor 124 Constructor
101 </p><dl> 125 </p>
126 <dl>
127
102 <dt><i>parent</i></dt> 128 <dt><i>parent</i></dt>
103 <dd> 129 <dd>
104 The parent widget of this dialog. (QWidget) 130 The parent widget of this dialog. (QWidget)
105 </dd><dt><i>name</i></dt> 131 </dd>
132 <dt><i>name</i></dt>
106 <dd> 133 <dd>
107 The name of this dialog. (string) 134 The name of this dialog. (string)
108 </dd><dt><i>modal</i></dt> 135 </dd>
136 <dt><i>modal</i></dt>
109 <dd> 137 <dd>
110 Flag indicating a modal dialog. (boolean) 138 Flag indicating a modal dialog. (boolean)
111 </dd> 139 </dd>
112 </dl><a NAME="ShortcutDialog.__clear" ID="ShortcutDialog.__clear"></a> 140 </dl>
141 <a NAME="ShortcutDialog.__clear" ID="ShortcutDialog.__clear"></a>
113 <h4>ShortcutDialog.__clear</h4> 142 <h4>ShortcutDialog.__clear</h4>
114 <b>__clear</b>(<i></i>) 143 <b>__clear</b>(<i></i>)
144
115 <p> 145 <p>
116 Private slot to handle the Clear button press. 146 Private slot to handle the Clear button press.
117 </p><a NAME="ShortcutDialog.__setKeyEditText" ID="ShortcutDialog.__setKeyEditText"></a> 147 </p>
148 <a NAME="ShortcutDialog.__setKeyEditText" ID="ShortcutDialog.__setKeyEditText"></a>
118 <h4>ShortcutDialog.__setKeyEditText</h4> 149 <h4>ShortcutDialog.__setKeyEditText</h4>
119 <b>__setKeyEditText</b>(<i>txt</i>) 150 <b>__setKeyEditText</b>(<i>txt</i>)
151
120 <p> 152 <p>
121 Private method to set the text of a key edit. 153 Private method to set the text of a key edit.
122 </p><dl> 154 </p>
155 <dl>
156
123 <dt><i>txt</i></dt> 157 <dt><i>txt</i></dt>
124 <dd> 158 <dd>
125 text to be set (string) 159 text to be set (string)
126 </dd> 160 </dd>
127 </dl><a NAME="ShortcutDialog.__typeChanged" ID="ShortcutDialog.__typeChanged"></a> 161 </dl>
162 <a NAME="ShortcutDialog.__typeChanged" ID="ShortcutDialog.__typeChanged"></a>
128 <h4>ShortcutDialog.__typeChanged</h4> 163 <h4>ShortcutDialog.__typeChanged</h4>
129 <b>__typeChanged</b>(<i></i>) 164 <b>__typeChanged</b>(<i></i>)
165
130 <p> 166 <p>
131 Private slot to handle the change of the shortcuts type. 167 Private slot to handle the change of the shortcuts type.
132 </p><a NAME="ShortcutDialog.eventFilter" ID="ShortcutDialog.eventFilter"></a> 168 </p>
169 <a NAME="ShortcutDialog.eventFilter" ID="ShortcutDialog.eventFilter"></a>
133 <h4>ShortcutDialog.eventFilter</h4> 170 <h4>ShortcutDialog.eventFilter</h4>
134 <b>eventFilter</b>(<i>watched, event</i>) 171 <b>eventFilter</b>(<i>watched, event</i>)
172
135 <p> 173 <p>
136 Public method called to filter the event queue. 174 Public method called to filter the event queue.
137 </p><dl> 175 </p>
176 <dl>
177
138 <dt><i>watched</i></dt> 178 <dt><i>watched</i></dt>
139 <dd> 179 <dd>
140 the QObject being watched 180 the QObject being watched
141 </dd><dt><i>event</i></dt> 181 </dd>
182 <dt><i>event</i></dt>
142 <dd> 183 <dd>
143 the event that occurred 184 the event that occurred
144 </dd> 185 </dd>
145 </dl><dl> 186 </dl>
187 <dl>
146 <dt>Returns:</dt> 188 <dt>Returns:</dt>
147 <dd> 189 <dd>
148 always False 190 always False
149 </dd> 191 </dd>
150 </dl><a NAME="ShortcutDialog.keyPressEvent" ID="ShortcutDialog.keyPressEvent"></a> 192 </dl>
193 <a NAME="ShortcutDialog.keyPressEvent" ID="ShortcutDialog.keyPressEvent"></a>
151 <h4>ShortcutDialog.keyPressEvent</h4> 194 <h4>ShortcutDialog.keyPressEvent</h4>
152 <b>keyPressEvent</b>(<i>evt</i>) 195 <b>keyPressEvent</b>(<i>evt</i>)
196
153 <p> 197 <p>
154 Protected method to handle a key press event. 198 Protected method to handle a key press event.
155 </p><dl> 199 </p>
200 <dl>
201
156 <dt><i>evt</i></dt> 202 <dt><i>evt</i></dt>
157 <dd> 203 <dd>
158 the key event (QKeyEvent) 204 the key event (QKeyEvent)
159 </dd> 205 </dd>
160 </dl><a NAME="ShortcutDialog.on_buttonBox_accepted" ID="ShortcutDialog.on_buttonBox_accepted"></a> 206 </dl>
207 <a NAME="ShortcutDialog.on_buttonBox_accepted" ID="ShortcutDialog.on_buttonBox_accepted"></a>
161 <h4>ShortcutDialog.on_buttonBox_accepted</h4> 208 <h4>ShortcutDialog.on_buttonBox_accepted</h4>
162 <b>on_buttonBox_accepted</b>(<i></i>) 209 <b>on_buttonBox_accepted</b>(<i></i>)
210
163 <p> 211 <p>
164 Private slot to handle the OK button press. 212 Private slot to handle the OK button press.
165 </p><a NAME="ShortcutDialog.setKeys" ID="ShortcutDialog.setKeys"></a> 213 </p>
214 <a NAME="ShortcutDialog.setKeys" ID="ShortcutDialog.setKeys"></a>
166 <h4>ShortcutDialog.setKeys</h4> 215 <h4>ShortcutDialog.setKeys</h4>
167 <b>setKeys</b>(<i>key, alternateKey, noCheck, objectType</i>) 216 <b>setKeys</b>(<i>key, alternateKey, noCheck, objectType</i>)
217
168 <p> 218 <p>
169 Public method to set the key to be configured. 219 Public method to set the key to be configured.
170 </p><dl> 220 </p>
221 <dl>
222
171 <dt><i>key</i></dt> 223 <dt><i>key</i></dt>
172 <dd> 224 <dd>
173 key sequence to be changed (QKeySequence) 225 key sequence to be changed (QKeySequence)
174 </dd><dt><i>alternateKey</i></dt> 226 </dd>
227 <dt><i>alternateKey</i></dt>
175 <dd> 228 <dd>
176 alternate key sequence to be changed (QKeySequence) 229 alternate key sequence to be changed (QKeySequence)
177 </dd><dt><i>noCheck</i></dt> 230 </dd>
231 <dt><i>noCheck</i></dt>
178 <dd> 232 <dd>
179 flag indicating that no uniqueness check should 233 flag indicating that no uniqueness check should
180 be performed (boolean) 234 be performed (boolean)
181 </dd><dt><i>objectType</i></dt> 235 </dd>
236 <dt><i>objectType</i></dt>
182 <dd> 237 <dd>
183 type of the object (string). 238 type of the object (string).
184 </dd> 239 </dd>
185 </dl> 240 </dl>
186 <div align="right"><a href="#top">Up</a></div> 241 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial