Back to index

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

This interface will calculate a week title from a given datetime. More...

import "calIWeekInfoService.idl";

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

List of all members.

Public Member Functions

AString getWeekTitle (in calIDateTime dateTime)
 Return the week title.
calIDateTime getStartOfWeek (in calIDateTime dateTime)
 Gets the first day of a week of a passed day under consideration of the preference setting "calendar.week.start".
calIDateTime getEndOfWeek (in calIDateTime dateTime)
 Gets the last day of a week of a passed day under consideration of the preference setting "calendar.week.start".

Detailed Description

This interface will calculate a week title from a given datetime.

This will depends on the users preferences. Extensions might override the default implementation, in order to generate week titles aimed at special cases (like weeknumbers for a schoolyear)

Definition at line 50 of file calIWeekInfoService.idl.


Member Function Documentation

Gets the last day of a week of a passed day under consideration of the preference setting "calendar.week.start".

Parameters:
aDateThe dateTime to get get the last day of the week for
Returns:
A dateTime-object denoting the last day of the week

Gets the first day of a week of a passed day under consideration of the preference setting "calendar.week.start".

Parameters:
aDateThe dateTime to get get the start of the week for
Returns:
A dateTime-object denoting the first day of the week

Return the week title.

It's meant to be displayed. (Usually, will return a weeknumber, but might return a string like Q1W4)

Parameters:
dateTimeThe dateTime to get the weektitle for
Returns:
A string, representing the week title. Will usually be the week number. Every week (7 days) should get a different string, but the switch from one week to the next isn't necessarily on sunday.

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