/////////////////////////////////////////////////////////////////////////////
// EuCommon.h
//
// Copyright (C) 2003-2010 Euphonix, Inc.
// This source code is licensed under the EuCon SDK License Agreement.
// All rights reserved.
//
// Date:        Monday, June 21, 2004
// Author:      SFRESHOUR
// Description: Base class for EuBrowser classes returned by EuCon.
/////////////////////////////////////////////////////////////////////////////
#if !defined(__EUPHONIX_EUCOMMON_H__)
#define __EUPHONIX_EUCOMMON_H__

#pragma once

#include "EuDefinitions.h"
#include "EuWrapperFactory.h"

#include <vector>

class EUAPI_CLASS EuCommon
{
public:
    virtual EUAPI_FUNC tERR GetSimpleFriendlyName( tEuString&  oFriendlyName) const;

    virtual EUAPI_FUNC tERR GetSimplePersistenceID( tEuString&  oPersistID ) const;
    virtual EUAPI_FUNC tERR GetFullPersistenceID( tEuString&  oPersistID ) const;

    virtual EUAPI_FUNC tERR GetAttribute( const tEuString& iAttributeID, tEuString& oAttributeValue ) const;
    virtual EUAPI_FUNC tERR GetAttribute( const tEuString& iAttributeID, NEuCon::int32& oAttributeValue ) const;
    virtual EUAPI_FUNC tERR GetAttribute( NEuCon::uint32 iAttributeID, tEuString& oAttributeValue ) const;
    virtual EUAPI_FUNC tERR GetAttribute( NEuCon::uint32 iAttributeID, NEuCon::int32& oAttributeValue ) const;

    virtual EUAPI_FUNC tERR GetAllAttributes( std::vector<tOneAttributeBinding*>& oAllAttributes ) const;

    //   SetAttribute will:
    //    - Add the attribute if it doesn't already exist
    //    - Change the value of an existing attribute
    virtual EUAPI_FUNC tERR SetAttribute( const tEuString& iAttributeID, const tEuString& iNewAttributeValue, NEuCon::uint32 iNotifyStatus = kAttrNotify_None  );
    virtual EUAPI_FUNC tERR SetAttribute( const tEuString& iAttributeID, NEuCon::int32 iNewAttributeValue, NEuCon::uint32 iNotifyStatus = kAttrNotify_None  );
    virtual EUAPI_FUNC tERR SetAttribute( NEuCon::int32  iAttributeID, NEuCon::int32 iNewAttributeValue, NEuCon::uint32 iNotifyStatus = kAttrNotify_None  );
    virtual EUAPI_FUNC tERR SetAttribute( NEuCon::int32  iAttributeID, const tEuString& iNewAttributeValue, NEuCon::uint32 iNotifyStatus = kAttrNotify_None  );

    virtual EUAPI_FUNC tERR DeleteAttribute( const tEuString& iAttributeID, NEuCon::uint32 iNotifyStatus = kAttrNotify_None );
    virtual EUAPI_FUNC tERR DeleteAttribute( NEuCon::uint32 iAttributeID,     NEuCon::uint32 iNotifyStatus = kAttrNotify_None );

    EUAPI_FUNC void  ClearUserPointer();
    EUAPI_FUNC void  SetUserPointer( void*  iUserPointer );
    EUAPI_FUNC void  GetUserPointer( void*& oUserPointer );
    EUAPI_FUNC void* GetUserPointer();

    // Reserved for use by EuCon
    EUAPI_FUNC tERR  EuCommonCommand( NEuCon::uint32 iCommandID,      NEuCon::uint32 iIntParam1,       NEuCon::uint32 iIntParam2,
                                      NEuCon::uint32& oIntParam,      void*  ioVoidPtr1 = NULL,        void*  ioVoidPtr2 = NULL   );

private:
    EuCommon(const EuCommon&);          // disallowed
    bool operator=(const EuCommon&);    // disallowed

protected:
    EUAPI_FUNC EuCommon();
    EUAPI_FUNC EuCommon(NEuCon::tOpaquePtr iSelf);
    virtual EUAPI_FUNC ~EuCommon();

    NEuCon::tOpaquePtr  mSelf;
    bool                mClientSideCreated;

public:
    // RESERVED FOR C API WRAPPERS ONLY!
    NEuCon::tOpaquePtr      GetSelf() const { return(mSelf); };
};

#endif  // __EUPHONIX_EUCOMMON_H__