Package peppy :: Package plugins :: Module tutorial_plugin :: Class TutorialPlugin

Class TutorialPlugin

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

The plugin object for the tutorial.

The plugin object describes the additional functionality that is provided by this code. There are a variety of interface methods provided by the superclass IPeppyPlugin, and only the interfaces actually used by the plugin need to be defined here. All others default to no-ops.

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

Instance Methods

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

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

convenience

Inherited from yapsy.plugins.IPeppyPlugin: importModule, isInUse

interface

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

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

Inherited from yapsy.plugins.IPeppyPlugin: aboutFiles, addCommandLineOptions, attemptOpen, finalShutdown, getCompatibleActions, getCompatibleMajorModes, getCompatibleMinorModes, getMajorModes, 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 0x8533...

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

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)

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)

Class Variable Details

classprefs

Value:

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