AzToolsFramework::EditorContextMenuEvents Class Reference

Editor Settings API Bus. More...

#include <EditorContextMenuBus.h>

Inherits AZ::EBusTraits.

Classes
struct	BusHandlerOrderCompare

Public Member Functions
virtual int	GetMenuPosition () const
virtual AZStd::string	GetMenuIdentifier () const
virtual void	PopulateEditorGlobalContextMenu (QMenu *menu, const AZStd::optional< AzFramework::ScreenPoint > &point, int flags)=0

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::MultipleAndOrdered
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::Single

Detailed Description

Editor Settings API Bus.

Member Function Documentation

GetMenuIdentifier()

virtual AZStd::string AzToolsFramework::EditorContextMenuEvents::GetMenuIdentifier ( ) const

inlinevirtual

Returns the identifier for this handler. Used to break ties in the order comparison.

Returns

A string containing the identifier for this handler.

GetMenuPosition()

virtual int AzToolsFramework::EditorContextMenuEvents::GetMenuPosition ( ) const

inlinevirtual

Specifies the order in which a handler receives context menu events relative to other handlers. This value should not be changed while the handler is connected. Use the EditorContextMenuOrdering enum values as a baseline.

Returns

A value specifying this handler's relative order.

PopulateEditorGlobalContextMenu()

virtual void AzToolsFramework::EditorContextMenuEvents::PopulateEditorGlobalContextMenu ( QMenu *  menu, const AZStd::optional< AzFramework::ScreenPoint > &  point, int  flags  )

pure virtual

Appends menu items to the global editor context menu. This is the menu that appears when right clicking the main editor window, including the Entity Outliner and the Viewport.

Parameters

menu	The QMenu to append menu items to.
point	An optional screen point indicating where the user clicked in the 3d viewport for entity placement. note: AZStd::nullopt may be passed when the context menu is created outside of the 3d viewport.
flags	See EditorEvents::EditorContextMenuFlags for available flags to pass.

---

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

• Code/Framework/AzToolsFramework/AzToolsFramework/Editor/EditorContextMenuBus.h