Back to index

plone3  3.1.7
Public Member Functions | Static Public Attributes
icalendar.interfaces.ITodo Class Reference
Inheritance diagram for icalendar.interfaces.ITodo:
Inheritance graph
[legend]
Collaboration diagram for icalendar.interfaces.ITodo:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __setitem__
def set_inline
def add
def add_component
def from_string
def __getitem__
def decoded
def get_inline
def as_string
def walk
def property_items

Static Public Attributes

tuple subcomponents = Attribute(""" A list of all subcomponents of this component, added using add_component()""")
tuple name = Attribute(""" Name of this component (VEVENT, etc) """)

Detailed Description

A component which conforms to an iCalendar VTODO.

Definition at line 135 of file interfaces.py.


Member Function Documentation

def icalendar.interfaces.IComponent.__getitem__ (   name) [inherited]
Get a property

name - case insensitive name

Returns an iCalendar property object such as vText.

Definition at line 74 of file interfaces.py.

00074 
00075     def __getitem__(name):
00076         """Get a property
00077 
00078         name - case insensitive name
00079 
00080         Returns an iCalendar property object such as vText.
00081         """

Here is the caller graph for this function:

def icalendar.interfaces.IComponent.__setitem__ (   name,
  value 
) [inherited]
Set a property.

name - case insensitive name
value - value of the property to set. This can be either a single
item or a list.

Some iCalendar properties are set INLINE; these properties
have multiple values on one property line in the iCalendar
representation.  The list can be supplied as a comma separated
string to __setitem__. If special iCalendar characters exist in
an entry, such as the colon (:) and (,), that comma-separated
entry needs to be quoted with double quotes. For example:

'foo, bar, "baz:hoi"'

See also set_inline() for an easier way to deal with this case.

Definition at line 24 of file interfaces.py.

00024 
00025     def __setitem__(name, value):
00026         """Set a property.
00027 
00028         name - case insensitive name
00029         value - value of the property to set. This can be either a single
00030         item or a list.
00031 
00032         Some iCalendar properties are set INLINE; these properties
00033         have multiple values on one property line in the iCalendar
00034         representation.  The list can be supplied as a comma separated
00035         string to __setitem__. If special iCalendar characters exist in
00036         an entry, such as the colon (:) and (,), that comma-separated
00037         entry needs to be quoted with double quotes. For example:
00038 
00039         'foo, bar, "baz:hoi"'
00040 
00041         See also set_inline() for an easier way to deal with this case.
00042         """

Here is the caller graph for this function:

def icalendar.interfaces.IComponent.add (   name,
  value 
) [inherited]
Add a property. Can be called multiple times to set a list.

name - case insensitive name
value - value of property to set or add to list for this property.

Definition at line 54 of file interfaces.py.

00054 
00055     def add(name, value):
00056         """Add a property. Can be called multiple times to set a list.
00057 
00058         name - case insensitive name
00059         value - value of property to set or add to list for this property.
00060         """

Here is the caller graph for this function:

def icalendar.interfaces.IComponent.add_component (   component) [inherited]
Add a nested subcomponent to this component.

Definition at line 61 of file interfaces.py.

00061 
00062     def add_component(component):
00063         """Add a nested subcomponent to this component.
00064         """

Render the component in the RFC 2445 (iCalendar) format.

Returns a string in RFC 2445 format.

Definition at line 102 of file interfaces.py.

00102 
00103     def as_string():
00104         """Render the component in the RFC 2445 (iCalendar) format.
00105 
00106         Returns a string in RFC 2445 format.
00107         """

def icalendar.interfaces.IComponent.decoded (   name,
  default = _marker 
) [inherited]
Get a property as a python object.

name - case insensitive name
default - optional argument. If supplied, will use this if
name cannot be found. If not supplied, decoded will raise a
KeyError if name cannot be found.

Returns python object (such as unicode string, datetime, etc).

Definition at line 82 of file interfaces.py.

00082 
00083     def decoded(name, default=_marker):
00084         """Get a property as a python object.
00085 
00086         name - case insensitive name
00087         default - optional argument. If supplied, will use this if
00088         name cannot be found. If not supplied, decoded will raise a
00089         KeyError if name cannot be found.
00090 
00091         Returns python object (such as unicode string, datetime, etc).
00092         """

def icalendar.interfaces.IComponent.from_string (   st,
  multiple = False 
) [inherited]
Populates the component recursively from a iCalendar string.

Reads the iCalendar string and constructs components and
subcomponents out of it.

Definition at line 66 of file interfaces.py.

00066 
00067     def from_string(st, multiple=False):
00068         """Populates the component recursively from a iCalendar string.
00069 
00070         Reads the iCalendar string and constructs components and
00071         subcomponents out of it.
00072         """

def icalendar.interfaces.IComponent.get_inline (   name,
  decode = 1 
) [inherited]
Get list of INLINE values from property.

name - case insensitive name
decode - decode to Python objects.

Returns list of python objects.

Definition at line 93 of file interfaces.py.

00093 
00094     def get_inline(name, decode=1):
00095         """Get list of INLINE values from property.
00096 
00097         name - case insensitive name
00098         decode - decode to Python objects.
00099 
00100         Returns list of python objects.
00101         """

Return properties as (name, value) tuples.

Returns all properties in this comopnent and subcomponents as
name, value tuples.

Definition at line 124 of file interfaces.py.

00124 
00125     def property_items():
00126         """Return properties as (name, value) tuples.
00127 
00128         Returns all properties in this comopnent and subcomponents as
00129         name, value tuples.
00130         """

def icalendar.interfaces.IComponent.set_inline (   name,
  values,
  encode = 1 
) [inherited]
Set list of INLINE values for property.

Converts a list of values into valid iCalendar comma seperated
string and sets value to that.

name - case insensitive name of property
values - list of values to set
encode - if True, encode Python values as iCalendar types first.

Definition at line 43 of file interfaces.py.

00043 
00044     def set_inline(name, values, encode=1):
00045         """Set list of INLINE values for property.
00046 
00047         Converts a list of values into valid iCalendar comma seperated
00048         string and sets value to that.
00049 
00050         name - case insensitive name of property
00051         values - list of values to set
00052         encode - if True, encode Python values as iCalendar types first.
00053         """

def icalendar.interfaces.IComponent.walk (   name = None) [inherited]
Recursively traverses component and subcomponents.

name - optional, if given, only return components with that name

Returns sequence of components.

Definition at line 116 of file interfaces.py.

00116 
00117     def walk(name=None):
00118         """Recursively traverses component and subcomponents.
00119 
00120         name - optional, if given, only return components with that name
00121 
00122         Returns sequence of components.
00123         """


Member Data Documentation

tuple icalendar.interfaces.IComponent.name = Attribute(""" Name of this component (VEVENT, etc) """) [static, inherited]

Definition at line 112 of file interfaces.py.

tuple icalendar.interfaces.IComponent.subcomponents = Attribute(""" A list of all subcomponents of this component, added using add_component()""") [static, inherited]

Definition at line 108 of file interfaces.py.


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