DataDescriptionUIInterface Class Reference

#include <datadescription_ui.h>

Inheritance diagram for DataDescriptionUIInterface:

Detailed Description

This interface provides helper functions for ui stuff in combination with descriptions.

Static Public Member Functions
static MAXON_METHOD Result< Bool >	EvaluateCondition (const CString &condition, const DataDescriptionWithUIAndString &description, const BaseArray< DataDictionary > &uiEntries, const GetDataCallbackType &getDataCallback, const HashMap< CString, CString > &externalVariables)
static MAXON_METHOD Result< void >	BuildPopupMenuForDescription (const DataDescriptionWithUIAndString &description, const HashMap< CString, CString > &externalVariables, const ContextVarsMap &contextVars, const ValueReceiver< SubMenuEntry && > &mainMenuEntries)

Private Member Functions
	MAXON_INTERFACE (DataDescriptionUIInterface, MAXON_REFERENCE_CONST, "net.maxon.interface.datadescriptionui")

Member Function Documentation

MAXON_INTERFACE()

MAXON_INTERFACE ( DataDescriptionUIInterface  , MAXON_REFERENCE_CONST  , "net.maxon.interface.datadescriptionui"    )

private

EvaluateCondition()

static MAXON_METHOD Result<Bool> EvaluateCondition ( const CString &  condition, const DataDescriptionWithUIAndString &  description, const BaseArray< DataDictionary > &  uiEntries, const GetDataCallbackType &  getDataCallback, const HashMap< CString, CString > &  externalVariables  )

static

Evaluates a condition for a given uiEntry

Parameters

[in]	condition	Condition string to evaluate.
[in]	description	Description to use.
[in]	uiEntries	UI entries.
[in]	getDataCallback	Callback to get data for the evaluation.
[in]	externalVariables	External variables for the FormulaParser.

Returns

True if the condition matches. False if not.

BuildPopupMenuForDescription()

static MAXON_METHOD Result<void> BuildPopupMenuForDescription ( const DataDescriptionWithUIAndString &  description, const HashMap< CString, CString > &  externalVariables, const ContextVarsMap &  contextVars, const ValueReceiver< SubMenuEntry && > &  mainMenuEntries  )

static

BuildPopupMenuForDescription description.

Parameters

[in]	description	Description to use.
[in]	externalVariables	External variables for the FormulaParser.
[in]	contextVars	HashMap with variables to execute and evaluate the menu checks for each context that should be used.
[out]	mainMenuEntries	Value Receiver which receives the created menu entries.

Returns

OK on success.