pyams_i18n.interfaces package ⊞

interface pyams_i18n.interfaces.II18n[source]

I18n attribute interface

get_attribute(self, attribute, lang=None, request=None, default=None)

Get attribute in given language

query_attribute(self, attribute, lang=None, request=None)

Query attribute in given language

interface pyams_i18n.interfaces.II18nManager[source]

Context languages manager

This interface is used to handle contents providing several languages

languages

Proposed languages

List of languages available for this content

Implementation:zope.schema.List
Read Only:False
Required:False
Default Value:None
Allowed Type:list

Value Type

Implementation:zope.schema.Choice
Read Only:False
Required:True
Default Value:None
get_languages(self)

Get full languages list

interface pyams_i18n.interfaces.INegotiator[source]

Local negotiator utility manager interface.

policy

Language lookup policy

Defines how the language lookup is working.

Implementation:zope.schema.Choice
Read Only:False
Required:True
Default Value:‘session –> browser –> server’
server_language

Server language

The language used for server policy.

Implementation:zope.schema.Choice
Read Only:False
Required:True
Default Value:‘en’
offered_languages

Offered languages

A list of offered languages. Can be used to user select languages which are offered in a skin.

Implementation:zope.schema.Set
Read Only:False
Required:True
Default Value:{‘en’}
Allowed Type:set

Value Type

Implementation:zope.schema.Choice
Read Only:False
Required:True
Default Value:None
cache_enabled

Language caching enabled

Language caching enabled (per request)

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
get_language(self, request)

Return the matching language to use.

If ‘lang’ parameter is defined into request, this lang is returned. Otherwise, returned language is based on browser settings, user’s session or server’s language, depending on negotiator’s settings.

If no match is found, None is returned.

clear_cache(self, request)

Clear cached language value

interface pyams_i18n.interfaces.IUserPreferredLanguage[source]

This interface provides language negotiation based on user preferences

get_language(self)

Return main user preferred language

pyams_i18n.interfaces.schema

interface pyams_i18n.interfaces.schema.II18nAudioField[source]

Extends: pyams_i18n.interfaces.schema.II18nMediaField

I18n audio field marker interface

interface pyams_i18n.interfaces.schema.II18nField[source]

Extends: zope.schema.interfaces.IDict

I18n field marker interface

interface pyams_i18n.interfaces.schema.II18nFileField[source]

Extends: pyams_i18n.interfaces.schema.II18nField

I18n file field marker interface

interface pyams_i18n.interfaces.schema.II18nHTMLField[source]

Extends: pyams_i18n.interfaces.schema.II18nField

I18n HTML field marker interface

interface pyams_i18n.interfaces.schema.II18nImageField[source]

Extends: pyams_i18n.interfaces.schema.II18nFileField

I18n image field marker interface

interface pyams_i18n.interfaces.schema.II18nMediaField[source]

Extends: pyams_i18n.interfaces.schema.II18nFileField

I18n media field marker interface

interface pyams_i18n.interfaces.schema.II18nTextField[source]

Extends: pyams_i18n.interfaces.schema.II18nField

I18n text field marker interface

interface pyams_i18n.interfaces.schema.II18nTextLineField[source]

Extends: pyams_i18n.interfaces.schema.II18nField

I18n text line field marker interface

interface pyams_i18n.interfaces.schema.II18nThumbnailImageField[source]

Extends: pyams_i18n.interfaces.schema.II18nImageField

I18n image field with thumbnail marker interface

interface pyams_i18n.interfaces.schema.II18nThumbnailMediaField[source]

Extends: pyams_i18n.interfaces.schema.II18nMediaField

I18n media field with thumbnail marker interface

interface pyams_i18n.interfaces.schema.II18nThumbnailVideoField[source]

Extends: pyams_i18n.interfaces.schema.II18nVideoField

I18n video field with thumbnail marker interface

interface pyams_i18n.interfaces.schema.II18nVideoField[source]

Extends: pyams_i18n.interfaces.schema.II18nMediaField

I18n video field marker interface

pyams_i18n.interfaces.widget

interface pyams_i18n.interfaces.widget.II18nFileWidget[source]

Extends: pyams_i18n.interfaces.widget.II18nWidget

I18n file widget interface

interface pyams_i18n.interfaces.widget.II18nHTMLWidget[source]

Extends: pyams_i18n.interfaces.widget.II18nWidget

I18n HTML widget interface

interface pyams_i18n.interfaces.widget.II18nSEOTextLineWidget[source]

Extends: pyams_i18n.interfaces.widget.II18nTextLineWidget

I18n text line widget wit SEO quality marker interface

interface pyams_i18n.interfaces.widget.II18nTextLineWidget[source]

Extends: pyams_i18n.interfaces.widget.II18nWidget

I18n text line widget interface

interface pyams_i18n.interfaces.widget.II18nTextWidget[source]

Extends: pyams_i18n.interfaces.widget.II18nWidget

I18n text widget interface

interface pyams_i18n.interfaces.widget.II18nWidget[source]

Extends: z3c.form.interfaces.IWidget

I18n base widget interface

set_mode(self, mode)

Set given mode to widget and all it’s sub-widgets