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::GenericButtonHandler Class Reference

Inherits AzToolsFramework::PropertyHandlerWidget< QToolButton >.

Inherited by AzToolsFramework::ContainerActionButtonHandler.

Public Member Functions

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

Protected Member Functions

virtual void OnClicked ()
 

Protected Attributes

AZ::Dom::Value m_node
 

Member Function Documentation

◆ ResetToDefaults()

virtual bool AzToolsFramework::GenericButtonHandler::ResetToDefaults ( )
inlineoverridevirtual

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

Reimplemented from AzToolsFramework::PropertyHandlerWidgetInterface.

Reimplemented in AzToolsFramework::ContainerActionButtonHandler.

◆ SetValueFromDom()

virtual void AzToolsFramework::GenericButtonHandler::SetValueFromDom ( const AZ::Dom::Value &  node)
overridevirtual

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.

Reimplemented in AzToolsFramework::ContainerActionButtonHandler.


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