gecko-dev/image/imgICache.idl
Birunthan Mohanathas 1c8872b6c4 Bug 1038536 - Flatten image/public/ directory. r=seth
--HG--
rename : image/public/ImageLogging.h => image/ImageLogging.h
rename : image/public/imgICache.idl => image/imgICache.idl
rename : image/public/imgIContainer.idl => image/imgIContainer.idl
rename : image/public/imgIContainerDebug.idl => image/imgIContainerDebug.idl
rename : image/public/imgIEncoder.idl => image/imgIEncoder.idl
rename : image/public/imgILoader.idl => image/imgILoader.idl
rename : image/public/imgINotificationObserver.idl => image/imgINotificationObserver.idl
rename : image/public/imgIOnloadBlocker.idl => image/imgIOnloadBlocker.idl
rename : image/public/imgIRequest.idl => image/imgIRequest.idl
rename : image/public/imgIScriptedNotificationObserver.idl => image/imgIScriptedNotificationObserver.idl
rename : image/public/imgITools.idl => image/imgITools.idl
rename : image/public/nsIIconURI.idl => image/nsIIconURI.idl
2015-05-06 10:57:19 -07:00

63 lines
1.8 KiB
Plaintext

/* -*- 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();
};