AzToolsFramework::Prefab::PrefabOverrideLabelHandler Class Reference

#include <PrefabOverrideLabelHandler.h>

Inherits AzToolsFramework::PropertyHandlerWidget< QWidget >.

Public Member Functions
void	SetValueFromDom (const AZ::Dom::Value &value) override
bool	ResetToDefaults () override
	Attempts to reset the widget handler to default, typically for recycling. Returns true if successful.
void	SetFilter (const QString &filter) override
	Allow the widget to lint its matching text to outline the current search.
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 *	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

ResetToDefaults()

bool AzToolsFramework::Prefab::PrefabOverrideLabelHandler::ResetToDefaults ( )

overridevirtual

Attempts to reset the widget handler to default, typically for recycling. Returns true if successful.

Reimplemented from AzToolsFramework::PropertyHandlerWidgetInterface.

SetFilter()

void AzToolsFramework::Prefab::PrefabOverrideLabelHandler::SetFilter ( const QString &  filter )

overridevirtual

Allow the widget to lint its matching text to outline the current search.

Reimplemented from AzToolsFramework::PropertyHandlerWidgetInterface.

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

value

The value holding the override label property in the DPE DOM

Implements AzToolsFramework::PropertyHandlerWidgetInterface.

---

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

• Code/Framework/AzToolsFramework/AzToolsFramework/Prefab/DocumentPropertyEditor/PrefabOverrideLabelHandler.h