Package peppy :: Package plugins :: Module openrecent :: Class RecentFilesPlugin

Class RecentFilesPlugin

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

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

initialActivation(self)
Give the plugin a chance to configure itself the first time it is activated.

requestedShutdown(self)
Give the plugin a chance to revoke a shutdown.

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

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

Class Methods

Inherited from yapsy.plugins.IPeppyPlugin: setStartupComplete

Inherited from debug.debugmixin: dprint

interface

getFile(cls)

Class Variables

default_classprefs = StrParam('history_file', 'recentfiles.txt...

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

initialActivation(self)

Give the plugin a chance to configure itself the first time it is activated.

Called during the plugin's first call to the activate method, which is typically during application initialization, after the application has loaded all its configuration information, but before the command line has been processed.

It can also occur later in the application lifecycle if the plugin is loaded by some other means.

This is for one-time initialization.

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

requestedShutdown(self)

Give the plugin a chance to revoke a shutdown.

Throw an exception to revoke a shutdown. The error message will be displayed to the user.

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

default_classprefs

Value:

StrParam('history_file', 'recentfiles.txt', 'Filename used in the pepp
y configuration directory\nto store the list of recently opened files.
'), IntParam('list_length', 10, 'Truncate the list to this number of\n
files most recently opened.'),