Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzToolsFramework::Prefab::PrefabOverrideLabelHandler Class Reference

#include <PrefabOverrideLabelHandler.h>

Inherits AzToolsFramework::PropertyHandlerWidget< QWidget >.

Public Member Functions

void SetValueFromDom (const AZ::Dom::Value &value) override
 
- Public Member Functions inherited from AzToolsFramework::PropertyHandlerWidget< QWidget >
 PropertyHandlerWidget (QWidget *parent=nullptr)
 
QWidget * GetWidget () override
 Gets the widget that should be added to the DocumentPropertyEditor.
 
- Public Member Functions inherited from AzToolsFramework::PropertyHandlerWidgetInterface
virtual QWidget * GetWidget ()=0
 Gets the widget that should be added to the DocumentPropertyEditor.
 
virtual void SetValueFromDom (const AZ::Dom::Value &node)=0
 
virtual void PrepareWidgetForReuse ()
 Resets the widget's attributes for reuse.
 
virtual QWidget * GetFirstInTabOrder ()
 
virtual QWidget * GetLastInTabOrder ()
 

Static Public Member Functions

static constexpr const AZStd::string_view GetHandlerName ()
 
- Static Public Member Functions inherited from AzToolsFramework::PropertyHandlerWidgetInterface
static bool ShouldHandleType (const AZ::TypeId &typeId)
 
static constexpr const AZStd::string_view GetHandlerName ()
 
static constexpr bool IsDefaultHandler ()
 

Static Public Attributes

static constexpr const char * OverriddenPropertyName = "overridden"
 

Detailed Description

Class to handle the override label property when encountered in a DPE DOM. Responsible for setting the ui/ux for overridden properties.

Member Function Documentation

◆ SetValueFromDom()

void AzToolsFramework::Prefab::PrefabOverrideLabelHandler::SetValueFromDom ( const AZ::Dom::Value &  value)
overridevirtual

Specifies the behavior when override label property is encountered in the DPE DOM.

Parameters
valueThe value holding the override label property in the DPE DOM

Implements AzToolsFramework::PropertyHandlerWidgetInterface.


The documentation for this class was generated from the following file: