WebCore:
[WebKit-https.git] / WebCore / bridge / mac / WebCoreIconDatabaseBridge.h
1 /*
2  * Copyright (C) 2006 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifdef __cplusplus
27 namespace WebCore { 
28     class IconDatabase; 
29 }
30 typedef WebCore::IconDatabase WebCoreIconDatabase;
31 #else
32 @class WebCoreIconDatabase;
33 #endif
34
35 @interface WebCoreIconDatabaseBridge : NSObject
36 {
37     WebCoreIconDatabase *_iconDB;
38 }
39 - (BOOL)openSharedDatabaseWithPath:(NSString *)path;
40 - (void)closeSharedDatabase;
41 - (BOOL)isOpen;
42 - (void)removeAllIcons;
43
44 - (NSImage *)iconForPageURL:(NSString *)url withSize:(NSSize)size;
45 - (NSString *)iconURLForPageURL:(NSString *)url;
46 - (NSImage *)defaultIconWithSize:(NSSize)size;
47 - (void)retainIconForURL:(NSString *)url;
48 - (void)releaseIconForURL:(NSString *)url;
49
50 - (BOOL)isIconExpiredForIconURL:(NSString *)iconURL;
51
52 - (void)setPrivateBrowsingEnabled:(BOOL)flag;
53 - (BOOL)privateBrowsingEnabled;
54
55 - (NSString *)defaultDatabaseFilename;
56
57 - (void)_setIconData:(NSData *)data forIconURL:(NSString *)iconURL;
58 - (void)_setHaveNoIconForIconURL:(NSString *)iconURL;
59 - (BOOL)_setIconURL:(NSString *)iconURL forPageURL:(NSString *)pageURL;
60 - (BOOL)_hasEntryForIconURL:(NSString *)iconURL;
61
62 - (BOOL)_isEmpty;
63 @end
64
65 // The WebCoreIconDatabaseBridge protocol contains methods for use by the WebCore side of the bridge.
66
67 @protocol WebCoreIconDatabaseBridge
68 + (WebCoreIconDatabaseBridge *)sharedInstance;
69 - (void)loadIconFromURL:(NSString *)iconURL;
70 @end
71
72 // This interface definition allows those who hold a WebCoreIconDatabaseBridge * to call all the methods
73 // in the WebCoreIconDatabaseBridge protocol without requiring the base implementation to supply the methods.
74 // This idiom is appropriate because WebCoreIconDatabaseBridge is an abstract class.
75
76 @interface WebCoreIconDatabaseBridge (SubclassResponsibility) <WebCoreIconDatabaseBridge>
77 @end