Package peppy :: Package actions :: Module base :: Class ScintillaCmdKeyExecute

Class ScintillaCmdKeyExecute

           object --+        
                    |        
BufferBusyActionMixin --+    
                        |    
       object --+       |    
                |       |    
 debug.debugmixin --+   |    
                    |   |    
         SelectAction --+    
                        |    
   TextModificationAction --+
                            |
                           ScintillaCmdKeyExecute

Known Subclasses:

Base class for an action that uses one of the scintilla key commands.

Scintilla has a number of messages that operate on the text but don't have direct method calls. This base class can be used as a simple wrapper around one of these scintilla messages.

See Also: http://www.yellowbrain.com/stc/keymap.html#exec

Instance Methods

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

Inherited from BufferBusyActionMixin: isActionAvailable, isEnabled

Inherited from 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 TextModificationAction: worksWithMajorMode

Inherited from SelectAction: getHelp, setAcceleratorText

Inherited from debug.debugmixin: dprint

Class Variables

cmd = 0

Inherited from SelectAction: alias, default_menu, default_toolbar, global_id, icon, key_bindings, keyboard, name, stock_id, tooltip

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: SelectAction.action

(inherited documentation)