Back to index

plone3  3.1.7
Public Member Functions
kupu.plone.interfaces.IKupuLibraryTool Class Reference
Inheritance diagram for kupu.plone.interfaces.IKupuLibraryTool:
Inheritance graph
[legend]
Collaboration diagram for kupu.plone.interfaces.IKupuLibraryTool:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def getLibraries
def addLibrary
def deleteLibraries
def updateLibraries
def moveUp
def moveDown
def getPortalTypesForResourceType
def queryPortalTypesForResourceType
def addResourceType
def updateResourceTypes
def deleteResourceTypes

Detailed Description

Interface for the Kupu library tool

Definition at line 87 of file interfaces.py.


Member Function Documentation

def kupu.plone.interfaces.ILibraryManager.addLibrary (   id,
  title,
  uri,
  src,
  icon 
) [inherited]
Add a library.

Definition at line 35 of file interfaces.py.

00035 
00036     def addLibrary(id, title, uri, src, icon):
00037         """Add a library.
00038         """

Here is the caller graph for this function:

def kupu.plone.interfaces.IResourceTypeMapper.addResourceType (   resource_type,
  portal_types,
  mode = 'whitelist' 
) [inherited]
Add a resource type pointing to a sequence of portal_types.

Definition at line 75 of file interfaces.py.

00075 
00076     def addResourceType(resource_type, portal_types, mode='whitelist'):
00077         """Add a resource type pointing to a sequence of portal_types."""

Delete libraries

Definition at line 39 of file interfaces.py.

00039 
00040     def deleteLibraries(indices):
00041         """Delete libraries
00042         """

Here is the caller graph for this function:

Delete the type mapping for the specififed resource types

Raises KeyError if one of the resource_types is not found.

Definition at line 81 of file interfaces.py.

00081 
00082     def deleteResourceTypes(resource_types):
00083         """Delete the type mapping for the specififed resource types
00084 
00085         Raises KeyError if one of the resource_types is not found.
00086         """

Here is the caller graph for this function:

Provide an interface for managing and retrieving libraries for
the Kupu editor.
Return an ordered sequence of libraries.

Since libraries might be defined placefully, we look them up
using a context. The return value is provided as a sequence of
dictionaries with the following keys:

  id    - the computed id
  title - the computed title of the library
  uri   - the computed URI of the library
  src   - the computed source URI
  icon  - the computed icon URI

Definition at line 21 of file interfaces.py.

00021 
00022     def getLibraries(context):
00023         """Return an ordered sequence of libraries.
00024 
00025         Since libraries might be defined placefully, we look them up
00026         using a context. The return value is provided as a sequence of
00027         dictionaries with the following keys:
00028 
00029           id    - the computed id
00030           title - the computed title of the library
00031           uri   - the computed URI of the library
00032           src   - the computed source URI
00033           icon  - the computed icon URI
00034         """

Here is the caller graph for this function:

Map portal types to resource types
Return a sequence of portal types for a specific resource type.

Raises KeyError if resource_type is not found.

Definition at line 63 of file interfaces.py.

00063 
00064     def getPortalTypesForResourceType(resource_type):
00065         """Return a sequence of portal types for a specific resource type.
00066 
00067         Raises KeyError if resource_type is not found.
00068         """

Here is the caller graph for this function:

def kupu.plone.interfaces.ILibraryManager.moveDown (   indices) [inherited]
Reorder libraries by moving specified libraries down.

Definition at line 56 of file interfaces.py.

00056 
00057     def moveDown(indices):
00058         """Reorder libraries by moving specified libraries down.
00059         """

Here is the caller graph for this function:

def kupu.plone.interfaces.ILibraryManager.moveUp (   indices) [inherited]
Reorder libraries by moving specified libraries up.

Definition at line 52 of file interfaces.py.

00052 
00053     def moveUp(indices):
00054         """Reorder libraries by moving specified libraries up.
00055         """

Here is the caller graph for this function:

def kupu.plone.interfaces.IResourceTypeMapper.queryPortalTypesForResourceType (   resource_type,
  default = None 
) [inherited]
Return a sequence of portal types for a specific resource type.

Returns 'default' if resource_type is not found.

Definition at line 69 of file interfaces.py.

00069 
00070     def queryPortalTypesForResourceType(resource_type, default=None):
00071         """Return a sequence of portal types for a specific resource type.
00072 
00073         Returns 'default' if resource_type is not found.
00074         """

Update libraries.

Update libraries using the sequence of mapping objects
provided in the 'libraries' parameter. Each mapping object
needs to provide an 'index' key to indicate which library it
is updating.

Definition at line 43 of file interfaces.py.

00043 
00044     def updateLibraries(libraries):
00045         """Update libraries.
00046 
00047         Update libraries using the sequence of mapping objects
00048         provided in the 'libraries' parameter. Each mapping object
00049         needs to provide an 'index' key to indicate which library it
00050         is updating.
00051         """

Here is the caller graph for this function:

Update resource types using the type mapping passed as argument.

Definition at line 78 of file interfaces.py.

00078 
00079     def updateResourceTypes(type_mapping):
00080         """Update resource types using the type mapping passed as argument."""

Here is the caller graph for this function:


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