PowerUI.TranslationInfo Class Reference

Detailed Description

Holds information about a particular translation.

Public Member Functions

 TranslationInfo (string languagePath, string languageText, string from, string to, string toName)
 Holds the given information about a translation. More...
 
void Complete (string translation)
 Called when the translation is complete. More...
 
void WriteToFile ()
 Writes this translation result to it's file. Fails if there is no result. More...
 

Public Attributes

string Key
 The authentication key to use. Currently obtained from Bing. More...
 
string ToCode
 The lower case language code to translate to, e.g. fr. More...
 
string ToName
 The language tag to append to the start of the result. More...
 
string Result
 The resulting translated text. More...
 
string FromCode
 The lower case language code to translate from, e.g. en. More...
 
bool LeftToRight
 True if the result should be marked left to right. More...
 
string ToTranslate
 The text to be translated. <v> should be used here. More...
 
string LanguagePath
 The path to the Languages/UI folder. More...
 
OnTranslated OnComplete
 A delegate triggered when the translation is complete. More...
 

Properties

string LanguageTag [get]
 Gets the language tag. That's the small >language< tag at the top of the resulting file. More...
 
string Filepath [get]
 The path to the newly translated file. More...
 

Constructor & Destructor Documentation

PowerUI.TranslationInfo.TranslationInfo ( string  languagePath,
string  languageText,
string  from,
string  to,
string  toName 
)
inline

Holds the given information about a translation.

Parameters
languagePathThe path to the Languages/UI folder.
languageTextThe text to be translated. <v> should be used here.
fromThe lower case language code to translate from, e.g. en.
toThe lower case language code to translate to, e.g. fr.
toNameThe language tag to append to the start of the result.

Member Function Documentation

void PowerUI.TranslationInfo.Complete ( string  translation)
inline

Called when the translation is complete.

Parameters
translationThe translated result.
void PowerUI.TranslationInfo.WriteToFile ( )
inline

Writes this translation result to it's file. Fails if there is no result.

Member Data Documentation

string PowerUI.TranslationInfo.FromCode

The lower case language code to translate from, e.g. en.

string PowerUI.TranslationInfo.Key

The authentication key to use. Currently obtained from Bing.

string PowerUI.TranslationInfo.LanguagePath

The path to the Languages/UI folder.

bool PowerUI.TranslationInfo.LeftToRight

True if the result should be marked left to right.

OnTranslated PowerUI.TranslationInfo.OnComplete

A delegate triggered when the translation is complete.

string PowerUI.TranslationInfo.Result

The resulting translated text.

string PowerUI.TranslationInfo.ToCode

The lower case language code to translate to, e.g. fr.

string PowerUI.TranslationInfo.ToName

The language tag to append to the start of the result.

string PowerUI.TranslationInfo.ToTranslate

The text to be translated. <v> should be used here.

Property Documentation

string PowerUI.TranslationInfo.Filepath
get

The path to the newly translated file.

string PowerUI.TranslationInfo.LanguageTag
get

Gets the language tag. That's the small >language< tag at the top of the resulting file.