Package peppy :: Package plugins :: Module function_menu :: Class FoldExplorerMenu

Class FoldExplorerMenu

         object --+            
                  |            
   debug.debugmixin --+        
                      |        
   actions.SelectAction --+    
                          |    
         actions.ListAction --+
                              |
                 object --+   |
                          |   |
actions.OnDemandActionMixin --+
                              |
                             FoldExplorerMenu

Nested Classes
Inherited from `actions.ListAction`: `IdCache`

Instance Methods

getItems(self)

getHash(self)

updateOnDemand(self)
Hook called before the menu is displayed.

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

Inherited from actions.ListAction: __init__, dynamic, getIcons, getIndexOfId, getSubIds, insertIntoMenu, showEnable

Inherited from actions.SelectAction: __call__, getMenuItemName, getTooltip, initPostHook, initPreHook, insertIntoToolbar, isEnabled

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

Class Methods

Inherited from actions.SelectAction: getHelp, setAcceleratorText, worksWithMajorMode

Inherited from debug.debugmixin: dprint

Class Variables
	name = `'Functions'` This is the name of the menu entry as it appears in the menu bar.
	inline = `True`
	tooltip = `'Go to a function'` Tooltip that is displayed when the mouse is hovering over the menu entry.
	default_menu = `('Functions', 100)` 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.
Inherited from `actions.ListAction`: `abbrev_width`, `localize_items`, `menumax` Inherited from `actions.SelectAction`: `alias`, `default_toolbar`, `global_id`, `icon`, `key_bindings`, `keyboard`, `stock_id` Inherited from `debug.debugmixin`: `debuglevel`

Properties
Inherited from `object`: `__class__`

Method Details

getItems(self)

Overrides: actions.ListAction.getItems

getHash(self)

Overrides: actions.ListAction.getHash

updateOnDemand(self)

Hook called before the menu is displayed.

This method allows the subclass to catch the menu opening event before it anything is added to the menu bar. When used in combination with a list, the list may be reordered and menu items can be inserted or deleted.

Overrides: actions.OnDemandActionMixin.updateOnDemand: (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)