IDVUINodeRef.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Burnard
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2008 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IDVUINODEREF__
#define __IDVUINODEREF__

#include "IPMUnknown.h"
#include "DV_WidgetID.h"

#include "DVAForwardDeclarations.h"

#include "boost/cast.hpp"


class IDV_UI_NodeRef : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IDV_UI_NODEREF};

 virtual dvaui::ui::UI_Node* Get_UI_Node() const = 0;

 virtual void Set_UI_Node(dvaui::ui::UI_Node*) = 0;


 template<class Target> 
 inline static Target* Get_UI_Node_As(dvaui::ui::UI_Node* node)
 {
 return ((node) ? dynamic_cast<Target*>(node) : nil);
 }

 template<class Target> 
 inline static Target* Get_UI_Node_As(IDV_UI_NodeRef* ref)
 {
 return ((ref && ref->Get_UI_Node()) ? dynamic_cast<Target*>(ref->Get_UI_Node()) : nil);
 }

 template<class Target> 
 inline static Target* Get_UI_Node_As(const IPMUnknown* ref)
 {
 InterfacePtr<IDV_UI_NodeRef> nodeRef(ref, UseDefaultIID());
 return ((nodeRef && nodeRef->Get_UI_Node()) ? dynamic_cast<Target*>(nodeRef->Get_UI_Node()) : nil );
 }

 template<class Target> 
 inline Target* Get_UI_Node_As() const
 {
 return Get_UI_Node_As<Target*>(Get_UI_Node());
 }

};

#endif