1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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 mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 2001
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Radha Kulkarni <radha@netscape.com> (original author)
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either of the GNU General Public License Version 2 or later (the "GPL"),
27 * or 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 "nsIChannel.idl"
40
41 /**
42 * A channel to manage all cache-related interactions for layout
43 * when it is dealing with dynamic pages created through
44 * document.write(). This interface provides methods that will
45 * help layout save dynamic pages in cache for future retrievals.
46 */
47
48 [scriptable, uuid (89b0674a-9e2f-4124-9b59-481444be841d)]
49 interface nsIWyciwygChannel : nsIChannel
50 {
51 /**
52 * Append data to the cache entry; opens the cache entry if necessary.
53 */
54 void writeToCacheEntry(in AString aData);
55
56 /**
57 * Close the cache entry; subsequent writes have undefined behavior.
58 */
59 void closeCacheEntry(in nsresult reason);
60
61 /**
62 * Set the wyciwyg channels security info
63 */
64 void setSecurityInfo(in nsISupports aSecurityInfo);
65
66 /**
67 * Store and read a charset and charset source on the wyciwyg channel. These
68 * are opaque values to the channel; consumers who set them should know what
69 * they mean.
70 */
71 void setCharsetAndSource(in long aSource, in ACString aCharset);
72 /**
73 * The return value is the charset. Throws if either the charset or the
74 * source cannot be retrieved. This is guaranteed to return a nonzero source
75 * and a nonempty charset if it does not throw.
76 */
77 ACString getCharsetAndSource(out long aSource);
78 };