Package peppy :: Module buffers :: Class BufferList

Class BufferList

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

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

Instance Methods

getItems(self)

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

dynamic(self)
Check to see if the list needs sorting before processing a dynamic menu update.

Inherited from actions.OnDemandGlobalListAction: getHash, updateOnDemand

Inherited from actions.ListAction: __init__, 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

addBuffer(cls, buf)
Convenience function to add a buffer and flag to be sorted

removeBuffer(cls, buf)
Convenience function to remove a buffer and flag to be sorted

findBufferByURL(cls, url)

findBuffersByBasename(cls, basename)

getBuffers(cls)

sort(cls)
Sort using the decorate, sort, undecorate pattern

needsSort(cls)

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

Inherited from actions.SelectAction: getHelp, setAcceleratorText, worksWithMajorMode

Inherited from debug.debugmixin: dprint

Static Methods

promptUnsaved()

Class Variables
	name = `'Documents'` This is the name of the menu entry as it appears in the menu bar.
	default_menu = `('Documents', -500)` 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`
	localhash = `0`
	storage = `[]`
	needs_sort = `True`
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

getItems(self)

Overrides: actions.ListAction.getItems

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)

dynamic(self)

Check to see if the list needs sorting before processing a dynamic menu update.

Overrides: actions.ListAction.dynamic