Back to index

plone3  3.1.7
interfaces.py
Go to the documentation of this file.
00001 from zope.interface import Interface, Attribute
00002 from zope.app.container.interfaces import IAdding
00003 from plone.app.form.interfaces import IPlonePageForm
00004 
00005 class IPortletAdding(IAdding):
00006     """Marker interface for the add view for portlet managers.
00007     
00008     Portlet add views should be registered for this interface.
00009     """
00010     
00011 class IPortletForm(IPlonePageForm):
00012     """Generic marker for form views that are used to create or edit portlets.
00013     """
00014     
00015     def referer(self):
00016         """Return the URL that the user came from before entering the form
00017         for the first time.
00018         """
00019     
00020 class IPortletAddForm(IPortletForm):
00021     """Add form view for portlets
00022     """
00023     
00024 class IPortletEditForm(IPortletForm):
00025     """Edit form view for portlets
00026     """
00027 
00028 class IManagePortletsView(Interface):
00029     """The screen used to manage portlets in a particular context.
00030     """
00031     
00032     category = Attribute("The portlet category being managed")
00033     key = Attribute("The key in the category under which portlets are assigned")
00034     
00035     def getAssignmentMappingUrl(manager):
00036         """Given a portlet manager, get the URL to its assignment mapping.
00037         """
00038         
00039     def getAssignmentsForManager(manager):
00040         """Get the assignments in the current context for the given manager.
00041         """
00042 
00043 class IManageDashboardPortletsView(IManagePortletsView):
00044     """Marker for the manage dashboard portlets view
00045     """
00046 
00047 class IManageColumnPortletsView(IManagePortletsView):
00048     """Base class for views that should display the edit fuctionality
00049     for column portlets.
00050     
00051     This allows us to register a generic portlet manager renderer for this
00052     view that can apply to different categories of assignment.
00053     """
00054 
00055 class IManageContextualPortletsView(IManageColumnPortletsView):
00056     """Marker for the manage contextual portlets view
00057     """
00058     
00059 class IManageUserPortletsView(IManageColumnPortletsView):
00060     """Marker for the manage user portlets view
00061     """
00062 
00063 class IManageGroupPortletsView(IManageColumnPortletsView):
00064     """Marker for the manage group portlets view
00065     """
00066 
00067 class IManageContentTypePortletsView(IManageColumnPortletsView):
00068     """Marker for the manage content type portlets view
00069     """