eric6.E5Gui.E5Action
Module implementing an Action class extending QAction.
This extension is necessary in order to support alternate keyboard
shortcuts.
Global Attributes
Classes
| ArgumentsError | Class implementing an exception, which is raised, if the wrong number of arguments are given. | 
| E5Action | Class implementing an Action class extending QAction. | 
Functions
ArgumentsError
    Class implementing an exception, which is raised, if the wrong number of
    arguments are given.
Derived from
RuntimeError
Class Attributes
Class Methods
Methods
| ArgumentsError | Constructor | 
| __repr__ | Special method returning a representation of the exception. | 
| __str__ | Special method returning a string representation of the exception. | 
Static Methods
ArgumentsError (Constructor)
ArgumentsError(error)
        Constructor
- error
- 
error message of the exception (string)
ArgumentsError.__repr__
__repr__()
        Special method returning a representation of the exception.
- Returns:
- 
string representing the error message
ArgumentsError.__str__
__str__()
        Special method returning a string representation of the exception.
- Returns:
- 
string representing the error message
E5Action
    Class implementing an Action class extending QAction.
Derived from
QAction
Class Attributes
Class Methods
Methods
Static Methods
E5Action (Constructor)
E5Action(*args)
        Constructor
- args
- 
argument list of the constructor. This list is one of
            
            - text (string), icon (QIcon), menu text (string),
                accelarator (QKeySequence), alternative accelerator
                (QKeySequence), parent (QObject), name (string), toggle
                (boolean)
- text (string), icon (QIcon), menu text (string),
                accelarator (QKeySequence), alternative accelerator
                (QKeySequence), parent (QObject), name (string)
- text (string), menu text (string),
                accelarator (QKeySequence), alternative accelerator
                (QKeySequence), parent (QObject), name (string), toggle
                (boolean)
- text (string), menu text (string),
                accelarator (QKeySequence), alternative accelerator
                (QKeySequence), parent (QObject), name (string)
 
- Raises ArgumentsError:
- 
raised to indicate invalid arguments
E5Action.__ammendToolTip
__ammendToolTip()
        Private slot to add the primary keyboard accelerator to the tooltip.
E5Action.alternateShortcut
alternateShortcut()
        Public method to retrieve the alternative keyboard shortcut.
- Returns:
- 
the alternative accelerator (QKeySequence)
E5Action.setAlternateShortcut
setAlternateShortcut(shortcut, removeEmpty=False)
        Public slot to set the alternative keyboard shortcut.
- shortcut
- 
the alternative accelerator (QKeySequence)
- removeEmpty
- 
flag indicating to remove the alternate shortcut,
            if it is empty (boolean)
E5Action.setIconText
setIconText(text)
        Public slot to set the icon text of the action.
- text
- 
new icon text (string)
E5Action.setShortcut
setShortcut(shortcut)
        Public slot to set the keyboard shortcut.
- shortcut
- 
the accelerator (QKeySequence)
E5Action.setShortcuts
setShortcuts(shortcuts)
        Public slot to set the list of keyboard shortcuts.
- shortcuts
- 
list of keyboard accelerators (list of QKeySequence)
            or key for a platform dependent list of accelerators
            (QKeySequence.StandardKey)
addActions
addActions(target, actions)
    Module function to add a list of actions to a widget.
- target
- 
reference to the target widget (QWidget)
- actions
- 
list of actions to be added to the target. A
        None indicates a separator (list of QActions)
createActionGroup
createActionGroup(parent, name=None, exclusive=False)
    Module function to create an action group.
- parent
- 
parent object of the action group (QObject)
- name
- 
name of the action group object (string)
- exclusive
- 
flag indicating an exclusive action group (boolean)
- Returns:
- 
reference to the created action group (QActionGroup)