Mercurial Repositories > eric / file revision

Documentation/Source/eric6.E5Gui.E5Action.html@a3809f75ca07

Documentation/Source/eric6.E5Gui.E5Action.html

Tue, 24 Oct 2017 19:09:09 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Tue, 24 Oct 2017 19:09:09 +0200
changeset 5928
a3809f75ca07
parent 3673
e26d7d0c1088
permissions
-rw-r--r--

Changed the logic of the two web browsers in order to put new downloads at the top of the list of downloads and add the download date and time to the shown info.

<!DOCTYPE html>
<html><head>
<title>eric6.E5Gui.E5Action</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric6.E5Gui.E5Action</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="#E5Action">E5Action</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>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>
</tr><tr>
<td><a href="#ArgumentsError.__repr__">__repr__</a></td>
<td>Special method returning a representation of the exception.</td>
</tr><tr>
<td><a href="#ArgumentsError.__str__">__str__</a></td>
<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></dt>
<dd>
error message of the exception (string)
</dd>
</dl><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>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>
        Special 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="E5Action" ID="E5Action"></a>
<h2>E5Action</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="#E5Action.__init__">E5Action</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#E5Action.__ammendToolTip">__ammendToolTip</a></td>
<td>Private slot to add the primary keyboard accelerator to the tooltip.</td>
</tr><tr>
<td><a href="#E5Action.alternateShortcut">alternateShortcut</a></td>
<td>Public method to retrieve the alternative keyboard shortcut.</td>
</tr><tr>
<td><a href="#E5Action.setAlternateShortcut">setAlternateShortcut</a></td>
<td>Public slot to set the alternative keyboard shortcut.</td>
</tr><tr>
<td><a href="#E5Action.setIconText">setIconText</a></td>
<td>Public slot to set the icon text of the action.</td>
</tr><tr>
<td><a href="#E5Action.setShortcut">setShortcut</a></td>
<td>Public slot to set the keyboard shortcut.</td>
</tr><tr>
<td><a href="#E5Action.setShortcuts">setShortcuts</a></td>
<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="E5Action.__init__" ID="E5Action.__init__"></a>
<h4>E5Action (Constructor)</h4>
<b>E5Action</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><dl>
<dt>Raises <b>ArgumentsError</b>:</dt>
<dd>
raised to indicate invalid arguments
</dd>
</dl><a NAME="E5Action.__ammendToolTip" ID="E5Action.__ammendToolTip"></a>
<h4>E5Action.__ammendToolTip</h4>
<b>__ammendToolTip</b>(<i></i>)
<p>
        Private slot to add the primary keyboard accelerator to the tooltip.
</p><a NAME="E5Action.alternateShortcut" ID="E5Action.alternateShortcut"></a>
<h4>E5Action.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="E5Action.setAlternateShortcut" ID="E5Action.setAlternateShortcut"></a>
<h4>E5Action.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></dt>
<dd>
the alternative accelerator (QKeySequence)
</dd><dt><i>removeEmpty</i></dt>
<dd>
flag indicating to remove the alternate shortcut,
            if it is empty (boolean)
</dd>
</dl><a NAME="E5Action.setIconText" ID="E5Action.setIconText"></a>
<h4>E5Action.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></dt>
<dd>
new icon text (string)
</dd>
</dl><a NAME="E5Action.setShortcut" ID="E5Action.setShortcut"></a>
<h4>E5Action.setShortcut</h4>
<b>setShortcut</b>(<i>shortcut</i>)
<p>
        Public slot to set the keyboard shortcut.
</p><dl>
<dt><i>shortcut</i></dt>
<dd>
the accelerator (QKeySequence)
</dd>
</dl><a NAME="E5Action.setShortcuts" ID="E5Action.setShortcuts"></a>
<h4>E5Action.setShortcuts</h4>
<b>setShortcuts</b>(<i>shortcuts</i>)
<p>
        Public slot to set the list of keyboard shortcuts.
</p><dl>
<dt><i>shortcuts</i></dt>
<dd>
list of keyboard accelerators (list of QKeySequence)
            or key for a platform dependent list of accelerators
            (QKeySequence.StandardKey)
</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>

Mercurial Repository: eric

eric ide

mercurial