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

« back to all changes in this revision

Viewing changes to mozilla/netwerk/base/public/nsIDirectoryListing.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:
 
1
/* -*- Mode: IDL; 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
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with 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 mozilla.org code.
 
16
 *
 
17
 * The Initial Developer of the Original Code is Bradley Baetz
 
18
 * Portions created by the Initial Developer are Copyright (C) 2001, 2002
 
19
 * the Initial Developer. All Rights Reserved.
 
20
 *
 
21
 * Contributor(s):
 
22
 *   Bradley Baetz      <bbaetz@student.usyd.edu.au>
 
23
 *   Jan Varga          <jan@mozdevgroup.com>
 
24
 *
 
25
 * Alternatively, the contents of this file may be used under the terms of
 
26
 * either the GNU General Public License Version 2 or later (the "GPL"), or 
 
27
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
28
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
29
 * of those above. If you wish to allow use of your version of this file only
 
30
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
31
 * use your version of this file under the terms of the MPL, indicate your
 
32
 * decision by deleting the provisions above and replace them with the notice
 
33
 * and other provisions required by the GPL or the LGPL. If you do not delete
 
34
 * the provisions above, a recipient may use your version of this file under
 
35
 * the terms of any one of the MPL, the GPL or the LGPL.
 
36
 *
 
37
 * ***** END LICENSE BLOCK ***** */
 
38
 
 
39
#include "nsISupports.idl"
 
40
 
 
41
/** This interface allows setting the output format for a directory listing
 
42
 * Implementations of this interface should default to html, since that is the
 
43
 * lowest common denominator which all places can deal with.
 
44
 */
 
45
[scriptable, uuid(a465d8ed-3661-483d-a6f1-a82a6bd617b3)]
 
46
interface nsIDirectoryListing : nsISupports {
 
47
    /** Use the pref */
 
48
    const unsigned long FORMAT_PREF = 0;
 
49
    
 
50
    /** Raw format - exactly what comes off the network. It is very
 
51
     * unlikely that you want this
 
52
     */
 
53
    const unsigned long FORMAT_RAW = 1;
 
54
 
 
55
    /** HTML */
 
56
    const unsigned long FORMAT_HTML = 2;
 
57
    
 
58
    /** application/http-index-format
 
59
     * This will end up at the code in xpfe/components/directory so if
 
60
     * you explicitly set this, be sure that this dependancy is OK
 
61
     */
 
62
    const unsigned long FORMAT_HTTP_INDEX = 3;
 
63
 
 
64
    /** The actual format
 
65
     * If the given format is not supported, NS_ERROR_FAILURE is returned.
 
66
     * The getter for this returns the actual value, having translated
 
67
     * FORMAT_PREF into the current pref format
 
68
     */
 
69
    attribute unsigned long listFormat;
 
70
 
 
71
    attribute boolean showHidden;
 
72
};