eric6/Documentation/Source/eric6.Preferences.Shortcuts.html

changeset 8049
af58c1d47e5e
parent 7900
72b88fb20261
--- a/eric6/Documentation/Source/eric6.Preferences.Shortcuts.html	Mon Feb 01 16:04:34 2021 +0100
+++ b/eric6/Documentation/Source/eric6.Preferences.Shortcuts.html	Mon Feb 01 16:06:23 2021 +0100
@@ -49,7 +49,7 @@
 </tr>
 <tr>
 <td><a href="#__setAction">__setAction</a></td>
-<td>Private function to write a single keyboard shortcut to the settings.</td>
+<td>Private function to set a single keyboard shortcut category shortcuts.</td>
 </tr>
 <tr>
 <td><a href="#exportShortcuts">exportShortcuts</a></td>
@@ -57,7 +57,7 @@
 </tr>
 <tr>
 <td><a href="#importShortcuts">importShortcuts</a></td>
-<td>Module function to import the keyboard shortcuts for the defined E5Actions.</td>
+<td>Module function to import the keyboard shortcuts for the defined actions.</td>
 </tr>
 <tr>
 <td><a href="#readShortcuts">readShortcuts</a></td>
@@ -69,7 +69,7 @@
 </tr>
 <tr>
 <td><a href="#setActions">setActions</a></td>
-<td>Module function to set actions based on new format shortcuts file.</td>
+<td>Module function to set actions based on the imported shortcuts file.</td>
 </tr>
 </table>
 <hr />
@@ -126,20 +126,21 @@
 <hr />
 <a NAME="__setAction" ID="__setAction"></a>
 <h2>__setAction</h2>
-<b>__setAction</b>(<i>actions, sdict</i>)
+<b>__setAction</b>(<i>actions, shortcutsDict</i>)
 
 <p>
-    Private function to write a single keyboard shortcut to the settings.
+    Private function to set a single keyboard shortcut category shortcuts.
 </p>
 <dl>
 
-<dt><i>actions</i></dt>
+<dt><i>actions</i> (list of E5Action)</dt>
 <dd>
-list of actions to set (list of E5Action)
+list of actions to set
 </dd>
-<dt><i>sdict</i></dt>
+<dt><i>shortcutsDict</i> (dict)</dt>
 <dd>
-dictionary containg accelerator information for one category
+dictionary containing accelerator information for
+        one category
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -154,11 +155,11 @@
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-filename of the export file (string)
+filename of the export file
 </dd>
-<dt><i>helpViewer</i></dt>
+<dt><i>helpViewer</i> (WebBrowserWindow)</dt>
 <dd>
 reference to the help window object
 </dd>
@@ -171,15 +172,15 @@
 <b>importShortcuts</b>(<i>fn, helpViewer=None</i>)
 
 <p>
-    Module function to import the keyboard shortcuts for the defined E5Actions.
+    Module function to import the keyboard shortcuts for the defined actions.
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-filename of the import file (string)
+filename of the import file
 </dd>
-<dt><i>helpViewer</i></dt>
+<dt><i>helpViewer</i> (WebBrowserWindow)</dt>
 <dd>
 reference to the help window object
 </dd>
@@ -239,16 +240,16 @@
 <b>setActions</b>(<i>shortcuts, helpViewer=None</i>)
 
 <p>
-    Module function to set actions based on new format shortcuts file.
+    Module function to set actions based on the imported shortcuts file.
 </p>
 <dl>
 
-<dt><i>shortcuts</i></dt>
+<dt><i>shortcuts</i> (dict)</dt>
 <dd>
 dictionary containing the accelerator information
-        read from a XML file
+        read from a JSON or XML file
 </dd>
-<dt><i>helpViewer</i></dt>
+<dt><i>helpViewer</i> (WebBrowserWindow)</dt>
 <dd>
 reference to the help window object
 </dd>

eric ide

mercurial