AZ::DocumentPropertyEditor::AdapterMessage Struct Reference

#include <DocumentAdapter.h>

Public Member Functions
bool	Match (Dom::Value &result) const
template<typename CallbackAttribute , typename Callback , typename... Rest>
bool	Match (Dom::Value &result, const CallbackAttribute &attribute, const Callback &callback, Rest... rest) const
template<typename CallbackAttribute , typename Callback , typename... Rest>
Dom::Value	Match (const CallbackAttribute &attribute, const Callback &callback, Rest... rest) const

Public Attributes
AZ::Name	m_messageName
	The name of this message (derived from the CallbackAttribute's name)
Dom::Path	m_messageOrigin
	The path in the adapter from which this message originated.
Dom::Value	m_messageParameters
	A DOM array value containing marshalled arguments for this message.
Dom::Value	m_contextData

Detailed Description

A message, invoked via CallbackAttribute, that is routed to a DocumentAdapter. Adapters, or their views, may handle these messages as they see fit, possibly providing a response.

Member Function Documentation

Match()

template<typename CallbackAttribute , typename Callback , typename... Rest>

Dom::Value AZ::DocumentPropertyEditor::AdapterMessage::Match ( const CallbackAttribute &  attribute, const Callback &  callback, Rest...  rest  ) const

inline

Takes arguments in pairs of {attribute, callback} and invokes the associated callback if this message is applicable.

Returns

The value returned by the message handler, or null if no messages matched.

Member Data Documentation

m_contextData

Dom::Value AZ::DocumentPropertyEditor::AdapterMessage::m_contextData

An arbitrary, user-specified DOM value containing additional context data. This is used to supplement message parameters on the adapter level.

---

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

• Code/Framework/AzFramework/AzFramework/DocumentPropertyEditor/DocumentAdapter.h