IActionItemOverrideManager.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 1998-2007 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.
/**************************************************************************
    FILE: IActionItemOverrideManager.h

    DESCRIPTION: Declares a public header for a function published core interface
                 for managing Action Item Overrides.
    AUTHOR: Michael Zyracki - created 01.02.2007
/***************************************************************************/
#pragma once
#include "MaxHeap.h"
#include <WTypes.h>
#include "ifnpub.h"

class ActionItem;


class IActionItemOverride : public MaxHeapOperators
{
public:
    virtual ~IActionItemOverride(){};

    virtual BOOL IsOverrideActive() = 0;


    virtual BOOL StartOverride() = 0;



    virtual BOOL EndOverride() = 0;
};

#define IACTIONITEMOVERRIDEMANAGER_INTERFACE Interface_ID(0x5e1b66eb, 0x4bc034de)


class IActionItemOverrideManager : public FPStaticInterface
{
public:


    virtual void SetOverridesActive(BOOL active) = 0;
    
    
    virtual BOOL GetOverridesActive(void)const = 0;


    virtual void SetTimeToStartOverride(float secs) =0;

    
    virtual float GetTimeToStartOverride()const = 0;



    virtual void RegisterActionItemOverride(ActionItem *aItem,MSTR &overrideDescription) =0;


    virtual void UnregisterActionItemOverride(ActionItem *aItem) =0;

    virtual BOOL IsActionItemRegistered(ActionItem *aItem,MSTR &description) = 0;

    virtual void ActivateActionItemOverride(ActionItem *aItem,IActionItemOverride*  aItemOverride)=0;
    

    virtual void DeactivateActionItemOverride(ActionItem* aItem)=0;

    
    virtual IActionItemOverride * FindOverride(ActionItem * aItem)=0 ;



    virtual ActionItem* GetOverridingActionItem()const = 0;

};