Back to index

plone3  3.1.7
Public Member Functions | Static Public Attributes
CMFCore.interfaces._tools.ISkinsTool Class Reference
Inheritance diagram for CMFCore.interfaces._tools.ISkinsTool:
Inheritance graph
[legend]
Collaboration diagram for CMFCore.interfaces._tools.ISkinsTool:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def getSkinSelections
def getSkinPath
def getDefaultSkin
def getRequestVarname
def getSkinByPath
def getSkinByName

Static Public Attributes

tuple id

Detailed Description

An object that provides skins to a portal object.

O XXX:  This shouldn't derive from ISkinsContainer?

Definition at line 1211 of file _tools.py.


Member Function Documentation

Return the default skin name.

o Permission:  Access contents information

Definition at line 1176 of file _tools.py.

01176 
01177     def getDefaultSkin():
01178         """ Return the default skin name.
01179 
01180         o Permission:  Access contents information
01181         """

Here is the caller graph for this function:

Return the variable name to look for in the REQUEST.

o Permission:  Access contents information

Definition at line 1182 of file _tools.py.

01182 
01183     def getRequestVarname():
01184         """ Return the variable name to look for in the REQUEST.
01185 
01186         o Permission:  Access contents information
01187         """

Get the named skin.

Permission:  Private (Python only)

Definition at line 1204 of file _tools.py.

01204 
01205     def getSkinByName(name):
01206         """ Get the named skin.
01207 
01208         Permission:  Private (Python only)
01209         """
01210 

def CMFCore.interfaces._tools.ISkinsContainer.getSkinByPath (   path,
  raise_exc = 0 
) [inherited]
Return a skin at the given path.

o XXX:  what are we doing here?

o A skin path is a search path of layers of the format:
  'some/path, some/other/path, ...'.

o Attributes are looked up in the layers in the named order.

o A skin is a specially wrapped object that looks through the layers
  in the correct order.

o Permission:  Private (Python only)

Definition at line 1188 of file _tools.py.

01188 
01189     def getSkinByPath(path, raise_exc=0):
01190         """ Return a skin at the given path.
01191 
01192         o XXX:  what are we doing here?
01193 
01194         o A skin path is a search path of layers of the format:
01195           'some/path, some/other/path, ...'.
01196 
01197         o Attributes are looked up in the layers in the named order.
01198 
01199         o A skin is a specially wrapped object that looks through the layers
01200           in the correct order.
01201 
01202         o Permission:  Private (Python only)
01203         """

Here is the caller graph for this function:

An object that provides skins.
Convert a skin name to a skin path.

o Permission:  Access contents information

Definition at line 1170 of file _tools.py.

01170 
01171     def getSkinPath(name):
01172         """ Convert a skin name to a skin path.
01173 
01174         o Permission:  Access contents information
01175         """

Here is the caller graph for this function:

Get the sorted list of available skin names.

o Permission:  Public

Definition at line 1225 of file _tools.py.

01225 
01226     def getSkinSelections():
01227         """ Get the sorted list of available skin names.
01228 
01229         o Permission:  Public
01230         """
01231 
01232 #
01233 # Syndication tool interface
#

Member Data Documentation

Initial value:
Attribute('id',
            """ The ID of the tool.o Must be set to "portal_skind"""",
            )
An object that provides skins to a portal object.

O XXX:  This shouldn't derive from ISkinsContainer?

Definition at line 1218 of file _tools.py.


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