/gecko_sdk/idl/nsIFileURL.idl
IDL | 64 lines | 7 code | 3 blank | 54 comment | 0 complexity | 830ab38b3c3646d173f640e13d82b5d2 MD5 | raw file
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.org code. 16 * 17 * The Initial Developer of the Original Code is 18 * Netscape Communications Corporation. 19 * Portions created by the Initial Developer are Copyright (C) 1998 20 * the Initial Developer. All Rights Reserved. 21 * 22 * Contributor(s): 23 * Darin Fisher <darin@netscape.com> (extracted from nsIFileChannel.idl) 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#include "nsIURL.idl" 40 41interface nsIFile; 42 43/** 44 * nsIFileURL provides access to the underlying nsIFile object corresponding to 45 * an URL. The URL scheme need not be file:, since other local protocols may 46 * map URLs to files (e.g., resource:). 47 * 48 * @status FROZEN 49 */ 50[scriptable, uuid(d26b2e2e-1dd1-11b2-88f3-8545a7ba7949)] 51interface nsIFileURL : nsIURL 52{ 53 /** 54 * Get/Set nsIFile corresponding to this URL. 55 * 56 * - Getter returns a reference to an immutable object. Callers must clone 57 * before attempting to modify the returned nsIFile object. NOTE: this 58 * constraint might not be enforced at runtime, so beware!! 59 * 60 * - Setter clones the nsIFile object (allowing the caller to safely modify 61 * the nsIFile object after setting it on this interface). 62 */ 63 attribute nsIFile file; 64};