src/eric7/Documentation/Source/eric7.Preferences.ShortcutsDialog.html

branch
eric7
changeset 10428
a071d4065202
parent 9209
b99e7fd55fd3
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.Preferences.ShortcutsDialog.html	Wed Dec 20 11:06:38 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Preferences.ShortcutsDialog.html	Wed Dec 20 14:58:58 2023 +0100
@@ -159,25 +159,30 @@
 </p>
 <dl>
 
-<dt><i>keysequence</i></dt>
+<dt><i>keysequence</i> (QKeySequence)</dt>
 <dd>
-the keysequence to check (QKeySequence)
+the keysequence to check
 </dd>
-<dt><i>objectType</i></dt>
+<dt><i>objectType</i> (str)</dt>
 <dd>
-type of the object (string). Entries with the same
+type of the object. Entries with the same
             object type are not checked for uniqueness.
 </dd>
-<dt><i>origTopItem</i></dt>
+<dt><i>origTopItem</i> (QTreeWidgetItem)</dt>
 <dd>
 refrence to the parent of the item to be checked
-            (QTreeWidgetItem)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating uniqueness (boolean)
+flag indicating uniqueness
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="ShortcutsDialog.__generateCategoryItem" ID="ShortcutsDialog.__generateCategoryItem"></a>
@@ -189,15 +194,21 @@
 </p>
 <dl>
 
-<dt><i>title</i></dt>
+<dt><i>title</i> (str)</dt>
 <dd>
-title for the item (string)
+title for the item
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the category item (QTreeWidgetItem)
+reference to the category item
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QTreeWidgetItem
 </dd>
 </dl>
 <a NAME="ShortcutsDialog.__generateShortcutItem" ID="ShortcutsDialog.__generateShortcutItem"></a>
@@ -209,22 +220,22 @@
 </p>
 <dl>
 
-<dt><i>category</i></dt>
+<dt><i>category</i> (QTreeWidgetItem)</dt>
 <dd>
-reference to the category item (QTreeWidgetItem)
+reference to the category item
 </dd>
-<dt><i>action</i></dt>
+<dt><i>action</i> (EricAction)</dt>
 <dd>
-reference to the keyboard action (EricAction)
+reference to the keyboard action
 </dd>
-<dt><i>noCheck</i></dt>
+<dt><i>noCheck</i> (bool)</dt>
 <dd>
 flag indicating that no uniqueness check should
-            be performed (boolean)
+            be performed
 </dd>
-<dt><i>objectType</i></dt>
+<dt><i>objectType</i> (str)</dt>
 <dd>
-type of the object (string). Objects of the same
+type of the object. Objects of the same
             type are not checked for duplicate shortcuts.
 </dd>
 </dl>
@@ -251,13 +262,13 @@
 </p>
 <dl>
 
-<dt><i>category</i></dt>
+<dt><i>category</i> (QTreeWidgetItem)</dt>
 <dd>
-reference to the category item (QTreeWidgetItem)
+reference to the category item
 </dd>
-<dt><i>actions</i></dt>
+<dt><i>actions</i> (list of EricAction)</dt>
 <dd>
-list of actions for the category (list of EricAction)
+list of actions for the category
 </dd>
 </dl>
 <a NAME="ShortcutsDialog.__shortcutChanged" ID="ShortcutsDialog.__shortcutChanged"></a>
@@ -270,23 +281,21 @@
 </p>
 <dl>
 
-<dt><i>keysequence</i></dt>
+<dt><i>keysequence</i> (QKeySequence)</dt>
 <dd>
-the keysequence of the changed action (QKeySequence)
+the keysequence of the changed action
 </dd>
-<dt><i>altKeysequence</i></dt>
+<dt><i>altKeysequence</i> (QKeySequence)</dt>
 <dd>
-the alternative keysequence of the changed
-            action (QKeySequence)
+the alternative keysequence of the changed action
 </dd>
-<dt><i>noCheck</i></dt>
+<dt><i>noCheck</i> (bool)</dt>
 <dd>
-flag indicating that no uniqueness check should
-            be performed (boolean)
+flag indicating that no uniqueness check should be performed
 </dd>
-<dt><i>objectType</i></dt>
+<dt><i>objectType</i> (str)</dt>
 <dd>
-type of the object (string).
+type of the object
 </dd>
 </dl>
 <a NAME="ShortcutsDialog.on_actionButton_toggled" ID="ShortcutsDialog.on_actionButton_toggled"></a>
@@ -298,9 +307,9 @@
 </p>
 <dl>
 
-<dt><i>checked</i></dt>
+<dt><i>checked</i> (bool)</dt>
 <dd>
-state of the action radio button (boolean)
+state of the action radio button
 </dd>
 </dl>
 <a NAME="ShortcutsDialog.on_buttonBox_accepted" ID="ShortcutsDialog.on_buttonBox_accepted"></a>
@@ -319,9 +328,9 @@
 </p>
 <dl>
 
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
 <dd>
-text of the search edit (string)
+text of the search edit
 </dd>
 </dl>
 <a NAME="ShortcutsDialog.on_shortcutButton_toggled" ID="ShortcutsDialog.on_shortcutButton_toggled"></a>
@@ -333,9 +342,9 @@
 </p>
 <dl>
 
-<dt><i>checked</i></dt>
+<dt><i>checked</i> (bool)</dt>
 <dd>
-state of the shortcuts radio button (boolean)
+state of the shortcuts radio button
 </dd>
 </dl>
 <a NAME="ShortcutsDialog.on_shortcutsList_itemChanged" ID="ShortcutsDialog.on_shortcutsList_itemChanged"></a>
@@ -347,13 +356,13 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
 <dd>
-reference to the item changed (QTreeWidgetItem)
+reference to the item changed
 </dd>
-<dt><i>column</i></dt>
+<dt><i>column</i> (int)</dt>
 <dd>
-column changed (integer)
+column changed
 </dd>
 </dl>
 <a NAME="ShortcutsDialog.on_shortcutsList_itemClicked" ID="ShortcutsDialog.on_shortcutsList_itemClicked"></a>
@@ -365,13 +374,13 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
 <dd>
-the list item that was clicked (QTreeWidgetItem)
+the list item that was clicked
 </dd>
-<dt><i>column</i></dt>
+<dt><i>column</i> (int)</dt>
 <dd>
-the list item was clicked in (integer)
+the list item was clicked in
 </dd>
 </dl>
 <a NAME="ShortcutsDialog.on_shortcutsList_itemDoubleClicked" ID="ShortcutsDialog.on_shortcutsList_itemDoubleClicked"></a>
@@ -383,27 +392,27 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
 <dd>
-the list item that was double clicked (QTreeWidgetItem)
+the list item that was double clicked
 </dd>
-<dt><i>column</i></dt>
+<dt><i>column</i> (int)</dt>
 <dd>
-the list item was double clicked in (integer)
+the list item was double clicked in
 </dd>
 </dl>
 <a NAME="ShortcutsDialog.populate" ID="ShortcutsDialog.populate"></a>
 <h4>ShortcutsDialog.populate</h4>
-<b>populate</b>(<i>helpViewer=None</i>)
+<b>populate</b>(<i>webBrowser=None</i>)
 
 <p>
         Public method to populate the dialog.
 </p>
 <dl>
 
-<dt><i>helpViewer</i></dt>
+<dt><i>webBrowser</i> (WebBrowserWindow)</dt>
 <dd>
-reference to the help window object
+reference to the web browser window object
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial