sbIGlobalHotkeys Interface Reference

Global hotkey registration/unregistration interface This interface is used to register or unregister hotkey callbacks. More...

List of all members.

Public Member Functions

void addHotkey (in PRInt32 keyCode, in PRBool altKey, in PRBool ctrlKey, in PRBool shiftKey, in PRBool metaKey, in AString key_id, in sbIGlobalHotkeyCallback cb)
 Global hotkey registration method This method is used to register a hotkey.
void removeHotkey (in AString key_id)
 Global hotkey unregistration method This method is used to unregister a hotkey that has been previously registered with AddHotkey.
void removeAllHotkeys ()
 Global hotkeys unregistration method This method is used to unregister all hotkeys that have been previously registered with addHotkey.


Detailed Description

Global hotkey registration/unregistration interface This interface is used to register or unregister hotkey callbacks.

See also:
sbIGlobalHotkeyCallback

Definition at line 66 of file IGlobalHotkeys.idl.


Member Function Documentation

void sbIGlobalHotkeys::addHotkey ( in PRInt32  keyCode,
in PRBool  altKey,
in PRBool  ctrlKey,
in PRBool  shiftKey,
in PRBool  metaKey,
in AString  key_id,
in sbIGlobalHotkeyCallback  cb 
)

Global hotkey registration method This method is used to register a hotkey.

Hotkeys are specified via key code and modifiers, and an arbitrary id string is given back to the callback method.

Parameters:
keyCode The keyboard code for the hotkey
altKey The state of the Alt key in combination with the keyboard code
ctrlKey The state of the Control key in combination with the keyboard code
shiftKey The state of the Shift key in combination with the keyboard code
metaKey The state of the Meta key in combination with the keyboard code
key_id The arbitrary id associated with this hotkey
cb The callback object to call when the hotkey is pressed
See also:
removeHotkey, sbIGlobalHotkeyCallback, sbIGlobalHotkeyCallback::onHotkey()

void sbIGlobalHotkeys::removeAllHotkeys (  ) 

Global hotkeys unregistration method This method is used to unregister all hotkeys that have been previously registered with addHotkey.

See also:
addHotkey, removeHotkey

void sbIGlobalHotkeys::removeHotkey ( in AString  key_id  ) 

Global hotkey unregistration method This method is used to unregister a hotkey that has been previously registered with AddHotkey.

Parameters:
key_id The id of the key to unregister
See also:
addHotkey, removeAllHotkeys


The documentation for this interface was generated from the following file:
Generated on Mon Aug 21 21:01:55 2006 for Songbird by  doxygen 1.4.7