vobject.icalendar.VEvent

Package vobject :: Module icalendar :: Class VEvent

[show private | hide private]

Type VEvent

   object --+        
            |        
     Behavior --+    
                |    
RecurringBehavior --+
                    |
                   VEvent

Event behavior.

Method Summary
	`validate(cls, obj, raiseException, args)` (Class method)*
Inherited from RecurringBehavior
	`generateImplicitParameters(obj)` Generate a UID if one does not exist. (Static method)
	`transformFromNative(obj)` (Static method)
	`transformToNative(obj)` Turn a recurring Component into a RecurringComponent. (Static method)
Inherited from Behavior
	`__init__(self)`
	`decode(cls, line)` (Class method)
	`encode(cls, line)` (Class method)
	`lineValidate(cls, line, raiseException, complainUnrecognized)` Examine a line's parameters and values, return True if valid. (Class method)
	`serialize(cls, obj, buf, lineLength)` Set implicit parameters, do encoding, return unicode string. (Class method)
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Class Variable Summary
`str`	`description`: A brief excerpt from the RFC explaining the function of the component or line.
`dict`	`knownChildren`: A dictionary with uppercased component/property names as keys and a tuple (min, max, id) as value, where id is the id used by `registerBehavior`, min and max are the limits on how many of this child must occur.
`str`	`name`: The uppercase name of the object described by the class, or a generic name if the class defines behavior for many objects.
`list`	`sortFirst`: The lower-case list of children which should come first when sorting.
Inherited from RecurringBehavior
`bool`	`hasNative`: A boolean describing whether the object can be transformed into a more Pythonic object.
`bool`	`isComponent`: A boolean, True if the object should be a Component.
Inherited from Behavior
`bool`	`allowGroup`: Whether or not vCard style group prefixes are allowed.
`bool`	`quotedPrintable`: A boolean describing whether the object should be encoded and decoded using quoted printable line folding and character escaping.
`str`	`versionString`: The string associated with the component, for instance, 2.0 if there's a line like VERSION:2.0, an empty string otherwise.

Class Variable Details

description

A brief excerpt from the RFC explaining the function of the component or line.

Type:: str
Value:: 'A grouping of component properties, and possibly including \ "VALARM" calendar components, that represents a scheduled \ amount of time on a calendar.'

knownChildren

A dictionary with uppercased component/property names as keys and a tuple (min, max, id) as value, where id is the id used by registerBehavior, min and max are the limits on how many of this child must occur. None is used to denote no max or no id.

Type:: dict
Value:: {'ATTACH': (0, None, None), 'ATTENDEE': (0, None, None), 'CATEGORIES': (0, None, None), 'CLASS': (0, 1, None), 'COMMENT': (0, None, None), 'CONTACT': (0, None, None), 'CREATED': (0, 1, None), 'DESCRIPTION': (0, 1, None), ...

name

The uppercase name of the object described by the class, or a generic name if the class defines behavior for many objects.

Type:: str
Value:: 'VEVENT'

sortFirst

The lower-case list of children which should come first when sorting.

Type:: list
Value:: ('uid', 'recurrence-id', 'dtstart', 'duration', 'dtend')

Generated by Epydoc 2.1 on Fri Dec 14 17:25:14 2007

http://epydoc.sf.net