MAddRemoveAttrEdit Class Reference
Related help topics: #include <MAddRemoveAttrEdit.h>
Class 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.
Inheritance diagram for MAddRemoveAttrEdit:
Public Member Functions | |
| MObject | node (MStatus *ReturnStatus=NULL) const |
| Returns the depend node involved in this edit. More... | |
| MString | attributeName (MStatus *ReturnStatus=NULL) const |
| Returns the name of the attribute that was added or removed. More... | |
| MString | nodeName (MStatus *ReturnStatus=NULL) const |
| Returns the name of the node where the attribute was added or removed. More... | |
| bool | isAttributeAdded () const |
| Returns true if this edit is for an added attribute, false for a removed attribute. More... | |
| virtual EditType | editType (MStatus *ReturnStatus=NULL) const |
| Virtual method used to return the edit type of this edit, which is MEdit::kAddRemoveAttrEdit. More... | |
| Public Member Functions inherited from MEdit | |
| MString | getString (MStatus *ReturnStatus=NULL) const |
| Returns the ASCII string related to the current edit. More... | |
| bool | isApplied (MStatus *ReturnStatus=NULL) const |
| Query if we attempted to apply the edit. More... | |
| bool | isFailed (MStatus *ReturnStatus=NULL) const |
| Query if the edit is applied successfully. More... | |
| bool | isTopLevel (MStatus *ReturnStatus=NULL) const |
| Query if the edit was made from the top-level. More... | |
| MStatus | setApplied (bool isApplied) |
| This method is obsolete. More... | |
| MStatus | setFailed (bool failed) |
| This method is obsolete. More... | |
| bool | hasEditData () const |
| Query if the edit has any user-defined editData associated with it. More... | |
| bool | matches (const MPxEditData *editData) const |
| Query if the edit has user-defined editData associated with it that matches the given editData object. More... | |
Static Public Member Functions | |
| static const char * | className () |
| Returns the name of this class. More... | |
| Static Public Member Functions inherited from MEdit | |
| static const char * | className () |
| Returns the name of this class. More... | |
Friends | |
| class | MItEdits |
Additional Inherited Members | |
| Public Types inherited from MEdit | |
| enum | EditType { kNullEdit, kSetAttrEdit, kConnectDisconnectEdit, kAddRemoveAttrEdit, kParentEdit, kFcurveEdit } |
| Type of edit. More... | |
Member Function Documentation
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.
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
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 |
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
|
virtual |
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.
|
static |
Returns the name of this class.
- Returns
- The name of this class.
The documentation for this class was generated from the following files:
- MAddRemoveAttrEdit.h
- MAddRemoveAttrEdit.cpp