Cascade filter management for a media list. More...

import"sbICascadeFilterSet.idl";

Inheritance diagram for sbICascadeFilterSet:

Collaboration diagram for sbICascadeFilterSet:

Public Member Functions
unsigned short	appendFilter (in AString aProperty)
	Add a new property value filter to the end of the cascade. More...

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. More...

void	remove (in unsigned short aIndex)
	Remove a filter from the cascade. More...

void	changeFilter (in unsigned short aIndex, in AString aProperty)
	Change the property used on a filter. More...

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. More...

nsIArray	get (in unsigned short aIndex)
	Get the configuration of a filter. More...

void	clearAll ()
	Clear the configuration of all filters. More...

nsIStringEnumerator	getValues (in unsigned short aIndex)
	Get the list of possible values for a filter. More...

AString	getValueAt (in unsigned short aIndex, in unsigned long aValueIndex)
	Get a single value of a filter list. More...

nsITreeView	getTreeView (in unsigned short aIndex)
	Get a nsITreeView to display the specified filter's contents. More...

unsigned long	getValueCount (in unsigned short aIndex, [optional] in boolean aUseCache)
	Get the number of possible values for a filter. More...

AString	getProperty (in unsigned short aIndex)
	Get the property for a filter by index. More...

boolean	isSearch (in unsigned short aIndex)
	Determine if the filter at a given index is a search filter. More...

void	addListener (in sbICascadeFilterSetListener aListener)
	Add a listener to get notified of filter configuration changes. More...

void	removeListener (in sbICascadeFilterSetListener aListener)
	Remove listener from notification list. More...

Public Attributes
readonly attribute unsigned short	length

Detailed Description

Cascade filter management for a media list.

See Also: sbICascadeFilterSetListener

Definition at line 60 of file sbICascadeFilterSet.idl.

Member Function Documentation

void sbICascadeFilterSet::addListener ( in sbICascadeFilterSetListener aListener )

Add a listener to get notified of filter configuration changes.

Parameters

aListener Listener to receive change notifications

unsigned short sbICascadeFilterSet::appendFilter ( in AString aProperty )

Add a new property value filter to the end of the cascade.

Parameters

aProperty Property that this filter will filter

Returns: The index of the newly created 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.

Parameters

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

Returns: The index of the newly created filter

void sbICascadeFilterSet::changeFilter	(	in unsigned short	aIndex,
		in AString	aProperty
	)

Change the property used on a filter.

Parameters

aIndex	Index of the filter to change
aProperty	Property to change the filter to

void sbICascadeFilterSet::clearAll ( )

Clear the configuration of all filters.

nsIArray sbICascadeFilterSet::get ( in unsigned short aIndex )

Get the configuration of a filter.

Parameters

aIndex Index of the filter to retrieve the configuration from

Returns: An array of values that the filter is currently configured for

AString sbICascadeFilterSet::getProperty ( in unsigned short aIndex )

Get the property for a filter by index.

Parameters

aIndex Index of the filter

Returns: The property for the given filter index

nsITreeView sbICascadeFilterSet::getTreeView ( in unsigned short aIndex )

Get a nsITreeView to display the specified filter's contents.

Parameters

aIndex Index of the filter

Returns: An nsITreeView

AString sbICascadeFilterSet::getValueAt	(	in unsigned short	aIndex,
		in unsigned long	aValueIndex
	)

Get a single value of a filter list.

Parameters

aIndex	Index of the filter
aValueIndex	Index of the value to get within the specified filter

Returns: The requested value

unsigned long sbICascadeFilterSet::getValueCount	(	in unsigned short	aIndex,
		[optional] in boolean	aUseCache
	)

Get the number of possible values for a filter.

Parameters

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.

Returns: The number of possible values for a filter

nsIStringEnumerator sbICascadeFilterSet::getValues ( in unsigned short aIndex )

Get the list of possible values for a filter.

Parameters

aIndex Index of the filter

Returns: A string enumerator of the values of the filter

boolean sbICascadeFilterSet::isSearch ( in unsigned short aIndex )

Determine if the filter at a given index is a search filter.

Parameters

aIndex Index of the filter

Returns: True if the filter at the index is a search filter

void sbICascadeFilterSet::remove ( in unsigned short aIndex )

Remove a filter from the cascade.

Parameters

aIndex Index of the filter to be removed

void sbICascadeFilterSet::removeListener ( in sbICascadeFilterSetListener aListener )

Remove listener from notification list.

Parameters

aListener Listener to remove

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.

Parameters

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

Member Data Documentation

readonly attribute unsigned short sbICascadeFilterSet::length

Number of filters in the set

Definition at line 65 of file sbICascadeFilterSet.idl.

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

/home/martin/dev/nightingale-hacking/components/library/base/public/sbICascadeFilterSet.idl

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation