ngIEqualizerPresetProvider.idl
Go to the documentation of this file.
1 /*
2 //
3 // BEGIN NIGHTINGALE GPL
4 //
5 // This file is part of the Nightingale web player.
6 //
7 // http://getnightingale.com
8 //
9 // This file may be licensed under the terms of of the
10 // GNU General Public License Version 2 (the "GPL").
11 //
12 // Software distributed under the License is distributed
13 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
14 // express or implied. See the GPL for the specific language
15 // governing rights and limitations.
16 //
17 // You should have received a copy of the GPL along with this
18 // program. If not, go to http://www.gnu.org/licenses/gpl.html
19 // or write to the Free Software Foundation, Inc.,
20 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 //
22 // END NIGHTINGALE GPL
23 //
24 */
25 
26 #include "nsISupports.idl"
27 
28 interface nsIArray;
29 interface ngIEqualizerPreset;
30 
36 [scriptable, uuid(cfb2690d-659c-462a-ac8f-c4eef7c536de)]
38 {
42  readonly attribute nsIArray presets;
43 };
44 
45 
53 [scriptable, uuid(ed4cde10-746d-4cc9-9da4-7421543f711f)]
55 {
61 
65  PRBool hasPresetNamed(in AString aName);
66 };
67 
75 [scriptable, uuid(24e07f0f-8715-4768-a2fc-6ef171f4aabd)]
77 {
85  void deletePreset(in AString aName);
86 
100  void savePreset(in AString aName, in nsIArray aValues);
101 };
102 
103 %{C++
104 #define NG_EQUALIZER_PRESET_SAVE_TOPIC "equalizer-preset-saved"
105 #define NG_EQUALIZER_PRESET_DELETE_TOPIC "equalizer-preset-deleted"
106 %}
107 
116 [scriptable, uuid(28fd6696-89ac-4895-8a62-27039473d98d)]
118 {
124  readonly attribute nsIArray providers;
125 
135  readonly attribute nsIArray presets;
136 
141 
147 };
148 
149 %{C++
150 #define NG_EQUALIZER_PRESETS_CHANGED_TOPIC "equalizer-presets-changed"
151 %}
ngIEqualizerPreset getPresetByName(in AString aName)
Returns the preset in the collection with the given name.
PRBool hasPresetNamed(in AString aName)
Returns wether the collection contains a preset with this name.
void savePreset(in AString aName, in nsIArray aValues)
Save a preset with the given name and values into the users profile.
The manager collects all preset providers and provides a collection of them.
void registerPresetProvider(in ngIEqualizerPresetProvider aNewProvider)
Add a ngIEqualizerPresetProvider to the collection.
var uuid
function C(H)
Specific accessors to preset collections.
function d(s)
Main provider, used to store user defined presets.
Provides a set of immutable presets.
Simple default interface for equalizer presets.
void deletePreset(in AString aName)
Delete the user set preset with the given name.
readonly attribute nsIArray providers
Array of ngIEqualizerPresetProvider elements.
_updateCookies aName
readonly attribute nsIArray presets
Array containing all presets.
readonly attribute nsIArray presets
Array of presets. Each element should implement ngIEqualizerPreset.
void unregisterPresetProvider(in ngIEqualizerPresetProvider aProvider)
Remove an ngIEqualizerPresetProvider from the list.