vobject.vcard.VCard3

Package vobject :: Module vcard :: Class VCard3_0

[show private | hide private]

Type VCard3_0

object --+        
         |        
  Behavior --+    
             |    
 VCardBehavior --+
                 |
                VCard3_0

vCard 3.0 behavior.

Method Summary
	`generateImplicitParameters(cls, obj)` Create PRODID, VERSION, and VTIMEZONEs if needed. (Class 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)
	`transformFromNative(cls, obj)` Inverse of transformToNative. (Class method)
	`transformToNative(cls, obj)` Turn a ContentLine or Component into a Python-native representation. (Class method)
	`validate(cls, obj, raiseException, complainUnrecognized)` Check if the object satisfies this behavior's requirements. (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.
`bool`	`isComponent`: A boolean, True if the object should be a Component.
`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.
`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.
Inherited from VCardBehavior
`bool`	`allowGroup`: Whether or not vCard style group prefixes are allowed.
Inherited from Behavior
`bool`	`hasNative`: A boolean describing whether the object can be transformed into a more Pythonic object.
`bool`	`quotedPrintable`: A boolean describing whether the object should be encoded and decoded using quoted printable line folding and character escaping.

Class Method Details

generateImplicitParameters(cls, obj)

Create PRODID, VERSION, and VTIMEZONEs if needed.

VTIMEZONEs will need to exist whenever TZID parameters exist or when datetimes with tzinfo exist.

Overrides:: __builtin__.type.generateImplicitParameters

Class Variable Details

description

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

Type:: str
Value:: 'vCard 3.0, defined in rfc2426'

isComponent

A boolean, True if the object should be a Component.

Type:: bool
Value:: True

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:: {'ADR': (0, None, None), 'FN': (1, 1, None), 'LABEL': (0, None, None), 'N': (1, 1, None), 'PRODID': (0, 1, None), 'UID': (0, None, None), 'VERSION': (1, 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:: 'VCARD'

sortFirst

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

Type:: list
Value:: ('version', 'prodid', 'uid')

versionString

The string associated with the component, for instance, 2.0 if there's a line like VERSION:2.0, an empty string otherwise.

Type:: str
Value:: '3.0'

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

http://epydoc.sf.net