Package peppy :: Package plugins :: Module shell_mode :: Class ShellPlugin

Class ShellPlugin

               object --+        
                        |        
    yapsy.IPlugin.IPlugin --+    
                            |    
               object --+   |    
                        |   |    
lib.userparams.ClassPrefs --+    
                            |    
               object --+   |    
                        |   |    
         debug.debugmixin --+    
                            |    
   yapsy.plugins.IPeppyPlugin --+
                                |
                               ShellPlugin

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

Instance Methods

activate(self)
Called at plugin activation to initialize some internal parameters.

deactivate(self)
Called when the plugin is disabled.

Inherited from yapsy.plugins.IPeppyPlugin: __init__, activateHook, deactivateHook

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

convenience

Inherited from yapsy.plugins.IPeppyPlugin: importModule, isInUse

interface

getMajorModes(self)
Return list of major modes provided by the plugin.

Inherited from yapsy.plugins.IPeppyPlugin: aboutFiles, addCommandLineOptions, attemptOpen, finalShutdown, getActions, getCompatibleActions, getCompatibleMajorModes, getCompatibleMinorModes, getMinorModes, getPipe, getSidebars, initialActivation, loadVirtualFileSystem, processCommandLineOptions, requestedShutdown, supportedShells

Class Methods

Inherited from yapsy.plugins.IPeppyPlugin: setStartupComplete

Inherited from debug.debugmixin: dprint

Class Variables

classprefs = <peppy.lib.userparams.PrefsProxy object at 0x8cff...

Inherited from yapsy.plugins.IPeppyPlugin: default_classprefs, preferences_tab

Inherited from lib.userparams.ClassPrefs: preferences_sort_weight

Inherited from debug.debugmixin: debuglevel

Properties
Inherited from `object`: `__class__`

Method Details

activate(self)

Called at plugin activation to initialize some internal parameters.

NOTE: if overridden in a subclass, make sure to call this method in the overriding method. In most cases, it's better to override activateHook instead.

Overrides: yapsy.IPlugin.IPlugin.activate: (inherited documentation)

deactivate(self)

Called when the plugin is disabled.

NOTE: if overridden in a subclass, make sure to call this method in the overriding method.

Overrides: yapsy.IPlugin.IPlugin.deactivate: (inherited documentation)

getMajorModes(self)

Return list of major modes provided by the plugin.

If this plugin provides any major modes, return a list or generator of all the major modes that this plugin is representing. Generally, a plugin will only represent a single mode, but it is possible to represent more.

Overrides: yapsy.plugins.IPeppyPlugin.getMajorModes: (inherited documentation)

Class Variable Details

classprefs

Value:

<peppy.lib.userparams.PrefsProxy object at 0x8cff8d0>