nsILocalFile.idl
上传用户:goldcmy89
上传日期:2017-12-03
资源大小:2246k
文件大小:6k
源码类别:

PlugIns编程

开发平台:

Visual C++

  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is Mozilla Communicator client code, released
  16.  * March 31, 1998.
  17.  *
  18.  * The Initial Developer of the Original Code is
  19.  * Netscape Communications Corporation.
  20.  * Portions created by the Initial Developer are Copyright (C) 1998-1999
  21.  * the Initial Developer. All Rights Reserved.
  22.  *
  23.  * Contributor(s):
  24.  *   Doug Turner <dougt@netscape.com>
  25.  *   Darin Fisher <darin@netscape.com>
  26.  *
  27.  * Alternatively, the contents of this file may be used under the terms of
  28.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  29.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30.  * in which case the provisions of the GPL or the LGPL are applicable instead
  31.  * of those above. If you wish to allow use of your version of this file only
  32.  * under the terms of either the GPL or the LGPL, and not to allow others to
  33.  * use your version of this file under the terms of the MPL, indicate your
  34.  * decision by deleting the provisions above and replace them with the notice
  35.  * and other provisions required by the GPL or the LGPL. If you do not delete
  36.  * the provisions above, a recipient may use your version of this file under
  37.  * the terms of any one of the MPL, the GPL or the LGPL.
  38.  *
  39.  * ***** END LICENSE BLOCK ***** */
  40. #include "nsIFile.idl"
  41. %{C++
  42. #include "prio.h"
  43. #include "prlink.h"
  44. #include <stdio.h>
  45. %}
  46. [ptr] native PRFileDescStar(PRFileDesc);
  47. [ptr] native PRLibraryStar(PRLibrary);
  48. [ptr] native FILE(FILE);
  49. /**
  50.  * This interface adds methods to nsIFile that are particular to a file
  51.  * that is accessible via the local file system.
  52.  *
  53.  * It follows the same string conventions as nsIFile.
  54.  *
  55.  * @status FROZEN
  56.  */
  57. [scriptable, uuid(aa610f20-a889-11d3-8c81-000064657374)]
  58. interface nsILocalFile : nsIFile
  59. {
  60.     /**
  61.      *  initWith[Native]Path
  62.      *
  63.      *  This function will initialize the nsILocalFile object.  Any
  64.      *  internal state information will be reset.  
  65.      *
  66.      *  NOTE: This function has a known bug on the macintosh and
  67.      *  other OSes which do not represent file locations as paths.
  68.      *  If you do use this function, be very aware of this problem!
  69.      *
  70.      *   @param filePath       
  71.      *       A string which specifies a full file path to a 
  72.      *       location.  Relative paths will be treated as an
  73.      *       error (NS_ERROR_FILE_UNRECOGNIZED_PATH).  For 
  74.      *       initWithNativePath, the filePath must be in the native
  75.      *       filesystem charset.
  76.      */
  77.     void initWithPath(in AString filePath);
  78.     [noscript] void initWithNativePath(in ACString filePath);
  79.     
  80.     /**
  81.      *  initWithFile
  82.      *
  83.      *  Initialize this object with another file
  84.      *
  85.      *   @param aFile
  86.      *       the file this becomes equivalent to
  87.      */
  88.     void initWithFile(in nsILocalFile aFile);
  89.     
  90.     /**
  91.      *  followLinks
  92.      *
  93.      *  This attribute will determine if the nsLocalFile will auto
  94.      *  resolve symbolic links.  By default, this value will be false
  95.      *  on all non unix systems.  On unix, this attribute is effectively
  96.      *  a noop.  
  97.      */
  98.     attribute PRBool followLinks;  
  99.     [noscript] PRFileDescStar openNSPRFileDesc(in long flags, in long mode);
  100.     [noscript] FILE           openANSIFileDesc(in string mode);
  101.     [noscript] PRLibraryStar  load();
  102.     
  103.     readonly attribute PRInt64 diskSpaceAvailable;
  104.     /**
  105.      *  appendRelative[Native]Path
  106.      *
  107.      *  Append a relative path to the current path of the nsILocalFile object.
  108.      *
  109.      *   @param relativeFilePath
  110.      *       relativeFilePath is a native relative path. For security reasons,
  111.      *       this cannot contain .. or cannot start with a directory separator.
  112.      *       For the |appendRelativeNativePath| method, the relativeFilePath 
  113.      *       must be in the native filesystem charset.
  114.      */
  115.     void appendRelativePath(in AString relativeFilePath);
  116.     [noscript] void appendRelativeNativePath(in ACString relativeFilePath);
  117.     
  118.     /**
  119.      *  Accessor to a null terminated string which will specify
  120.      *  the file in a persistent manner for disk storage.
  121.      *
  122.      *  The character set of this attribute is undefined.  DO NOT TRY TO
  123.      *  INTERPRET IT AS HUMAN READABLE TEXT!
  124.      */
  125.     attribute ACString persistentDescriptor;
  126.     /** 
  127.      *  reveal
  128.      *
  129.      *  Ask the operating system to open the folder which contains
  130.      *  this file or folder. This routine only works on platforms which 
  131.      *  support the ability to open a folder...
  132.      */
  133.     void reveal();
  134.     
  135.     /** 
  136.      *  launch
  137.      *
  138.      *  Ask the operating system to attempt to open the file. 
  139.      *  this really just simulates "double clicking" the file on your platform.
  140.      *  This routine only works on platforms which support this functionality.
  141.      */
  142.     void launch();
  143.     
  144.     /**
  145.      *  getRelativeDescriptor
  146.      *
  147.      *  Returns a relative file path in an opaque, XP format. It is therefore
  148.      *  not a native path.
  149.      *
  150.      *  The character set of the string returned from this function is
  151.      *  undefined.  DO NOT TRY TO INTERPRET IT AS HUMAN READABLE TEXT!
  152.      *
  153.      *   @param fromFile
  154.      *       the file from which the descriptor is relative.
  155.      *       There is no defined result if this param is null.
  156.      */
  157.     ACString getRelativeDescriptor(in nsILocalFile fromFile);
  158.     /**
  159.      *  setRelativeDescriptor
  160.      *
  161.      *  Initializes the file to the location relative to fromFile using
  162.      *  a string returned by getRelativeDescriptor.
  163.      *
  164.      *   @param fromFile
  165.      *       the file to which the descriptor is relative
  166.      *   @param relative
  167.      *       the relative descriptor obtained from getRelativeDescriptor
  168.      */
  169.     void setRelativeDescriptor(in nsILocalFile fromFile, in ACString relativeDesc);    
  170. };