Template class for context commands. More...

#include <MTemplateManipulator.h>

Inheritance diagram for MTemplateContextCommand< ContextCommandName, ContextCommandClass, ContextClass >:

Public Member Functions
	MTemplateContextCommand ()
	Constructor.

virtual MPxContext *	makeObj ()
	Command function for make the context.

Public Member Functions inherited from MPxContextCommand
	MPxContextCommand ()
	Class constructor.

virtual	~MPxContextCommand ()
	Class destructor.

virtual MStatus	doEditFlags ()
	This method is called when the command is called in edit mode. More...

virtual MStatus	doQueryFlags ()
	This method is called when the command is called in query mode. More...

virtual MStatus	appendSyntax ()
	This method should be overridden to append syntax to the context command. More...

MStatus	setResult (bool result)
	This method should be called when the result of the context command is a boolean. More...

MStatus	setResult (int result)
	This method should be called when the result of the context command is an integer. More...

MStatus	setResult (double result)
	This method should be called when the result of the context command is a double. More...

MStatus	setResult (const MString &result)
	This method should be called when the result of the context command a string. More...

Static Public Member Functions
static void *	creator ()
	Creator of the context command.

static MStatus	registerContextCommand (MObject obj)
	Plug-in registration method. More...

static MStatus	deregisterContextCommand (MObject obj)
	Plug-in deregistration method. More...

Static Public Member Functions inherited from MPxContextCommand
static const char *	className ()
	Returns the name of this class. More...

Additional Inherited Members
Protected Member Functions inherited from MPxContextCommand
MSyntax	syntax (MStatus *ReturnStatus=NULL) const
	USE _syntax() IN SCRIPT. More...

MArgParser	parser (MStatus *ReturnStatus=NULL) const
	USE _parser() IN SCRIPT. More...

Detailed Description

Template class for context commands.

Template helper to build command that is used to create context.

Parameters

[in]	ContextCommandName	: string name of context command
[in]	ContextCommandClass	: context command derived from MPxContextCommand
[in]	ContextClass	: context derived from MPxSelectionContext

Examples:: lineManipContainer/lineManipContainer.cpp, and squareScaleManipContext/squareScaleManipContext.cpp.

Member Function Documentation

static MStatus registerContextCommand ( MObject obj )

inlinestatic

Plug-in registration method.

Parameters

[in] obj plugin object taken from the initializePlugin() entry point.

static MStatus deregisterContextCommand ( MObject obj )

inlinestatic

Plug-in deregistration method.

Parameters

[in] obj plugin object taken from the initializePlugin() entry point.

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