Back to index

lightning-sunbird  0.9+nobinonly
nsIFile.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 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  *   Christopher Blizzard <blizzard@mozilla.org>
00026  *   Darin Fisher <darin@netscape.com>
00027  *
00028  * Alternatively, the contents of this file may be used under the terms of
00029  * either of the GNU General Public License Version 2 or later (the "GPL"),
00030  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00031  * in which case the provisions of the GPL or the LGPL are applicable instead
00032  * of those above. If you wish to allow use of your version of this file only
00033  * under the terms of either the GPL or the LGPL, and not to allow others to
00034  * use your version of this file under the terms of the MPL, indicate your
00035  * decision by deleting the provisions above and replace them with the notice
00036  * and other provisions required by the GPL or the LGPL. If you do not delete
00037  * the provisions above, a recipient may use your version of this file under
00038  * the terms of any one of the MPL, the GPL or the LGPL.
00039  *
00040  * ***** END LICENSE BLOCK ***** */
00041 
00042 #include "nsISupports.idl"
00043 
00044 interface nsISimpleEnumerator;
00045 
00061 [scriptable, uuid(c8c0a080-0868-11d3-915f-d9d889d48e3c)]
00062 interface nsIFile : nsISupports
00063 {
00070     const unsigned long NORMAL_FILE_TYPE = 0;
00071     const unsigned long DIRECTORY_TYPE   = 1;
00072 
00084     void append(in AString node);
00085     [noscript] void appendNative(in ACString node);
00086 
00090     void normalize();
00091 
00112     void create(in unsigned long type, in unsigned long permissions);
00113 
00119     attribute AString leafName;
00120     [noscript] attribute ACString nativeLeafName;
00121 
00149     void copyTo(in nsIFile newParentDir, in AString newName);
00150     [noscript] void CopyToNative(in nsIFile newParentDir, in ACString newName);
00151 
00161     void copyToFollowingLinks(in nsIFile newParentDir, in AString newName);
00162     [noscript] void copyToFollowingLinksNative(in nsIFile newParentDir, in ACString newName);
00163 
00195     void moveTo(in nsIFile newParentDir, in AString newName);
00196     [noscript] void moveToNative(in nsIFile newParentDir, in ACString newName);
00197 
00204     void remove(in boolean recursive);
00205 
00210     attribute unsigned long permissions;
00211     attribute unsigned long permissionsOfLink;
00212 
00218     attribute PRInt64 lastModifiedTime;
00219     attribute PRInt64 lastModifiedTimeOfLink;
00220 
00227     attribute PRInt64 fileSize;
00228     readonly attribute PRInt64 fileSizeOfLink;
00229 
00255     readonly attribute AString target;
00256     [noscript] readonly attribute ACString nativeTarget;
00257     readonly attribute AString path;
00258     [noscript] readonly attribute ACString nativePath;
00259 
00260     boolean exists();
00261     boolean isWritable();
00262     boolean isReadable();
00263     boolean isExecutable();
00264     boolean isHidden();
00265     boolean isDirectory();
00266     boolean isFile();
00267     boolean isSymlink();
00271     boolean isSpecial();
00272 
00298     void createUnique(in unsigned long type, in unsigned long permissions);
00299 
00311     nsIFile clone();
00312 
00316     boolean equals(in nsIFile inFile);
00317 
00322     boolean contains(in nsIFile inFile, in boolean recur);
00323 
00327     readonly attribute nsIFile parent;
00328     
00336     readonly attribute nsISimpleEnumerator directoryEntries;
00337 };
00338 
00339 %{C++
00340 #ifdef MOZILLA_INTERNAL_API
00341 #include "nsDirectoryServiceUtils.h"
00342 #endif
00343 %}