xpcom/components/nsICategoryManager.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39 #include "nsISimpleEnumerator.idl"
  40
  41 /*
  42  * nsICategoryManager
  43  */
  44
  45 [scriptable, uuid(3275b2cd-af6d-429a-80d7-f0c5120342ac)]
  46 interface nsICategoryManager : nsISupports
  47 {
  48     /**
  49      * Get the value for the given category's entry.
  50      * @param aCategory The name of the category ("protocol")
  51      * @param aEntry The entry you're looking for ("http")
  52      * @return The value.
  53      */
  54     string getCategoryEntry(in string aCategory, in string aEntry);
  55
  56     /**
  57      * Add an entry to a category.
  58      * @param aCategory The name of the category ("protocol")
  59      * @param aEntry The entry to be added ("http")
  60      * @param aValue The value for the entry ("moz.httprulez.1")
  61      * @param aPersist Should this data persist between invocations?
  62      * @param aReplace Should we replace an existing entry?
  63      * @return Previous entry, if any
  64      */
  65     string addCategoryEntry(in string aCategory, in string aEntry,
  66                             in string aValue, in boolean aPersist,
  67                             in boolean aReplace);
  68
  69     /**
  70      * Delete an entry from the category.
  71      * @param aCategory The name of the category ("protocol")
  72      * @param aEntry The entry to be added ("http")
  73      * @param aPersist Delete persistent data from registry, if present?
  74      */
  75     void deleteCategoryEntry(in string aCategory, in string aEntry,
  76                                in boolean aPersist);
  77
  78     /**
  79      * Delete a category and all entries.
  80      * @param aCategory The category to be deleted.
  81      */
  82     void deleteCategory(in string aCategory);
  83
  84     /**
  85      * Enumerate the entries in a category.
  86      * @param aCategory The category to be enumerated.
  87      * @return a simple enumerator, each result QIs to
  88      *         nsISupportsCString.
  89      */
  90     nsISimpleEnumerator enumerateCategory(in string aCategory);
  91
  92     /**
  93      * Enumerate all existing categories
  94      * @param aCategory The category to be enumerated.
  95      * @return a simple enumerator, each result QIs to
  96      *         nsISupportsCString.
  97      */
  98     nsISimpleEnumerator enumerateCategories();
  99 };
 100