Bug 100828 - New file for nsLocalFileMac reworking. r=rjc@netscape.com/sr=sfraser@netscape.com

xpcom/io/nsILocalFileMac.idl

@@ -0,0 +1,166 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/* ***** 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 mozilla.org code.
+ *
+ * The Initial Developer of the Original Code is
+ * Netscape Communications Corporation.
+ * Portions created by the Initial Developer are Copyright (C) 2001
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *  Conrad Carlen <ccarlen@netscape.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 "nsILocalFile.idl"
+
+%{C++
+#include <Files.h>
+%}
+
+      native OSType(OSType);
+      native FSSpec(FSSpec);
+[ref] native FSSpecRef(FSSpec);
+[ptr] native FSSpecPtr(FSSpec);
+
+
+[uuid(614c3010-1dd2-11b2-be04-bcd57a64ffc9)]
+interface nsILocalFileMac : nsILocalFile
+{
+   /**
+    * initWithFSSpec
+    *
+    * Init this object with an FSSpec
+    *
+    * @param   aFileSpec       the native file spec
+    *
+    */
+    void initWithFSSpec([const] in FSSpecPtr aFileSpec);
+
+   /**
+    * initToAppWithCreatorCode
+    *
+    * Init this object to point to an application having the given
+    * creator code. If this app is missing, this will fail. It will first
+    * look for running application with the given creator.
+    *
+    * @param   aAppCreator     the signature of the app
+    *
+    */
+    void initToAppWithCreatorCode(in OSType aAppCreator);
+    
+   /**
+    * getFSSpec
+    *
+    * Returns the FSSpec of the file object.
+    *
+    * NOTE: Observes the state of the followLinks attribute.
+    * If the file object is an alias and followLinks is TRUE, returns
+    * the target of the alias. If followLinks is FALSE, returns
+    * the unresolved alias file.
+    *
+    * @return
+    *  
+    */ 
+    FSSpec getFSSpec();
+
+   /**
+    * fileSizeWithResFork
+    * 
+    * Returns the combined size of both the data fork and the resource
+    * fork (if present) rather than just the size of the data fork
+    * as returned by GetFileSize()
+    *
+    */
+    readonly attribute PRInt64 fileSizeWithResFork;
+    
+   /**
+    * Use with SetFileType() to specify the signature of current process
+    */
+    const unsigned long CURRENT_PROCESS_CREATOR = 0x8000000;
+    
+   /**
+    * fileType, creator
+    *
+    * File type and creator attributes
+    *
+    */
+    attribute OSType fileType;
+    attribute OSType fileCreator;
+    
+   /**
+    * setFileTypeAndCreatorFromMIMEType
+    *
+    * Sets the file type and creator code from a MIME type.
+    * Internet Config is used to determine the mapping.
+    *
+    * @param   aMIMEType
+    *
+    */
+    void setFileTypeAndCreatorFromMIMEType(in string aMIMEType);
+    
+   /**
+    * setFileTypeAndCreatorFromExtension
+    *
+    * Sets the file type and creator code from a file extension
+    * Internet Config is used to determine the mapping.
+    *
+    * @param   aExtension
+    *
+    */
+    void setFileTypeAndCreatorFromExtension(in string aExtension);
+    
+   /**
+    * launchWithDoc
+    *
+    * Launch the application that this file points to with a document.
+    *
+    * @param   aDocToLoad          Must not be NULL. If no document, use nsILocalFile::launch
+    * @param   aLaunchInBackground TRUE if the application should not come to the front.
+    *
+    */
+    void launchWithDoc(in nsILocalFile aDocToLoad, in boolean aLaunchInBackground);
+
+   /**
+    * openDocWithApp
+    *
+    * Open the document that this file points to with the given application.
+    *
+    * @param   aAppToOpenWith      The application with  which to open the document.
+    *                              If NULL, the creator code of the document is used
+    *                              to determine the application.
+    * @param   aLaunchInBackground TRUE if the application should not come to the front.
+    *
+    */
+    void openDocWithApp(in nsILocalFile aAppToOpenWith, in boolean aLaunchInBackground);
+
+};
+
+%{C++
+extern "C" NS_EXPORT nsresult
+NS_NewLocalFileWithFSSpec(FSSpec* inSpec, PRBool followSymlinks, nsILocalFileMac* *result);
+%}