gecko-dev/calendar/base/public/calICalendarViewController.idl

91 lines
3.4 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** 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 calendar views.
*
* The Initial Developer of the Original Code is
* Oracle Corporation
* Portions created by the Initial Developer are Copyright (C) 2001
* 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 ***** */
#include "nsISupports.idl"
interface calICalendar;
interface calIDateTime;
interface calIEvent;
interface calIItemBase;
[scriptable, uuid(1f783898-f4c2-4b2d-972e-360e0de38237)]
interface calICalendarViewController : nsISupports
{
/**
* Create an event, with an optional start time and optional end
* time in the given Calendar. The Calendar will be the
* displayCalendar set on the View which invokes this method
* on the controller.
*
* If neither aStartTime or aEndTime are given, the user wants to
* create a generic event with no information prefilled.
*
* If aStartTime is given and is a date, the user wants to
* create an all day event, optionally a multi-all-day event if
* aEndTime is given (and is also a date).
*
* If aStartTime is given and is a time, but no aEndTime is
* given, the user wants to create an event starting at
* aStartTime and of the default duration.
*
* If both aStartTime and aEndTime are given as times, then
* the user wants to create an event going from aStartTime
* to aEndTime.
*/
void createNewEvent (in calICalendar aCalendar,
in calIDateTime aStartTime,
in calIDateTime aEndTime);
/**
* Modify aOccurrence. If aNewStartTime and aNewEndTime are given,
* update the event to those times. Otherwise ask the user to modify.
*/
void modifyOccurrence (in calIItemBase aOccurrence,
in calIDateTime aNewStartTime,
in calIDateTime aNewEndTime);
/**
* Delete the given event. This should prompt whether to delete
* just this occurrence or all occurrences, and do whatever else
* is appropriate.
*/
void deleteOccurrence (in calIItemBase aOccurrence);
};