Python API 2.0 Reference: OpenMayaUI.MPxContextCommand Class Reference

+ Inheritance diagram for OpenMayaUI.MPxContextCommand:

Public Member Functions

__init__ ()
 
appendSyntax ()
 
doEditFlags ()
 
doQueryFlags ()
 
makeObj ()
 
setResult ()
 

Detailed Description

Base class for custom context commands.

Constructor & Destructor Documentation

OpenMayaUI.MPxContextCommand.__init__ ( )
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Member Function Documentation

OpenMayaUI.MPxContextCommand.appendSyntax ( )
appendSyntax() -> None

This method should be overridden to append syntax
to the context 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'.
OpenMayaUI.MPxContextCommand.doEditFlags ( )
doEditFlags() -> None

This method is called when the command is called in edit mode.
This method should be overridden by context 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.
OpenMayaUI.MPxContextCommand.doQueryFlags ( )
doQueryFlags() -> None

This method is called when the command is called in query mode.
This method should be overridden by context commands
to determine which query 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.
OpenMayaUI.MPxContextCommand.makeObj ( )
makeObj() -> MPxContext

This function is used to instantiate a proxy context.
In your derived class, declare this function:

def makeObj(self)
    return userContextClass()

where userContextClass is derived from MPxContext.
OpenMayaUI.MPxContextCommand.setResult ( )
setResult() -> None

Set the value of the result to be returned by the command.  The value can be
either a boolean, integer, floating point value, or string.