sbIHotkeyService.idl
Go to the documentation of this file.
1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /*
3  *=BEGIN SONGBIRD GPL
4  *
5  * This file is part of the Songbird web player.
6  *
7  * Copyright(c) 2005-2009 POTI, Inc.
8  * http://www.songbirdnest.com
9  *
10  * This file may be licensed under the terms of of the
11  * GNU General Public License Version 2 (the ``GPL'').
12  *
13  * Software distributed under the License is distributed
14  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
15  * express or implied. See the GPL for the specific language
16  * governing rights and limitations.
17  *
18  * You should have received a copy of the GPL along with this
19  * program. If not, go to http://www.gnu.org/licenses/gpl.html
20  * or write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  *
23  *=END SONGBIRD GPL
24  */
25 
26 #include "nsISupports.idl"
27 
28 
38 [scriptable, uuid(b021d970-1dd1-11b2-9c4e-8c3e3cfe9b88)]
40 {
45  attribute AString key;
46 
47 
52  attribute AString keyReadable;
53 
54 
59  attribute AString action;
60 };
61 
62 
72 interface nsIArray;
73 
74 [scriptable, uuid(99c883d0-1dd1-11b2-88fc-a67455e77067)]
76 {
81  attribute boolean hotkeysEnabled;
82 
83 
88  readonly attribute AString hotkeysEnabledDRKey;
89 
90 
98  nsIArray getHotkeys();
99 
100 
109  sbIHotkeyConfiguration getHotkey(in AString aKey);
110 
111 
119  void setHotkeys(in nsIArray aHotkeyConfigList);
120 
121 
128  void addHotkey(in sbIHotkeyConfiguration aHotkeyConfig);
129 
130 
137  void removeHotkeyByKey(in AString aKey);
138 
139 
146  void removeHotkeysByAction(in AString aAction);
147 };
148 
149 
150 //
151 // C++ defs.
152 //
153 
154 %{C++
155 #define SB_HOTKEY_SERVICE_CONTRACTID \
156  "@songbirdnest.com/Songbird/HotkeyService;1"
157 
158 #define SB_HOTKEY_CONFIGURATION_CONTRACTID \
159  "@songbirdnest.com/Songbird/HotkeyConfiguration;1"
160 %}C++
161 
162 
attribute AString action
Hotkey action string.
void removeHotkeysByAction(in AString aAction)
Remove all hotkeys with the action specified by aAction.
var uuid
function C(H)
void removeHotkeyByKey(in AString aKey)
Remove the hotkey with the key specified by aKey.
nsIArray getHotkeys()
Return the set of hot key configurations as an nsIArray of sbIHotkeyConfiguration objects...
void addHotkey(in sbIHotkeyConfiguration aHotkeyConfig)
Add the hotkey specified by aHotkeyConfig.
sbIHotkeyConfiguration getHotkey(in AString aKey)
Return the hotkey configuration for the key specified by aKey.
attribute AString key
Hotkey key.
attribute boolean hotkeysEnabled
If true, hotkeys are enabled.
void setHotkeys(in nsIArray aHotkeyConfigList)
Set the hot key configuration to the nsIArray of sbIHotkeyConfiguration objects specified by aHotkeyC...
readonly attribute AString hotkeysEnabledDRKey
Key string for data remote used to enable or disable hot keys.
attribute AString keyReadable
Human readable key name.