Back to index

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

import "calIPrintFormatter.idl";

Inheritance diagram for calIPrintFormatter:
Inheritance graph
Collaboration diagram for calIPrintFormatter:
Collaboration graph

List of all members.

Public Member Functions

void formatToHtml (in nsIOutputStream aStream, in calIDateTime aStart, in calIDateTime aEnd, in unsigned long aCount,[array, size_is(aCount)] in calIItemBase aItems, in AString aTitle)
 Format the items into the stream, as html code.

Public Attributes

readonly attribute AString name
 The name of this layout.

Detailed Description

Definition at line 46 of file calIPrintFormatter.idl.

Member Function Documentation

void calIPrintFormatter::formatToHtml ( in nsIOutputStream  aStream,
in calIDateTime  aStart,
in calIDateTime  aEnd,
in unsigned long  aCount,
[array, size_is(aCount)] in calIItemBase  aItems,
in AString  aTitle 

Format the items into the stream, as html code.

May assume that all the items are inside the given daterange. The user requested to show all the days in the daterange, so unless there is a special reason, all the days should be shown. aStart and aEnd may be null, in which case the implementation can show the minimal days needed to show all the events. It can skip months without events, for example.

aStreamthe stream to put the html data into
aStartthe first date that should be printed
aEndthe last date that should be printed
aCountthe number of items being printed
aItemsthe items to print
aTitlea title for the HTML page

Member Data Documentation

The name of this layout.

Implementers should make sure this string is localizable, ie uses nsIStringBundle

Definition at line 52 of file calIPrintFormatter.idl.

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