Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Protected Member Functions
nsMultiStateCommand Class Reference

#include <nsComposerCommands.h>

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

List of all members.

Public Member Functions

 nsMultiStateCommand ()
virtual ~nsMultiStateCommand ()
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)

Protected Member Functions

virtual nsresult GetCurrentState (nsIEditor *aEditor, nsICommandParams *aParams)=0
virtual nsresult SetState (nsIEditor *aEditor, nsString &newState)=0

Detailed Description

Definition at line 175 of file nsComposerCommands.h.


Constructor & Destructor Documentation

Definition at line 611 of file nsComposerCommands.cpp.

Definition at line 616 of file nsComposerCommands.cpp.

{
}

Member Function Documentation

NS_IMETHOD nsBaseComposerCommand::DoCommand ( const char *  aCommandName,
nsISupports *  aCommandRefCon 
) [pure virtual, inherited]
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]
virtual nsresult nsMultiStateCommand::GetCurrentState ( nsIEditor aEditor,
nsICommandParams aParams 
) [protected, 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.
NS_DECL_ISUPPORTS NS_IMETHOD nsBaseComposerCommand::IsCommandEnabled ( const char *  aCommandName,
nsISupports *  aCommandRefCon,
PRBool _retval 
) [pure virtual, inherited]
virtual nsresult nsMultiStateCommand::SetState ( nsIEditor aEditor,
nsString newState 
) [protected, pure virtual]

The documentation for this class was generated from the following files: