////////////////////////////////////////////////////////////////////////////////////////////////////
// NoesisGUI - http://www.noesisengine.com
// Copyright (c) 2013 Noesis Technologies S.L. All Rights Reserved.
////////////////////////////////////////////////////////////////////////////////////////////////////


#ifndef __GUI_INAMESCOPE_H__
#define __GUI_INAMESCOPE_H__


#include <NsCore/Noesis.h>
#include <NsCore/Interface.h>
#include <NsCore/BaseComponent.h>


namespace Noesis
{

template<class T> class Delegate;

enum NameScopeChangedAction
{
    NameScopeChangedAction_Register,
    NameScopeChangedAction_Unregister,
    NameScopeChangedAction_Update,
    NameScopeChangedAction_Destroy
};

struct NameScopeChangedArgs
{
    NameScopeChangedAction action;
    const char* name;
    BaseComponent* newElement;
    BaseComponent* oldElement;
};

////////////////////////////////////////////////////////////////////////////////////////////////////
/// Defines how names of elements should be accessed within a particular XAML scope, and how to
/// enforce uniqueness of names within that scope.
////////////////////////////////////////////////////////////////////////////////////////////////////
NS_INTERFACE INameScope: public Interface
{
    /// Returns an object that has the provided identifying name
    virtual BaseComponent* FindName(const char* name) const = 0;

    /// Registers the provided name into the current XAML namescope
    virtual void RegisterName(const char* name, BaseComponent* object) = 0;

    /// Unregisters the provided name from the current XAML namescope
    virtual void UnregisterName(const char* name) = 0;

    /// Updates previously registered item with new one. This is required to refresh Binginds when
    /// freezables are cloned during animations
    virtual void UpdateName(const char* name, BaseComponent* object) = 0;

    /// Delegate to be notified about events
    typedef Delegate<void (INameScope*, const NameScopeChangedArgs&)> ChangedDelegate;
    virtual ChangedDelegate& NameScopeChanged() = 0;

    NS_IMPLEMENT_INLINE_REFLECTION_(INameScope, Interface)
};

}


#endif