--- a/Documentation/Source/eric5.E4Gui.E4Action.html Tue Jan 12 18:39:15 2010 +0000
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,220 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
-'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
-<html><head>
-<title>eric5.E4Gui.E4Action</title>
-<style>
-body {
- background:white;
- margin: 0em 1em 10em 1em;
- color: black;
-}
-
-h1 { color: white; background: #4FA4FF; }
-h2 { color: white; background: #4FA4FF; }
-h3 { color: white; background: #00557F; }
-h4 { color: white; background: #00557F; }
-
-a { color: #AA5500; }
-
-</style>
-</head>
-<body><a NAME="top" ID="top"></a>
-<h1>eric5.E4Gui.E4Action</h1>
-<p>
-Module implementing an Action class extending QAction.
-</p><p>
-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>
-</tr><tr>
-<td><a href="#E4Action">E4Action</a></td>
-<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>
-</tr><tr>
-<td><a href="#createActionGroup">createActionGroup</a></td>
-<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>Methods</h3>
-<table>
-<tr>
-<td><a href="#ArgumentsError.__init__">ArgumentsError</a></td>
-<td>Constructor</td>
-</tr><tr>
-<td><a href="#ArgumentsError.__repr__">__repr__</a></td>
-<td>Private method returning a representation of the exception.</td>
-</tr><tr>
-<td><a href="#ArgumentsError.__str__">__str__</a></td>
-<td>Private method returning a string representation of the exception.</td>
-</tr>
-</table>
-<a NAME="ArgumentsError.__init__" ID="ArgumentsError.__init__"></a>
-<h4>ArgumentsError (Constructor)</h4>
-<b>ArgumentsError</b>(<i>error</i>)
-<p>
- Constructor
-</p><a NAME="ArgumentsError.__repr__" ID="ArgumentsError.__repr__"></a>
-<h4>ArgumentsError.__repr__</h4>
-<b>__repr__</b>(<i></i>)
-<p>
- Private method returning a representation of the exception.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-string representing the error message
-</dd>
-</dl><a NAME="ArgumentsError.__str__" ID="ArgumentsError.__str__"></a>
-<h4>ArgumentsError.__str__</h4>
-<b>__str__</b>(<i></i>)
-<p>
- Private method returning a string representation of the exception.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-string representing the error message
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
-<a NAME="E4Action" ID="E4Action"></a>
-<h2>E4Action</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>Methods</h3>
-<table>
-<tr>
-<td><a href="#E4Action.__init__">E4Action</a></td>
-<td>Constructor</td>
-</tr><tr>
-<td><a href="#E4Action.alternateShortcut">alternateShortcut</a></td>
-<td>Public method to retrieve the alternative keyboard shortcut.</td>
-</tr><tr>
-<td><a href="#E4Action.setAlternateShortcut">setAlternateShortcut</a></td>
-<td>Public slot to set the alternative keyboard shortcut.</td>
-</tr>
-</table>
-<a NAME="E4Action.__init__" ID="E4Action.__init__"></a>
-<h4>E4Action (Constructor)</h4>
-<b>E4Action</b>(<i>*args</i>)
-<p>
- Constructor
-</p><dl>
-<dt><i>args</i></dt>
-<dd>
-argument list of the constructor. This list is one of
- <ul>
- <li>text (string), icon (QIcon), menu text (string),
- accelarator (QKeySequence), alternative accelerator (QKeySequence),
- parent (QObject), name (string), toggle (boolean)</li>
- <li>text (string), icon (QIcon), menu text (string),
- accelarator (QKeySequence), alternative accelerator (QKeySequence),
- parent (QObject), name (string)</li>
- <li>text (string), menu text (string),
- accelarator (QKeySequence), alternative accelerator (QKeySequence),
- parent (QObject), name (string), toggle (boolean)</li>
- <li>text (string), menu text (string),
- accelarator (QKeySequence), alternative accelerator (QKeySequence),
- parent (QObject), name (string)</li>
- </ul>
-</dd>
-</dl><a NAME="E4Action.alternateShortcut" ID="E4Action.alternateShortcut"></a>
-<h4>E4Action.alternateShortcut</h4>
-<b>alternateShortcut</b>(<i></i>)
-<p>
- Public method to retrieve the alternative keyboard shortcut.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-the alternative accelerator (QKeySequence)
-</dd>
-</dl><a NAME="E4Action.setAlternateShortcut" ID="E4Action.setAlternateShortcut"></a>
-<h4>E4Action.setAlternateShortcut</h4>
-<b>setAlternateShortcut</b>(<i>shortcut</i>)
-<p>
- Public slot to set the alternative keyboard shortcut.
-</p><dl>
-<dt><i>shortcut</i></dt>
-<dd>
-the alternative accelerator (QKeySequence)
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
-<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></dt>
-<dd>
-reference to the target widget (QWidget)
-</dd><dt><i>actions</i></dt>
-<dd>
-list of actions to be added to the target. A
- None indicates a separator (list of QActions)
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
-<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></dt>
-<dd>
-parent object of the action group (QObject)
-</dd><dt><i>name</i></dt>
-<dd>
-name of the action group object (string)
-</dd><dt><i>exclusive</i></dt>
-<dd>
-flag indicating an exclusive action group (boolean)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-reference to the created action group (QActionGroup)
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr />
-</body></html>
\ No newline at end of file
