Class HotkeyManagerHelper

Helper methods for ICamIpcHotkeyManager

Inheritance
object
HotkeyManagerHelper
Inherited Members
Namespace: CAMIPC.DotnetHelper
Assembly: CAMIPC.DotnetHelper.dll
Syntax
public static class HotkeyManagerHelper

Methods

AddShortcut(ComWrapper<ICamIpcHotkeyManager>, string, string)

Add a plugin hotkey for the given shortcut (e.g. "Ctrl+Shift+K") and caption. Throws if the shortcut is already taken. Returns the created binding.

Declaration
public static ComWrapper<ICamIpcHotkey> AddShortcut(this ComWrapper<ICamIpcHotkeyManager> managerCom, string shortcut, string caption)
Parameters
Type Name Description
ComWrapper<ICamIpcHotkeyManager> managerCom
string shortcut
string caption
Returns
Type Description
ComWrapper<ICamIpcHotkey>

EnumerateShortcuts(ComWrapper<ICamIpcHotkeyManager>)

Enumerate the (normalized) shortcut text of every registered hotkey.

Declaration
public static IEnumerable<string> EnumerateShortcuts(this ComWrapper<ICamIpcHotkeyManager> managerCom)
Parameters
Type Name Description
ComWrapper<ICamIpcHotkeyManager> managerCom
Returns
Type Description
IEnumerable<string>

FindByShortcut(ComWrapper<ICamIpcHotkeyManager>, string)

Hotkey occupying the given shortcut (plugin or reserved native). The returned wrapper is IsNull when the shortcut is free.

Declaration
public static ComWrapper<ICamIpcHotkey> FindByShortcut(this ComWrapper<ICamIpcHotkeyManager> managerCom, string shortcut)
Parameters
Type Name Description
ComWrapper<ICamIpcHotkeyManager> managerCom
string shortcut
Returns
Type Description
ComWrapper<ICamIpcHotkey>

GetCount(ComWrapper<ICamIpcHotkeyManager>)

Number of registered hotkeys (plugin plus reserved native).

Declaration
public static int GetCount(this ComWrapper<ICamIpcHotkeyManager> managerCom)
Parameters
Type Name Description
ComWrapper<ICamIpcHotkeyManager> managerCom
Returns
Type Description
int

GetHotkey(ComWrapper<ICamIpcHotkeyManager>, int)

Registered hotkey at the given index (0..Count-1).

Declaration
public static ComWrapper<ICamIpcHotkey> GetHotkey(this ComWrapper<ICamIpcHotkeyManager> managerCom, int index)
Parameters
Type Name Description
ComWrapper<ICamIpcHotkeyManager> managerCom
int index
Returns
Type Description
ComWrapper<ICamIpcHotkey>

RemoveShortcut(ComWrapper<ICamIpcHotkeyManager>, string)

Remove a previously added plugin hotkey by its shortcut. Throws for a reserved shortcut.

Declaration
public static void RemoveShortcut(this ComWrapper<ICamIpcHotkeyManager> managerCom, string shortcut)
Parameters
Type Name Description
ComWrapper<ICamIpcHotkeyManager> managerCom
string shortcut