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::PropertyHandlerWidget< BaseWidget > Class Template Reference

#include <PropertyHandlerWidget.h>

Inherits BaseWidget, and AzToolsFramework::PropertyHandlerWidgetInterface.

Public Member Functions

 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 ()
 

Additional Inherited Members

- 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 ()
 

Detailed Description

template<typename BaseWidget>
class AzToolsFramework::PropertyHandlerWidget< BaseWidget >

Helper class, provides a PropertyHandlerWidgetInterface implementation in which the handler itself is-a QWidget of a given type. BaseWidget can be any QWidget subclass.

Member Function Documentation

◆ GetWidget()

template<typename BaseWidget >
QWidget * AzToolsFramework::PropertyHandlerWidget< BaseWidget >::GetWidget ( )
inlineoverridevirtual

Gets the widget that should be added to the DocumentPropertyEditor.

Implements AzToolsFramework::PropertyHandlerWidgetInterface.


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