mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
263 lines
7.7 KiB
Plaintext
263 lines
7.7 KiB
Plaintext
/* -*- 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>
|
|
* Mark Mentovai <mark@moxienet.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>
|
|
#include <CFURL.h>
|
|
%}
|
|
|
|
native OSType(OSType);
|
|
native FSSpec(FSSpec);
|
|
[ptr] native FSSpecPtr(FSSpec);
|
|
native FSRef(FSRef);
|
|
[ptr] native FSRefPtr(FSRef);
|
|
native CFURLRef(CFURLRef);
|
|
|
|
[scriptable, uuid(748f3ffe-27d9-4402-9de9-494badbeebf4)]
|
|
interface nsILocalFileMac : nsILocalFile
|
|
{
|
|
/**
|
|
* initWithCFURL
|
|
*
|
|
* Init this object with a CFURLRef
|
|
*
|
|
* NOTE: Supported only for XP_MACOSX or TARGET_CARBON
|
|
* NOTE: If the path of the CFURL is /a/b/c, at least a/b must exist beforehand.
|
|
*
|
|
* @param aCFURL the CoreFoundation URL
|
|
*
|
|
*/
|
|
[noscript] void initWithCFURL(in CFURLRef aCFURL);
|
|
|
|
/**
|
|
* initWithFSRef
|
|
*
|
|
* Init this object with an FSRef
|
|
*
|
|
* NOTE: Supported only for XP_MACOSX or TARGET_CARBON
|
|
*
|
|
* @param aFSRef the native file spec
|
|
*
|
|
*/
|
|
[noscript] void initWithFSRef([const] in FSRefPtr aFSRef);
|
|
|
|
/**
|
|
* initWithFSSpec
|
|
*
|
|
* Init this object with an FSSpec
|
|
* Legacy method - leaving in place for now
|
|
*
|
|
* @param aFileSpec the native file spec
|
|
*
|
|
*/
|
|
[noscript] 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
|
|
*
|
|
*/
|
|
[noscript] void initToAppWithCreatorCode(in OSType aAppCreator);
|
|
|
|
/**
|
|
* getCFURL
|
|
*
|
|
* Returns the CFURLRef of the file object. The caller is
|
|
* responsible for calling CFRelease() on it.
|
|
*
|
|
* 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.
|
|
*
|
|
* NOTE: Supported only for XP_MACOSX or TARGET_CARBON
|
|
*
|
|
* @return
|
|
*
|
|
*/
|
|
[noscript] CFURLRef getCFURL();
|
|
|
|
/**
|
|
* getFSRef
|
|
*
|
|
* Returns the FSRef 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.
|
|
*
|
|
* NOTE: Supported only for XP_MACOSX or TARGET_CARBON
|
|
*
|
|
* @return
|
|
*
|
|
*/
|
|
[noscript] FSRef getFSRef();
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
*/
|
|
[noscript] 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
|
|
*
|
|
*/
|
|
[noscript] attribute OSType fileType;
|
|
[noscript] 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);
|
|
|
|
/**
|
|
* isPackage
|
|
*
|
|
* returns true if a directory is determined to be a package under Mac OS 9/X
|
|
*
|
|
*/
|
|
boolean isPackage();
|
|
|
|
/**
|
|
* bundleDisplayName
|
|
*
|
|
* returns the display name of the application bundle (usually the human
|
|
* readable name of the application)
|
|
*/
|
|
readonly attribute AString bundleDisplayName;
|
|
|
|
/**
|
|
* bundleIdentifier
|
|
*
|
|
* returns the identifier of the bundle
|
|
*/
|
|
readonly attribute AUTF8String bundleIdentifier;
|
|
};
|
|
|
|
%{C++
|
|
extern "C"
|
|
{
|
|
|
|
#ifndef XP_MACOSX
|
|
NS_EXPORT const char* NS_TruncNodeName(const char *aNode, char *outBuf);
|
|
#endif
|
|
|
|
NS_EXPORT nsresult NS_NewLocalFileWithFSSpec(const FSSpec* inSpec, PRBool followSymlinks, nsILocalFileMac* *result);
|
|
|
|
// NS_NewLocalFileWithFSRef is available since Mozilla 1.8.1.
|
|
NS_EXPORT nsresult NS_NewLocalFileWithFSRef(const FSRef* aFSRef, PRBool aFollowSymlinks, nsILocalFileMac** result);
|
|
}
|
|
%}
|