Package peppy :: Module mainmenu :: Class PasteAtColumn

Class PasteAtColumn

                        object --+            
                                 |            
actions.base.BufferBusyActionMixin --+        
                                     |        
                    object --+       |        
                             |       |        
              debug.debugmixin --+   |        
                                 |   |        
              actions.SelectAction --+        
                                     |        
    actions.base.STCModificationAction --+    
                                         |    
                                     Paste --+
                                             |
                                            PasteAtColumn

Instance Methods

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

Inherited from Paste: isActionAvailable

Inherited from actions.base.BufferBusyActionMixin: 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

worksWithMajorMode(cls, mode)
Hook to restrict the action to only be displayed with a specific major mode

Inherited from actions.SelectAction: getHelp, setAcceleratorText

Inherited from debug.debugmixin: dprint

Class Variables
	alias = `"paste-at-column"` This alias holds an emacs style name that is used during M-X processing.
	name = `"Paste at Column"` This is the name of the menu entry as it appears in the menu bar.
	tooltip = `"Paste selection indented to the cursor's column"` Tooltip that is displayed when the mouse is hovering over the menu entry.
	icon = `"icons/paste_plain.png"` If there is an icon associated with this action, name it here.
	default_menu = `"Edit", 103` The default menu location is specified here as a tuple containing the menu path (separated by / characters) and a number between 1 and 1000 representing the position within the menu.
	default_toolbar = `False` Toolbar item will automatically be created unless this is False
	key_bindings = `None` Map of platform to default keybinding.
	global_id = `None` If the action doesn't use a stock id, it will automatically get assigned a global id here.
Inherited from `actions.SelectAction`: `keyboard`, `stock_id` Inherited from `debug.debugmixin`: `debuglevel`

Properties
Inherited from `object`: `__class__`

Method Details

worksWithMajorMode(cls, mode)
Class Method

Hook to restrict the action to only be displayed with a specific major mode

This hook is called by the menu creation code to determine if the action should be displayed when showing the major mode's user interface.

Parameters:

mode - the major mode instance

Returns:

True if the action is allowed to be associated with the major mode

Overrides: actions.SelectAction.worksWithMajorMode

(inherited documentation)

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)

Class PasteAtColumn

worksWithMajorMode(cls, mode) Class Method

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

worksWithMajorMode(cls, mode)
Class Method