Class HotkeyManagerHelper

Helper methods for ICamApiHotkeyManager

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

Methods

AddShortcut(ComWrapper<ICamApiHotkeyManager>, ComWrapper<ICamApiHotkey>)

Register a hotkey created by CreateHotkey(ComWrapper<ICamApiHotkeyManager>, string). Throws if its shortcut is taken.

Declaration
public static void AddShortcut(this ComWrapper<ICamApiHotkeyManager> managerCom, ComWrapper<ICamApiHotkey> hotkeyCom)
Parameters
Type Name Description
ComWrapper<ICamApiHotkeyManager> managerCom
ComWrapper<ICamApiHotkey> hotkeyCom

Count(ComWrapper<ICamApiHotkeyManager>)

Number of registered hotkeys (plugin plus reserved native).

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

CreateHotkey(ComWrapper<ICamApiHotkeyManager>, string)

Create a detached hotkey bound to the given shortcut (e.g. "Ctrl+Shift+K"). Set caption/handler on it, then pass it to AddShortcut(ComWrapper<ICamApiHotkeyManager>, ComWrapper<ICamApiHotkey>).

Declaration
public static ComWrapper<ICamApiHotkey> CreateHotkey(this ComWrapper<ICamApiHotkeyManager> managerCom, string shortcut)
Parameters
Type Name Description
ComWrapper<ICamApiHotkeyManager> managerCom
string shortcut
Returns
Type Description
ComWrapper<ICamApiHotkey>

EnumerateShortcuts(ComWrapper<ICamApiHotkeyManager>)

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

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

FindByShortcut(ComWrapper<ICamApiHotkeyManager>, string)

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

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

GetHotkey(ComWrapper<ICamApiHotkeyManager>, int)

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

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

RemoveShortcut(ComWrapper<ICamApiHotkeyManager>, string)

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

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