netwerk/protocol/wyciwyg/nsIWyciwygChannel.idl

Thu, 15 Jan 2015 21:03:48 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 15 Jan 2015 21:03:48 +0100
branch
TOR_BUG_9701
changeset 11
deefc01c0e14
permissions
-rw-r--r--

Integrate friendly tips from Tor colleagues to make (or not) 4.5 alpha 3;
This includes removal of overloaded (but unused) methods, and addition of
a overlooked call to DataStruct::SetData(nsISupports, uint32_t, bool.)

michael@0 1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0 2 /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0 3 * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0 4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0 5
michael@0 6 #include "nsIChannel.idl"
michael@0 7
michael@0 8 /**
michael@0 9 * A channel to manage all cache-related interactions for layout
michael@0 10 * when it is dealing with dynamic pages created through
michael@0 11 * document.write(). This interface provides methods that will
michael@0 12 * help layout save dynamic pages in cache for future retrievals.
michael@0 13 */
michael@0 14
michael@0 15 [scriptable, uuid (89b0674a-9e2f-4124-9b59-481444be841d)]
michael@0 16 interface nsIWyciwygChannel : nsIChannel
michael@0 17 {
michael@0 18 /**
michael@0 19 * Append data to the cache entry; opens the cache entry if necessary.
michael@0 20 */
michael@0 21 void writeToCacheEntry(in AString aData);
michael@0 22
michael@0 23 /**
michael@0 24 * Close the cache entry; subsequent writes have undefined behavior.
michael@0 25 */
michael@0 26 void closeCacheEntry(in nsresult reason);
michael@0 27
michael@0 28 /**
michael@0 29 * Set the wyciwyg channels security info
michael@0 30 */
michael@0 31 void setSecurityInfo(in nsISupports aSecurityInfo);
michael@0 32
michael@0 33 /**
michael@0 34 * Store and read a charset and charset source on the wyciwyg channel. These
michael@0 35 * are opaque values to the channel; consumers who set them should know what
michael@0 36 * they mean.
michael@0 37 */
michael@0 38 void setCharsetAndSource(in long aSource, in ACString aCharset);
michael@0 39 /**
michael@0 40 * The return value is the charset. Throws if either the charset or the
michael@0 41 * source cannot be retrieved. This is guaranteed to return a nonzero source
michael@0 42 * and a nonempty charset if it does not throw.
michael@0 43 */
michael@0 44 ACString getCharsetAndSource(out long aSource);
michael@0 45 };

mercurial