Back to index

lightning-sunbird  0.9+nobinonly
nsIImportABDescriptor.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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 mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or 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 /*
00039 
00040   Interface for importing mail - ui provided by the import module.  If
00041   you wish to provide your own UI then implement the nsIImportGeneric
00042   interface.
00043 
00044   Can I get an attribute set method to take a const value???
00045   
00046  */
00047 
00048 #include "nsISupports.idl"
00049 
00050 interface nsIFileSpec;
00051 
00052 [scriptable, uuid(9c1774e0-3538-11d3-a206-00a0cc26da63)]
00053 interface nsIImportABDescriptor : nsISupports
00054 {      
00055        /*
00056               use the following 2 attributes however you'd like to
00057               refer to a specific address book
00058        */
00059        attribute unsigned long            identifier;
00060        attribute unsigned long                   ref;
00061        
00062        /*
00063               Doesn't have to be accurate, this is merely used to report progress.
00064               If you're importing a file, using file size and reporting progress
00065               as the number of bytes processed so far makes sense.  For other formats
00066               returning the number of records may make more sense.  
00067        */
00068        attribute unsigned long                   size;
00069        
00070        /*
00071               The preferred name for this address book.  Depending upon how the 
00072               user selected import, the caller of the nsIImportAddressBooks interface
00073               may use this name to create the destination address book or it may
00074               ignore it.  However, this must be provided in all cases as it is
00075               also displayed in the UI to the user.
00076        */
00077        wstring       GetPreferredName();
00078        void   SetPreferredName( [const] in wstring name);
00079        
00080        /*
00081               For address books that want a file descriptor to locate the address book.
00082               For formats that do not, use identifier & ref to refer to the address book
00083               OR implement your own nsIImportABDescriptor that contains additional data
00084               necessary to identify specific address books,
00085        */
00086        
00087        readonly attribute nsIFileSpec     fileSpec;
00088        
00089        /*
00090               Set by the UI to indicate whether or not this address book should be imported.
00091        */
00092        attribute boolean                         import;
00093 };
00094        
00095 
00096 
00097 %{ C++
00098 
00099 /*
00100        The default implementation can be obtained from
00101        nsIImportService::CreateNewABDescriptor();
00102        
00103        You should only be interested in using this class if you implement
00104        the nsIImportAddressBooks interface in which case, just using the service to
00105        create new ones should work fine for you.  If not, implement your
00106        own.
00107 */
00108 
00109 %}