modules/libjar/nsIJARURI.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsIURL.idl"
   8
   9 /**
  10  * JAR URLs have the following syntax
  11  *
  12  * jar:<jar-file-uri>!/<jar-entry>
  13  *
  14  * EXAMPLE: jar:http://www.big.com/blue.jar!/ocean.html
  15  *
  16  * The nsIURL methods operate on the <jar-entry> part of the spec.
  17  */
  18 [scriptable, builtinclass, uuid(646a508c-f786-4e14-be6d-8dda2a633c60)]
  19 interface nsIJARURI : nsIURL {
  20
  21     /**
  22      * Returns the root URI (the one for the actual JAR file) for this JAR
  23      * (e.g., http://www.big.com/blue.jar).
  24      */
  25     readonly attribute nsIURI JARFile;
  26
  27     /**
  28      * Returns the entry specified for this JAR URI (e.g., "ocean.html").  This
  29      * value may contain %-escaped byte sequences.
  30      */
  31     readonly attribute AUTF8String JAREntry;
  32 };
  33
  34 [uuid(d66df117-eda7-4324-b4e4-1f670ff6718e)]
  35 interface nsIJARURIMutator : nsISupports
  36 {
  37     /**
  38      * Will initialize a URI using the passed spec, baseURI and charset.
  39      */
  40     void setSpecBaseCharset(in AUTF8String aSpec, in nsIURI aBase, in string aCharset);
  41 };