Back to index

lightning-sunbird  0.9+nobinonly
nsImportABDescriptor.h
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 #ifndef nsImportABDescriptor_h___
00039 #define nsImportABDescriptor_h___
00040 
00041 #include "nscore.h"
00042 #include "nsString.h"
00043 #include "nsReadableUtils.h"
00044 #include "nsIImportABDescriptor.h"
00045 #include "nsIFileSpec.h"
00046 
00048 
00049 
00050 class nsImportABDescriptor : public nsIImportABDescriptor
00051 {
00052 public: 
00053        NS_DECL_ISUPPORTS
00054 
00055        NS_IMETHOD    GetIdentifier( PRUint32 *pIdentifier) { *pIdentifier = m_id; return( NS_OK);}
00056        NS_IMETHOD    SetIdentifier( PRUint32 ident) { m_id = ident; return( NS_OK);}
00057        
00058        /* attribute unsigned long ref; */
00059        NS_IMETHOD    GetRef( PRUint32 *pRef) { *pRef = m_ref; return( NS_OK);}
00060        NS_IMETHOD    SetRef( PRUint32 ref) { m_ref = ref; return( NS_OK);}
00061        
00062        /* attribute unsigned long size; */
00063        NS_IMETHOD    GetSize( PRUint32 *pSize) { *pSize = m_size; return( NS_OK);}
00064        NS_IMETHOD    SetSize( PRUint32 theSize) { m_size = theSize; return( NS_OK);}
00065        
00066        /* attribute wstring displayName; */
00067        NS_IMETHOD    GetPreferredName( PRUnichar **pName) { *pName = ToNewUnicode(m_displayName); return( NS_OK);}
00068        NS_IMETHOD    SetPreferredName( const PRUnichar * pName) { m_displayName = pName; return( NS_OK);}
00069        
00070        /* readonly attribute nsIFileSpec fileSpec; */
00071        NS_IMETHOD GetFileSpec(nsIFileSpec * *aFileSpec) { if (m_pFileSpec) { m_pFileSpec->AddRef(); *aFileSpec = m_pFileSpec; return( NS_OK);} else return( NS_ERROR_FAILURE); }
00072        
00073        /* attribute boolean import; */
00074        NS_IMETHOD    GetImport( PRBool *pImport) { *pImport = m_import; return( NS_OK);}
00075        NS_IMETHOD    SetImport( PRBool doImport) { m_import = doImport; return( NS_OK);}
00076        
00077 
00078        nsImportABDescriptor();
00079        virtual ~nsImportABDescriptor() { if (m_pFileSpec) m_pFileSpec->Release();}
00080 
00081        static NS_METHOD Create( nsISupports *aOuter, REFNSIID aIID, void **aResult);
00082                      
00083 private:
00084        PRUint32             m_id;                // used by creator of the structure
00085        PRUint32             m_ref;               // depth in the heirarchy
00086        nsString             m_displayName;       // name of this mailbox
00087        nsIFileSpec   *      m_pFileSpec;  // source file (if applicable)
00088        PRUint32             m_size;                     // size
00089        PRBool               m_import;            // import it or not? 
00090 };
00091 
00092 
00093 #endif