import "sbICascadeFilterSet.idl";
Public Member Functions | |
unsigned short | appendFilter (in AString aProperty) |
Add a new property value filter to the end of the cascade. | |
unsigned short | appendSearch ([array, size_is(aPropertyArrayCount)] in wstring aPropertyArray, in unsigned long aPropertyArrayCount) |
Add a new text search filter to the end of the cascade. | |
void | remove (in unsigned short aIndex) |
Remove a filter from the cascade. | |
void | changeFilter (in unsigned short aIndex, in AString aProperty) |
Change the property used on a filter. | |
void | set (in unsigned short aIndex,[array, size_is(aValueArrayCount)] in wstring aValueArray, in unsigned long aValueArrayCount) |
Set the configuration of a filter. Note that changing a filter will clear the configuration of all downstream filters. | |
nsIArray | get (in unsigned short aIndex) |
Get the configuration of a filter. | |
void | clearAll () |
Clear the configuration of all filters. | |
nsIStringEnumerator | getValues (in unsigned short aIndex) |
Get the list of possible values for a filter. | |
AString | getValueAt (in unsigned short aIndex, in unsigned long aValueIndex) |
Get a single value of a filter list. | |
nsITreeView | getTreeView (in unsigned short aIndex) |
Get a nsITreeView to display the specified filter's contents. | |
unsigned long | getValueCount (in unsigned short aIndex,[optional] in boolean aUseCache) |
Get the number of possible values for a filter. | |
AString | getProperty (in unsigned short aIndex) |
Get the property for a filter by index. | |
boolean | isSearch (in unsigned short aIndex) |
Determine if the filter at a given index is a search filter. | |
void | addListener (in sbICascadeFilterSetListener aListener) |
Add a listener to get notified of filter configuration changes. | |
void | removeListener (in sbICascadeFilterSetListener aListener) |
Remove listener from notification list. | |
Public Attributes | |
readonly attribute unsigned short | length |
Definition at line 60 of file sbICascadeFilterSet.idl.
unsigned short sbICascadeFilterSet::appendFilter | ( | in AString | aProperty | ) |
Add a new property value filter to the end of the cascade.
aProperty | Property that this filter will filter |
unsigned short sbICascadeFilterSet::appendSearch | ( | [array, size_is(aPropertyArrayCount)] in wstring | aPropertyArray, | |
in unsigned long | aPropertyArrayCount | |||
) |
Add a new text search filter to the end of the cascade.
aPropertyArray | Array of property that this text search filter will search over. Use a single element array with the value "*" to indicate all properties are to be searched. | |
aPropertyArrayCount | The length of the aPropertyArray array |
void sbICascadeFilterSet::remove | ( | in unsigned short | aIndex | ) |
Remove a filter from the cascade.
aIndex | Index of the filter to be removed |
void sbICascadeFilterSet::changeFilter | ( | in unsigned short | aIndex, | |
in AString | aProperty | |||
) |
Change the property used on a filter.
aIndex | Index of the filter to change | |
aProperty | Property to change the filter to |
void sbICascadeFilterSet::set | ( | in unsigned short | aIndex, | |
[array, size_is(aValueArrayCount)] in wstring | aValueArray, | |||
in unsigned long | aValueArrayCount | |||
) |
Set the configuration of a filter. Note that changing a filter will clear the configuration of all downstream filters.
aIndex | Index of the filter to be configured | |
aValueArray | Array of values used to constrain the filter. Note that only the first item in the array is used to constrain a text search filter. Send a zero-length array to reset the filter. | |
aValueArrayCount | length of the aValueArray array |
nsIArray sbICascadeFilterSet::get | ( | in unsigned short | aIndex | ) |
Get the configuration of a filter.
aIndex | Index of the filter to retrieve the configuration from |
nsIStringEnumerator sbICascadeFilterSet::getValues | ( | in unsigned short | aIndex | ) |
Get the list of possible values for a filter.
aIndex | Index of the filter |
AString sbICascadeFilterSet::getValueAt | ( | in unsigned short | aIndex, | |
in unsigned long | aValueIndex | |||
) |
Get a single value of a filter list.
aIndex | Index of the filter | |
aValueIndex | Index of the value to get within the specified filter |
nsITreeView sbICascadeFilterSet::getTreeView | ( | in unsigned short | aIndex | ) |
Get a nsITreeView to display the specified filter's contents.
aIndex | Index of the filter |
unsigned long sbICascadeFilterSet::getValueCount | ( | in unsigned short | aIndex, | |
[optional] in boolean | aUseCache | |||
) |
Get the number of possible values for a filter.
aIndex | Index of the filter | |
aUseCache | If true, use a cached value if available. This may be used by listeners to get a new value count without forcing the count to be recalculated. The cached value may not be the most up-to-date value. The default is false. |
AString sbICascadeFilterSet::getProperty | ( | in unsigned short | aIndex | ) |
Get the property for a filter by index.
aIndex | Index of the filter |
boolean sbICascadeFilterSet::isSearch | ( | in unsigned short | aIndex | ) |
Determine if the filter at a given index is a search filter.
aIndex | Index of the filter |
void sbICascadeFilterSet::addListener | ( | in sbICascadeFilterSetListener | aListener | ) |
Add a listener to get notified of filter configuration changes.
aListener | Listener to receive change notifications |
void sbICascadeFilterSet::removeListener | ( | in sbICascadeFilterSetListener | aListener | ) |
Remove listener from notification list.
aListener | Listener to remove |
readonly attribute unsigned short sbICascadeFilterSet::length |
Number of filters in the set
Definition at line 65 of file sbICascadeFilterSet.idl.