maxon.LazyLanguageDictionaryInterface

Description

Interface to manage lazy loading of maxon.LanguageDictionary for description strings.

Inheritance diagram

Inheritance

Parent Class:

Child Class:

Methods Signature

Get(languageId)

Returns the description of the given language.

GetMetaData()

Returns all descriptions to export.

LoadAll()

Loads all string resources from the meta data into memory (e.g.

NullValuePtr()

Helper function to return the default value for an empty cow object.

Set(languageId, description)

Stores the description for the given language.

SetMetaData(meta, path)

Sets the asset from which the definition shall be loaded lazily.

Methods Definition

LazyLanguageDictionaryInterface.Get(languageId)

Returns the description of the given language.

Parameters

languageId (maxon.Id) – Id of the language to load.

Returns

maxon.DataDictionary on success.

Return type

maxon.DataDictionary

LazyLanguageDictionaryInterface.GetMetaData()

Returns all descriptions to export.

Returns

maxon.DataDictionary on success.

Return type

maxon.DataDictionary

LazyLanguageDictionaryInterface.LoadAll()

Loads all string resources from the meta data into memory (e.g. for copying data).

LazyLanguageDictionaryInterface.NullValuePtr()

Helper function to return the default value for an empty cow object.

Returns

An empty maxon.LazyLanguageDictionary.

Return type

maxon.LazyLanguageDictionary

LazyLanguageDictionaryInterface.Set(languageId, description)

Stores the description for the given language.

Parameters
LazyLanguageDictionaryInterface.SetMetaData(meta, path)

Sets the asset from which the definition shall be loaded lazily.

Parameters
  • meta (maxon.AssetMetaData) – Asset meta data to use for loading the strings.

  • path (str) – Relative path of the description within the asset.