Package peppy :: Module mainmenu :: Class ElectricReturn

Class ElectricReturn

                        object --+        
                                 |        
actions.base.BufferBusyActionMixin --+    
                                     |    
                    object --+       |    
                             |       |    
              debug.debugmixin --+   |    
                                 |   |    
              actions.SelectAction --+    
                                     |    
   actions.base.TextModificationAction --+
                                         |
                                        ElectricReturn

Instance Methods

action(self, index=-1, multiplier=1)
Override this to provide the functionality of the action.

Inherited from actions.base.BufferBusyActionMixin: isActionAvailable, isEnabled

Inherited from actions.SelectAction: __call__, __init__, getMenuItemName, getSubIds, getTooltip, initPostHook, initPreHook, insertIntoMenu, insertIntoToolbar, showEnable

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Methods

Inherited from actions.base.TextModificationAction: worksWithMajorMode

Inherited from actions.SelectAction: getHelp, setAcceleratorText

Inherited from debug.debugmixin: dprint

Class Variables
	alias = `"electric-return"` This alias holds an emacs style name that is used during M-X processing.
	name = `"Electric Return"` This is the name of the menu entry as it appears in the menu bar.
	tooltip = `"Indent the next line following a return"` Tooltip that is displayed when the mouse is hovering over the menu entry.
	icon = `'icons/text_indent_rob.png'` If there is an icon associated with this action, name it here.
	key_bindings = `{'default': 'RET',}` Map of platform to default keybinding.
Inherited from `actions.SelectAction`: `default_menu`, `default_toolbar`, `global_id`, `keyboard`, `stock_id` Inherited from `debug.debugmixin`: `debuglevel`

Properties
Inherited from `object`: `__class__`

Method Details

action(self, index=-1, multiplier=1)

Override this to provide the functionality of the action.

This method gets called when the user initiates the action, whether it be from the menu bar, toolbar, or keyboard.

Parameters:

index - The index of the item in the list. This is only useful for list or radio items.
multiplier - the multiplier supplied by the keyboard handler. The keyboard handler allows for emacs-style repeat commands. For some actions, it makes sense to allow repetition of the command. For instance, in a command that uppercases words, the multiplier could be 4, would mean that the next 4 words get uppercased. The default is 1.

Overrides: actions.SelectAction.action

(inherited documentation)