Reviewed by Darin
[WebKit-https.git] / WebKit / Misc / WebIconDatabasePrivate.h
1 /*
2  * Copyright (C) 2005 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #import <Cocoa/Cocoa.h>
30 #import <WebKit/WebIconDatabase.h>
31
32 @class WebFileDatabase;
33 @class WebCoreIconDatabaseBridge;
34 @class WebDataSource;
35
36 @interface WebIconDatabasePrivate : NSObject {
37
38 @public
39     WebCoreIconDatabaseBridge *databaseBridge;
40     
41     NSMutableDictionary *htmlIcons;
42     NSMutableDictionary *defaultIcons;
43 }
44
45 @end
46
47 // Sent when all icons are removed from the databse. The object of the notification is 
48 // the icon database. There is no userInfo. Clients should react by removing any cached
49 // icon images from the user interface. Clients need not and should not call 
50 // releaseIconForURL: in response to this notification.
51 extern NSString *WebIconDatabaseDidRemoveAllIconsNotification;
52
53 @interface WebIconDatabase (WebPendingPublic)
54 /*!
55    @method removeAllIcons:
56    @discussion Causes the icon database to delete all of the images that it has stored,
57    and to send out the notification WebIconDatabaseDidRemoveAllIconsNotification.
58 */
59 - (void)removeAllIcons;
60
61 /*!
62    @method isIconExpiredForIconURL:
63    @discussion Returns whether or not the icon at the specified URL is expired in the DB
64 */
65 - (BOOL)isIconExpiredForIconURL:(NSString *)iconURL;
66
67 @end
68
69 @interface WebIconDatabase (WebPrivate)
70
71 - (BOOL)_isEnabled;
72
73 // Called by WebIconLoader after loading an icon.
74 - (void)_setIconData:(NSData *)data forIconURL:(NSString *)iconURL;
75 - (void)_setHaveNoIconForIconURL:(NSString *)iconURL;
76
77 // Called by WebDataSource to bind a web site URL to a icon URL and icon image.
78 - (void)_setIconURL:(NSString *)iconURL forURL:(NSString *)URL;
79
80 - (BOOL)_hasEntryForIconURL:(NSString *)iconURL;
81 - (void)_sendNotificationForURL:(NSString *)URL;
82
83 - (void)loadIconFromURL:(NSString *)iconURL;
84
85 @end