DefaultState.h

#pragma once
 
#include <GuiFoundation/GuiFoundationDLL.h>
 
#include <Foundation/Basics.h>
#include <Foundation/Serialization/AbstractObjectGraph.h>
#include <Foundation/Types/SharedPtr.h>
#include <Foundation/Types/Status.h>
#include <GuiFoundation/PropertyGrid/Declarations.h>
 
class plDefaultStateProvider;
class plObjectAccessorBase;
class plDocumentObject;
class plAbstractProperty;
 
class PL_GUIFOUNDATION_DLL plDefaultState
{
public:
  using CreateStateProviderFunc = plSharedPtr<plDefaultStateProvider> (*)(plObjectAccessorBase*, const plDocumentObject*, const plAbstractProperty*);
 
  static void RegisterDefaultStateProvider(CreateStateProviderFunc func);
  static void UnregisterDefaultStateProvider(CreateStateProviderFunc func);
 
private:
  friend class plDefaultObjectState;
  friend class plDefaultContainerState;
  static plDynamicArray<CreateStateProviderFunc> s_Factories;
};
 
class PL_GUIFOUNDATION_DLL plDefaultObjectState
{
  PL_DISALLOW_COPY_AND_ASSIGN(plDefaultObjectState);
 
public:
  plDefaultObjectState(plObjectAccessorBase* pAccessor, const plArrayPtr<plPropertySelection> selection);
 
  plColorGammaUB GetBackgroundColor() const;
  plString GetStateProviderName() const;
 
  bool IsDefaultValue(const char* szProperty) const;
  bool IsDefaultValue(const plAbstractProperty* pProp) const;
  plStatus RevertProperty(const char* szProperty);
  plStatus RevertProperty(const plAbstractProperty* pProp);
  plStatus RevertObject();
  plVariant GetDefaultValue(const char* szProperty, plUInt32 uiSelectionIndex = 0) const;
  plVariant GetDefaultValue(const plAbstractProperty* pProp, plUInt32 uiSelectionIndex = 0) const;
 
 
private:
  plObjectAccessorBase* m_pAccessor = nullptr;
  plArrayPtr<plPropertySelection> m_Selection;
  plHybridArray<plHybridArray<plSharedPtr<plDefaultStateProvider>, 4>, 1> m_Providers;
};
 
class PL_GUIFOUNDATION_DLL plDefaultContainerState
{
  PL_DISALLOW_COPY_AND_ASSIGN(plDefaultContainerState);
 
public:
  plDefaultContainerState(plObjectAccessorBase* pAccessor, const plArrayPtr<plPropertySelection> selection, const char* szProperty);
 
  plColorGammaUB GetBackgroundColor() const;
  plString GetStateProviderName() const;
 
  bool IsDefaultElement(plVariant index) const;
  bool IsDefaultContainer() const;
  plStatus RevertElement(plVariant index);
  plStatus RevertContainer();
  plVariant GetDefaultElement(plVariant index, plUInt32 uiSelectionIndex = 0) const;
  plVariant GetDefaultContainer(plUInt32 uiSelectionIndex = 0) const;
 
private:
  plObjectAccessorBase* m_pAccessor = nullptr;
  const plAbstractProperty* m_pProp = nullptr;
  plArrayPtr<plPropertySelection> m_Selection;
  plHybridArray<plHybridArray<plSharedPtr<plDefaultStateProvider>, 4>, 1> m_Providers;
};
 
class PL_GUIFOUNDATION_DLL plDefaultStateProvider : public plRefCounted
{
public:
  using SuperArray = const plArrayPtr<const plSharedPtr<plDefaultStateProvider>>;
 
  virtual plInt32 GetRootDepth() const = 0;
 
  virtual plColorGammaUB GetBackgroundColor() const = 0;
 
  virtual plString GetStateProviderName() const = 0;
 
  virtual plVariant GetDefaultValue(SuperArray superPtr, plObjectAccessorBase* pAccessor, const plDocumentObject* pObject, const plAbstractProperty* pProp, plVariant index = plVariant()) = 0;
 
  virtual plStatus CreateRevertContainerDiff(SuperArray superPtr, plObjectAccessorBase* pAccessor, const plDocumentObject* pObject, const plAbstractProperty* pProp, plDeque<plAbstractGraphDiffOperation>& out_diff) = 0;
 
public:
  virtual bool IsDefaultValue(SuperArray superPtr, plObjectAccessorBase* pAccessor, const plDocumentObject* pObject, const plAbstractProperty* pProp, plVariant index = plVariant());
  virtual plStatus RevertProperty(SuperArray superPtr, plObjectAccessorBase* pAccessor, const plDocumentObject* pObject, const plAbstractProperty* pProp, plVariant index = plVariant());
  virtual plStatus RevertObjectContainer(SuperArray superPtr, plObjectAccessorBase* pAccessor, const plDocumentObject* pObject, const plAbstractProperty* pProp);
 
  static bool DoesVariantMatchProperty(const plVariant& value, const plAbstractProperty* pProp, plVariant index = plVariant());
};