Package peppy :: Module sidebar :: Class Sidebar

Class Sidebar

               object --+    
                        |    
lib.userparams.ClassPrefs --+
                            |
               object --+   |
                        |   |
         debug.debugmixin --+
                            |
                           Sidebar

Known Subclasses:

Mixin class for all frame sidebars.

A frame sidebar is generally used to create a new UI window in a frame that is outside the purview of the major mode. It is a constant regardless of which major mode is selected.

Nested Classes
Inherited from `lib.userparams.ClassPrefs`: `__metaclass__`

Instance Methods

__init__(self, frame)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

getPaneInfo(self)
Create the AuiPaneInfo object for this minor mode.

getDefaultPaneInfo(self)
Factory method to return pane info.

paneInfoHook(self, paneinfo)
Hook to modify the paneinfo object before the major mode does anything with it.

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

Class Methods

getClasses(cls, frame, sidebarlist=[])

Inherited from debug.debugmixin: dprint

Class Variables
	keyword = `None`
	caption = `None`
	default_classprefs = `IntParam('best_width', 100, 'Desired widt...`
	classprefs = `<peppy.lib.userparams.PrefsProxy object at 0x5067...`
Inherited from `lib.userparams.ClassPrefs`: `preferences_sort_weight` Inherited from `debug.debugmixin`: `debuglevel`

Properties
Inherited from `object`: `__class__`

Method Details

init(self, frame)
(Constructor)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

getDefaultPaneInfo(self)

Factory method to return pane info.

Most sidebars won't need to override this, but it is available in the case that it is necessary. A wx.aui.AuiPaneInfo object should be returned.

Class Variable Details

default_classprefs

Value:

IntParam('best_width', 100, 'Desired width of sidebar in pixels'), Int
Param('best_height', 100, 'Desired height of sidebar in pixels'), IntP
aram('min_width', 100, 'Minimum width of sidebar in pixels\nenforced b
y the AuiManager'), IntParam('min_height', 100, 'Minimum height of sid
ebar in pixels\nenforced by the AuiManager'), BoolParam('show', True),

classprefs