WebIconDatabasePrivate.h 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. /*
  2. * Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2009 Apple 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. #import <WebKit/WebIconDatabase.h>
  29. // FIXME: Some of the following is not API and should be moved
  30. // either inside WebIconDatabase.mm, or to WebIconDatabaseInternal.h.
  31. // Sent when all icons are removed from the database. The object of the notification is
  32. // the icon database. There is no userInfo. Clients should react by removing any cached
  33. // icon images from the user interface. Clients need not and should not call
  34. // releaseIconForURL: in response to this notification.
  35. extern NSString *WebIconDatabaseDidRemoveAllIconsNotification;
  36. @interface WebIconDatabase (WebPendingPublic)
  37. /*!
  38. @method isEnabled
  39. @discussion Returns true if the icon database is currently enabled, or false if it
  40. is disabled.
  41. */
  42. - (BOOL)isEnabled;
  43. /*!
  44. @method setEnabled:
  45. @discussion Enables or disables the icon database based on the flag passed in.
  46. @param flag Pass true to enable the icon database, or false to disable it.
  47. */
  48. - (void)setEnabled:(BOOL)flag;
  49. /*!
  50. @method removeAllIcons
  51. @discussion Causes the icon database to delete all of the images that it has stored,
  52. and to send out the notification WebIconDatabaseDidRemoveAllIconsNotification.
  53. */
  54. - (void)removeAllIcons;
  55. @end
  56. @interface WebIconDatabase (WebPrivate)
  57. + (void)_checkIntegrityBeforeOpening;
  58. @end