Back to index

plone3  3.1.7
Public Member Functions
PluginRegistry.interfaces.IPluginRegistry Class Reference
Inheritance diagram for PluginRegistry.interfaces.IPluginRegistry:
Inheritance graph
[legend]
Collaboration diagram for PluginRegistry.interfaces.IPluginRegistry:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def listPluginTypeInfo
def listPlugins
def listPluginIds
def activatePlugin
def deactivatePlugin
def movePluginsUp
def movePluginsDown

Detailed Description

Manage a set of plugin definitions, grouped by type.

Definition at line 27 of file interfaces.py.


Member Function Documentation

def PluginRegistry.interfaces.IPluginRegistry.activatePlugin (   plugin_type,
  plugin_id 
)
Activate a plugin of the given type.

o 'plugin_type' must be one of the known types, else raise KeyError.

o 'plugin_id' must be the ID of an available plugin, else raise
  KeyError.

o Append 'plugin_id' to the list of active plugins for the given
  'plugin_type'.

Definition at line 68 of file interfaces.py.

00068 
00069     def activatePlugin( plugin_type, plugin_id ):
00070 
00071         """ Activate a plugin of the given type.
00072 
00073         o 'plugin_type' must be one of the known types, else raise KeyError.
00074 
00075         o 'plugin_id' must be the ID of an available plugin, else raise
00076           KeyError.
00077 
00078         o Append 'plugin_id' to the list of active plugins for the given
00079           'plugin_type'.
00080         """

Here is the caller graph for this function:

def PluginRegistry.interfaces.IPluginRegistry.deactivatePlugin (   plugin_type,
  plugin_id 
)
Deactivate a plugin of the given type.

o 'plugin_type' must be one of the known types, else raise KeyError.

o 'plugin_id' must be an ID of an existing plugin of that type,
  else raise KeyError.

Definition at line 81 of file interfaces.py.

00081 
00082     def deactivatePlugin( plugin_type, plugin_id ):
00083 
00084         """ Deactivate a plugin of the given type.
00085 
00086         o 'plugin_type' must be one of the known types, else raise KeyError.
00087 
00088         o 'plugin_id' must be an ID of an existing plugin of that type,
00089           else raise KeyError.
00090         """

Here is the caller graph for this function:

Return a sequence of plugin ids

o Return ids for each active plugin of the given type.

o 'plugin_type' must be one of the known types, else raise KeyError.

Definition at line 59 of file interfaces.py.

00059 
00060     def listPluginIds( plugin_type ):
00061 
00062         """ Return a sequence of plugin ids
00063         
00064         o Return ids for each active plugin of the given type.
00065 
00066         o 'plugin_type' must be one of the known types, else raise KeyError.
00067         """

Return a sequence of tuples, one for each plugin of the given type.

o 'plugin_type' must be one of the known types, else raise KeyError.

o Tuples will be of the form, '( plugin_id, plugin )'.

Definition at line 50 of file interfaces.py.

00050 
00051     def listPlugins( plugin_type ):
00052 
00053         """ Return a sequence of tuples, one for each plugin of the given type.
00054 
00055         o 'plugin_type' must be one of the known types, else raise KeyError.
00056 
00057         o Tuples will be of the form, '( plugin_id, plugin )'.
00058         """

Return a sequence of mappings describing our plugin types.

o Keys for the mappings must include:

  'id' -- a string used to identify the plugin type (should be
    the __name__ of the interface)

  'interface' -- the plugin type interface

  'methods' -- the methods expected by the plugin type interface

  'title' -- a display title for the plugin type

  'description' -- a description of what the plugins do

Definition at line 32 of file interfaces.py.

00032 
00033     def listPluginTypeInfo():
00034 
00035         """ Return a sequence of mappings describing our plugin types.
00036 
00037         o Keys for the mappings must include:
00038 
00039           'id' -- a string used to identify the plugin type (should be
00040             the __name__ of the interface)
00041 
00042           'interface' -- the plugin type interface
00043 
00044           'methods' -- the methods expected by the plugin type interface
00045 
00046           'title' -- a display title for the plugin type
00047 
00048           'description' -- a description of what the plugins do
00049         """

def PluginRegistry.interfaces.IPluginRegistry.movePluginsDown (   plugin_type,
  ids_to_move 
)
Move a set of plugins "down" in their list.

o 'plugin_type' must be one of the known types, else raise KeyError.

o 'ids_to_move' must be a sequence of indexes of items in the current
  list of plugins for that type.
  
  - If any item is not the ID of a current plugin, raise ValueError.

Definition at line 103 of file interfaces.py.

00103 
00104     def movePluginsDown( plugin_type, ids_to_move ):
00105 
00106         """ Move a set of plugins "down" in their list.
00107 
00108         o 'plugin_type' must be one of the known types, else raise KeyError.
00109 
00110         o 'ids_to_move' must be a sequence of indexes of items in the current
00111           list of plugins for that type.
00112           
00113           - If any item is not the ID of a current plugin, raise ValueError.
00114         """

Here is the caller graph for this function:

def PluginRegistry.interfaces.IPluginRegistry.movePluginsUp (   plugin_type,
  ids_to_move 
)
Move a set of plugins "up" in their list.

o 'plugin_type' must be one of the known types, else raise KeyError.

o 'ids_to_move' must be a sequence of ids of current plugins
  for that type.
  
  - If any item is not the ID of a current plugin, raise ValueError.

Definition at line 91 of file interfaces.py.

00091 
00092     def movePluginsUp( plugin_type, ids_to_move ):
00093 
00094         """ Move a set of plugins "up" in their list.
00095 
00096         o 'plugin_type' must be one of the known types, else raise KeyError.
00097 
00098         o 'ids_to_move' must be a sequence of ids of current plugins
00099           for that type.
00100           
00101           - If any item is not the ID of a current plugin, raise ValueError.
00102         """

Here is the caller graph for this function:


The documentation for this class was generated from the following file: