Open 3D Engine AzToolsFramework API Reference 26.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzToolsFramework::RpePropertyHandlerWrapper< WrappedType > Class Template Reference

Inherits AzToolsFramework::PropertyHandlerWidgetInterface, and IndividualPropertyHandlerEditNotifications::Bus::Handler.

Public Member Functions

 RpePropertyHandlerWrapper (PropertyHandlerBase &handlerToWrap)
 
QWidget * GetWidget () override
 Gets the widget that should be added to the DocumentPropertyEditor.
 
void SetValueFromDom (const AZ::Dom::Value &node)
 
bool ResetToDefaults () override
 Attempts to reset the widget handler to default, typically for recycling. Returns true if successful.
 
QWidget * GetFirstInTabOrder () override
 
QWidget * GetLastInTabOrder () override
 
void OnValueChanged (AZ::DocumentPropertyEditor::Nodes::ValueChangeType changeType) override
 
void OnRequestPropertyNotify () override
 
- Public Member Functions inherited from AzToolsFramework::PropertyHandlerWidgetInterface
virtual void SetFilter (const QString &filter)
 Allow the widget to lint its matching text to outline the current search.
 

Static Public Member Functions

static bool ShouldHandleType (PropertyHandlerBase &rpeHandler, const AZ::TypeId &typeId)
 
static const AZStd::string_view GetHandlerName (PropertyHandlerBase &rpeHandler)
 
- 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 ()
 

Member Function Documentation

◆ GetFirstInTabOrder()

template<typename WrappedType >
QWidget * AzToolsFramework::RpePropertyHandlerWrapper< WrappedType >::GetFirstInTabOrder ( )
inlineoverridevirtual

Returns the first widget in the tab order for this property editor, i.e. the widget that should be selected when the user hits tab on the widget immediately prior to this. By default, this returns GetWidget, a single widget tab order.

Reimplemented from AzToolsFramework::PropertyHandlerWidgetInterface.

◆ GetLastInTabOrder()

template<typename WrappedType >
QWidget * AzToolsFramework::RpePropertyHandlerWrapper< WrappedType >::GetLastInTabOrder ( )
inlineoverridevirtual

Returns the last widget in the tab order for this property editor, i.e. the widget that should select the widget immediately subsequent to this property editor when the user presses tab. By default, this returns GetWidget, a single widget tab order.

Reimplemented from AzToolsFramework::PropertyHandlerWidgetInterface.

◆ GetWidget()

template<typename WrappedType >
QWidget * AzToolsFramework::RpePropertyHandlerWrapper< WrappedType >::GetWidget ( )
inlineoverridevirtual

Gets the widget that should be added to the DocumentPropertyEditor.

Implements AzToolsFramework::PropertyHandlerWidgetInterface.

◆ ResetToDefaults()

template<typename WrappedType >
bool AzToolsFramework::RpePropertyHandlerWrapper< WrappedType >::ResetToDefaults ( )
inlineoverridevirtual

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

Reimplemented from AzToolsFramework::PropertyHandlerWidgetInterface.

◆ SetValueFromDom()

template<typename WrappedType >
void AzToolsFramework::RpePropertyHandlerWrapper< WrappedType >::SetValueFromDom ( const AZ::Dom::Value &  node)
inlinevirtual

Sets up the widget provided by GetWidget to reflect the values provided by a given DOM node. This should consume both the property value (if applicable) and any attributes, including OnChange.

Implements AzToolsFramework::PropertyHandlerWidgetInterface.


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