Public Member Functions

nsIControllerCommand Interface Reference

nsIControllerCommand More...

import "nsIControllerCommand.idl";

List of all members.

Public Member Functions

boolean isCommandEnabled (in string aCommandName, in nsISupports aCommandContext)
 Returns true if the command is currently enabled.
void getCommandStateParams (in string aCommandName, in nsICommandParams aParams, in nsISupports aCommandContext)
void doCommand (in string aCommandName, in nsISupports aCommandContext)
 Execute the name command.
void doCommandParams (in string aCommandName, in nsICommandParams aParams, in nsISupports aCommandContext)

Detailed Description

nsIControllerCommand

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


Member Function Documentation

void nsIControllerCommand::doCommand ( in string  aCommandName,
in nsISupports  aCommandContext 
)

Execute the name command.

Parameters:
aCommandName the name of the command to execute.
aCommandContext a cookie held by the nsIControllerCommandTable, allowing the command to get some context information. The contents of this cookie are implementation-defined.
void nsIControllerCommand::doCommandParams ( in string  aCommandName,
in nsICommandParams  aParams,
in nsISupports  aCommandContext 
)
void nsIControllerCommand::getCommandStateParams ( in string  aCommandName,
in nsICommandParams  aParams,
in nsISupports  aCommandContext 
)
boolean nsIControllerCommand::isCommandEnabled ( in string  aCommandName,
in nsISupports  aCommandContext 
)

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 the name of the command for which we want the enabled state.
aCommandContext a cookie held by the nsIControllerCommandTable, allowing the command to get some context information. The contents of this cookie are implementation-defined.

The documentation for this interface was generated from the following file: