sbIGlobalHotkeys Interface Reference

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

import"IGlobalHotkeys.idl";

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

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. More...
 
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. More...
 
void removeAllHotkeys ()
 Global hotkeys unregistration method This method is used to unregister all hotkeys that have been previously registered with addHotkey. More...
 

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
keyCodeThe keyboard code for the hotkey
altKeyThe state of the Alt key in combination with the keyboard code
ctrlKeyThe state of the Control key in combination with the keyboard code
shiftKeyThe state of the Shift key in combination with the keyboard code
metaKeyThe state of the Meta key in combination with the keyboard code
key_idThe arbitrary id associated with this hotkey
cbThe 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_idThe id of the key to unregister
See Also
addHotkey, removeAllHotkeys

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