class MPxControlCommand

Jump to documentation

public members:

	MPxControlCommand ()
virtual	~MPxControlCommand ()
virtual MPxUIControl *	makeControl ()
virtual MStatus	doEditFlags ()
virtual MStatus	doQueryFlags ()
virtual MStatus	appendSyntax ()
virtual bool	skipFlagForCreate (const MString &longFlag)
void	clearResult ()
MStatus	setResult (bool result)
MStatus	setResult (int result)
MStatus	setResult (double result)
MStatus	setResult (const MString &result)
MStatus	setResult (const MStringArray &result)
MStatus	setResult (const MIntArray &result)

protected members:

MPxUIControl *	control ( MStatus *ReturnStatus = NULL ) USE _control() IN SCRIPT
MSyntax	syntax ( MStatus *ReturnStatus = NULL) const USE _syntax() IN SCRIPT
MArgParser	parser ( MStatus *ReturnStatus = NULL) const USE _parser() IN SCRIPT

Documentation

Description

MPxControlCommand is the base class for user defined UI control commands. This command gives all of the flags and options of the base control command in addition to any user defined flags or behaviours. When registering this command, use the MFnPlugin::registerControlCommand() method. All control commands have a corresponding MPxUIControl. It is important to note that a given MPxControlCommand is reponsible for only ONE MPxUIControl.

Functions

MPxControlCommand:: MPxControlCommand ()

Description

Class constructor.

MPxControlCommand:: ~MPxControlCommand ()

Description

Class destructor.

MStatus MPxControlCommand:: doEditFlags ()

Description

This method is called when the command is called in edit mode. This method should be overridden by control commands to determine which edit flags are set in conjunction with the argument parser for this command. The argument parser for this command can be obtained by calling the parser method.

If the command is called with both the edit flag and the query flag, then the query flag will be ignored.

If the command returns MS::kUnknownParameter, the flag is processed by the parent class.

Return Value

• MS::kSuccess operation successful
• MS::kUnknownParameter pass to the parent class
• MS::kFailure operation failed

MStatus MPxControlCommand:: doQueryFlags ()

Description

This method is invoked during query mode, and the default method should be overridden in user-defined control commands to determine which query flags are set in conjunction with the argument parser for the command. The argument parser for this command can be obtained by calling the parser method. If the command is called with both the edit flag and the query flag, then the query flag will be ignored.

If the command returns MS::kUnknownParameter, the flag is processed by the parent class.

Return Value

• MS::kSuccess operation successful
• MS::kUnknownParameter pass to the parent class
• MS::kFailure operation failed

MStatus MPxControlCommand:: appendSyntax ()

Description

This method should be overridden to append syntax to the control command. The syntax object can be obtained by calling the syntax method. The following flags cannot be used as user-defined flags as they are reserved for edit and query: "-e", "-edit", "-q", "-query".

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

bool MPxControlCommand:: skipFlagForCreate (const MString &longFlag)

Description

Returns true if the passed long flag name should be skipped during the creation portion of the command.

Arguments

• longFlag The string containing the long flag name.

Return Value

• Return true if the flag shoiuld be skipped during creation.

Status Codes

• MS::kSuccess Operation successful

void MPxControlCommand:: clearResult ()

Description

This method should be called to clear the result to be output by the command.

MStatus MPxControlCommand:: setResult (bool result)

Description

This method should be called when the result of the control command is a boolean.

Arguments

• result the boolean result

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MPxControlCommand:: setResult (int result)

Description

This method should be called when the result of the control command is an integer.

Arguments

• result the integer result

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MPxControlCommand:: setResult (double result)

Description

This method should be called when the result of the control command is a double.

Arguments

• result the double result

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MPxControlCommand:: setResult (const MString &result)

Description

This method should be called when the result of the control command is a string.

Arguments

• result the string result

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MPxControlCommand:: setResult (const MStringArray &result)

Description

This method should be called when the result of the control command is a string array.

Arguments

• result the string result

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MPxControlCommand:: setResult (const MIntArray &result)

Description

This method should be called when the result of the control command is a integer array.

Arguments

• result the integer array result

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

MPxUIControl * MPxControlCommand:: makeControl ()

Description

This method is called when the UI control should be created. You need to create a new MPxUIControl on call to this method (the base implementation is abstract, so that the compiler will force you to define an implementation of this method).

Return Codes

• NULL - unable to create the UI control for this command.
• pointer to control - ui control successfully created.

MPxUIControl * MPxControlCommand:: control ( MStatus *ReturnStatus )

Description

Returns the control instance. All UI commands require the name of the UI control as the last argument. This name is stored in a table that has the pointer to the control. When the command is executed, the pointer is retrieved. You should only call this method in the doEditFlags & doQueryFlags. All other cases are invalid.

Arguments

• ReturnStatus

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

MSyntax MPxControlCommand:: syntax ( MStatus *ReturnStatus) const

Description

This method returns the syntax object of this control command. The syntax object can be appended to in an overridden version of the appendSyntax method.

Arguments

• ReturnStatus return status

Return Value

• the syntax object

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

MArgParser MPxControlCommand:: parser ( MStatus *ReturnStatus ) const

Description

This method returns the argument parser of this control command. The argument parser can be used in the overridden versions of doEditFlags and doQueryFlags to determine which flags are set.

Arguments

• Arguments

Return Value

• the argument parser

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

This class has no child classes.