sbIHotkeyService Interface Reference

import"sbIHotkeyService.idl";

Inheritance diagram for sbIHotkeyService:
[legend]
Collaboration diagram for sbIHotkeyService:
[legend]

Public Member Functions

nsIArray getHotkeys ()
 Return the set of hot key configurations as an nsIArray of sbIHotkeyConfiguration objects. More...
 
sbIHotkeyConfiguration getHotkey (in AString aKey)
 Return the hotkey configuration for the key specified by aKey. More...
 
void setHotkeys (in nsIArray aHotkeyConfigList)
 Set the hot key configuration to the nsIArray of sbIHotkeyConfiguration objects specified by aHotkeyConfigList. More...
 
void addHotkey (in sbIHotkeyConfiguration aHotkeyConfig)
 Add the hotkey specified by aHotkeyConfig. More...
 
void removeHotkeyByKey (in AString aKey)
 Remove the hotkey with the key specified by aKey. More...
 
void removeHotkeysByAction (in AString aAction)
 Remove all hotkeys with the action specified by aAction. More...
 

Public Attributes

attribute boolean hotkeysEnabled
 If true, hotkeys are enabled. More...
 
readonly attribute AString hotkeysEnabledDRKey
 Key string for data remote used to enable or disable hot keys. More...
 

Detailed Description

This interface provides services for managing global hot key settings.

"@songbirdnest.com/Songbird/HotkeyService;1" Use get service with this component.

Definition at line 75 of file sbIHotkeyService.idl.

Member Function Documentation

void sbIHotkeyService::addHotkey ( in sbIHotkeyConfiguration  aHotkeyConfig)

Add the hotkey specified by aHotkeyConfig.

Parameters
aHotkeyConfigHotkey configuration.
sbIHotkeyConfiguration sbIHotkeyService::getHotkey ( in AString  aKey)

Return the hotkey configuration for the key specified by aKey.

Parameters
aKeyKey for which to get hotkey configuration.
Returns
Hotkey configuration.
nsIArray sbIHotkeyService::getHotkeys ( )

Return the set of hot key configurations as an nsIArray of sbIHotkeyConfiguration objects.

Returns
Hot key configuration list.
void sbIHotkeyService::removeHotkeyByKey ( in AString  aKey)

Remove the hotkey with the key specified by aKey.

Parameters
aKeyHotkey to remove.
void sbIHotkeyService::removeHotkeysByAction ( in AString  aAction)

Remove all hotkeys with the action specified by aAction.

Parameters
aActionAction for which to remove hotkeys.
void sbIHotkeyService::setHotkeys ( in nsIArray  aHotkeyConfigList)

Set the hot key configuration to the nsIArray of sbIHotkeyConfiguration objects specified by aHotkeyConfigList.

Parameters
aHotkeyConfigListHotkey configuration list.

Member Data Documentation

attribute boolean sbIHotkeyService::hotkeysEnabled

If true, hotkeys are enabled.

Definition at line 81 of file sbIHotkeyService.idl.

readonly attribute AString sbIHotkeyService::hotkeysEnabledDRKey

Key string for data remote used to enable or disable hot keys.

Definition at line 88 of file sbIHotkeyService.idl.


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