Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
calIIcsParser Interface Reference

An interface for parsing an ics string or stream into its items. More...

import "calIIcsParser.idl";

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

List of all members.

Public Member Functions

void parseString (in AString aICSString, in calITimezoneProvider aTzProvider)
 Parse an ics string into its items, and store top-level properties and components that are not interpreted.
void parseFromStream (in nsIInputStream aStream, in calITimezoneProvider aTzProvider)
 Parse an input stream.
void getItems (out PRUint32 aCount,[array, size_is(aCount), retval] out calIItemBase aItems)
 Get the items that were in the string or stream.
void getParentlessItems (out PRUint32 aCount,[array, size_is(aCount), retval] out calIItemBase aItems)
 Get the parentless items that may have occurred, i.e.
void getProperties (out PRUint32 aCount,[array, size_is(aCount), retval] out calIIcalProperty aProperties)
 Get the top-level properties that were not interpreted as anything special.
void getComponents (out PRUint32 aCount,[array, size_is(aCount), retval] out calIIcalComponent aComponents)
 Get the top-level components that were not interpreted as anything special.

Detailed Description

An interface for parsing an ics string or stream into its items.

Note that this is not a service. A new instance must be created for every new string or stream to be parsed.

Definition at line 52 of file calIIcsParser.idl.


Member Function Documentation

void calIIcsParser::getComponents ( out PRUint32  aCount,
[array, size_is(aCount), retval] out calIIcalComponent  aComponents 
)

Get the top-level components that were not interpreted as anything special.

Parameters:
aCountWill hold the number of components that were found
aComponentsThe components
void calIIcsParser::getItems ( out PRUint32  aCount,
[array, size_is(aCount), retval] out calIItemBase  aItems 
)

Get the items that were in the string or stream.

In case an item represents a recurring series, the (unexpanded) parent item is returned only. Please keep in mind that any parentless items (see below) are not contained in the returned set of items.

Parameters:
aCountWill hold the number of items that were parsed
aItemsThe items
void calIIcsParser::getParentlessItems ( out PRUint32  aCount,
[array, size_is(aCount), retval] out calIItemBase  aItems 
)

Get the parentless items that may have occurred, i.e.

overridden items of a recurring series (having a RECURRENCE-ID) missing their parent item in the parsed content.

Parameters:
aCountWill hold the number of items that were parsed
aItemsThe items
void calIIcsParser::getProperties ( out PRUint32  aCount,
[array, size_is(aCount), retval] out calIIcalProperty  aProperties 
)

Get the top-level properties that were not interpreted as anything special.

Parameters:
aCountWill hold the number of properties that were found
aPropertiesThe properties

Parse an input stream.

See also:
parseString
Parameters:
aICSStringThe stream to parse
aTzProviderThe timezone provider used to resolve timezones not contained in the parent VCALENDAR or null (falls back to timezone service)
void calIIcsParser::parseString ( in AString  aICSString,
in calITimezoneProvider  aTzProvider 
)

Parse an ics string into its items, and store top-level properties and components that are not interpreted.

Parameters:
aICSStringThe ICS string to parse
aTzProviderThe timezone provider used to resolve timezones not contained in the parent VCALENDAR or null (falls back to timezone service)

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