Main provider, used to store user defined presets. More...

Inheritance diagram for ngIMainEqualizerPresetProvider:

Collaboration diagram for ngIMainEqualizerPresetProvider:

Public Member Functions
void	deletePreset (in AString aName)
	Delete the user set preset with the given name. More...

void	savePreset (in AString aName, in nsIArray aValues)
	Save a preset with the given name and values into the users profile. More...

Additional Inherited Members
Public Attributes inherited from ngIEqualizerPresetProvider
readonly attribute nsIArray	presets
	Array of presets. Each element should implement ngIEqualizerPreset. More...

Detailed Description

Main provider, used to store user defined presets.

Note: Emits "equalizer-preset-saved" and "equalizer-preset-deleted" observer notifications.; Is a service.

Member Function Documentation

void ngIMainEqualizerPresetProvider::deletePreset ( in AString aName )

Delete the user set preset with the given name.

Note: Observers of the topic "equalizer-preset-deleted" are notified after the preset has been deleted.

Exceptions

NS_ERROR_ILLEGAL_VALUE if the preset name has no contents (is an empty string).

void ngIMainEqualizerPresetProvider::savePreset	(	in AString	aName,
		in nsIArray	aValues
	)

Save a preset with the given name and values into the users profile.

Note: Observers of the topic "equalizer-preset-saved" are notified after the preset has been saved with the service as subject and the name as data.; This should not be used to add presets to the list unless importing, rather create an ngIEqualizerPresetProvider to add presets.

Exceptions

NS_ERROR_ILLEGAL_VALUE	if the supplied array does not have the same length as the equalizer has bands.
NS_ERROR_ILLEGAL_VALUE	if the preset name has no contents (is an empty string).

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

/home/martin/dev/nightingale-hacking/components/equalizerpresets/public/ngIEqualizerPresetProvider.idl