1.7.3Please send us your comment about this page
Base class for control creation commands.
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.
#include <MPxControlCommand.h>
Public Member Functions |
|
| MPxControlCommand () | |
| Class constructor. |
|
| virtual | ~MPxControlCommand () |
| Class destructor. |
|
| virtual MPxUIControl * | makeControl ()=0 |
| This method is called when the UI control
should be created. |
|
| virtual MStatus | doEditFlags () |
| This method is called when the command is
called in edit mode. |
|
| virtual MStatus | doQueryFlags () |
| 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. |
|
| virtual MStatus | appendSyntax () |
| This method should be overridden to append
syntax to the control command. |
|
| virtual bool | skipFlagForCreate (const MString &longFlag) |
| Returns true if the passed long flag name
should be skipped during the creation portion of the command.
|
|
| void | clearResult () |
| This method should be called to clear the
result to be output by the command. |
|
| MStatus | setResult (bool result) |
| This method should be called when the result
of the control command is a boolean. |
|
| MStatus | setResult (int result) |
| This method should be called when the result
of the control command is an integer. |
|
| MStatus | setResult (double result) |
| This method should be called when the result
of the control command is a double. |
|
| MStatus | setResult (const MString &result) |
| This method should be called when the result
of the control command is a string. |
|
| MStatus | setResult (const MStringArray &result) |
| This method should be called when the result
of the control command is a string array. |
|
| MStatus | setResult (const MIntArray &result) |
| This method should be called when the result
of the control command is a integer array. |
|
Static Public Member Functions |
|
| static const char * | className () |
| Returns the name of this class. |
|
Protected Member Functions |
|
| 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. |
|
Friends |
|
| class | MPxUIControl |
| class | MPxUITableControl |
| MPxUIControl * makeControl | ( | ) | [pure virtual] |
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).
| MStatus doEditFlags | ( | ) | [virtual] |
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.
| MStatus doQueryFlags | ( | ) | [virtual] |
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.
| MStatus appendSyntax | ( | ) | [virtual] |
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".
| bool skipFlagForCreate | ( | const MString & | longFlag | ) | [virtual] |
Returns true if the passed long flag name should be skipped during the creation portion of the command.
| [in] | longFlag | The string containing the long flag name. |
| MStatus setResult | ( | bool | result | ) |
This method should be called when the result of the control command is a boolean.
| [in] | result | the boolean result |
| MStatus setResult | ( | int | result | ) |
This method should be called when the result of the control command is an integer.
| [in] | result | the integer result |
| MStatus setResult | ( | double | result | ) |
This method should be called when the result of the control command is a double.
| [in] | result | the double result |
This method should be called when the result of the control command is a string.
| [in] | result | the string result |
| MStatus setResult | ( | const MStringArray & | result | ) |
This method should be called when the result of the control command is a string array.
| [in] | result | the string result |
This method should be called when the result of the control command is a integer array.
| [in] | result | the integer array result |
| const char * className | ( | ) | [static] |
| MPxUIControl * control | ( | MStatus * | ReturnStatus =
NULL |
) | [protected] |
USE _control() IN SCRIPT.
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.
| [out] | ReturnStatus | return status |
USE _syntax() IN SCRIPT.
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.
| [out] | ReturnStatus | return status |
| MArgParser parser | ( | MStatus * | ReturnStatus =
NULL |
) | const [protected] |
USE _parser() IN SCRIPT.
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.
| [out] | ReturnStatus | return status |