Back to index

lightning-sunbird  0.9+nobinonly
nsILocalFile.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; 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 Communicator client code, released
00016  * March 31, 1998.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1998-1999
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Doug Turner <dougt@netscape.com>
00025  *   Darin Fisher <darin@netscape.com>
00026  *
00027  * Alternatively, the contents of this file may be used under the terms of
00028  * either of the GNU General Public License Version 2 or later (the "GPL"),
00029  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00030  * in which case the provisions of the GPL or the LGPL are applicable instead
00031  * of those above. If you wish to allow use of your version of this file only
00032  * under the terms of either the GPL or the LGPL, and not to allow others to
00033  * use your version of this file under the terms of the MPL, indicate your
00034  * decision by deleting the provisions above and replace them with the notice
00035  * and other provisions required by the GPL or the LGPL. If you do not delete
00036  * the provisions above, a recipient may use your version of this file under
00037  * the terms of any one of the MPL, the GPL or the LGPL.
00038  *
00039  * ***** END LICENSE BLOCK ***** */
00040 
00041 #include "nsIFile.idl"
00042 
00043 %{C++
00044 #include "prio.h"
00045 #include "prlink.h"
00046 #include <stdio.h>
00047 %}
00048 
00049 [ptr] native PRFileDescStar(PRFileDesc);
00050 [ptr] native PRLibraryStar(PRLibrary);
00051 [ptr] native FILE(FILE);
00052 
00061 [scriptable, uuid(aa610f20-a889-11d3-8c81-000064657374)]
00062 interface nsILocalFile : nsIFile
00063 {
00081     void initWithPath(in AString filePath);
00082     [noscript] void initWithNativePath(in ACString filePath);
00083     
00092     void initWithFile(in nsILocalFile aFile);
00093     
00102     attribute PRBool followLinks;  
00103 
00104     [noscript] PRFileDescStar openNSPRFileDesc(in long flags, in long mode);
00105     [noscript] FILE           openANSIFileDesc(in string mode);
00106 
00107     [noscript] PRLibraryStar  load();
00108     
00109     readonly attribute PRInt64 diskSpaceAvailable;
00110 
00122     void appendRelativePath(in AString relativeFilePath);
00123     [noscript] void appendRelativeNativePath(in ACString relativeFilePath);
00124     
00132     attribute ACString persistentDescriptor;
00133 
00141     void reveal();
00142     
00150     void launch();
00151     
00165     ACString getRelativeDescriptor(in nsILocalFile fromFile);
00166 
00178     void setRelativeDescriptor(in nsILocalFile fromFile, in ACString relativeDesc);    
00179 };
00180