michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsIURL.idl"
michael@0: 
michael@0: interface nsIFile;
michael@0: 
michael@0: /**
michael@0:  * nsIFileURL provides access to the underlying nsIFile object corresponding to
michael@0:  * an URL.  The URL scheme need not be file:, since other local protocols may
michael@0:  * map URLs to files (e.g., resource:).
michael@0:  */
michael@0: [scriptable, uuid(7750029c-1b0a-414e-8359-a77f24a2a0a6)]
michael@0: interface nsIFileURL : nsIURL
michael@0: {
michael@0:     /**
michael@0:      * Get/Set nsIFile corresponding to this URL.
michael@0:      *
michael@0:      *  - Getter returns a reference to an immutable object.  Callers must clone
michael@0:      *    before attempting to modify the returned nsIFile object.  NOTE: this
michael@0:      *    constraint might not be enforced at runtime, so beware!!
michael@0:      *
michael@0:      *  - Setter clones the nsIFile object (allowing the caller to safely modify
michael@0:      *    the nsIFile object after setting it on this interface).
michael@0:      */
michael@0:     attribute nsIFile file;
michael@0: };