Package peppy :: Module frame :: Class WindowList

Class WindowList

                  object --+        
                           |        
 actions.OnDemandActionMixin --+    
                               |    
          object --+           |    
                   |           |    
    debug.debugmixin --+       |    
                       |       |    
    actions.SelectAction --+   |    
                           |   |    
          actions.ListAction --+    
                               |    
actions.OnDemandGlobalListAction --+
                                   |
                                  WindowList

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

Instance Methods

getItems(self)

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

Inherited from actions.OnDemandGlobalListAction: getHash, updateOnDemand

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

calcHash(cls)
Hash calculation method to determine if menu items have changed.

getFrames(self)

Inherited from actions.OnDemandGlobalListAction: append, remove, setStorage, trimStorage

Inherited from actions.SelectAction: getHelp, setAcceleratorText, worksWithMajorMode

Inherited from debug.debugmixin: dprint

Class Variables
	name = `"Frames"` This is the name of the menu entry as it appears in the menu bar.
	default_menu = `"Window",-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.
	inline = `True`
	storage = `[]`
Inherited from `actions.OnDemandGlobalListAction`: `globalhash` Inherited from `actions.ListAction`: `abbrev_width`, `localize_items`, `menumax` Inherited from `actions.SelectAction`: `alias`, `default_toolbar`, `global_id`, `icon`, `key_bindings`, `keyboard`, `stock_id`, `tooltip` Inherited from `debug.debugmixin`: `debuglevel`

Properties
Inherited from `object`: `__class__`

Method Details

calcHash(cls)
Class Method

Hash calculation method to determine if menu items have changed.

The default implementation is a simplistic one that changes every time calcHash is called, guaranteeing that the menu will be updated the next time.

If calcHash sets cls.localhash or cls.globalhash to None, the menu will always be updated.

Overrides: actions.OnDemandGlobalListAction.calcHash: (inherited documentation)

getItems(self)

Overrides: actions.ListAction.getItems

action(self, index=0, 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 WindowList

calcHash(cls) Class Method

getItems(self)

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

calcHash(cls)
Class Method