--- a/src/eric7/Documentation/Source/eric7.EricGui.EricAction.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.EricGui.EricAction.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,7 +7,6 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.EricGui.EricAction</h1> - <p> Module implementing an Action class extending QAction. </p> @@ -15,15 +14,14 @@ This extension is necessary in order to support alternate keyboard shortcuts. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#ArgumentsError">ArgumentsError</a></td> <td>Class implementing an exception, which is raised, if the wrong number of arguments are given.</td> @@ -33,10 +31,9 @@ <td>Class implementing an Action class extending QAction.</td> </tr> </table> + <h3>Functions</h3> - <table> - <tr> <td><a href="#addActions">addActions</a></td> <td>Module function to add a list of actions to a widget.</td> @@ -46,31 +43,30 @@ <td>Module function to create an action group.</td> </tr> </table> + <hr /> <hr /> <a NAME="ArgumentsError" ID="ArgumentsError"></a> <h2>ArgumentsError</h2> - <p> Class implementing an exception, which is raised, if the wrong number of arguments are given. </p> + <h3>Derived from</h3> RuntimeError <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#ArgumentsError.__init__">ArgumentsError</a></td> <td>Constructor</td> @@ -84,19 +80,20 @@ <td>Special method returning a string representation of the exception.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="ArgumentsError.__init__" ID="ArgumentsError.__init__"></a> <h4>ArgumentsError (Constructor)</h4> <b>ArgumentsError</b>(<i>error</i>) - <p> Constructor </p> + <dl> <dt><i>error</i> (str)</dt> @@ -107,10 +104,10 @@ <a NAME="ArgumentsError.__repr__" ID="ArgumentsError.__repr__"></a> <h4>ArgumentsError.__repr__</h4> <b>__repr__</b>(<i></i>) - <p> Special method returning a representation of the exception. </p> + <dl> <dt>Return:</dt> <dd> @@ -126,10 +123,10 @@ <a NAME="ArgumentsError.__str__" ID="ArgumentsError.__str__"></a> <h4>ArgumentsError.__str__</h4> <b>__str__</b>(<i></i>) - <p> Special method returning a string representation of the exception. </p> + <dl> <dt>Return:</dt> <dd> @@ -147,26 +144,24 @@ <hr /> <a NAME="EricAction" ID="EricAction"></a> <h2>EricAction</h2> - <p> Class implementing an Action class extending QAction. </p> + <h3>Derived from</h3> QAction <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#EricAction.__init__">EricAction</a></td> <td>Constructor</td> @@ -196,19 +191,20 @@ <td>Public slot to set the list of keyboard shortcuts.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="EricAction.__init__" ID="EricAction.__init__"></a> <h4>EricAction (Constructor)</h4> <b>EricAction</b>(<i>*args</i>) - <p> Constructor </p> + <dl> <dt><i>args</i> (list of one of the following)</dt> @@ -241,17 +237,17 @@ <a NAME="EricAction.__ammendToolTip" ID="EricAction.__ammendToolTip"></a> <h4>EricAction.__ammendToolTip</h4> <b>__ammendToolTip</b>(<i></i>) - <p> Private slot to add the primary keyboard accelerator to the tooltip. </p> + <a NAME="EricAction.alternateShortcut" ID="EricAction.alternateShortcut"></a> <h4>EricAction.alternateShortcut</h4> <b>alternateShortcut</b>(<i></i>) - <p> Public method to retrieve the alternative keyboard shortcut. </p> + <dl> <dt>Return:</dt> <dd> @@ -267,10 +263,10 @@ <a NAME="EricAction.setAlternateShortcut" ID="EricAction.setAlternateShortcut"></a> <h4>EricAction.setAlternateShortcut</h4> <b>setAlternateShortcut</b>(<i>shortcut, removeEmpty=False</i>) - <p> Public slot to set the alternative keyboard shortcut. </p> + <dl> <dt><i>shortcut</i> (QKeySequence)</dt> @@ -286,10 +282,10 @@ <a NAME="EricAction.setIconText" ID="EricAction.setIconText"></a> <h4>EricAction.setIconText</h4> <b>setIconText</b>(<i>text</i>) - <p> Public slot to set the icon text of the action. </p> + <dl> <dt><i>text</i> (str)</dt> @@ -300,10 +296,10 @@ <a NAME="EricAction.setShortcut" ID="EricAction.setShortcut"></a> <h4>EricAction.setShortcut</h4> <b>setShortcut</b>(<i>shortcut</i>) - <p> Public slot to set the keyboard shortcut. </p> + <dl> <dt><i>shortcut</i> (QKeySequence)</dt> @@ -314,10 +310,10 @@ <a NAME="EricAction.setShortcuts" ID="EricAction.setShortcuts"></a> <h4>EricAction.setShortcuts</h4> <b>setShortcuts</b>(<i>shortcuts</i>) - <p> Public slot to set the list of keyboard shortcuts. </p> + <dl> <dt><i>shortcuts</i> (list of QKeySequence or QKeySequence.StandardKey)</dt> @@ -332,10 +328,10 @@ <a NAME="addActions" ID="addActions"></a> <h2>addActions</h2> <b>addActions</b>(<i>target, actions</i>) - <p> Module function to add a list of actions to a widget. </p> + <dl> <dt><i>target</i> (QWidget)</dt> @@ -354,10 +350,10 @@ <a NAME="createActionGroup" ID="createActionGroup"></a> <h2>createActionGroup</h2> <b>createActionGroup</b>(<i>parent, name=None, exclusive=False</i>) - <p> Module function to create an action group. </p> + <dl> <dt><i>parent</i> (QObject)</dt> @@ -387,4 +383,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>