Interface nsICommandManagerType

nsICommandManager is an interface used to executing user-level commands, and getting the state of available commands.

Commands are identified by strings, which are documented elsewhere. In addition, the list of required and optional parameters for each command, that are passed in via the nsICommandParams, are also documented elsewhere. (Where? Need a good location for this).

Hierarchy

Methods

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

  • Register an observer on the specified command. The observer's Observe method will get called when the state (enabled/disabled, or toggled etc) of the command changes.

    You can register the same observer on multiple commmands by calling this multiple times.

    Parameters

    • aCommandObserver: nsIObserver
    • aCommandToObserve: string

    Returns void

  • Execute the specified command. The command will be executed in aTargetWindow if it is specified. If aTargetWindow is null, it will go to the focused window.

    param: aCommandParams, a list of name-value pairs of command parameters, may be null for parameter-less commands.

    Parameters

    • aCommandName: string
    • aCommandParams: nsICommandParams
    • aTargetWindow: mozIDOMWindowProxy

    Returns void

  • Get the state of the specified commands.

    On input: aCommandParams filled in with values that the caller cares about, most of which are command-specific (see the command documentation for details). One boolean value, "enabled", applies to all commands, and, in return will be set to indicate whether the command is enabled (equivalent to calling isCommandEnabled).

    aCommandName is the name of the command that needs the state aTargetWindow is the source of command controller (null means use focus controller) On output: aCommandParams: values set by the caller filled in with state from the command.

    Parameters

    • aCommandName: string
    • aTargetWindow: mozIDOMWindowProxy
    • aCommandParams: nsICommandParams

    Returns void

  • Ask the command manager if the specified command is currently. enabled. If aTargetWindow is null, the focused window is used.

    Parameters

    • aCommandName: string
    • aTargetWindow: mozIDOMWindowProxy

    Returns boolean

  • Ask the command manager if the specified command is supported. If aTargetWindow is null, the focused window is used.

    Parameters

    • aCommandName: string
    • aTargetWindow: mozIDOMWindowProxy

    Returns boolean

  • Stop an observer from observering the specified command. If the observer was also registered on ther commands, they will continue to be observed.

    Passing an empty string in 'aCommandObserved' will remove the observer from all commands.

    Parameters

    • aCommandObserver: nsIObserver
    • aCommandObserved: string

    Returns void

Generated using TypeDoc