Package peppy :: Module menu :: Class UserActionClassList

Class UserActionClassList

      object --+    
               |    
debug.debugmixin --+
                   |
                  UserActionClassList

Creates a list of actions for a major mode

This class creates a list of action classes and a sorted list of actions ready to be populated into a menu.

Instance Methods

__init__(self, mode)
Initialize the mapping with the new set of actions.

getActiveActions(self, mode)

getInfo(self, action)
Get menu ordering info from the action

getParent(self, menu_title)
Get the parent menu title.

sortActions(self)
Sort the actions into a hierarchy of menus

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

Class Methods

setDefaultMenuBarWeights(cls, weights, override=False)
Set the default menubar weights.

Inherited from debug.debugmixin: dprint

Class Variables
	default_menu_weights = `{}`
Inherited from `debug.debugmixin`: `debuglevel`

Properties
Inherited from `object`: `__class__`

Method Details

setDefaultMenuBarWeights(cls, weights, override=False)
Class Method

Set the default menubar weights.

Weights is a mapping of the menu name to the sort order of the menu name. By default the sort order of the menu ranges from 0 to 1000, and floating-point numbers are OK.

init(self, mode)
(Constructor)

Initialize the mapping with the new set of actions.

The ordering of the menu items is set here, but nothing is actually mapped to a menubar or a toolbar until either updateMenuActions or updateToolbarActions is called.

frame: parent Frame object action_classes: list of possible action classes (i.e. not instantiated classes, but the classes themselves. They will be instantiated when they are mapped to a menubar or toolbar.

Overrides: object.__init__

getInfo(self, action)

Get menu ordering info from the action

The class attribute default_menu is decoded here into the mode (either a text string or None indicating the action is applicable to all major modes), the menu title, menu weight (sorting order of the menu itself) and the item weight (sorting order of the action within the menu).

getParent(self, menu_title)

Get the parent menu title.

Submenus are indicated by a / in the menu title

sortActions(self)

Sort the actions into a hierarchy of menus

Menus and menu items are sorted here by the weights given in the default_menu attribute of the action.