IRefTargMonitorClass.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 1998-2005 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.
//**************************************************************************/
// DESCRIPTION: Defines an interface that uses the RefTargMonitorRefMaker class to monitor a RefTarg for 
// deletion. If the RefTargMonitor instance is saved as part of a partial save, or loaded as a partial load, 
// the RefTarg pointed to by the RefTargMonitor is not forced to be saved or loaded.
// AUTHOR: Larry.Minton - created Jan.11.2006
//***************************************************************************/

#pragma once

#include "iFnPub.h"
#include "IRefTargMonitor.h"

#define REFTARGMONITOR_CLASS_ID         Class_ID(0x1af82963, 0x29663cd2)

#define IID_REFTARGMONITOR_CLASS        Interface_ID(0x1af82963, 0x29663cd2)

#define REFMSG_REFTARGMONITOR_TARGET_DELETED                REFMSG_USER + 0x18f81904


class IRefTargMonitorClass : public FPMixinInterface  {
public:

    virtual RefTargetHandle GetRefTarg() = 0;

    virtual void SetRefTarg(RefTargetHandle theRefTarg) = 0;


    virtual bool GetPersist() = 0;

    virtual void SetPersist(bool persist) = 0;

    // --- Function publishing
    FPInterfaceDesc* GetDesc();    // <-- must implement 
    virtual Interface_ID GetID() { return IID_REFTARGMONITOR_CLASS; }

    enum {  
        kfpGetRefTarg, kfpSetRefTarg,
        kfpGetPersist, kfpSetPersist,
    };

    BEGIN_FUNCTION_MAP
        PROP_FNS(kfpGetRefTarg, GetRefTarg, kfpSetRefTarg, SetRefTarg, TYPE_REFTARG);
        PROP_FNS(kfpGetPersist, GetPersist, kfpSetPersist, SetPersist, TYPE_bool);
    END_FUNCTION_MAP

};