netwerk/streamconv/nsIDirIndexListener.idl

   1 /* -*- Mode: C++; tab-width: 4; 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/. */
   5
   6 #include "nsIStreamListener.idl"
   7
   8 interface nsIDirIndex;
   9
  10 /**
  11  * This interface is used to receive contents of directory index listings
  12  * from a protocol. They can then be transformed into an output format
  13  * (such as rdf, html, etc)
  14  */
  15 [scriptable, uuid(fae4e9a8-1dd1-11b2-b53c-8f3aa1bbf8f5)]
  16 interface nsIDirIndexListener : nsISupports {
  17     /**
  18      * Called for each directory entry
  19      *
  20      * @param request - the request
  21      * @param index - new index to add
  22      */
  23     void onIndexAvailable(in nsIRequest aRequest,
  24                           in nsIDirIndex aIndex);
  25
  26     /**
  27      * Called for each information line
  28      *
  29      * @param request - the request
  30      * @param info - new info to add
  31      */
  32     void onInformationAvailable(in nsIRequest aRequest,
  33                                 in AString aInfo);
  34
  35 };
  36
  37 /**
  38  * A parser for application/http-index-format
  39  */
  40 [scriptable, uuid(38e3066c-1dd2-11b2-9b59-8be515c1ee3f)]
  41 interface nsIDirIndexParser : nsIStreamListener {
  42     /**
  43      * The interface to use as a callback for new entries
  44      */
  45     attribute nsIDirIndexListener listener;
  46 };