Back to index

lightning-sunbird  0.9+nobinonly
calICalendarSearchProvider.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 Microsystems code.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Sun Microsystems, Inc.
00018  * Portions created by the Initial Developer are Copyright (C) 2007
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Daniel Boelzle <daniel.boelzle@sun.com>
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 
00040 interface calIOperation;
00041 interface calIGenericOperationListener;
00042 
00043 [scriptable, uuid(306DA1C9-DB54-4ef3-B27E-FEA709F638FF)]
00044 interface calICalendarSearchProvider : nsISupports
00045 {
00049     const unsigned long HINT_EXACT_MATCH = 1;
00050 
00051     /* ...possibly more to come... */
00052 
00069     calIOperation searchForCalendars(in AUTF8String aString,
00070                                      in unsigned long aHints,
00071                                      in unsigned long aMaxResults,
00072                                      in calIGenericOperationListener aListener);
00073 };
00074 
00080 [scriptable, uuid(2F2055CA-F558-4dc8-A1D4-11384A00E85C)]
00081 interface calICalendarSearchService : calICalendarSearchProvider
00082 {
00086     void getProviders(out PRUint32 aCount,
00087                       [array, size_is(aCount), retval] out calICalendarSearchProvider aProviders);
00088 
00092     void addProvider(in calICalendarSearchProvider aProvider);
00093 
00097     void removeProvider(in calICalendarSearchProvider aProvider);
00098 };