Back to index

plone3  3.1.7
Public Member Functions
CMFEditions.interfaces.IModifier.IConditionalModifier Class Reference
Inheritance diagram for CMFEditions.interfaces.IModifier.IConditionalModifier:
Inheritance graph
[legend]
Collaboration diagram for CMFEditions.interfaces.IModifier.IConditionalModifier:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def edit
def isApplicable
def isEnabled
def getModifier

Detailed Description

A modifier with a condition.

The modifiers get only called if it is enabled and if a possibly 
existing implicit condition evaluates to a true value.

Definition at line 195 of file IModifier.py.


Constructor & Destructor Documentation

def CMFEditions.interfaces.IModifier.IConditionalModifier.__init__ (   id,
  modifier,
  title = '' 
)
A modifier with a condition.

The modifiers get only called if it is enabled and if a possibly 
existing implicit condition evaluates to a true value.
Initialize with a modifier.

The conditional modifier is disabled by default.

Definition at line 202 of file IModifier.py.

00202 
00203     def __init__(id, modifier, title=''):
00204         """Initialize with a modifier.
00205         
00206         The conditional modifier is disabled by default.
00207         """
        

Member Function Documentation

Modifies an existing conditional modifier.

None values leave the respective parameter unchanged.

Definition at line 208 of file IModifier.py.

00208 
00209     def edit(enabled=None):
00210         """Modifies an existing conditional modifier.
00211         
00212         None values leave the respective parameter unchanged.
00213         """
        

Here is the caller graph for this function:

Returns the modifier.

Definition at line 225 of file IModifier.py.

00225 
00226     def getModifier():
00227         """Returns the modifier.
00228         """
    
Returns True if the modifier is applicable.

A modifier is applicable if it is enabled and if an additional
condition evaluates to a true value.

Definition at line 214 of file IModifier.py.

00214 
00215     def isApplicable(obj, portal=None):
00216         """Returns True if the modifier is applicable.
00217         
00218         A modifier is applicable if it is enabled and if an additional
00219         condition evaluates to a true value.
00220         """
        
Returns the enable status.

Definition at line 221 of file IModifier.py.

00221 
00222     def isEnabled():
00223         """Returns the enable status.
00224         """
        

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