DataDescriptionObjectInterface Class Reference

#include <datadescriptionobject.h>

Inheritance diagram for DataDescriptionObjectInterface:

详细描述

Interface and base implementation to allow objects to access descriptions. The base implementation automatically loads resources from the data description data bases.

公共成员函数

MAXON_METHOD Result < DataDescription >  GetObjectDescription (const Id &category, const LanguageRef &language, const DataDictionaryObjectRef &objectData) const

静态公共成员函数

static MAXON_METHOD Result < String GetObjectName (const Id &classId, const LanguageRef &language)

私有成员函数

  MAXON_INTERFACE ( DataDescriptionObjectInterface , MAXON_REFERENCE_NORMAL , "net.maxon.interface.datadescriptionobject")

成员函数文档编制

◆  MAXON_INTERFACE()

MAXON_INTERFACE ( DataDescriptionObjectInterface   ,
MAXON_REFERENCE_NORMAL   ,
"net.maxon.interface.datadescriptionobject"   
)
private

◆  GetObjectDescription()

MAXON_METHOD Result <DataDescription> GetObjectDescription ( const Id category ,
const LanguageRef &  language ,
const DataDictionaryObjectRef &  objectData  
) const

GetObjectDescription returns the description of the object.

参数
[in] category 描述 category to load (DATADESCRIPTION_CATEGORY_DATA/DATADESCRIPTION_CATEGORY_UI).
[in] language Language (only valid for category DATADESCRIPTION_CATEGORY_STRING).
[in] objectData 数据 of the object to use for evaluation.
返回
DataDescription on success. If the 描述 could not be found an empty description is returned but no error.

◆  GetObjectName()

static MAXON_METHOD Result < String > GetObjectName ( const Id classId ,
const LanguageRef &  language  
)
static

GetObjectName returns the localized name of the description (OBJECT::BASE::NAME).

参数
[in] classId Id of the class to determine.
[in] language Language to use. "nullptr" for current language.
返回
String on success.