1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
2 *
3 * ***** BEGIN LICENSE BLOCK *****
4 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 1.1 (the "License"); you may not use this file except in compliance with
8 * the License. You may obtain a copy of the License at
9 * http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * The Original Code is mozilla.org code.
17 *
18 * The Initial Developer of the Original Code is
19 * Netscape Communications Corporation.
20 * Portions created by the Initial Developer are Copyright (C) 2001
21 * the Initial Developer. All Rights Reserved.
22 *
23 * Contributor(s):
24 * Stuart Parmenter <pavlov@netscape.com>
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * either the GNU General Public License Version 2 or later (the "GPL"), or
28 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 * in which case the provisions of the GPL or the LGPL are applicable instead
30 * of those above. If you wish to allow use of your version of this file only
31 * under the terms of either the GPL or the LGPL, and not to allow others to
32 * use your version of this file under the terms of the MPL, indicate your
33 * decision by deleting the provisions above and replace them with the notice
34 * and other provisions required by the GPL or the LGPL. If you do not delete
35 * the provisions above, a recipient may use your version of this file under
36 * the terms of any one of the MPL, the GPL or the LGPL.
37 *
38 * ***** END LICENSE BLOCK ***** */
39
40 #include "nsISupports.idl"
41
42 interface nsIURI;
43 interface imgIRequest;
44 interface nsIProperties;
45
46 /**
47 * imgICache interface
48 *
49 * @author Stuart Parmenter <pavlov@netscape.com>
50 * @version 0.1
51 * @see imagelib2
52 */
53 [scriptable, uuid(f1b74aae-5661-4753-a21c-66dd644afebc)]
54 interface imgICache : nsISupports
55 {
56 /**
57 * Evict images from the cache.
58 *
59 * @param chrome If TRUE, evict only chrome images.
60 * If FALSE, evict everything except chrome images.
61 */
62 void clearCache(in boolean chrome);
63
64 /**
65 * Evict images from the cache.
66 *
67 * @param uri The URI to remove.
68 * @return NS_OK if \a uri was removed from the cache.
69 * NS_ERROR_NOT_AVAILABLE if \a uri was unable to be removed from the cache.
70 */
71 void removeEntry(in nsIURI uri);
72
73 /**
74 * Find Properties
75 * Used to get properties such as 'type' and 'content-disposition'
76 * 'type' is a nsISupportsCString containing the images' mime type such as 'image/png'
77 * 'content-disposition' will be a nsISupportsCString containing the header
78 * If you call this before any data has been loaded from a URI, it will succeed,
79 * but come back empty.
80 *
81 * @param uri The URI to look up.
82 * @returns NULL if the URL was not found in the cache
83 */
84 nsIProperties findEntryProperties(in nsIURI uri);
85 };