--- a/Documentation/Source/eric5.Preferences.Shortcuts.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Preferences.Shortcuts.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Preferences.Shortcuts</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115; &#100;&#101;&#97;&#108;&#105;&#110;&#103; w&#105;&#116;&#104; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115;.
+Module implementing functions dealing with keyboard shortcuts.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -36,28 +36,28 @@
 <table>
 <tr>
 <td><a href="#__readShortcut">__readShortcut</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#114;&#101;&#97;&#100; &#97; &#115;&#105;&#110;&#103;&#108;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;.</td>
+<td>Private function to read a single keyboard shortcut from the settings.</td>
 </tr><tr>
 <td><a href="#__saveShortcut">__saveShortcut</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#115;&#105;&#110;&#103;&#108;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116; &#116;&#111; &#116;&#104;&#101; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;.</td>
+<td>Private function to write a single keyboard shortcut to the settings.</td>
 </tr><tr>
 <td><a href="#__setAction">__setAction</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#115;&#105;&#110;&#103;&#108;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116; &#116;&#111; &#116;&#104;&#101; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;.</td>
+<td>Private function to write a single keyboard shortcut to the settings.</td>
 </tr><tr>
 <td><a href="#exportShortcuts">exportShortcuts</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#101;x&#112;&#111;&#114;&#116; &#116;&#104;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#100;&#101;&#102;&#105;&#110;&#101;&#100; &#81;&#65;&#99;&#116;&#105;&#111;&#110;&#115;.</td>
+<td>Module function to export the keyboard shortcuts for the defined QActions.</td>
 </tr><tr>
 <td><a href="#importShortcuts">importShortcuts</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#105;&#109;&#112;&#111;&#114;&#116; &#116;&#104;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#100;&#101;&#102;&#105;&#110;&#101;&#100; &#69;&#53;&#65;&#99;&#116;&#105;&#111;&#110;&#115;.</td>
+<td>Module function to import the keyboard shortcuts for the defined E5Actions.</td>
 </tr><tr>
 <td><a href="#readShortcuts">readShortcuts</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#114;&#101;&#97;&#100; &#116;&#104;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#100;&#101;&#102;&#105;&#110;&#101;&#100; &#81;&#65;&#99;&#116;&#105;&#111;&#110;&#115;.</td>
+<td>Module function to read the keyboard shortcuts for the defined QActions.</td>
 </tr><tr>
 <td><a href="#saveShortcuts">saveShortcuts</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; w&#114;&#105;&#116;&#101; &#116;&#104;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#100;&#101;&#102;&#105;&#110;&#101;&#100; &#81;&#65;&#99;&#116;&#105;&#111;&#110;&#115;.</td>
+<td>Module function to write the keyboard shortcuts for the defined QActions.</td>
 </tr><tr>
 <td><a href="#setActions">setActions</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#101;&#116; &#97;&#99;&#116;&#105;&#111;&#110;&#115; &#98;&#97;&#115;&#101;&#100; &#111;&#110; &#110;&#101;w &#102;&#111;&#114;&#109;&#97;&#116; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115; &#102;&#105;&#108;&#101;.</td>
+<td>Module function to set actions based on new format shortcuts file.</td>
 </tr>
 </table>
 <hr /><hr />
@@ -65,17 +65,17 @@
 <h2>__readShortcut</h2>
 <b>__readShortcut</b>(<i>act, category, prefClass</i>)
 <p>
-    &#80;&#114;&#105;v&#97;&#116;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#114;&#101;&#97;&#100; &#97; &#115;&#105;&#110;&#103;&#108;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116; &#102;&#114;&#111;&#109; &#116;&#104;&#101; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;.
+    Private function to read a single keyboard shortcut from the settings.
 </p><dl>
 <dt><i>act</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#97;&#99;&#116;&#105;&#111;&#110; &#111;&#98;&#106;&#101;&#99;&#116; (&#69;&#53;&#65;&#99;&#116;&#105;&#111;&#110;)
+reference to the action object (E5Action)
 </dd><dt><i>category</i></dt>
 <dd>
-&#99;&#97;&#116;&#101;&#103;&#111;&#114;y &#116;&#104;&#101; &#97;&#99;&#116;&#105;&#111;&#110; &#98;&#101;&#108;&#111;&#110;&#103;&#115; &#116;&#111; (&#115;&#116;&#114;&#105;&#110;&#103;)
+category the action belongs to (string)
 </dd><dt><i>prefClass</i></dt>
 <dd>
-&#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#99;&#108;&#97;&#115;&#115; &#117;&#115;&#101;&#100; &#97;&#115; &#116;&#104;&#101; &#115;&#116;&#111;&#114;&#97;&#103;&#101; &#97;&#114;&#101;&#97;
+preferences class used as the storage area
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -84,17 +84,17 @@
 <h2>__saveShortcut</h2>
 <b>__saveShortcut</b>(<i>act, category, prefClass</i>)
 <p>
-    &#80;&#114;&#105;v&#97;&#116;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#115;&#105;&#110;&#103;&#108;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116; &#116;&#111; &#116;&#104;&#101; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;.
+    Private function to write a single keyboard shortcut to the settings.
 </p><dl>
 <dt><i>act</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#97;&#99;&#116;&#105;&#111;&#110; &#111;&#98;&#106;&#101;&#99;&#116; (&#69;&#53;&#65;&#99;&#116;&#105;&#111;&#110;)
+reference to the action object (E5Action)
 </dd><dt><i>category</i></dt>
 <dd>
-&#99;&#97;&#116;&#101;&#103;&#111;&#114;y &#116;&#104;&#101; &#97;&#99;&#116;&#105;&#111;&#110; &#98;&#101;&#108;&#111;&#110;&#103;&#115; &#116;&#111; (&#115;&#116;&#114;&#105;&#110;&#103;)
+category the action belongs to (string)
 </dd><dt><i>prefClass</i></dt>
 <dd>
-&#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#99;&#108;&#97;&#115;&#115; &#117;&#115;&#101;&#100; &#97;&#115; &#116;&#104;&#101; &#115;&#116;&#111;&#114;&#97;&#103;&#101; &#97;&#114;&#101;&#97;
+preferences class used as the storage area
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -103,14 +103,14 @@
 <h2>__setAction</h2>
 <b>__setAction</b>(<i>actions, sdict</i>)
 <p>
-    &#80;&#114;&#105;v&#97;&#116;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#115;&#105;&#110;&#103;&#108;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116; &#116;&#111; &#116;&#104;&#101; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;.
+    Private function to write a single keyboard shortcut to the settings.
 </p><dl>
 <dt><i>actions</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#97;&#99;&#116;&#105;&#111;&#110;&#115; &#116;&#111; &#115;&#101;&#116; (&#108;&#105;&#115;&#116; &#111;&#102; &#69;&#53;&#65;&#99;&#116;&#105;&#111;&#110;)
+list of actions to set (list of E5Action)
 </dd><dt><i>sdict</i></dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#103; &#97;&#99;&#99;&#101;&#108;&#101;&#114;&#97;&#116;&#111;&#114; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#111;&#110;&#101; &#99;&#97;&#116;&#101;&#103;&#111;&#114;y
+dictionary containg accelerator information for one category
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -119,16 +119,16 @@
 <h2>exportShortcuts</h2>
 <b>exportShortcuts</b>(<i>fn</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#101;x&#112;&#111;&#114;&#116; &#116;&#104;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#100;&#101;&#102;&#105;&#110;&#101;&#100; &#81;&#65;&#99;&#116;&#105;&#111;&#110;&#115;.
+    Module function to export the keyboard shortcuts for the defined QActions.
 </p><dl>
 <dt><i>fn</i></dt>
 <dd>
-&#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#101;x&#112;&#111;&#114;&#116; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+filename of the export file (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#115;&#117;&#99;&#99;&#101;&#115;&#115;
+flag indicating success
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -137,16 +137,16 @@
 <h2>importShortcuts</h2>
 <b>importShortcuts</b>(<i>fn</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#105;&#109;&#112;&#111;&#114;&#116; &#116;&#104;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#100;&#101;&#102;&#105;&#110;&#101;&#100; &#69;&#53;&#65;&#99;&#116;&#105;&#111;&#110;&#115;.
+    Module function to import the keyboard shortcuts for the defined E5Actions.
 </p><dl>
 <dt><i>fn</i></dt>
 <dd>
-&#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#105;&#109;&#112;&#111;&#114;&#116; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+filename of the import file (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#115;&#117;&#99;&#99;&#101;&#115;&#115;
+flag indicating success
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -155,17 +155,17 @@
 <h2>readShortcuts</h2>
 <b>readShortcuts</b>(<i>prefClass = Prefs, helpViewer = None, pluginName = None</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#114;&#101;&#97;&#100; &#116;&#104;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#100;&#101;&#102;&#105;&#110;&#101;&#100; &#81;&#65;&#99;&#116;&#105;&#111;&#110;&#115;.
+    Module function to read the keyboard shortcuts for the defined QActions.
 </p><dl>
 <dt><i>prefClass=</i></dt>
 <dd>
-&#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#99;&#108;&#97;&#115;&#115; &#117;&#115;&#101;&#100; &#97;&#115; &#116;&#104;&#101; &#115;&#116;&#111;&#114;&#97;&#103;&#101; &#97;&#114;&#101;&#97;
+preferences class used as the storage area
 </dd><dt><i>helpViewer=</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#104;&#101;&#108;&#112; w&#105;&#110;&#100;&#111;w &#111;&#98;&#106;&#101;&#99;&#116;
+reference to the help window object
 </dd><dt><i>pluginName=</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#112;&#108;&#117;&#103;&#105;&#110; &#102;&#111;&#114; w&#104;&#105;&#99;&#104; &#116;&#111; &#108;&#111;&#97;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the plugin for which to load shortcuts (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -174,11 +174,11 @@
 <h2>saveShortcuts</h2>
 <b>saveShortcuts</b>(<i>prefClass = Prefs</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; w&#114;&#105;&#116;&#101; &#116;&#104;&#101; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#100;&#101;&#102;&#105;&#110;&#101;&#100; &#81;&#65;&#99;&#116;&#105;&#111;&#110;&#115;.
+    Module function to write the keyboard shortcuts for the defined QActions.
 </p><dl>
 <dt><i>prefClass</i></dt>
 <dd>
-&#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#99;&#108;&#97;&#115;&#115; &#117;&#115;&#101;&#100; &#97;&#115; &#116;&#104;&#101; &#115;&#116;&#111;&#114;&#97;&#103;&#101; &#97;&#114;&#101;&#97;
+preferences class used as the storage area
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -187,12 +187,12 @@
 <h2>setActions</h2>
 <b>setActions</b>(<i>shortcuts</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#101;&#116; &#97;&#99;&#116;&#105;&#111;&#110;&#115; &#98;&#97;&#115;&#101;&#100; &#111;&#110; &#110;&#101;w &#102;&#111;&#114;&#109;&#97;&#116; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115; &#102;&#105;&#108;&#101;.
+    Module function to set actions based on new format shortcuts file.
 </p><dl>
 <dt><i>shortcuts</i></dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#99;&#99;&#101;&#108;&#101;&#114;&#97;&#116;&#111;&#114; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;
-        &#114;&#101;&#97;&#100; &#102;&#114;&#111;&#109; &#97; &#88;&#77;&#76; &#102;&#105;&#108;&#101;
+dictionary containing the accelerator information
+        read from a XML file
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>