Back to index

lightning-sunbird  0.9+nobinonly
calITodo.idl
Go to the documentation of this file.
00001 /* -*- Mode: idl; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Oracle Corporation code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  *  Oracle Corporation
00019  * Portions created by the Initial Developer are Copyright (C) 2004
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "calIItemBase.idl"
00040 
00041 //
00042 // calITodo
00043 //
00044 // An interface for a todo item (analogous to a VTODO)
00045 //
00046 
00047 [scriptable, uuid(522991f2-4928-4cd2-9a02-e3071c58cf1c)]
00048 interface calITodo : calIItemBase
00049 {
00050   const long CAL_TODO_STATUS_NEEDSACTION = 4;
00051   const long CAL_TODO_STATUS_COMPLETED = 5;
00052   const long CAL_TODO_STATUS_INPROCESS = 6;
00053 
00054   // as per the rather broken RFC2445,
00055 
00056   // entryDate maps to DTSTART, which is the day
00057   // this todo shows up on, if set. (optional).
00058   //
00059   // dueDate maps to DUE, which is the day
00060   // this todo is due, if set. (optional).
00061   //
00062   // If neither DUE nor DTSTART are set, then
00063   // the todo appears "today" until it is completed.
00064   //
00065   // The completeDate is the date the todo was completed,
00066   // or null if it hasn't been completed yet.
00067 
00068   attribute calIDateTime entryDate;
00069   attribute calIDateTime dueDate;
00070   attribute calIDateTime completedDate;
00071   attribute short percentComplete;
00072 
00073   // A todo isCompleted if any of the following is true:
00074   // - percentComplete is 100, or
00075   // - completedDate is non-null, or
00076   // - status is COMPLETED.
00077   // Setting isCompleted to true will
00078   // - set percentComplete to 100, and
00079   // - set completedDate to the current time, if it is not already set, and
00080   // - set status to COMPLETED.
00081   // Setting isCompleted to false will remove percentComplete, completedDate,
00082   // and status properties.  (This returns the todo to its state at creation,
00083   // in terms of completion-relevant properties.)
00084   //
00085   // If you would like to take advantage of the full, confusing disaster that
00086   // is the RFC2445 VTODO status state space, you can feel free to set the
00087   // fields individually, instead of setting isCompleted directly.  (And then
00088   // hope that whatever else you're talking to has the same set of rules for
00089   // determining if something is completed or not.)
00090   //
00091   // Setting percentComplete, completedDate, or status individually does not
00092   // affect any of the others at present.  (E.g., setting the percentComplete
00093   // from 100 to 50 doesn't clear completedDate, or change status to
00094   // IN-PROCESS.)  It's not clear that we want any more magic than a simple
00095   // property to control "all complete" vs "not complete in any way".
00096   attribute boolean isCompleted;
00097 
00103   readonly attribute calIDuration duration;
00104 };
00105