Back to index

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

calIDecoratedView is an interface for modifying/extending the standard calICalendarView, typically to add specific navigation functions while removing the unnecessary code duplication this would generally require. More...

import "calIDecoratedView.idl";

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

List of all members.

Public Member Functions

void getSelectedItems (out unsigned long aCount,[array, size_is(aCount), retval] out calIItemBase aItems)
 See calICalendarView.idl for the description of these functions.
void setSelectedItems (in unsigned long aCount,[array, size_is(aCount)] in calIItemBase aItems, in boolean aSuppressEvent)
void goToDay (in calIDateTime aDate)
 Ensures that the given date is visible, and that the view is centered around this date.
void moveView (in long aNumber)
 Moves the view a specific number of pages.
AString getRangeDescription ()
 gets the description of the range displayed by the view

Public Attributes

readonly attribute AUTF8String observerID
 Oftentimes other elements in the DOM in which a calIDecoratedView is used want to be aware of whether or not the view is selected.
readonly attribute boolean initialized
 Generally corresponds to whether or not the view has been previously shown.
attribute calICalendar displayCalendar
 The displayCalendar of the embedded calICalendarView.
attribute
calICalendarViewController 
controller
 The controller of the calICalendarView that is embedded.
attribute boolean workdaysOnly
 If this is set to 'true', the view should not display days specified to be non-workdays.
attribute boolean tasksInView
 Whether or not tasks are to be displayed in the calICalendarView.
attribute boolean rotated
 If set, the view will be rotated (i.e time on top, date at left)
attribute boolean showCompleted
 Whether or not completed tasks are shown in the calICalendarView.
readonly attribute calIDateTime selectedDay
 The selectedDay in the embedded view.
readonly attribute calIDateTime startDay
 The first day shown in the embedded view.
readonly attribute calIDateTime endDay
 The last day shown in the embedded view.
attribute AUTF8String timezone
 Get or set the timezone that the view's elements should be displayed in.

Detailed Description

calIDecoratedView is an interface for modifying/extending the standard calICalendarView, typically to add specific navigation functions while removing the unnecessary code duplication this would generally require.

Because it contains a calICalendarView as an anonymous node, not easily accessible, it must therefore expose several of that interface's methods and attributes, as well as its own.

Note:
Implementations of this interface are intended to be the home for view preference handling. The lower-level views (ie implementers of calICalendarView) are intended to be pure widgetry, and this sort of view should be pluggable, meaning that callers shouldn't need to know about view-specific preferences.

Definition at line 63 of file calIDecoratedView.idl.


Member Function Documentation

gets the description of the range displayed by the view

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

See calICalendarView.idl for the description of these functions.

Ensures that the given date is visible, and that the view is centered around this date.

aDate becomes the selectedDay of the view. Calling this function with the current selectedDay effectively refreshes the view

Parameters:
aDatethe date that must be shown in the view and becomes the selected day

Moves the view a specific number of pages.

Negative numbers correspond to moving the view backwards. Note that it is up to the view to determine how the selected day ought to move as well.

Parameters:
aNumberthe number of pages to move the view
void calIDecoratedView::setSelectedItems ( in unsigned long  aCount,
[array, size_is(aCount)] in calIItemBase  aItems,
in boolean  aSuppressEvent 
)

Member Data Documentation

The controller of the calICalendarView that is embedded.

Definition at line 89 of file calIDecoratedView.idl.

The displayCalendar of the embedded calICalendarView.

This must be set prior to calling goToDay the first time.

Definition at line 84 of file calIDecoratedView.idl.

The last day shown in the embedded view.

Definition at line 136 of file calIDecoratedView.idl.

Generally corresponds to whether or not the view has been previously shown.

Strictly speaking, it reports whether displayCalendar, startDay and endDay are all non-null.

Definition at line 78 of file calIDecoratedView.idl.

Oftentimes other elements in the DOM in which a calIDecoratedView is used want to be aware of whether or not the view is selected.

An element whose ID is observerID can be included in that DOM, and will be set to be enabled or disabled depending on whether the view is selected.

Definition at line 71 of file calIDecoratedView.idl.

If set, the view will be rotated (i.e time on top, date at left)

Definition at line 106 of file calIDecoratedView.idl.

The selectedDay in the embedded view.

Use the goToDay function to set a particular day to be selected.

Definition at line 126 of file calIDecoratedView.idl.

Whether or not completed tasks are shown in the calICalendarView.

Definition at line 111 of file calIDecoratedView.idl.

The first day shown in the embedded view.

Definition at line 131 of file calIDecoratedView.idl.

Whether or not tasks are to be displayed in the calICalendarView.

Definition at line 101 of file calIDecoratedView.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 142 of file calIDecoratedView.idl.

If this is set to 'true', the view should not display days specified to be non-workdays.

The implementor is responsible for obtaining what those days are on its own.

Definition at line 96 of file calIDecoratedView.idl.


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