IATSNotifications.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: Interfaces for ATS Notifications 
// AUTHOR: Michael Russo - created April 27, 2005
//***************************************************************************/

#pragma once

#include "IATSProvider.h"

#ifndef ATSExport
    #define ATSExport __declspec( dllexport )
#endif

//
// Consts and Typedefs
//
typedef DWORD           ATSNotifyID;
typedef DWORD           ATSNotifyResult;
typedef LONG_PTR        ATSNotifyClientPtr;


namespace ATS {

    // ATS Notification IDs
    const ATSNotifyID       kATSNotifyPreLogin              = 1;
    const ATSNotifyID       kATSNotifyPostLogin             = 2;
    const ATSNotifyID       kATSNotifyPreLogout             = 3;
    const ATSNotifyID       kATSNotifyPostLogout            = 4;
    const ATSNotifyID       kATSNotifyPreOpenProject        = 5;
    const ATSNotifyID       kATSNotifyPostOpenProject       = 6;
    const ATSNotifyID       kATSNotifyPreCloseProject       = 7;
    const ATSNotifyID       kATSNotifyPostCloseProject      = 8;
    const ATSNotifyID       kATSNotifyPreLaunchOptions      = 9;
    const ATSNotifyID       kATSNotifyPostLaunchOptions     = 10;
    const ATSNotifyID       kATSNotifyPreLaunchProvider     = 11;
    const ATSNotifyID       kATSNotifyPostLaunchProvider    = 12;
    const ATSNotifyID       kATSNotifyPreCheckin            = 13;
    const ATSNotifyID       kATSNotifyPostCheckin           = 14;
    const ATSNotifyID       kATSNotifyPreCheckout           = 15;
    const ATSNotifyID       kATSNotifyPostCheckout          = 16;
    const ATSNotifyID       kATSNotifyPreUndoCheckout       = 17;
    const ATSNotifyID       kATSNotifyPostUndoCheckout      = 18;
    const ATSNotifyID       kATSNotifyPreAddFiles           = 19;
    const ATSNotifyID       kATSNotifyPostAddFiles          = 20;
    const ATSNotifyID       kATSNotifyPreGetLatest          = 21;
    const ATSNotifyID       kATSNotifyPostGetLatest         = 22;
    const ATSNotifyID       kATSNotifyPreProperties         = 23;
    const ATSNotifyID       kATSNotifyPostProperties        = 24;
    const ATSNotifyID       kATSNotifyPreShowHistory        = 25;
    const ATSNotifyID       kATSNotifyPostShowHistory       = 26;
    const ATSNotifyID       kATSNotifyFileListUpdate        = 27;
    const ATSNotifyID       kATSNotifyPreExploreProvider    = 28;
    const ATSNotifyID       kATSNotifyPostExploreProvider   = 29;
    const ATSNotifyID       kATSNotifyPreGetVersion         = 30;
    const ATSNotifyID       kATSNotifyPostGetVersion        = 31;


    //
    // ATS Notification Callback Results
    //

    const ATSNotifyResult   kATSNotifyResultOk              = 0;
    const ATSNotifyResult   kATSNotifyResultCancel          = 1;    
    const ATSNotifyResult   kATSNotifyResultStop            = 2;    
};

//
// class ATSNotifyParams
//


class ATSNotifyParams : public MaxHeapOperators
{
public:
    ATSExport ATSNotifyParams();
    ATSExport virtual ~ATSNotifyParams();


    ATSExport virtual ATSNotifyID       GetID();


    ATSExport virtual void              SetID( ATSNotifyID id );


    ATSExport virtual UINT              GetProviderIndex();


    ATSExport virtual void              SetProviderIndex( UINT uIndex );


    ATSExport virtual bool              IsCancelled();


    ATSExport virtual void              SetCancelled( bool bCancelled );


    ATSExport virtual ATSFileList*      GetATSFileList();


    ATSExport virtual void              SetATSFileList( ATSFileList* pATSFileList );

protected:
    ATSNotifyID     mID;
    UINT            mProviderIndex;
    bool            mCancelled;
    ATSFileList*    mpATSFileList;
};

//
// class IATSNotifyCallback
//


class IATSNotifyCallback : public MaxHeapOperators
{
public:

    virtual ATSNotifyResult ATSNotifyCallback( ATSNotifyParams *pATSNotifyParams, ATSNotifyClientPtr pClientPtr ) = 0;
};

//
// class ATSNotification
//
class ATSNotification : public MaxHeapOperators
{
public:

    ATSExport static bool               RegisterATSNotification( IATSNotifyCallback *pCallback, ATSNotifyClientPtr pClientPtr );

    ATSExport static bool               UnRegisterATSNotification( IATSNotifyCallback *pCallback );


    ATSExport static ATSNotifyResult    BroadcastATSNotification( ATSNotifyParams *pATSNotifyParamsn );

    ATSExport static ATSNotifyResult    BroadcastATSNotification( ATSNotifyID id, UINT uProviderIndex );
};