Back to index

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

List of all members.

Public Member Functions

def getLibraries
def addLibrary
def deleteLibraries
def updateLibraries
def moveUp
def moveDown

Detailed Description

Provide an interface for managing and retrieving libraries for
the Kupu editor.

Definition at line 16 of file interfaces.py.


Member Function Documentation

def kupu.plone.interfaces.ILibraryManager.addLibrary (   id,
  title,
  uri,
  src,
  icon 
)
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:

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:

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:

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:

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:

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:


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