image/public/imgICache.idl
author Nicolas B. Pierron <nicolas.b.pierron@mozilla.com>
Wed, 01 Oct 2014 19:17:51 +0200
changeset 208230 ed4b995667b58b364d2a7ce9b2111fc22dc1f622
parent 132085 fcfeafc7cf398ab7488855616882606f928f0514
child 218598 dde067dbfe2739942b5fa202e04dd8b055b83600
permissions -rw-r--r--
Bug 1074911 - Replace JS_ASSERT by MOZ_ASSERT. r=jorendorff Apply the following script sed -i ' /JS_ASSERT(/ { s/JS_ASSERT(/MOZ_ASSERT(/; :b; s/ \\$/\\/; /;/ { p; d; }; n; s/^/ /; b b; }; s/JS_ASSERT (/MOZ_ASSERT(/; ' Except where the JS_ASSERT macro does not end with a semi-colon, where empty lines are in the middle of the macro, and where the backslahes are always the same-length after the expression.

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

interface nsIURI;
interface imgIRequest;
interface nsIProperties;

/**
 * imgICache interface
 *
 * @author Stuart Parmenter <pavlov@netscape.com>
 * @version 0.1
 * @see imagelib2
 */
[scriptable, builtinclass, uuid(b06e0fa5-d6e2-4fa3-8fc0-7775aed96522)]
interface imgICache : nsISupports
{
  /**
   * Evict images from the cache.
   *
   * @param chrome If TRUE,  evict only chrome images.
   *               If FALSE, evict everything except chrome images.
   */
  void clearCache(in boolean chrome);

  /**
   * Evict images from the cache.
   *
   * @param uri The URI to remove.
   * @throws NS_ERROR_NOT_AVAILABLE if \a uri was unable to be removed from the cache.
   */
  void removeEntry(in nsIURI uri);

  /**
   * Find Properties
   * Used to get properties such as 'type' and 'content-disposition'
   * 'type' is a nsISupportsCString containing the images' mime type such as 'image/png'
   * 'content-disposition' will be a nsISupportsCString containing the header
   * If you call this before any data has been loaded from a URI, it will succeed,
   * but come back empty.
   *
   * Hopefully this will be removed with bug 805119
   *
   * @param uri The URI to look up.
   * @returns NULL if the URL was not found in the cache
   */
  nsIProperties findEntryProperties(in nsIURI uri);

  /**
   * Make this cache instance respect private browsing notifications. This entails clearing
   * the chrome and content caches whenever the last-pb-context-exited notification is
   * observed.
   */
  void respectPrivacyNotifications();
};