#ifndef _MEdit
#define _MEdit
//-
// ==========================================================================
// Copyright (C) 2012 Autodesk, Inc., and/or its licensors.  All
// rights reserved.
//
// The coded instructions, statements, computer programs, and/or related
// material (collectively the "Data") in these files contain unpublished
// information proprietary to Autodesk, Inc. ("Autodesk") and/or its
// licensors,  which is protected by U.S. and Canadian federal copyright law
// and by international treaties.
//
// The Data may not be disclosed or distributed to third parties or be
// copied or duplicated, in whole or in part, without the prior written
// consent of Autodesk.
//
// The copyright notices in the Software and this entire statement,
// including the above license grant, this restriction and the following
// disclaimer, must be included in all copies of the Software, in whole
// or in part, and all derivative works of the Software, unless such copies
// or derivative works are solely in the form of machine-executable object
// code generated by a source language processor.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.
// AUTODESK DOES NOT MAKE AND HEREBY DISCLAIMS ANY EXPRESS OR IMPLIED
// WARRANTIES INCLUDING, BUT NOT LIMITED TO, THE WARRANTIES OF
// NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
// OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO
// EVENT WILL AUTODESK AND/OR ITS LICENSORS BE LIABLE FOR ANY LOST
// REVENUES, DATA, OR PROFITS, OR SPECIAL, DIRECT, INDIRECT, OR
// CONSEQUENTIAL DAMAGES, EVEN IF AUTODESK AND/OR ITS LICENSORS HAS
// BEEN ADVISED OF THE POSSIBILITY OR PROBABILITY OF SUCH DAMAGES.
// ==========================================================================
//+
//
// CLASS:    MEdit
//
// ****************************************************************************

#if defined __cplusplus

// ****************************************************************************
// INCLUDED HEADER FILES

#include <maya/MStatus.h>

class MString;
class MStatus;
class MPxEditData;

// ****************************************************************************
// CLASS DECLARATION (MEdit)

//! \ingroup OpenMaya
//! \brief Base class for representing information about edits 
/*!
  
MEdit serves as the base class for representing information about edits that
are made to certain types of entities, specifically references and assemblies.
An edit is any operation that modifies a member of the entity.  Examples of
such modifications include changing attribute values, connections, parenting
and so on.

In the case of references, edits are the changes that occur to referenced nodes. 

In the case of assemblies, edits are the changes that occur to assembly members.

Derived classes implement specific types of edits, allowing them to be queried depending on the type of operation.

*/

class OPENMAYA_EXPORT MEdit
{
public:
	friend class MItEdits;

	//! Type of edit
	enum EditType
	{
		//! Null edit
		kNullEdit,
		//! Edit indicating a change in plug value
		kSetAttrEdit,
		//! Edit indicating a connection or disconnection
		kConnectDisconnectEdit,
		//! Edit indicating an attribute added or removed
		kAddRemoveAttrEdit,
		//! Edit indicating a parenting operation
		kParentEdit,
		//! Edit indicating an fcurve modification
		kFcurveEdit
	};
		
	virtual 		~MEdit();

	virtual	EditType	editType(MStatus* ReturnStatus = NULL) const;	
	MString			getString(MStatus* ReturnStatus = NULL) const;

    bool 			isApplied(MStatus* ReturnStatus = NULL) const;
    bool 			isFailed(MStatus* ReturnStatus = NULL) const;
    bool            isTopLevel(MStatus* ReturnStatus = NULL) const;

    MStatus			setApplied(bool isApplied);
    MStatus			setFailed(bool failed);

	// Query user-defined editData
	bool			hasEditData() const;
	bool			matches(const MPxEditData *editData) const;

	static const char* className();	
protected:
	MEdit(void* edit, bool loaded);

	void*       fEdit;
	bool		fLoaded;
};

#endif /* __cplusplus */
#endif /* _MEdit */