CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface ICamApiHotkeyManager

    Manager for plugin global keyboard shortcuts. Plugin hotkeys are dispatched after the viewport but before classic menu/action shortcuts, and only while the main window is active and focus is not in a text editor. Native application shortcuts are pre-registered as reserved entries so FindByShortcut reports them too.

    Namespace: CAMAPI.ApplicationMainForm
    Assembly: CAMAPI.ApplicationMainForm.dll
    Syntax
    [Guid("B8F24D07-5E91-4A3C-8D16-2F9E0C7A5B34")]
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    public interface ICamApiHotkeyManager

    Properties

    Count

    Number of registered hotkeys (plugin plus reserved native).

    Declaration
    int Count { get; }
    Property Value
    Type Description
    int

    Hotkey[int]

    Declaration
    ICamApiHotkey Hotkey[int Index] { get; }
    Parameters
    Type Name Description
    int Index
    Property Value
    Type Description
    ICamApiHotkey

    Methods

    AddShortcut(ICamApiHotkey, out TResultStatus)

    Declaration
    void AddShortcut(ICamApiHotkey Hotkey, out TResultStatus ResultStatus)
    Parameters
    Type Name Description
    ICamApiHotkey Hotkey
    TResultStatus ResultStatus

    CreateHotkey(string)

    Create a detached hotkey bound to the given shortcut (e.g. "Ctrl+Shift+K"). Set OnExecute/Caption/Enabled on it, then pass it to AddShortcut.

    Declaration
    ICamApiHotkey CreateHotkey(string Shortcut)
    Parameters
    Type Name Description
    string Shortcut
    Returns
    Type Description
    ICamApiHotkey

    FindByShortcut(string)

    Hotkey occupying the given shortcut (plugin or reserved native), or null if free.

    Declaration
    ICamApiHotkey FindByShortcut(string Shortcut)
    Parameters
    Type Name Description
    string Shortcut
    Returns
    Type Description
    ICamApiHotkey

    RemoveShortcut(string, out TResultStatus)

    Declaration
    void RemoveShortcut(string Shortcut, out TResultStatus ResultStatus)
    Parameters
    Type Name Description
    string Shortcut
    TResultStatus ResultStatus
    In this article