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

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

mercurial