Back to index

lightning-sunbird  0.9+nobinonly
nsILocalFileMac.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) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *  Conrad Carlen <ccarlen@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsILocalFile.idl"
00040 
00041 %{C++
00042 #include <Files.h>
00043 #include <CFURL.h>
00044 %}
00045 
00046       native OSType(OSType);
00047       native FSSpec(FSSpec);
00048 [ptr] native FSSpecPtr(FSSpec);
00049       native FSRef(FSRef);
00050 [ptr] native FSRefPtr(FSRef);
00051       native CFURLRef(CFURLRef);
00052 
00053 [uuid(614c3010-1dd2-11b2-be04-bcd57a64ffc9)]
00054 interface nsILocalFileMac : nsILocalFile
00055 {
00067     void initWithCFURL(in CFURLRef aCFURL);
00068 
00079     void initWithFSRef([const] in FSRefPtr aFSRef);
00080 
00090     void initWithFSSpec([const] in FSSpecPtr aFileSpec);
00091 
00102     void initToAppWithCreatorCode(in OSType aAppCreator);
00103 
00120     CFURLRef getCFURL();
00121  
00137     FSRef getFSRef();
00138    
00152     FSSpec getFSSpec();
00153 
00162     readonly attribute PRInt64 fileSizeWithResFork;
00163     
00167     const unsigned long CURRENT_PROCESS_CREATOR = 0x8000000;
00168     
00175     attribute OSType fileType;
00176     attribute OSType fileCreator;
00177     
00187     void setFileTypeAndCreatorFromMIMEType(in string aMIMEType);
00188     
00198     void setFileTypeAndCreatorFromExtension(in string aExtension);
00199     
00209     void launchWithDoc(in nsILocalFile aDocToLoad, in boolean aLaunchInBackground);
00210 
00222     void openDocWithApp(in nsILocalFile aAppToOpenWith, in boolean aLaunchInBackground);
00223 
00230     boolean isPackage();
00231 };
00232 
00233 [scriptable, uuid(BB388DF7-F29B-478E-9639-F54D3B8A4A30)]
00234 interface nsILocalFileMac_MOZILLA_1_8_BRANCH : nsISupports
00235 {
00242   readonly attribute AString bundleDisplayName;
00243 };
00244 
00245 %{C++
00246 extern "C"
00247 {
00248 
00249 #ifndef XP_MACOSX
00250 NS_EXPORT const char* NS_TruncNodeName(const char *aNode, char *outBuf);
00251 #endif
00252 
00253 NS_EXPORT nsresult NS_NewLocalFileWithFSSpec(const FSSpec* inSpec, PRBool followSymlinks, nsILocalFileMac* *result);
00254 }
00255 %}