Methods
|
|
__init__
getProductHelp
registerBaseClass
registerClass
registerHelp
registerHelpTitle
registerHelpTopic
registerZClass
|
|
__init__
|
__init__ (
self,
product,
app,
package,
)
|
|
getProductHelp
|
getProductHelp ( self )
Returns the ProductHelp associated with the current Product.
|
|
registerBaseClass
|
registerBaseClass (
self,
base_class,
meta_type=None,
)
|
|
registerClass
|
registerClass (
self,
instance_class=None,
meta_type='',
permission=None,
constructors=(),
icon=None,
permissions=None,
legacy=(),
)
Register a constructor
Keyword arguments are used to provide meta data:
- instance_class
The class of the object that will be created.
This is not currently used, but may be used in the future to
increase object mobility.
- meta_type
The kind of object being created
This appears in add lists. If not specified, then the class
meta_type will be used.
- permission
The permission name for the constructors.
If not specified, then a permission name based on the
meta type will be used.
- constructors
A list of constructor methods
A method can me a callable object with a __name__
attribute giving the name the method should have in the
product, or the method may be a tuple consisting of a
name and a callable object. The method must be picklable.
The first method will be used as the initial method called
when creating an object.
- icon
The name of an image file in the package to
be used for instances. Note that the class icon
attribute will be set automagically if an icon is
provided.
- permissions
Additional permissions to be registered
If not provided, then permissions defined in the
class will be registered.
- legacy
A list of legacy methods to be added to ObjectManager
for backward compatibility
|
|
registerHelp
|
registerHelp (
self,
directory='help',
clear=1,
)
Registers Help Topics for all objects in a directory.
Nothing will be done if the files in the directory haven't
changed since the last registerHelp call.
clear indicates whether or not to delete all existing
Topics from the Product.
HelpTopics are created for these kind of files
- .dtml
DTMLHelpTopic
.html .htm -- TextHelpTopic
.stx .txt -- STXHelpTopic
.jpg .png .gif -- ImageHelpTopic
.py -- APIHelpTopic
|
|
registerHelpTitle
|
registerHelpTitle ( self, title )
Sets the title of the Product's Product Help
|
|
registerHelpTopic
|
registerHelpTopic (
self,
id,
topic,
)
Register a Help Topic for a product.
|
|
registerZClass
|
registerZClass (
self,
Z,
meta_type=None,
)
|
|