2004-11-11 00:25:38 +03:00
|
|
|
/* -*- Mode: idl; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
2004-11-03 22:10:49 +03:00
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/MPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
|
|
|
*
|
|
|
|
* The Original Code is Oracle Corporation code.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Oracle Corporation
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2004
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
2004-11-04 00:48:23 +03:00
|
|
|
#include "nsISupports.idl"
|
|
|
|
|
2004-11-03 22:10:49 +03:00
|
|
|
[scriptable, uuid(5678d4a3-2543-4ece-afbb-079292f2866e)]
|
|
|
|
interface calIDateTime : nsISupports
|
2004-11-11 00:25:38 +03:00
|
|
|
{
|
2004-11-16 03:24:17 +03:00
|
|
|
// returns true if this thing is able to be modified;
|
|
|
|
// if the item is not mutable, attempts to modify
|
|
|
|
// any data will throw CAL_ERROR_ITEM_IS_IMMUTABLE
|
|
|
|
readonly attribute boolean isMutable;
|
2004-11-11 00:25:38 +03:00
|
|
|
|
2004-11-16 03:24:17 +03:00
|
|
|
// makes this item immutable
|
|
|
|
void makeImmutable();
|
2004-11-11 00:25:38 +03:00
|
|
|
|
2004-11-16 03:24:17 +03:00
|
|
|
// clone always returns a mutable event
|
|
|
|
calIDateTime clone();
|
2004-11-11 00:25:38 +03:00
|
|
|
|
|
|
|
// true if this thing is set/valid
|
|
|
|
readonly attribute boolean valid;
|
|
|
|
|
2004-11-16 03:24:17 +03:00
|
|
|
// this thing's base PRTime value, either
|
|
|
|
// as UTC or as local. Setting this
|
|
|
|
// will explode the PRTime value to
|
|
|
|
// year/etc.
|
|
|
|
attribute PRTime nativeTime;
|
2004-11-11 00:25:38 +03:00
|
|
|
|
2004-11-19 05:52:10 +03:00
|
|
|
// also implemented is a jsTime attribute,
|
|
|
|
// for getting/setting a javascript Date object
|
2004-11-03 22:10:49 +03:00
|
|
|
|
|
|
|
// Year, fully exploded (e.g. "1989", "2004")
|
|
|
|
attribute short year;
|
|
|
|
|
|
|
|
// Month, 0-11
|
|
|
|
attribute short month;
|
|
|
|
|
2004-11-16 03:24:17 +03:00
|
|
|
// Day, 1 through whatever XXX - does libical want 1.. or 0..?
|
2004-11-03 22:10:49 +03:00
|
|
|
attribute short day;
|
|
|
|
|
|
|
|
// Hour, 0-23
|
|
|
|
attribute short hour;
|
|
|
|
|
|
|
|
// Minute, 0-59
|
|
|
|
attribute short minute;
|
|
|
|
|
|
|
|
// Second, 0-59
|
|
|
|
attribute short second;
|
|
|
|
|
2004-11-16 03:24:17 +03:00
|
|
|
// whether this thing indicates a time in UTC, or in the local time
|
|
|
|
// zone
|
|
|
|
attribute PRBool isUtc;
|
|
|
|
|
|
|
|
// an associated timezone that's the preferred way of representing
|
2004-11-18 10:06:43 +03:00
|
|
|
// this object. If this is null/empty, then there is no preferred
|
2004-11-16 03:24:17 +03:00
|
|
|
// timezone, and UTC or localtime is assumed (based on isUtc).
|
2004-11-18 10:06:43 +03:00
|
|
|
attribute AUTF8String timezone;
|
2004-11-16 03:24:17 +03:00
|
|
|
|
|
|
|
//
|
|
|
|
// computed values
|
|
|
|
//
|
2004-11-03 22:10:49 +03:00
|
|
|
|
|
|
|
// Day of the week, 0-6, Sunday = 0
|
|
|
|
readonly attribute short weekday;
|
|
|
|
|
|
|
|
// Day of the year, 0-365/366
|
|
|
|
readonly attribute short yearday;
|
|
|
|
|
|
|
|
//
|
|
|
|
// Methods
|
|
|
|
//
|
|
|
|
|
|
|
|
// return a string representation of this date/time
|
|
|
|
// in the current locale
|
|
|
|
AUTF8String toString();
|
|
|
|
|
2004-11-16 03:24:17 +03:00
|
|
|
// normalize and validate the expanded-out values
|
|
|
|
void normalize();
|
|
|
|
|
|
|
|
// sets this thing to a time in the given timezone
|
|
|
|
void setTimeInTimezone (in PRTime aTime, in string aTimezone);
|
|
|
|
|
|
|
|
// gets a new calIDateTime object representing this
|
|
|
|
// item in the given timezone
|
|
|
|
calIDateTime getInTimezone (in string aTimezone);
|
|
|
|
|
2004-11-03 22:10:49 +03:00
|
|
|
//
|
|
|
|
// Some helper getters for calculating useful ranges
|
|
|
|
//
|
|
|
|
|
|
|
|
// the start/end of the current object's week
|
|
|
|
readonly attribute calIDateTime startOfWeek;
|
|
|
|
readonly attribute calIDateTime endOfWeek;
|
|
|
|
|
|
|
|
// the start/end of the current object's month
|
|
|
|
readonly attribute calIDateTime startOfMonth;
|
|
|
|
readonly attribute calIDateTime endOfMonth;
|
|
|
|
|
|
|
|
// the start/end of the current object's year
|
|
|
|
readonly attribute calIDateTime startOfYear;
|
|
|
|
readonly attribute calIDateTime endOfYear;
|
|
|
|
};
|