sbIHotkeyService.idl

Go to the documentation of this file.

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2009 POTI, Inc.
 * http://www.songbirdnest.com
 *
 * This file may be licensed under the terms of of the
 * GNU General Public License Version 2 (the ``GPL'').
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the GPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the GPL along with this
 * program. If not, go to http://www.gnu.org/licenses/gpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *=END SONGBIRD GPL
 */

#include "nsISupports.idl"


[scriptable, uuid(b021d970-1dd1-11b2-9c4e-8c3e3cfe9b88)]
interface sbIHotkeyConfiguration : nsISupports
{
  attribute AString key;


  attribute AString keyReadable;


  attribute AString action;
};


interface nsIArray;

[scriptable, uuid(99c883d0-1dd1-11b2-88fc-a67455e77067)]
interface sbIHotkeyService : nsISupports
{
  attribute boolean hotkeysEnabled;


  readonly attribute AString hotkeysEnabledDRKey;


  nsIArray getHotkeys();


  sbIHotkeyConfiguration getHotkey(in AString aKey);


  void setHotkeys(in nsIArray aHotkeyConfigList);


  void addHotkey(in sbIHotkeyConfiguration aHotkeyConfig);


  void removeHotkeyByKey(in AString aKey);


  void removeHotkeysByAction(in AString aAction);
};


//
// C++ defs.
//

%{C++
#define SB_HOTKEY_SERVICE_CONTRACTID \
          "@songbirdnest.com/Songbird/HotkeyService;1"

#define SB_HOTKEY_CONFIGURATION_CONTRACTID \
          "@songbirdnest.com/Songbird/HotkeyConfiguration;1"
%}C++