Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsICategoryManager Interface Reference

import "nsICategoryManager.idl";

Inheritance diagram for nsICategoryManager:
Inheritance graph
[legend]
Collaboration diagram for nsICategoryManager:
Collaboration graph
[legend]

List of all members.

Public Member Functions

string getCategoryEntry (in string aCategory, in string aEntry)
 Get the value for the given category's entry.
string addCategoryEntry (in string aCategory, in string aEntry, in string aValue, in boolean aPersist, in boolean aReplace)
 Add an entry to a category.
void deleteCategoryEntry (in string aCategory, in string aEntry, in boolean aPersist)
 Delete an entry from the category.
void deleteCategory (in string aCategory)
 Delete a category and all entries.
nsISimpleEnumerator enumerateCategory (in string aCategory)
 Enumerate the entries in a category.
nsISimpleEnumerator enumerateCategories ()
 Enumerate all existing categories.

Detailed Description

Definition at line 47 of file nsICategoryManager.idl.


Member Function Documentation

string nsICategoryManager::addCategoryEntry ( in string  aCategory,
in string  aEntry,
in string  aValue,
in boolean  aPersist,
in boolean  aReplace 
)

Add an entry to a category.

Parameters:
aCategoryThe name of the category ("protocol")
aEntryThe entry to be added ("http")
aValueThe value for the entry ("moz.httprulez.1")
aPersistShould this data persist between invocations?
aReplaceShould we replace an existing entry?
Returns:
Previous entry, if any

Delete a category and all entries.

Parameters:
aCategoryThe category to be deleted.
void nsICategoryManager::deleteCategoryEntry ( in string  aCategory,
in string  aEntry,
in boolean  aPersist 
)

Delete an entry from the category.

Parameters:
aCategoryThe name of the category ("protocol")
aEntryThe entry to be added ("http")
aPersistDelete persistent data from registry, if present?

Enumerate all existing categories.

Parameters:
aCategoryThe category to be enumerated.
Returns:
a simple enumerator, each result QIs to nsISupportsCString.

Enumerate the entries in a category.

Parameters:
aCategoryThe category to be enumerated.
Returns:
a simple enumerator, each result QIs to nsISupportsCString.

Get the value for the given category's entry.

Parameters:
aCategoryThe name of the category ("protocol")
aEntryThe entry you're looking for ("http")
Returns:
The value.

The documentation for this interface was generated from the following file: