vobject.vobject.ContentLine

Package vobject :: Module vobject :: Class ContentLine

[show private | hide private]

Type ContentLine

object --+    
         |    
     VBase --+
             |
            ContentLine

Holds one content line for formats like vCard and vCalendar.

For example:

 <SUMMARY{u'param1' : [u'val1'], u'param2' : [u'val2']}Bastille Day Party>

Method Summary
	`__init__(self, name, params, value, group, encoded, isNative, lineNumber, args, *kwds)` Take output from parseLine, convert params list to dictionary.
	`__eq__(self, other)`
	`__repr__(self)`
	`__str__(self)`
	`prettyPrint(self, level, tabwidth)`
Inherited from VBase
	`autoBehavior(self, cascade)` Set behavior if name is in self.parentBehavior.knownChildren.
	`clearBehavior(self, cascade)` Set behavior to None.
	`getChildren(self)` Return an iterable containing the contents of the object.
	`serialize(self, buf, lineLength, validate)` Serialize to buf if it exists, otherwise return a string.
	`setBehavior(self, behavior, cascade)` Set behavior.
	`transformChildrenFromNative(self, clearBehavior)` Recursively transform native children to vanilla representations.
	`transformChildrenToNative(self)` Recursively replace children with their native representation.
	`transformFromNative(self)` Return self transformed into a ContentLine or Component if needed.
	`transformToNative(self)` Transform this object into a custom VBase subclass.
	`validate(self, args, *kwds)` Call the behavior's validate method, or return True.
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
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value

Instance Variable Summary
	`encoded`: A boolean describing whether the data in the content line is encoded.
	`lineNumber`: An optional line number associated with the contentline.
	`name`: The uppercased name of the contentline.
	`params`: A dictionary of parameters and associated lists of values (the list may be empty for empty parameters).
	`singletonparams`: A list of parameters for which it's unclear if the string represents the parameter name or the parameter value.
	`value`: The value of the contentline.
Inherited from VBase
	`behavior`: The Behavior class associated with this object, which controls validation, transformations, and encoding.
	`group`: An optional group prefix, should be used only to indicate sort order in vCards, according to RFC2426
	`isNative`: Boolean describing whether this component is a Native instance.
	`parentBehavior`: The object's parent's behavior, or None if no behaviored parent exists.

Method Details

init(self, name, params, value, group=None, encoded=False, isNative=False, lineNumber=None, *args, **kwds)
(Constructor)

Take output from parseLine, convert params list to dictionary.

Overrides:: vobject.vobject.VBase.__init__

Instance Variable Details

encoded

A boolean describing whether the data in the content line is encoded. Generally, text read from a serialized vCard or vCalendar should be considered encoded. Data added programmatically should not be encoded.

lineNumber

An optional line number associated with the contentline.

name

The uppercased name of the contentline.

params

A dictionary of parameters and associated lists of values (the list may be empty for empty parameters).

singletonparams

A list of parameters for which it's unclear if the string represents the parameter name or the parameter value. In vCard 2.1, "The value string can be specified alone in those cases where the value is unambiguous". This is crazy, but we have to deal with it.

value

The value of the contentline.

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

http://epydoc.sf.net