netwerk/base/public/nsIFileURL.idl

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

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

mercurial