Back to index

lightning-sunbird  0.9+nobinonly
calIAlarm.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is Sun Microsytems code.
00015  *
00016  * The Initial Developer of the Original Code is
00017  *   Philipp Kewisch <mozilla@kewis.ch>
00018  * Portions created by the Initial Developer are Copyright (C) 2007
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either the GNU General Public License Version 2 or later (the "GPL"), or
00025  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 
00037 #include "nsISupports.idl"
00038 
00039 interface nsIVariant;
00040 interface nsISimpleEnumerator;
00041 
00042 interface calIDateTime;
00043 interface calIDuration;
00044 interface calIItemBase;
00045 interface calIcalComponent;
00046 
00047 [scriptable, uuid(b8db7c7f-c168-4e11-becb-f26c1c4f5f8f)]
00048 interface calIAlarm : nsISupports
00049 {
00053     readonly attribute boolean isMutable;
00054 
00058     void makeImmutable();
00059 
00063     calIAlarm clone();
00064 
00068     attribute calIItemBase item;
00069 
00079     attribute AUTF8String action;
00080 
00087     attribute calIDuration offset;
00088 
00095     attribute calIDateTime alarmDate;
00096 
00102     attribute unsigned long related;
00103 
00108     const unsigned long ALARM_RELATED_START = 0;
00109 
00114     const unsigned long ALARM_RELATED_END = 1;
00115 
00119     attribute calIDateTime lastAck;
00120 
00128     attribute unsigned long repeat;
00129 
00136     attribute calIDuration repeatOffset;
00137 
00142     readonly attribute calIDateTime repeatDate;
00143 
00147     attribute AUTF8String description;
00148 
00152     attribute AUTF8String summary;
00153 
00157     // TODO void addAttendee(in AUTF8String aAttendee);
00158     // TODO void deleteAttendee(in AUTF8String aAttendee);
00159 
00166     // TODO void addAttachment(in AUTF8String aAttachment);
00167     // TODO void deleteAttachment(in AUTF8String aAttachment);
00168 
00172     attribute AUTF8String icalString;
00173 
00177     attribute calIcalComponent icalComponent;
00178 
00179     // Property bag
00180     boolean hasProperty(in AUTF8String name);
00181     nsIVariant getProperty(in AUTF8String name);
00182     void setProperty(in AUTF8String name, in nsIVariant value);
00183     void deleteProperty(in AUTF8String name);
00184 
00185     readonly attribute nsISimpleEnumerator propertyEnumerator;
00186 
00187 };