Package peppy :: Package hsi :: Module hsi_major_mode_proxy :: Class HSIPlugin

Class HSIPlugin

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

HSI viewer plugin to register modes and user interface.

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

attemptOpen(self, buffer)
Last resort to major mode matching: attempting to open the url.

getCompatibleMajorModes(self, stc_class)
Return list of major modes that are compatible to the given stc class.

getCompatibleMinorModes(self, cls)
Return list of minor modes provided by the plugin that are compatible with the specified major mode.

getCompatibleActions(self, mode)
Return list of actions compatible with the major mode.

Inherited from yapsy.plugins.IPeppyPlugin: aboutFiles, addCommandLineOptions, finalShutdown, getActions, 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 0x68c2...

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

attemptOpen(self, buffer)

Last resort to major mode matching: attempting to open the url.

This method is the last resort if all other pattern matching and mode searching fails. Typically, this is only an issue with non-Scintilla editors that use third-party file loading libraries.

buffer: the Buffer object to attempt to load

Returns:: major mode class if successful in matching
Overrides: yapsy.plugins.IPeppyPlugin.attemptOpen: (inherited documentation)

getCompatibleMajorModes(self, stc_class)

Return list of major modes that are compatible to the given stc class.

Return an iterator containing the major mode classes if the stc backend is compatible with the given stc. This is used to provide the list of allowable major modes when the user wants to switch the major mode view.

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

getCompatibleMinorModes(self, cls)

Return list of minor modes provided by the plugin that are compatible with the specified major mode.

Return an iterator containing the minor modes if they are compatible with the specified major mode class.

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

getCompatibleActions(self, mode)

Return list of actions compatible with the major mode.

Return an iterator containing the list of actions provided by this plugin that are compatible with the given major mode. 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.getCompatibleActions: (inherited documentation)

Class Variable Details

classprefs

Value:

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