MAddRemoveAttrEdit Class Reference

This reference page is linked to from the following overview topics: Extension for Autodesk Maya 2013.

---

Search for all occurrences

---

Detailed Description

Class for describing edits involving attributes which are added or removed.

This class is used to represent information about edits involving attributes which are added or removed. Such edits occur when attributes are added or removed from nodes in a referenced file. When a reference is unloaded, only the node and attribute name may be queried successfully. When the referenced file is loaded, the node itself may also be queried.

The MItEdits class may be used to iterate over all the edits on a given reference or assembly.

#include <MAddRemoveAttrEdit.h>

Inheritance diagram for MAddRemoveAttrEdit:

List of all members.

Public Member Functions
MObject	node (MStatus *ReturnStatus=NULL) const
	Returns the depend node involved in this edit.
MString	attributeName (MStatus *ReturnStatus=NULL) const
	Returns the name of the attribute that was added or removed.
MString	nodeName (MStatus *ReturnStatus=NULL) const
	Returns the name of the node where the attribute was added or removed.
bool	isAttributeAdded () const
	Returns true if this edit is for an added attribute, false for a removed attribute.
virtual EditType	editType (MStatus *ReturnStatus=NULL) const
	Virtual method used to return the edit type of this edit, which is MEdit::kAddRemoveAttrEdit.
Static Public Member Functions
static const char *	className ()
	Returns the name of this class.
Friends
class	MItEdits Search for all occurrences

---

Member Function Documentation

MObject node

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

Returns the depend node involved in this edit.

The node can only be returned when the related reference or assembly is loaded. When the reference or assembly is unloaded, only the node name string may be queried successfully.

Parameters:

[out]

ReturnStatus

Status Code

Returns:

The node involved in this edit

Status Codes:

• MS::kSuccess Node was successfully returned
• MS::kFailure Related reference or assembly was not loaded.

MString attributeName

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

Returns the name of the attribute that was added or removed.

Parameters:

[out]

ReturnStatus

Status Code

Returns:

The name of the attribute involved in this edit

Status Codes:

• MS::kSuccess Attribute name was returned successfully
• MS::kFailure Edit was not initialized successfully

MString nodeName

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

Returns the name of the node where the attribute was added or removed.

Parameters:

[out]

ReturnStatus

Status Code

Returns:

The name of the node involved in this edit

Status Codes:

• MS::kSuccess Node name was returned successfully
• MS::kFailure Edit was not initialized successfully

bool isAttributeAdded

(

)

const

Search for all occurrences

Returns true if this edit is for an added attribute, false for a removed attribute.

Returns:

True for an added attribute, false for a removed attribute

MEdit::EditType editType

(

MStatus *

ReturnStatus = NULL

)

const [virtual]

Search for all occurrences

Virtual method used to return the edit type of this edit, which is MEdit::kAddRemoveAttrEdit.

Parameters:

[out]

ReturnStatus

return status

Returns:

MEdit::kAddRemoveAttrEdit

Status Codes:

• MS::kSuccess Operation successful

Reimplemented from MEdit.

const char * className

(

)

[static]

Search for all occurrences

Returns the name of this class.

Returns:

The name of this class.

Reimplemented from MEdit.