l.t.i.t.ITranslationMessage(Interface) : interface documentation

Part of lp.translations.interfaces.translationmessage View In Hierarchy

A translation message in a translation file.
Int id Undocumented
Object browser_pofile Undocumented
Int sequence Undocumented
Object potemplate Undocumented
Choice language Undocumented
Object potmsgset Undocumented
Datetime date_created Undocumented
Object submitter Undocumented
Datetime date_reviewed Undocumented
Object reviewer Undocumented
Object msgstr0 Undocumented
Object msgstr1 Undocumented
Object msgstr2 Undocumented
Object msgstr3 Undocumented
Object msgstr4 Undocumented
Object msgstr5 Undocumented
List all_msgstrs All translations [msgstr0, msgstr1, ...] for this message,
List translations All translations for this message, its number will depend on the
Text comment Undocumented
Choice origin Undocumented
Choice validation_status Undocumented
Bool is_current_ubuntu Undocumented
Bool is_complete Undocumented
Bool is_current_upstream Undocumented
Bool was_obsolete_in_last_import Undocumented
Bool is_empty Undocumented
Int plural_forms Undocumented
Bool is_diverged Undocumented
Method setPOFile Set a POFile for use in views.
Method getOnePOFile Get any POFile containing this translation.
Method ensureBrowserPOFile Assign the result of getOnePOFile to browser_pofile.
Method getSharedEquivalent Find shared message that otherwise exactly matches this one.
Method shareIfPossible Make this message shared, if possible.
Method isHidden Whether this is an unused, hidden suggestion in pofile.
Method destroySelf Remove this object.
Method clone Create a copy of this message associated with a different MsgSet.
Method approve Approve this suggestion, making it a current translation.
Method approveAsDiverged Approve this suggestion, as a diverged translation.
Method acceptFromImport Accept a suggestion coming from a translation import.
Method acceptFromUpstreamImportOnPackage Accept a suggestion coming from a translation import.
Method makeHTMLID Unique identifier for self, suitable for use in HTML element ids.
Method markReviewed Mark this message as reviewed.
id =
Undocumented
browser_pofile =
Undocumented
sequence =
Undocumented
potemplate =
Undocumented
language =
Undocumented
potmsgset =
Undocumented
date_created =
Undocumented
submitter =
Undocumented
date_reviewed =
Undocumented
reviewer =
Undocumented
msgstr0 =
Undocumented
msgstr1 =
Undocumented
msgstr2 =
Undocumented
msgstr3 =
Undocumented
msgstr4 =
Undocumented
msgstr5 =
Undocumented
all_msgstrs =
All translations [msgstr0, msgstr1, ...] for this message, including any empty ones.
translations =
All translations for this message, its number will depend on the number of plural forms available for its language.
comment =
Undocumented
origin =
Undocumented
validation_status =
Undocumented
is_current_ubuntu =
Undocumented
is_complete =
Undocumented
is_current_upstream =
Undocumented
was_obsolete_in_last_import =
Undocumented
is_empty =
Undocumented
plural_forms =
Undocumented
is_diverged =
Undocumented
def setPOFile(pofile):
Set a POFile for use in views.
def getOnePOFile():
Get any POFile containing this translation.
def ensureBrowserPOFile():
Assign the result of getOnePOFile to browser_pofile.

If browser_pofile is already set, it is left unchanged.

def getSharedEquivalent():
Find shared message that otherwise exactly matches this one.
def shareIfPossible():
Make this message shared, if possible.

If there is already a similar message that is shared, this message's information is merged into that of the existing one, and self is deleted.

def isHidden(pofile):
Whether this is an unused, hidden suggestion in pofile.

A suggestion is hidden if it's older than the current translation.

def destroySelf():
Remove this object.

It must not be referenced by any other object.

def clone(potmsgset):
Create a copy of this message associated with a different MsgSet.

potemplate of the clone is always None. Aside from this, all values should be the same.

def approve(pofile, reviewer, share_with_other_side=False, lock_timestamp=None):
Approve this suggestion, making it a current translation.
def approveAsDiverged(pofile, reviewer, lock_timestamp=None):
Approve this suggestion, as a diverged translation.
def acceptFromImport(pofile, share_with_other_side=False, lock_timestamp=None):
Accept a suggestion coming from a translation import.
def acceptFromUpstreamImportOnPackage(pofile, lock_timestamp=None):
Accept a suggestion coming from a translation import.

This method allows to mark a translation as being current in upstream even though there is no upstream template.

def makeHTMLID(description):
Unique identifier for self, suitable for use in HTML element ids.

Constructs an identifier for use in HTML. This identifier matches the format parsed by BaseTranslationView.

Parametersdescriptiona keyword to be embedded in the id string, e.g. "suggestion" or "translation." Must be suitable for use in an HTML element id.
def markReviewed(reviewer, timestamp=None):
Mark this message as reviewed.

Sets the reviewer and review date for this message.

Parametersreviewerthe person who reviewed the message.
timestampoptional timestamp indicating when the review happened. Defaults to "now."
API Documentation for Launchpad, generated by pydoctor at 2020-07-03 00:00:04.