Back to index

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

An interface for view widgets containing calendaring data. More...

import "calICalendarView.idl";

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

List of all members.

Public Member Functions

void showDate (in calIDateTime aDate)
 Ensure that the given date is visible; the view is free to show more dates than the given date (e.g.
void setDateRange (in calIDateTime aStartDate, in calIDateTime aEndDate)
 Set a date range for the view to display, from aStartDate to aEndDate, inclusive.
void setDateList (in unsigned long aCount,[array, size_is(aCount)] in calIDateTime aDates)
 Set a disjoint date list for this view to show.
void getDateList (out unsigned long aCount,[array, size_is(aCount), retval] out calIDateTime aDates)
 Returns the list of dates being shown by this calendar.
void getSelectedItems (out unsigned long aCount,[array, size_is(aCount), retval] out calIItemBase aItems)
 Get the items currently selected in this view.
void setSelectedItems (in unsigned long aCount,[array, size_is(aCount)] in calIItemBase aItems, in boolean aSuppressEvent)
 Select an array of items in the view.
void centerSelectedItems ()
 Make as many of the selected items as possible are visible in the view.

Public Attributes

attribute calICalendar displayCalendar
 the calendar that this view is displaying
attribute
calICalendarViewController 
controller
 the controller for this view
readonly attribute calIDateTime startDate
 The start date of the view's display.
readonly attribute calIDateTime endDate
 The end date of the view's display.
readonly attribute boolean supportsDisjointDates
 True if this view supports disjoint dates.
readonly attribute boolean hasDisjointDates
 True if this view currently has a disjoint date set.
attribute calIDateTime selectedDay
 Get or set the selected day.
attribute AUTF8String timezone
 Get or set the timezone that the view's elements should be displayed in.

Detailed Description

An interface for view widgets containing calendaring data.

Note:
Code that implements this interface is intended to be pure widgetry and thus not have any preference dependencies. Preferences and pref observers should live in the decorated views.

Definition at line 56 of file calICalendarView.idl.


Member Function Documentation

Make as many of the selected items as possible are visible in the view.

void calICalendarView::getDateList ( out unsigned long  aCount,
[array, size_is(aCount), retval] out calIDateTime  aDates 
)

Returns the list of dates being shown by this calendar.

If a date range is set, it will expand out the date range by day and return the full set.

void calICalendarView::getSelectedItems ( out unsigned long  aCount,
[array, size_is(aCount), retval] out calIItemBase  aItems 
)

Get the items currently selected in this view.

Parameters:
aCounta variable to hold the number of items in this array
Returns:
the array of items currently selected in this.
void calICalendarView::setDateList ( in unsigned long  aCount,
[array, size_is(aCount)] in calIDateTime  aDates 
)

Set a disjoint date list for this view to show.

Throws if supportsDisjointDates is false for this view.

Set a date range for the view to display, from aStartDate to aEndDate, inclusive.

Some views may decide to utilize the time portion of these calIDateTimes; pass in calIDateTimes that are dates if you want to make sure this doesn't happen.

void calICalendarView::setSelectedItems ( in unsigned long  aCount,
[array, size_is(aCount)] in calIItemBase  aItems,
in boolean  aSuppressEvent 
)

Select an array of items in the view.

Items outside the view's current display range will be ignored.

Parameters:
aCountthe number of items to select
aItemsan array of items to select
aSuppressEventif true, the 'itemselect' event will not be fired.

Ensure that the given date is visible; the view is free to show more dates than the given date (e.g.

week view would show the entire week).


Member Data Documentation

the controller for this view

Definition at line 66 of file calICalendarView.idl.

the calendar that this view is displaying

Definition at line 61 of file calICalendarView.idl.

The end date of the view's display.

If the view is displaying disjoint dates, this will be the latest date that's displayed.

Note that this won't be equivalent to the aEndDate passed to setDateRange, because that date isn't actually displayed!

Definition at line 98 of file calICalendarView.idl.

True if this view currently has a disjoint date set.

Definition at line 108 of file calICalendarView.idl.

Get or set the selected day.

Definition at line 153 of file calICalendarView.idl.

The start date of the view's display.

If the view is displaying disjoint dates, this will be the earliest date that's displayed.

Definition at line 89 of file calICalendarView.idl.

True if this view supports disjoint dates.

Definition at line 103 of file calICalendarView.idl.

Get or set the timezone that the view's elements should be displayed in.

Setting this does not refresh the view.

Definition at line 159 of file calICalendarView.idl.


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