Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
calIIcalProperty Interface Reference

import "calIICSService.idl";

Inheritance diagram for calIIcalProperty:
Inheritance graph
[legend]
Collaboration diagram for calIIcalProperty:
Collaboration graph
[legend]

List of all members.

Public Member Functions

AUTF8String toString ()
 Return a string representation of this instance.
AUTF8String getParameter (in AUTF8String paramname)
void setParameter (in AUTF8String paramname, in AUTF8String paramval)
AUTF8String getFirstParameterName ()
AUTF8String getNextParameterName ()
void removeParameter (in AUTF8String paramname)
 This does not work with X-PARAMETERS, due to limitations in libical.
void clearXParameters ()
icalpropertyptr getIcalProperty ()
icalcomponentptr getIcalComponent ()
 Returns the icalcompoment this property belongs to.

Public Attributes

readonly attribute AUTF8String icalString
 The whole property as an ical string.
attribute AUTF8String value
 The value of the property as string.
attribute AUTF8String valueAsIcalString
 The value of the property in (escaped) ical format.
attribute calIDateTime valueAsDatetime
 The value of the property as date/datetime value, keeping track of the used timezone referenced in the owning component.
readonly attribute AUTF8String propertyName

Detailed Description

Definition at line 194 of file calIICSService.idl.


Member Function Documentation

Returns the icalcompoment this property belongs to.

Please note that the returned object is a raw pointer to the appropriate component and is owned by libical.

AUTF8String calIIcalProperty::getParameter ( in AUTF8String  paramname)
void calIIcalProperty::removeParameter ( in AUTF8String  paramname)

This does not work with X-PARAMETERS, due to limitations in libical.

You have to use clearXParameters() and then rebuild the ones you wanted to preserve. Sorry about that.

void calIIcalProperty::setParameter ( in AUTF8String  paramname,
in AUTF8String  paramval 
)
AUTF8String calIIcalProperty::toString ( )

Return a string representation of this instance.


Member Data Documentation

The whole property as an ical string.

Exceptions:
Anylibical error will be thrown as an calIError::ICS_ error.

Definition at line 200 of file calIICSService.idl.

Definition at line 227 of file calIICSService.idl.

The value of the property as string.

The exception for properties of TEXT or X- type, those will be unescaped when getting, and also expects an unescaped string when setting. Datetime, numeric and other non-text types are represented as ical string

Definition at line 213 of file calIICSService.idl.

The value of the property as date/datetime value, keeping track of the used timezone referenced in the owning component.

Definition at line 224 of file calIICSService.idl.

The value of the property in (escaped) ical format.

Definition at line 218 of file calIICSService.idl.


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