Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsBaseEditorCommand Class Reference

#include <nsEditorCommands.h>

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

List of all members.

Public Member Functions

 nsBaseEditorCommand ()
virtual ~nsBaseEditorCommand ()
NS_DECL_ISUPPORTS NS_IMETHOD IsCommandEnabled (const char *aCommandName, nsISupports *aCommandRefCon, PRBool *_retval)=0
NS_IMETHOD DoCommand (const char *aCommandName, nsISupports *aCommandRefCon)=0
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

Definition at line 48 of file nsEditorCommands.h.


Constructor & Destructor Documentation

Definition at line 56 of file nsEditorCommands.cpp.

{
}
virtual nsBaseEditorCommand::~nsBaseEditorCommand ( ) [inline, virtual]

Definition at line 53 of file nsEditorCommands.h.

{}

Member Function Documentation

NS_IMETHOD nsBaseEditorCommand::DoCommand ( const char *  aCommandName,
nsISupports *  aCommandRefCon 
) [pure virtual]
void nsIControllerCommand::doCommand ( in string  aCommandName,
in nsISupports  aCommandContext 
) [inherited]

Execute the name command.

Parameters:
aCommandNamethe name of the command to execute.
aCommandContexta 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 
) [inherited]
void nsIControllerCommand::getCommandStateParams ( in string  aCommandName,
in nsICommandParams  aParams,
in nsISupports  aCommandContext 
) [inherited]
NS_DECL_ISUPPORTS NS_IMETHOD nsBaseEditorCommand::IsCommandEnabled ( const char *  aCommandName,
nsISupports *  aCommandRefCon,
PRBool _retval 
) [pure virtual]
boolean nsIControllerCommand::isCommandEnabled ( in string  aCommandName,
in nsISupports  aCommandContext 
) [inherited]

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:
aCommandNamethe name of the command for which we want the enabled state.
aCommandContexta 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 class was generated from the following files: