Back to index

plone3  3.1.7
Public Member Functions | Static Public Attributes
plone.app.layout.nextprevious.interfaces.INextPreviousProvider Class Reference
Inheritance diagram for plone.app.layout.nextprevious.interfaces.INextPreviousProvider:
Inheritance graph
[legend]
Collaboration diagram for plone.app.layout.nextprevious.interfaces.INextPreviousProvider:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def getNextItem
def getPreviousItem

Static Public Attributes

tuple enabled = Bool(title=u"True if next/previous behaviour is enabled")

Detailed Description

A folderish component capable of describing the next and previous 
item relative to a particular id.

Definition at line 4 of file interfaces.py.


Member Function Documentation

Returns information about next item in the container relative to 
the given object.

This is a dict with the following keys:

    - id, the id of the object
    - url, the url of the object
    - title, the title of the object
    - description, a description of the object
    - portal_type, the object's portal type

Definition at line 11 of file interfaces.py.

00011 
00012     def getNextItem(obj):
00013         """Returns information about next item in the container relative to 
00014         the given object.
00015         
00016         This is a dict with the following keys:
00017         
00018             - id, the id of the object
00019             - url, the url of the object
00020             - title, the title of the object
00021             - description, a description of the object
00022             - portal_type, the object's portal type
00023         """

Returns the previous item in the container relative to the given 
object

Definition at line 24 of file interfaces.py.

00024 
00025     def getPreviousItem(obj):
00026         """Returns the previous item in the container relative to the given 
00027         object
00028         """
00029 

Member Data Documentation

tuple plone.app.layout.nextprevious.interfaces.INextPreviousProvider.enabled = Bool(title=u"True if next/previous behaviour is enabled") [static]

Definition at line 9 of file interfaces.py.


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