| /* -*- 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 Places Tagging Service code. |
| * |
| * The Initial Developer of the Original Code is |
| * Mozilla Corporation. |
| * Portions created by the Initial Developer are Copyright (C) 2007 |
| * the Initial Developer. All Rights Reserved. |
| * |
| * Contributor(s): |
| * Asaf Romano <mano@mozilla.com> (Original Author) |
| * |
| * 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 nsIVariant; |
| |
| [scriptable, uuid(e39cea60-7e6d-4c8b-80a3-997af1c2cbcb)] |
| interface nsITaggingService : nsISupports |
| { |
| /** |
| * Tags a URL with the given set of tags. Current tags set for the URL |
| * persist. Tags in aTags which are already set for the given URL are |
| * ignored. |
| * |
| * @param aURI |
| * the URL to tag. |
| * @param aTags |
| * Array of tags to set for the given URL. Each element within the |
| * array can be either a tag name or a concrete itemId of a tag |
| * container. |
| */ |
| void tagURI(in nsIURI aURI, in nsIVariant aTags); |
| |
| /** |
| * Removes tags from a URL. Tags from aTags which are not set for the |
| * given URL are ignored. |
| * |
| * @param aURI |
| * the URL to un-tag. |
| * @param aTags |
| * Array of tags to unset. pass null to remove all tags from the given |
| * url. Each element within the array can be either a tag name or a |
| * concrete itemId of a tag container. |
| */ |
| void untagURI(in nsIURI aURI, in nsIVariant aTags); |
| |
| /** |
| * Retrieves all URLs tagged with the given tag. |
| * |
| * @param aTag |
| * tag name |
| * @returns Array of uris tagged with aTag. |
| */ |
| nsIVariant getURIsForTag(in AString aTag); |
| |
| /** |
| * Retrieves all tags set for the given URL. |
| * |
| * @param aURI |
| * a URL. |
| * @returns array of tags (sorted by name). |
| */ |
| void getTagsForURI(in nsIURI aURI, out unsigned long length, [retval, array, size_is(length)] out wstring aTags); |
| |
| /** |
| * Retrieves all tags used to tag URIs in the data-base (sorted by name). |
| */ |
| readonly attribute nsIVariant allTags; |
| }; |
| |
| %{C++ |
| |
| #define TAGGING_SERVICE_CID "@mozilla.org/browser/tagging-service;1" |
| |
| %} |