Open 3D Engine EditorPythonBindings Gem 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.
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
EditorPythonBindings::PythonActionManagerHandler Class Referencefinal

#include <PythonActionManagerHandler.h>

Inherits ActionManagerRequestBus::Handler, MenuManagerRequestBus::Handler, ToolBarManagerRequestBus::Handler, and EditorPythonBindings::CustomTypeBindingNotificationBus::Handler.

Public Types

using Handle = EditorPythonBindings::CustomTypeBindingNotifications::ValueHandle
 
using AllocationHandle = EditorPythonBindings::CustomTypeBindingNotifications::AllocationHandle
 

Public Member Functions

AzToolsFramework::ActionManagerOperationResult RegisterAction (const AZStd::string &contextIdentifier, const AZStd::string &actionIdentifier, const AzToolsFramework::ActionProperties &properties, PythonEditorAction handler) override
 
AzToolsFramework::ActionManagerOperationResult RegisterCheckableAction (const AZStd::string &contextIdentifier, const AZStd::string &actionIdentifier, const AzToolsFramework::ActionProperties &properties, PythonEditorAction handler, PythonEditorAction updateCallback) override
 
AzToolsFramework::ActionManagerOperationResult TriggerAction (const AZStd::string &actionIdentifier) override
 
AzToolsFramework::ActionManagerOperationResult UpdateAction (const AZStd::string &actionIdentifier) override
 
AzToolsFramework::MenuManagerOperationResult RegisterMenu (const AZStd::string &identifier, const AzToolsFramework::MenuProperties &properties) override
 
AzToolsFramework::MenuManagerOperationResult AddActionToMenu (const AZStd::string &menuIdentifier, const AZStd::string &actionIdentifier, int sortIndex) override
 
AzToolsFramework::MenuManagerOperationResult AddSeparatorToMenu (const AZStd::string &menuIdentifier, int sortIndex) override
 
AzToolsFramework::MenuManagerOperationResult AddSubMenuToMenu (const AZStd::string &menuIdentifier, const AZStd::string &subMenuIdentifier, int sortIndex) override
 
AzToolsFramework::MenuManagerOperationResult AddWidgetToMenu (const AZStd::string &menuIdentifier, const AZStd::string &widgetActionIdentifier, int sortIndex) override
 
AzToolsFramework::MenuManagerOperationResult AddMenuToMenuBar (const AZStd::string &menuBarIdentifier, const AZStd::string &menuIdentifier, int sortIndex) override
 
AzToolsFramework::ToolBarManagerOperationResult RegisterToolBar (const AZStd::string &toolBarIdentifier, const AzToolsFramework::ToolBarProperties &properties) override
 
AzToolsFramework::ToolBarManagerOperationResult RegisterToolBarArea (const AZStd::string &toolBarAreaIdentifier, QMainWindow *mainWindow, Qt::ToolBarArea toolBarArea) override
 
AzToolsFramework::ToolBarManagerOperationResult AddActionToToolBar (const AZStd::string &toolBarIdentifier, const AZStd::string &actionIdentifier, int sortIndex) override
 
AzToolsFramework::ToolBarManagerOperationResult AddActionWithSubMenuToToolBar (const AZStd::string &toolBarIdentifier, const AZStd::string &actionIdentifier, const AZStd::string &subMenuIdentifier, int sortIndex) override
 
AzToolsFramework::ToolBarManagerOperationResult AddActionsToToolBar (const AZStd::string &toolBarIdentifier, const AZStd::vector< AZStd::pair< AZStd::string, int > > &actions) override
 
AzToolsFramework::ToolBarManagerOperationResult RemoveActionFromToolBar (const AZStd::string &toolBarIdentifier, const AZStd::string &actionIdentifier) override
 
AzToolsFramework::ToolBarManagerOperationResult RemoveActionsFromToolBar (const AZStd::string &toolBarIdentifier, const AZStd::vector< AZStd::string > &actionIdentifiers) override
 
AzToolsFramework::ToolBarManagerOperationResult AddSeparatorToToolBar (const AZStd::string &toolBarIdentifier, int sortIndex) override
 
AzToolsFramework::ToolBarManagerOperationResult AddWidgetToToolBar (const AZStd::string &toolBarIdentifier, const AZStd::string &widgetActionIdentifier, int sortIndex) override
 
AzToolsFramework::ToolBarManagerOperationResult AddToolBarToToolBarArea (const AZStd::string &toolBarAreaIdentifier, const AZStd::string &toolBarIdentifier, int sortIndex) override
 
QToolBar * GenerateToolBar (const AZStd::string &toolBarIdentifier) override
 
AzToolsFramework::ToolBarManagerIntegerResult GetSortKeyOfActionInToolBar (const AZStd::string &toolBarIdentifier, const AZStd::string &actionIdentifier) const override
 
AzToolsFramework::ToolBarManagerIntegerResult GetSortKeyOfWidgetInToolBar (const AZStd::string &toolBarIdentifier, const AZStd::string &widgetActionIdentifier) const override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Static Public Attributes

static constexpr Handle NoAllocation { ~0LL }
 

Detailed Description

Handler for the Python integration of the Action Manager system. Provides implementation for the Action Manager buses, and for marshaling Python callable objects as functions for use in C++ with correct reference counting to prevent them from being garbage collected.

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