xpcom/io/nsILocalFileOS2.idl

   1 /* -*- Mode: C++; tab-width: 4; 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.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Richard L. Walsh.
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Rich Walsh <dragtext@e-vertise.com> (Original Author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK *****
  38  */
  39
  40 #include "nsILocalFile.idl"
  41
  42 interface nsIArray;
  43
  44 [scriptable, uuid(26de2089-239d-4697-818b-bae1fe8e8e0d)]
  45 interface nsILocalFileOS2 : nsILocalFile
  46 {
  47    /**
  48     * getFileTypes
  49     *
  50     * Returns the file's .TYPE extended attribute as an array of
  51     * nsISupportsCStrings.
  52     *
  53     */
  54     nsIArray getFileTypes( );
  55
  56    /**
  57     * setFileTypes
  58     *
  59     * Sets the file's .TYPE extended attribute from a comma-separated
  60     * list of types (this format is used because clients are unlikely
  61     * to write more than a single type).
  62     *   @param fileTypes
  63     *       a string in the filesystem's native character set
  64     *
  65     */
  66     void setFileTypes( in ACString fileTypes );
  67
  68    /**
  69     * isFileType
  70     *
  71     * Returns TRUE if the file has a .TYPE extended attribute that
  72     * matches the string passed in.  The comparison is case-sensitive.
  73     *   @param fileType
  74     *       a string in the filesystem's native character set
  75     *
  76     */
  77     PRBool isFileType( in ACString fileType );
  78
  79    /**
  80     * setFileSource
  81     *
  82     * Identifies the origin of a downloaded file by writing the
  83     * source URI's spec to the .SUBJECT extended attribute.
  84     *
  85     *   @param aURI
  86     *       the source URI
  87     *
  88     */
  89     void setFileSource( in AUTF8String aURI );
  90 };