Back to index

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

import "calIDuration.idl";

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

List of all members.

Public Member Functions

void makeImmutable ()
 Make this calIDuration instance immutable.
calIDuration clone ()
 Clone this calIDuration instance into a new mutable object.
void addDuration (in calIDuration aDuration)
 Add a duration.
long compare (in calIDuration aOther)
 Compare with another duration.
void reset ()
 Reset this duration to 0.
void normalize ()
 Normalize the duration.
AUTF8String toString ()
 Return a string representation of this instance.
void toIcalDuration (in icaldurationtypeptr idt)

Public Attributes

readonly attribute boolean isMutable
 isMutable is true if this instance is modifiable.
attribute boolean isNegative
 Is Negative.
attribute short weeks
 Weeks.
attribute short days
 Days.
attribute short hours
 Hours.
attribute short minutes
 Minutes.
attribute short seconds
 Seconds.
attribute long inSeconds
 total duration in seconds
attribute ACString icalString
 This object as an iCalendar DURATION string.

Detailed Description

Definition at line 44 of file calIDuration.idl.


Member Function Documentation

Add a duration.

Clone this calIDuration instance into a new mutable object.

Compare with another duration.

Parameters:
aOtherto be compared with this object
Returns:
-1, 0, 1 if this < aOther, this == aOther, or this > aOther, respectively.

Make this calIDuration instance immutable.

Normalize the duration.

Reset this duration to 0.

AUTF8String calIDuration::toString ( )

Return a string representation of this instance.


Member Data Documentation

Days.

Definition at line 77 of file calIDuration.idl.

Hours.

Definition at line 82 of file calIDuration.idl.

This object as an iCalendar DURATION string.

Definition at line 138 of file calIDuration.idl.

total duration in seconds

Definition at line 97 of file calIDuration.idl.

isMutable is true if this instance is modifiable.

If isMutable is false, any attempts to modify the object will throw CAL_ERROR_ITEM_IS_MUTABLE.

Definition at line 51 of file calIDuration.idl.

Is Negative.

Definition at line 67 of file calIDuration.idl.

Minutes.

Definition at line 87 of file calIDuration.idl.

Seconds.

Definition at line 92 of file calIDuration.idl.

Weeks.

Definition at line 72 of file calIDuration.idl.


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