Interface nsIControllerCommandType

nsIControllerCommand

A generic command interface. You can register an nsIControllerCommand with the nsIControllerCommandTable.

Hierarchy

Methods

AddRef QueryInterface Release doCommand doCommandParams getCommandStateParams isCommandEnabled

Methods

AddRef

  • 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

QueryInterface

  • 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

Release

  • 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

doCommand

  • Execute the name command.

    Parameters

    • aCommandName: string

      the name of the command to execute.

    • aCommandContext: nsISupports

      a cookie held by the nsIControllerCommandTable, allowing the command to get some context information. The contents of this cookie are implementation-defined.

    Returns void

doCommandParams

  • Parameters

    • aCommandName: string
    • aParams: nsICommandParams
    • aCommandContext: nsISupports

    Returns void

getCommandStateParams

  • Parameters

    • aCommandName: string
    • aParams: nsICommandParams
    • aCommandContext: nsISupports

    Returns void

isCommandEnabled

  • Returns true if the command is currently enabled. An nsIControllerCommand can implement more than one commands; say, a group of related commands (e.g. delete left/delete right). Because of this, the command name is passed to each method.

    Parameters

    • aCommandName: string

      the name of the command for which we want the enabled state.

    • aCommandContext: nsISupports

      a cookie held by the nsIControllerCommandTable, allowing the command to get some context information. The contents of this cookie are implementation-defined.

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc