mirror of
https://github.com/MindWorkAI/AI-Studio.git
synced 2025-04-28 16:59:47 +00:00
41 lines
1.8 KiB
C#
41 lines
1.8 KiB
C#
namespace AIStudio.Tools.PluginSystem;
|
|
|
|
/// <summary>
|
|
/// Represents a contract to access text from a language plugin.
|
|
/// </summary>
|
|
public interface ILang
|
|
{
|
|
/// <summary>
|
|
/// Tries to get a text from the language plugin.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The given fallback text is used to determine the key for
|
|
/// the language plugin. Base for the key is the namespace of
|
|
/// the using component and the fallback text in English (US).
|
|
/// The given text getting hashed. When the key does not exist,
|
|
/// the fallback text will be returned.
|
|
/// </remarks>
|
|
/// <param name="fallbackEN">The fallback text in English (US).</param>
|
|
/// <returns>The text from the language plugin or the fallback text.</returns>
|
|
public string T(string fallbackEN);
|
|
|
|
/// <summary>
|
|
/// Tries to get a text from the language plugin.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The given fallback text is used to determine the key for
|
|
/// the language plugin. Base for the key is the namespace of
|
|
/// the using component and the fallback text in English (US).
|
|
/// The given text is hashed. When the key does not exist,
|
|
/// the fallback text will be returned.<br/>
|
|
/// <br/>
|
|
/// You might predefine the namespace and type. This is needed
|
|
/// when your abstract base class component wants to localize
|
|
/// text as well.
|
|
/// </remarks>
|
|
/// <param name="fallbackEN">The fallback text in English (US).</param>
|
|
/// <param name="typeNamespace">The namespace of the type requesting the text, used as part of the key.</param>
|
|
/// <param name="typeName">The name of the type requesting the text, used as part of the key.</param>
|
|
/// <returns>The text from the language plugin or the fallback text.</returns>
|
|
public string T(string fallbackEN, string? typeNamespace, string? typeName);
|
|
} |