WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsICommandParams

IID:83f892cf-7ed3-490e-967a-62640f3158e1
Inherits From:nsISupports

This interface is implemented by the following components:

Constants

PRInt16 eNoType = 0
PRInt16 eBooleanType = 1
PRInt16 eLongType = 2
PRInt16 eDoubleType = 3
PRInt16 eWStringType = 4
PRInt16 eISupportsType = 5
PRInt16 eStringType = 6

Methods

void first ( ) PRBool getBooleanValue ( char* name ) char* getCStringValue ( char* name ) double getDoubleValue ( char* name ) nsISupports getISupportsValue ( char* name ) PRInt32 getLongValue ( char* name ) char* getNext ( ) AString getStringValue ( char* name ) PRInt16 getValueType ( char* name ) PRBool hasMoreElements ( ) void removeValue ( char* name ) void setBooleanValue ( char* name , PRBool value ) void setCStringValue ( char* name , char* value ) void setDoubleValue ( char* name , double value ) void setISupportsValue ( char* name , nsISupports value ) void setLongValue ( char* name , PRInt32 value ) void setStringValue ( char* name , AString value )

void first ( )

PRBool getBooleanValue ( char* name )

Arguments:
name

char* getCStringValue ( char* name )

Arguments:
name

double getDoubleValue ( char* name )

Arguments:
name

nsISupports getISupportsValue ( char* name )

Arguments:
name

PRInt32 getLongValue ( char* name )

Arguments:
name

char* getNext ( )

GetNext()

Returns:
string pointer that will be allocated and is up to the caller to free

AString getStringValue ( char* name )

Arguments:
name

PRInt16 getValueType ( char* name )

Arguments:
name

PRBool hasMoreElements ( )

void removeValue ( char* name )

Arguments:
name

void setBooleanValue ( char* name , PRBool value )

Arguments:
name
value

void setCStringValue ( char* name , char* value )

Arguments:
name
value

void setDoubleValue ( char* name , double value )

Arguments:
name
value

void setISupportsValue ( char* name , nsISupports value )

Arguments:
name
value

void setLongValue ( char* name , PRInt32 value )

Arguments:
name
value

void setStringValue ( char* name , AString value )

Arguments:
name
value

References

This interface is passed as an argument to the following methods:

nsICommandController.doCommandWithParams, nsICommandController.getCommandStateWithParams, nsICommandManager.doCommand, nsICommandManager.getCommandState, nsIControllerCommand.doCommandParams, nsIControllerCommand.getCommandStateParams, nsIControllerCommandTable.doCommandParams, nsIControllerCommandTable.getCommandState

Reference documentation is generated from Mozilla's source.