netwerk/base/public/nsIFileURL.idl

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/netwerk/base/public/nsIFileURL.idl	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,29 @@
     1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
     1.5 +/* This Source Code Form is subject to the terms of the Mozilla Public
     1.6 + * License, v. 2.0. If a copy of the MPL was not distributed with this
     1.7 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     1.8 +
     1.9 +#include "nsIURL.idl"
    1.10 +
    1.11 +interface nsIFile;
    1.12 +
    1.13 +/**
    1.14 + * nsIFileURL provides access to the underlying nsIFile object corresponding to
    1.15 + * an URL.  The URL scheme need not be file:, since other local protocols may
    1.16 + * map URLs to files (e.g., resource:).
    1.17 + */
    1.18 +[scriptable, uuid(7750029c-1b0a-414e-8359-a77f24a2a0a6)]
    1.19 +interface nsIFileURL : nsIURL
    1.20 +{
    1.21 +    /**
    1.22 +     * Get/Set nsIFile corresponding to this URL.
    1.23 +     *
    1.24 +     *  - Getter returns a reference to an immutable object.  Callers must clone
    1.25 +     *    before attempting to modify the returned nsIFile object.  NOTE: this
    1.26 +     *    constraint might not be enforced at runtime, so beware!!
    1.27 +     *
    1.28 +     *  - Setter clones the nsIFile object (allowing the caller to safely modify
    1.29 +     *    the nsIFile object after setting it on this interface).
    1.30 +     */
    1.31 +    attribute nsIFile file;
    1.32 +};

mercurial