Package peppy :: Package plugins :: Module mpd_major_mode :: Class MPDPlugin

Class MPDPlugin

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

HSI viewer plugin to register modes and user interface.

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.

getMinorModes(self)
Return list of minor modes provided by the plugin.

getActions(self)
Return list of actions provided by the plugin.

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

Class Methods

Inherited from yapsy.plugins.IPeppyPlugin: setStartupComplete

Inherited from debug.debugmixin: dprint

Class Variables

Inherited from yapsy.plugins.IPeppyPlugin: classprefs, 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)

getMinorModes(self)

Return list of minor modes provided by the plugin.

Return an iterator containing the minor mode classes associated with this plugin.

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

getActions(self)

Return list of actions provided by the plugin.

Return an iterator containing the list of actions that are provided by this plugin. Actions are defined as subclasses of the SelectAction class in menu.py. They define the menubar, toolbar, and keyboard control commands.

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