gecko/widget/public/nsIJumpListItem.idl

152 lines
4.5 KiB
Plaintext
Raw Normal View History

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** 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 mozilla.org code.
*
* The Initial Developer of the Original Code is
* Mozilla Foundation.
* Portions created by the Initial Developer are Copyright (C) 2009
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Jim Mathies <jmathies@mozilla.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 nsILocalHandlerApp;
interface nsIMutableArray;
/**
* Implements Win7 Taskbar jump list item interfaces.
*
* Note to consumers: it's reasonable to expect we'll need support for other types
* of jump list items (an audio file, an email message, etc.). To add types,
* create the specific interface here, add an implementation class to WinJumpListItem,
* and add support to addListBuild & removed items processing.
*
*/
[scriptable, uuid(ACB8FB3C-E1B0-4044-8A50-E52C3E7C1057)]
interface nsIJumpListItem : nsISupports
{
const short JUMPLIST_ITEM_EMPTY = 0; // Empty list item
const short JUMPLIST_ITEM_SEPARATOR = 1; // Separator
const short JUMPLIST_ITEM_LINK = 2; // Web link item
const short JUMPLIST_ITEM_SHORTCUT = 3; // Application shortcut
/**
* Retrieves the jump list item type.
*/
readonly attribute short type;
/**
* Compare this item to another.
*
* Compares the type and other properties specific to this item's
* type.
*
* separator: type
* link: type, uri, title
* shortcut: type, handler app
*/
boolean equals(in nsIJumpListItem item);
};
/**
* A menu separator.
*/
[scriptable, uuid(69A2D5C5-14DC-47da-925D-869E0BD64D27)]
interface nsIJumpListSeparator : nsIJumpListItem
{
/* nothing needed here */
};
/**
* A URI link jump list item.
*
* Note the application must be the registered protocol
* handler for the protocol of the link.
*/
[scriptable, uuid(76EA47B1-C797-49b3-9F18-5E740A688524)]
interface nsIJumpListLink : nsIJumpListItem
{
/**
* Set or get the uri for this link item.
*/
attribute nsIURI uri;
/**
* Set or get the title for a link item.
*/
attribute AString uriTitle;
/**
* Get a 'privacy safe' unique string hash of the uri's
* spec. Useful in tracking removed items using visible
* data stores such as prefs. Generates an MD5 hash of
* the URI spec using nsICryptoHash.
*/
readonly attribute ACString uriHash;
/**
* Compare this item's hash to another uri.
*
* Generates a spec hash of the incoming uri and compares
* it to this item's uri spec hash.
*/
boolean compareHash(in nsIURI uri);
};
/**
* A generic application shortcut with command line support.
*/
[scriptable, uuid(9664389E-11D6-4bea-B68C-D70232162068)]
interface nsIJumpListShortcut : nsIJumpListItem
{
/**
* Set or get the handler app for this shortcut item.
*
* @throw NS_ERROR_FILE_NOT_FOUND if the handler app can
* not be found on the system.
*/
attribute nsILocalHandlerApp app;
/**
* Set or get the icon displayed with the jump list item.
*
* Indicates the resource index of the icon contained
* within the the handler executable.
*/
attribute long iconIndex;
};