AtomToolsFramework::InspectorRequests Class Reference

Inherits AZ::EBusTraits.

Public Types
typedef AZ::Uuid	BusIdType

Public Member Functions
virtual void	AddHeading (QWidget *headingWidget)=0
	Add heading widget above scroll area.
virtual void	ClearHeading ()=0
	Clear heading widgets.
virtual void	Reset ()=0
	Clear all inspector groups and content.
virtual void	AddGroupsBegin ()=0
	Called before all groups are added.
virtual void	AddGroupsEnd ()=0
	Called after all groups are added.
virtual void	AddGroup (const AZStd::string &groupName, const AZStd::string &groupDisplayName, const AZStd::string &groupDescription, QWidget *groupWidget)=0
	Add a group consisting of a collapsable header and widget.
virtual void	SetGroupVisible (const AZStd::string &groupName, bool visible)=0
	Sets the visibility of a specific property group. This impacts both the header and the widget.
virtual bool	IsGroupVisible (const AZStd::string &groupName) const =0
virtual bool	IsGroupHidden (const AZStd::string &groupName) const =0
virtual void	RefreshGroup (const AZStd::string &groupName)=0
	Calls Refresh for a specific InspectorGroupWidget, allowing for non-destructive UI changes.
virtual void	RebuildGroup (const AZStd::string &groupName)=0
	Calls Rebuild for a specific InspectorGroupWidget, allowing for destructive UI changes.
virtual void	RefreshAll ()=0
	Calls Refresh for all InspectorGroupWidget, allowing for non-destructive UI changes.
virtual void	RebuildAll ()=0
	Calls Rebuild for all InspectorGroupWidget, allowing for destructive UI changes.
virtual void	ExpandGroup (const AZStd::string &groupName)=0
	Expands a specific group.
virtual void	CollapseGroup (const AZStd::string &groupName)=0
	Collapses a specific group.
virtual bool	IsGroupExpanded (const AZStd::string &groupName) const =0
	Checks the expansion state of a specific group.
virtual void	ExpandAll ()=0
	Expands all groups and headers.
virtual void	CollapseAll ()=0
	Collapses all groups and headers.

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::ById

Member Function Documentation

IsGroupHidden()

virtual bool AtomToolsFramework::InspectorRequests::IsGroupHidden ( const AZStd::string & groupName ) const

pure virtual

Returns whether a specific property is explicitly hidden. Note this follows the same rules as QWidget::isHidden(), meaning a group that is hidden will not become visible automatically when the parent becomes visible.

IsGroupVisible()

virtual bool AtomToolsFramework::InspectorRequests::IsGroupVisible ( const AZStd::string & groupName ) const

pure virtual

Returns whether a specific property is visible. Note this follows the same rules as QWidget::isVisible(), meaning a group could be not visible due to the widget's parents being not visible.

---

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

• Gems/Atom/Tools/AtomToolsFramework/Code/Include/AtomToolsFramework/Inspector/InspectorRequestBus.h