2011-05-20 12:37:02 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/MPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
|
|
|
*
|
|
|
|
* The Original Code is Places code.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is the Mozilla Foundation.
|
|
|
|
*
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2011
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Justin Lebar <justin.lebar@gmail.com>
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
|
|
|
|
interface nsIURI;
|
|
|
|
interface nsIFaviconDataCallback;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Interface for accessing the favicon service asynchronously.
|
|
|
|
*
|
|
|
|
* @status EXPERIMENTAL
|
|
|
|
*/
|
|
|
|
|
2011-08-31 14:28:13 +00:00
|
|
|
[scriptable, uuid(0cb4e536-e120-41e6-998f-66123d81ec53)]
|
2011-05-20 12:37:02 +00:00
|
|
|
interface mozIAsyncFavicons : nsISupports
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* Declares that a given page uses a favicon with the given URI and
|
|
|
|
* attempts to fetch and save the icon data by loading the favicon URI
|
|
|
|
* through an async network request.
|
|
|
|
*
|
|
|
|
* If the icon data already exists, we won't try to reload the icon unless
|
|
|
|
* aForceReload is true. Similarly, if the icon is in the failed favicon
|
|
|
|
* cache we won't do anything unless aForceReload is true, in which case
|
|
|
|
* we'll try to reload the favicon.
|
|
|
|
*
|
|
|
|
* This function will only save favicons for "good" URIs, as defined by what
|
|
|
|
* gets added to history or is a bookmark. For "bad" URIs, this function
|
|
|
|
* will succeed but do nothing. This function will also ignore the error
|
|
|
|
* page favicon URI (see FAVICON_ERRORPAGE_URL below).
|
|
|
|
*
|
|
|
|
* Icons that fail to load will automatically be added to the failed favicon
|
|
|
|
* cache, and this function will not save favicons for non-bookmarked URIs
|
|
|
|
* when history is disabled.
|
|
|
|
*
|
|
|
|
* @note This function is identical to
|
|
|
|
* nsIFaviconService::setAndLoadFaviconForPage.
|
|
|
|
*
|
|
|
|
* @param aPageURI
|
|
|
|
* URI of the page whose favicon is being set.
|
|
|
|
* @param aFaviconURI
|
|
|
|
* URI of the favicon to associate with the page.
|
|
|
|
* @param aForceReload
|
|
|
|
* If aForceReload is false, we try to reload the favicon only if we
|
|
|
|
* don't have it or it has expired from the cache. Setting
|
|
|
|
* aForceReload to true causes us to reload the favicon even if we
|
|
|
|
* have a usable copy.
|
|
|
|
* @param aCallback
|
|
|
|
* Once we're done setting and/or fetching the favicon, we invoke this
|
|
|
|
* callback.
|
|
|
|
*
|
|
|
|
* @see nsIFaviconDataCallback in nsIFaviconService.idl.
|
|
|
|
*/
|
|
|
|
void setAndFetchFaviconForPage(in nsIURI aPageURI,
|
|
|
|
in nsIURI aFaviconURI,
|
|
|
|
in boolean aForceReload,
|
|
|
|
[optional] in nsIFaviconDataCallback aCallback);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieve the URL of the favicon for the given page.
|
|
|
|
*
|
|
|
|
* @param aPageURI
|
|
|
|
* URI of the page whose favicon's URL we're looking up
|
|
|
|
* @param aCallback
|
|
|
|
* Once we've found the favicon's URL, we invoke this callback. Note
|
|
|
|
* that the callback's aDataLen will be 0, aData will be null, and
|
|
|
|
* aMimeType will be empty -- only aURI will be non-zero/null/empty.
|
|
|
|
*
|
|
|
|
* @see nsIFaviconDataCallback in nsIFaviconService.idl.
|
|
|
|
*/
|
|
|
|
void getFaviconURLForPage(in nsIURI aPageURI,
|
|
|
|
in nsIFaviconDataCallback aCallback);
|
2011-08-31 14:28:13 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieve the URL and data of the favicon for the given page.
|
|
|
|
*
|
|
|
|
* @param aPageURI
|
|
|
|
* URI of the page whose favicon's URL and data we're looking up
|
|
|
|
* @param aCallback
|
|
|
|
* Once we've found the favicon's URL, we invoke this callback with
|
|
|
|
* the favicon data.
|
|
|
|
*
|
|
|
|
* @see nsIFaviconDataCallback in nsIFaviconService.idl.
|
|
|
|
*/
|
|
|
|
void getFaviconDataForPage(in nsIURI aPageURI,
|
|
|
|
in nsIFaviconDataCallback aCallback);
|
2011-05-20 12:37:02 +00:00
|
|
|
};
|