PageRenderTime 76ms CodeModel.GetById 35ms app.highlight 1ms RepoModel.GetById 39ms app.codeStats 0ms

/gecko_sdk/idl/nsICategoryManager.idl

http://firefox-mac-pdf.googlecode.com/
IDL | 101 lines | 15 code | 9 blank | 77 comment | 0 complexity | d45f839b17d0b00e5465e81c9429fcb0 MD5 | raw file
  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 * @status FROZEN
 44 */
 45
 46[scriptable, uuid(3275b2cd-af6d-429a-80d7-f0c5120342ac)]
 47interface nsICategoryManager : nsISupports
 48{
 49    /**
 50     * Get the value for the given category's entry.
 51     * @param aCategory The name of the category ("protocol")
 52     * @param aEntry The entry you're looking for ("http")
 53     * @return The value.
 54     */
 55    string getCategoryEntry(in string aCategory, in string aEntry);
 56    
 57    /**
 58     * Add an entry to a category.
 59     * @param aCategory The name of the category ("protocol")
 60     * @param aEntry The entry to be added ("http")
 61     * @param aValue The value for the entry ("moz.httprulez.1")
 62     * @param aPersist Should this data persist between invocations?
 63     * @param aReplace Should we replace an existing entry?
 64     * @return Previous entry, if any
 65     */
 66    string addCategoryEntry(in string aCategory, in string aEntry,
 67			    in string aValue, in boolean aPersist,
 68			    in boolean aReplace);
 69
 70    /**
 71     * Delete an entry from the category.
 72     * @param aCategory The name of the category ("protocol")
 73     * @param aEntry The entry to be added ("http")
 74     * @param aPersist Delete persistent data from registry, if present?
 75     */
 76    void deleteCategoryEntry(in string aCategory, in string aEntry,
 77                               in boolean aPersist);
 78
 79    /**
 80     * Delete a category and all entries.
 81     * @param aCategory The category to be deleted.
 82     */
 83    void deleteCategory(in string aCategory);
 84
 85    /**
 86     * Enumerate the entries in a category.
 87     * @param aCategory The category to be enumerated.
 88     * @return a simple enumerator, each result QIs to
 89     *         nsISupportsCString.
 90     */
 91    nsISimpleEnumerator enumerateCategory(in string aCategory);
 92
 93    /**
 94     * Enumerate all existing categories
 95     * @param aCategory The category to be enumerated.
 96     * @return a simple enumerator, each result QIs to
 97     *         nsISupportsCString.
 98     */
 99    nsISimpleEnumerator enumerateCategories();
100};
101