Documentation/Source/eric5.Preferences.ShortcutDialog.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
--- a/Documentation/Source/eric5.Preferences.ShortcutDialog.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Preferences.ShortcutDialog.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Preferences.ShortcutDialog</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;.
+Module implementing a dialog for the configuration of a keyboard shortcut.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#ShortcutDialog">ShortcutDialog</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;.</td>
+<td>Class implementing a dialog for the configuration of a keyboard shortcut.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,13 +43,13 @@
 <a NAME="ShortcutDialog" ID="ShortcutDialog"></a>
 <h2>ShortcutDialog</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;.
+    Class implementing a dialog for the configuration of a keyboard shortcut.
 </p><h4>Signals</h4>
 <dl>
 <dt>shortcutChanged(QKeySequence, QKeySequence, bool, objectType)</dt>
 <dd>
-&#101;&#109;&#105;&#116;&#116;&#101;&#100;
-        &#97;&#102;&#116;&#101;&#114; &#116;&#104;&#101; &#79;&#75; &#98;&#117;&#116;&#116;&#111;&#110; w&#97;&#115; &#112;&#114;&#101;&#115;&#115;&#101;&#100;
+emitted
+        after the OK button was pressed
 </dd>
 </dl>
 <h3>Derived from</h3>
@@ -62,118 +62,118 @@
 <table>
 <tr>
 <td><a href="#ShortcutDialog.__init__">ShortcutDialog</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#ShortcutDialog.__clear">__clear</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#67;&#108;&#101;&#97;&#114; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.</td>
+<td>Private slot to handle the Clear button press.</td>
 </tr><tr>
 <td><a href="#ShortcutDialog.__setKeyLabelText">__setKeyLabelText</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#116;&#101;x&#116; &#111;&#102; &#97; &#107;&#101;y &#108;&#97;&#98;&#101;&#108;.</td>
+<td>Private method to set the text of a key label.</td>
 </tr><tr>
 <td><a href="#ShortcutDialog.__typeChanged">__typeChanged</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#99;&#104;&#97;&#110;&#103;&#101; &#111;&#102; &#116;&#104;&#101; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115; &#116;y&#112;&#101;.</td>
+<td>Private slot to handle the change of the shortcuts type.</td>
 </tr><tr>
 <td><a href="#ShortcutDialog.eventFilter">eventFilter</a></td>
-<td>&#77;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#102;&#105;&#108;&#116;&#101;&#114; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#113;&#117;&#101;&#117;&#101;.</td>
+<td>Method called to filter the event queue.</td>
 </tr><tr>
 <td><a href="#ShortcutDialog.keyPressEvent">keyPressEvent</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#97; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116;.</td>
+<td>Private method to handle a key press event.</td>
 </tr><tr>
 <td><a href="#ShortcutDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#79;&#75; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.</td>
+<td>Private slot to handle the OK button press.</td>
 </tr><tr>
 <td><a href="#ShortcutDialog.setKeys">setKeys</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#107;&#101;y &#116;&#111; &#98;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#101;&#100;.</td>
+<td>Public method to set the key to be configured.</td>
 </tr>
 </table>
 <a NAME="ShortcutDialog.__init__" ID="ShortcutDialog.__init__"></a>
 <h4>ShortcutDialog (Constructor)</h4>
 <b>ShortcutDialog</b>(<i>parent = None, name = None, modal = False</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
-&#84;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; &#111;&#102; &#116;&#104;&#105;&#115; &#100;&#105;&#97;&#108;&#111;&#103;. (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+The parent widget of this dialog. (QWidget)
 </dd><dt><i>name</i></dt>
 <dd>
-&#84;&#104;&#101; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#100;&#105;&#97;&#108;&#111;&#103;. (&#115;&#116;&#114;&#105;&#110;&#103;)
+The name of this dialog. (string)
 </dd><dt><i>modal</i></dt>
 <dd>
-&#70;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97; &#109;&#111;&#100;&#97;&#108; &#100;&#105;&#97;&#108;&#111;&#103;. (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+Flag indicating a modal dialog. (boolean)
 </dd>
 </dl><a NAME="ShortcutDialog.__clear" ID="ShortcutDialog.__clear"></a>
 <h4>ShortcutDialog.__clear</h4>
 <b>__clear</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#67;&#108;&#101;&#97;&#114; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.
+        Private slot to handle the Clear button press.
 </p><a NAME="ShortcutDialog.__setKeyLabelText" ID="ShortcutDialog.__setKeyLabelText"></a>
 <h4>ShortcutDialog.__setKeyLabelText</h4>
 <b>__setKeyLabelText</b>(<i>txt</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#116;&#101;x&#116; &#111;&#102; &#97; &#107;&#101;y &#108;&#97;&#98;&#101;&#108;.
+        Private method to set the text of a key label.
 </p><dl>
 <dt><i>txt</i></dt>
 <dd>
-&#116;&#101;x&#116; &#116;&#111; &#98;&#101; &#115;&#101;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+text to be set (string)
 </dd>
 </dl><a NAME="ShortcutDialog.__typeChanged" ID="ShortcutDialog.__typeChanged"></a>
 <h4>ShortcutDialog.__typeChanged</h4>
 <b>__typeChanged</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#99;&#104;&#97;&#110;&#103;&#101; &#111;&#102; &#116;&#104;&#101; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115; &#116;y&#112;&#101;.
+        Private slot to handle the change of the shortcuts type.
 </p><a NAME="ShortcutDialog.eventFilter" ID="ShortcutDialog.eventFilter"></a>
 <h4>ShortcutDialog.eventFilter</h4>
 <b>eventFilter</b>(<i>watched, event</i>)
 <p>
-        &#77;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#102;&#105;&#108;&#116;&#101;&#114; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#113;&#117;&#101;&#117;&#101;.
+        Method called to filter the event queue.
 </p><dl>
 <dt><i>watched</i></dt>
 <dd>
-&#116;&#104;&#101; &#81;&#79;&#98;&#106;&#101;&#99;&#116; &#98;&#101;&#105;&#110;&#103; w&#97;&#116;&#99;&#104;&#101;&#100;
+the QObject being watched
 </dd><dt><i>event</i></dt>
 <dd>
-&#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#116;&#104;&#97;&#116; &#111;&#99;&#99;&#117;&#114;&#114;&#101;&#100;
+the event that occurred
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#97;&#108;w&#97;y&#115; &#70;&#97;&#108;&#115;&#101;
+always False
 </dd>
 </dl><a NAME="ShortcutDialog.keyPressEvent" ID="ShortcutDialog.keyPressEvent"></a>
 <h4>ShortcutDialog.keyPressEvent</h4>
 <b>keyPressEvent</b>(<i>evt</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#97; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116;.
+        Private method to handle a key press event.
 </p><dl>
 <dt><i>evt</i></dt>
 <dd>
-&#116;&#104;&#101; &#107;&#101;y &#101;v&#101;&#110;&#116; (&#81;&#75;&#101;y&#69;v&#101;&#110;&#116;)
+the key event (QKeyEvent)
 </dd>
 </dl><a NAME="ShortcutDialog.on_buttonBox_accepted" ID="ShortcutDialog.on_buttonBox_accepted"></a>
 <h4>ShortcutDialog.on_buttonBox_accepted</h4>
 <b>on_buttonBox_accepted</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#79;&#75; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.
+        Private slot to handle the OK button press.
 </p><a NAME="ShortcutDialog.setKeys" ID="ShortcutDialog.setKeys"></a>
 <h4>ShortcutDialog.setKeys</h4>
 <b>setKeys</b>(<i>key, alternateKey, noCheck, objectType</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#107;&#101;y &#116;&#111; &#98;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#101;&#100;.
+        Public method to set the key to be configured.
 </p><dl>
 <dt><i>key</i></dt>
 <dd>
-&#107;&#101;y &#115;&#101;&#113;&#117;&#101;&#110;&#99;&#101; &#116;&#111; &#98;&#101; &#99;&#104;&#97;&#110;&#103;&#101;&#100; (&#81;&#75;&#101;y&#83;&#101;&#113;&#117;&#101;&#110;&#99;&#101;)
+key sequence to be changed (QKeySequence)
 </dd><dt><i>alternateKey</i></dt>
 <dd>
-&#97;&#108;&#116;&#101;&#114;&#110;&#97;&#116;&#101; &#107;&#101;y &#115;&#101;&#113;&#117;&#101;&#110;&#99;&#101; &#116;&#111; &#98;&#101; &#99;&#104;&#97;&#110;&#103;&#101;&#100; (&#81;&#75;&#101;y&#83;&#101;&#113;&#117;&#101;&#110;&#99;&#101;)
+alternate key sequence to be changed (QKeySequence)
 </dd><dt><i>noCheck</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#97;&#116; &#110;&#111; &#117;&#110;&#105;&#113;&#117;&#101;&#110;&#101;&#115;&#115; &#99;&#104;&#101;&#99;&#107; &#115;&#104;&#111;&#117;&#108;&#100;
-            &#98;&#101; &#112;&#101;&#114;&#102;&#111;&#114;&#109;&#101;&#100; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating that no uniqueness check should
+            be performed (boolean)
 </dd><dt><i>objectType</i></dt>
 <dd>
-&#116;y&#112;&#101; &#111;&#102; &#116;&#104;&#101; &#111;&#98;&#106;&#101;&#99;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;).
+type of the object (string).
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial