Package peppy :: Package plugins :: Module help :: Class HelpPlugin

Class HelpPlugin

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

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

aboutFiles(self)
Add entries to the about filesystem.

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

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

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

aboutFiles(self)

Add entries to the about filesystem.

The plugin may define additions to the about filesystem by returning a dict here. The about filesystem is a pseudo- filesystem that returns data from about: urls, and is used mostly for storing read-only help files or sample files. It is useful for adding help text for your plugin.

The dict is keyed on the filename, and the value is the contents of the file.

Overrides: yapsy.plugins.IPeppyPlugin.aboutFiles: (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)

Class Variable Details

classprefs

Value:

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