Package peppy :: Package actions :: Module minibuffer :: Class MinibufferAction

Class MinibufferAction

                object --+        
                         |        
base.BufferBusyActionMixin --+    
                             |    
            object --+       |    
                     |       |    
      debug.debugmixin --+   |    
                         |   |    
              SelectAction --+    
                             |    
   base.TextModificationAction --+
                                 |
                                MinibufferAction

Known Subclasses:

Instance Methods

getInitialValueHook(self)
Get the initial value (if any)

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

processMinibuffer(self, minibuffer, mode, text)

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

Inherited from SelectAction: getHelp, setAcceleratorText

Inherited from debug.debugmixin: dprint

Class Variables

minibuffer_label = None

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

getInitialValueHook(self)

Get the initial value (if any)

This hook is called immediately before the minibuffer is placed in the mode. If overridden in a subclass, this should return a text representation of the string to place in the minibuffer.

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)