PageRenderTime 28ms CodeModel.GetById 0ms RepoModel.GetById 0ms app.codeStats 1ms

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