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.
Public Member Functions | Protected Member Functions | Friends | List of all members
AzToolsFramework::PropertyHandlerBase Class Referenceabstract

Inherited by AzToolsFramework::PropertyHandler_Internal< AudioControlSelectorWidget >, AzToolsFramework::PropertyHandler_Internal< PropertyCRCCtrl >, AzToolsFramework::PropertyHandler_Internal< ExeSelectPropertyCtrl >, AzToolsFramework::PropertyHandler_Internal< GenericComboBoxCtrlBase >, AzToolsFramework::PropertyHandler_Internal< PropertyControl >, AzToolsFramework::PropertyHandler_Internal< QLabel >, AzToolsFramework::PropertyHandler_Internal< GrowTextEdit >, AzToolsFramework::PropertyHandler_Internal< PropertyFilePathCtrl >, and AzToolsFramework::PropertyHandler_Internal< WidgetType >.

Public Member Functions

virtual void RegisterWithPropertySystem (AZ::DocumentPropertyEditor::PropertyEditorSystemInterface *)
 
virtual AZ::u32 GetHandlerName () const =0
 
virtual bool IsDefaultHandler () const
 
virtual bool AutoDelete () const
 
virtual int Priority () const
 
virtual QWidget * CreateGUI (QWidget *pParent)=0
 
virtual void DestroyGUI (QWidget *pTarget)
 
virtual bool ModifyNameLabel (QWidget *, QString &)
 
virtual bool ModifyTooltip (QWidget *, QString &)
 
virtual void PreventRefresh (QWidget *, bool)
 
virtual void RegisterDpeHandler ()
 
virtual void UnregisterDpeHandler ()
 

Protected Member Functions

virtual bool HandlesType (const AZ::Uuid &id) const =0
 
virtual AZ::TypeId GetHandledType () const =0
 

Friends

class ReflectedPropertyEditor
 
class Components::PropertyManagerComponent
 
template<typename WrappedType >
class RpePropertyHandlerWrapper
 

Member Function Documentation

◆ RegisterDpeHandler()

virtual void AzToolsFramework::PropertyHandlerBase::RegisterDpeHandler ( )
inlinevirtual

Registers this handler for usage in the DocumentPropertyHandler. GenericPropertyHandler handles this for most cases.

Reimplemented in AzToolsFramework::GenericPropertyHandler< WidgetType >, and AzToolsFramework::GenericPropertyHandler< QLabel >.

◆ UnregisterDpeHandler()

virtual void AzToolsFramework::PropertyHandlerBase::UnregisterDpeHandler ( )
inlinevirtual

Unregisters this handler from the DocumentPropertyHandler. GenericPropertyHandler handles this for most cases.

Reimplemented in AzToolsFramework::GenericPropertyHandler< WidgetType >, and AzToolsFramework::GenericPropertyHandler< QLabel >.

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