Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIControllerCommandTable Interface Reference

nsIControllerCommandTable More...

import "nsIControllerCommandTable.idl";

Inheritance diagram for nsIControllerCommandTable:
Inheritance graph
[legend]
Collaboration diagram for nsIControllerCommandTable:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void makeImmutable ()
 Make this command table immutable, so that commands cannot be registered or unregistered.
void registerCommand (in string aCommandName, in nsIControllerCommand aCommand)
 Register and unregister commands with the command table.
void unregisterCommand (in string aCommandName, in nsIControllerCommand aCommand)
nsIControllerCommand findCommandHandler (in string aCommandName)
 Find the command handler which has been registered to handle the named command.
boolean isCommandEnabled (in string aCommandName, in nsISupports aCommandRefCon)
 Get whether the named command is enabled.
void updateCommandState (in string aCommandName, in nsISupports aCommandRefCon)
 Tell the command to udpate its state (if it is a state updating command)
boolean supportsCommand (in string aCommandName, in nsISupports aCommandRefCon)
 Get whether the named command is supported.
void doCommand (in string aCommandName, in nsISupports aCommandRefCon)
 Execute the named command.
void doCommandParams (in string aCommandName, in nsICommandParams aParam, in nsISupports aCommandRefCon)
void getCommandState (in string aCommandName, in nsICommandParams aParam, in nsISupports aCommandRefCon)

Detailed Description

nsIControllerCommandTable

An interface via which a controller can maintain a series of commands, and efficiently dispatch commands to their respective handlers.

Controllers that use an nsIControllerCommandTable should support nsIInterfaceRequestor, and be able to return an interface to their controller command table via getInterface().

Definition at line 55 of file nsIControllerCommandTable.idl.


Member Function Documentation

void nsIControllerCommandTable::doCommand ( in string  aCommandName,
in nsISupports  aCommandRefCon 
)

Execute the named command.

Parameters:
aCommandNamethe name of the command to execute
aCommandRefConthe command context data
void nsIControllerCommandTable::doCommandParams ( in string  aCommandName,
in nsICommandParams  aParam,
in nsISupports  aCommandRefCon 
)

Find the command handler which has been registered to handle the named command.

Parameters:
aCommandNamethe name of the command to find the handler for.
void nsIControllerCommandTable::getCommandState ( in string  aCommandName,
in nsICommandParams  aParam,
in nsISupports  aCommandRefCon 
)
boolean nsIControllerCommandTable::isCommandEnabled ( in string  aCommandName,
in nsISupports  aCommandRefCon 
)

Get whether the named command is enabled.

Parameters:
aCommandNamethe name of the command to test
aCommandRefConthe command context data

Make this command table immutable, so that commands cannot be registered or unregistered.

Some command tables are made mutable after command registration so that they can be used as singletons.

Register and unregister commands with the command table.

Parameters:
aCommandNamethe name of the command under which to register or unregister the given command handler.
aCommandthe handler for this command.
boolean nsIControllerCommandTable::supportsCommand ( in string  aCommandName,
in nsISupports  aCommandRefCon 
)

Get whether the named command is supported.

Parameters:
aCommandNamethe name of the command to test
aCommandRefConthe command context data
void nsIControllerCommandTable::updateCommandState ( in string  aCommandName,
in nsISupports  aCommandRefCon 
)

Tell the command to udpate its state (if it is a state updating command)

Parameters:
aCommandNamethe name of the command to update
aCommandRefConthe command context data

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