← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/netwerk/streamconv/public/nsIDirIndexListener.idl

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/netwerk/streamconv/public/nsIDirIndexListener.idl
 
1
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 
2
/* ----- BEGIN LICENSE BLOCK -----
 
3
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Mozilla Public License Version
 
6
 * 1.1 (the "License"); you may not use this file except in compliance with
 
7
 * the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/MPL/
 
9
 *
 
10
 * Software distributed under the License is distributed on an "AS IS" basis,
 
11
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 
12
 * for the specific language governing rights and limitations under the
 
13
 * License.
 
14
 *
 
15
 * The Original Code is the directory index parsing code.
 
16
 *
 
17
 * The Initial Developer of the Original Code is Bradley Baetz.
 
18
 * Portions created by Bradley Baetz are
 
19
 * Copyright (C) 2001 Bradley Baetz.
 
20
 * All Rights Reserved.
 
21
 *
 
22
 * Contributor(s): Bradley Baetz <bbaetz@cs.mcgill.ca>
 
23
 *
 
24
 * Alternatively, the contents of this file may be used under the terms of
 
25
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 
26
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
27
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
28
 * of those above. If you wish to allow use of your version of this file only
 
29
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
30
 * use your version of this file under the terms of the MPL, indicate your
 
31
 * decision by deleting the provisions above and replace them with the notice
 
32
 * and other provisions required by the LGPL or the GPL. If you do not delete
 
33
 * the provisions above, a recipient may use your version of this file under
 
34
 * the terms of any one of the MPL, the GPL or the LGPL.
 
35
 *
 
36
 * ----- END LICENSE BLOCK ----- */
 
37
 
 
38
#include "nsIStreamListener.idl"
 
39
 
 
40
interface nsIDirIndex;
 
41
 
 
42
/**
 
43
 * This interface is used to receive contents of directory index listings
 
44
 * from a protocol. They can then be transformed into an output format
 
45
 * (such as rdf, html, etc)
 
46
 */
 
47
[scriptable, uuid(fae4e9a8-1dd1-11b2-b53c-8f3aa1bbf8f5)]
 
48
interface nsIDirIndexListener : nsISupports {
 
49
    /**
 
50
     * Called for each directory entry
 
51
     *
 
52
     * @param request - the request
 
53
     * @param ctxt - opaque parameter
 
54
     * @param index - new index to add
 
55
     */
 
56
    void onIndexAvailable(in nsIRequest aRequest,
 
57
                          in nsISupports aCtxt,
 
58
                          in nsIDirIndex aIndex);
 
59
};
 
60
 
 
61
%{C++
 
62
#define NS_IDIRINDEXLISTENER_KEY         "@mozilla.org/dirIndexListener;1"
 
63
%}
 
64
 
 
65
/**
 
66
 * A parser for application/http-index-format
 
67
 */
 
68
[scriptable, uuid(38e3066c-1dd2-11b2-9b59-8be515c1ee3f)]
 
69
interface nsIDirIndexParser : nsIStreamListener {
 
70
    /**
 
71
     * The interface to use as a callback for new entries
 
72
     */
 
73
    attribute nsIDirIndexListener listener;
 
74
 
 
75
    /**
 
76
     * The comment given, if any
 
77
     * This result is only valid _after_ OnStopRequest has occurred,
 
78
     * because it can occur anywhere in the datastream
 
79
     */
 
80
    readonly attribute string comment;
 
81
 
 
82
    /**
 
83
     * The encoding to use
 
84
     */
 
85
    attribute string encoding;
 
86
};
 
87
 
 
88
%{C++
 
89
#define NS_DIRINDEXPARSER_CID \
 
90
{ /* a0d6ad32-1dd1-11b2-aa55-a40187b54036 */ \
 
91
    0xa0d6ad32, \
 
92
    0x1dd1, \
 
93
    0x11b2, \
 
94
    { 0xaa, 0x55, 0xa4, 0x01, 0x87, 0xb5, 0x40, 0x36 } \
 
95
}
 
96
 
 
97
#define NS_DIRINDEXPARSER_CONTRACTID "@mozilla.org/dirIndexParser;1"
 
98
 
 
99
%}